Create API Key

curl --request POST \
  --url https://api.velt.dev/v2/workspace/apikey/create \
  --header 'Content-Type: application/json' \
  --header 'x-velt-auth-token: <x-velt-auth-token>' \
  --header 'x-velt-workspace-id: <x-velt-workspace-id>' \
  --data '
{
  "data": {
    "ownerEmail": "<string>",
    "type": "<string>",
    "createAuthToken": true,
    "apiKeyName": "<string>",
    "planInfo": {
      "type": "<string>"
    },
    "customPlanInfo": true,
    "customPlanInfoData": {},
    "allowedDomains": [
      "<string>"
    ],
    "addLocalHostToAllowedDomains": true,
    "useEmailService": true,
    "useWebhookService": true,
    "emailServiceConfig": {
      "type": "<string>",
      "apiKey": "<string>",
      "fromEmail": "<string>",
      "fromCompany": "<string>",
      "commentTemplateId": "<string>",
      "tagTemplateId": "<string>"
    },
    "webhookServiceConfig": {
      "authToken": "<string>",
      "rawNotificationUrl": "<string>",
      "processedNotificationUrl": "<string>"
    }
  }
}
'

{
  "result": {
    "status": "success",
    "message": "API key created successfully.",
    "data": {
      "apiKey": "your_new_api_key"
    }
  }
}

POST

workspace

apikey

create

Create API Key

curl --request POST \
  --url https://api.velt.dev/v2/workspace/apikey/create \
  --header 'Content-Type: application/json' \
  --header 'x-velt-auth-token: <x-velt-auth-token>' \
  --header 'x-velt-workspace-id: <x-velt-workspace-id>' \
  --data '
{
  "data": {
    "ownerEmail": "<string>",
    "type": "<string>",
    "createAuthToken": true,
    "apiKeyName": "<string>",
    "planInfo": {
      "type": "<string>"
    },
    "customPlanInfo": true,
    "customPlanInfoData": {},
    "allowedDomains": [
      "<string>"
    ],
    "addLocalHostToAllowedDomains": true,
    "useEmailService": true,
    "useWebhookService": true,
    "emailServiceConfig": {
      "type": "<string>",
      "apiKey": "<string>",
      "fromEmail": "<string>",
      "fromCompany": "<string>",
      "commentTemplateId": "<string>",
      "tagTemplateId": "<string>"
    },
    "webhookServiceConfig": {
      "authToken": "<string>",
      "rawNotificationUrl": "<string>",
      "processedNotificationUrl": "<string>"
    }
  }
}
'

{
  "result": {
    "status": "success",
    "message": "API key created successfully.",
    "data": {
      "apiKey": "your_new_api_key"
    }
  }
}

Use this API to create a new API key for a workspace.

This endpoint uses workspace-level auth: pass x-velt-workspace-id and x-velt-auth-token (from the Create Workspace response) as headers.

Endpoint

POST https://api.velt.dev/v2/workspace/apikey/create

Headers

x-velt-workspace-id

string

required

Your Workspace ID.

x-velt-auth-token

string

required

Your Auth Token.

Body

Params

data

object

required

Show properties

ownerEmail

string

required

Email address of the API key owner.

type

string

required

API key type. Accepted values: "testing" or "production". Production keys require planInfo or customPlanInfo.

createAuthToken

boolean

Whether to create an auth token along with the API key. Recommended: true.

apiKeyName

string

Display name for the API key.

planInfo

object

Plan information object associated with this API key. Required for "production" type unless customPlanInfo is true.

Show properties

type

string

Plan type identifier (e.g., "sdk test", "production").

customPlanInfo

boolean

Whether to use custom plan info instead of standard planInfo.

customPlanInfoData

object

Freeform custom plan info data payload. Required when customPlanInfo is true. You can pass any key-value pairs needed for your custom plan configuration.

allowedDomains

string[]

List of domains allowed to use this API key.

addLocalHostToAllowedDomains

boolean

Whether to automatically add localhost to allowed domains.

useEmailService

boolean

Whether to enable the email service for this API key.

useWebhookService

boolean

Whether to enable the webhook service for this API key.

emailServiceConfig

object

Configuration object for the email service. See Update Email Config for the full schema.

Show properties

type

string

Email service provider type. Accepted values: "default" or "sendgrid".

apiKey

string

API key for the email service provider (e.g., your SendGrid API key).

fromEmail

string

Sender email address.

fromCompany

string

Sender company name.

commentTemplateId

string

SendGrid template ID for comment notification emails.

tagTemplateId

string

SendGrid template ID for tag/mention notification emails.

webhookServiceConfig

object

Configuration object for the webhook service. See Update Webhook Config for the full schema.

Show properties

authToken

string

Auth token sent with each webhook request for verification.

rawNotificationUrl

string

URL to receive raw (unprocessed) webhook notifications.

processedNotificationUrl

string

URL to receive processed webhook notifications.

Example Request

{
  "data": {
    "ownerEmail": "owner@example.com",
    "type": "testing",
    "createAuthToken": true
  }
}

Example Response

Success Response

{
  "result": {
    "status": "success",
    "message": "API key created successfully.",
    "data": {
      "apiKey": "your_new_api_key"
    }
  }
}

Failure Response

{
  "error": {
    "status": "INVALID_ARGUMENT",
    "message": "ownerEmail is required."
  }
}

{
  "result": {
    "status": "success",
    "message": "API key created successfully.",
    "data": {
      "apiKey": "your_new_api_key"
    }
  }
}

Send Login Link Get API Keys

⌘I

REST APIs

SDK

Create API Key

Endpoint

Headers

Body

Params

Example Request

Example Response

Success Response

Failure Response

REST APIs

SDK

​Endpoint

​Headers

​Body

​Params

​Example Request

​Example Response

​Success Response

​Failure Response

Endpoint

Headers

Body

Params

Example Request

Example Response

Success Response

Failure Response