Create API Key

POST /v2/workspace/apikey/create

Create API Key

cURL

curl --request POST \
  --url https://api.velt.dev/v2/workspace/apikey/create \
  --header 'Content-Type: application/json' \
  --header 'x-velt-workspace-auth-token: <x-velt-workspace-auth-token>' \
  --header 'x-velt-workspace-id: <x-velt-workspace-id>' \
  --data '
{
  "data": {
    "ownerEmail": "<string>",
    "type": "<string>",
    "persistenceDBRegion": "<string>",
    "createAuthToken": true,
    "apiKeyName": "<string>",
    "allowedDomains": [
      "<string>"
    ],
    "addLocalHostToAllowedDomains": true,
    "useEmailService": true,
    "useWebhookService": true,
    "useNotificationService": true,
    "setDefaultNotificationTriggers": true,
    "setDefaultEmailTriggers": true,
    "requireAutoOrgUser": true,
    "enablePrivateComments": 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-workspace-auth-token (from the Create Workspace response) as headers.

Creating a production API key is gated. The workspace must be explicitly enabled for self‑serve production key creation and must already be on a paid plan. See Production API Keys below.

​

Endpoint

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

​

Headers

x-velt-workspace-id · string · required

Your Workspace ID.

x-velt-workspace-auth-token · string · required

Your workspace Auth Token.

​

Body

​

Params

data · object · required

Show properties

ownerEmail · string · required

Email address of the API key owner. Must be a valid email.

type · string · required

API key type. Accepted values: "testing" or "production".

persistenceDBRegion · string

Provide this only for type: "production". Accepts any supported region from Supported Regions.

createAuthToken · boolean

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

apiKeyName · string

Display name for the API key.

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.

useNotificationService · boolean

Whether to enable the in‑app notification service for this API key.

setDefaultNotificationTriggers · boolean

Seed the default notification triggers when enabling the notification service.

setDefaultEmailTriggers · boolean

Seed the default email triggers when enabling the email service.

requireAutoOrgUser · boolean

Require auto‑creation of the organization user.

enablePrivateComments · boolean

Initial value for the workspace‑scoped private comments feature flag. Defaults to false when omitted.

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

​

Testing key

{
  "data": {
    "ownerEmail": "[e-mail]",
    "type": "testing",
    "createAuthToken": true
  }
}

​

Production key (default North America region)

{
  "data": {
    "ownerEmail": "[e-mail]",
    "type": "production",
    "apiKeyName": "Production Key",
    "createAuthToken": true
  }
}

​

Production key with region selection (Europe)

{
  "data": {
    "ownerEmail": "[e-mail]",
    "type": "production",
    "apiKeyName": "EU Production Key",
    "persistenceDBRegion": "eur3",
    "realtimeDBRegion": "europe-west1",
    "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."
  }
}

​

Errors

Status	When
INVALID_ARGUMENT	Missing/invalid ownerEmail or type, or an unsupported persistenceDBRegion / realtimeDBRegion (including an explicit empty string).
PERMISSION_DENIED	Invalid workspace credentials, or the workspace is not allowed to create production API keys.
FAILED_PRECONDITION	Creating a production key but the workspace has not been upgraded to a paid plan.
RESOURCE_EXHAUSTED	The workspace has reached its maximum number of production API keys.

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