Skip to main content
POST
/
v2
/
workspace
/
create
Create Workspace
curl --request POST \
  --url https://api.velt.dev/v2/workspace/create \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {
    "ownerEmail": "<string>",
    "name": "<string>",
    "workspaceName": "<string>",
    "avatar": "<string>"
  }
}
'
{
  "result": {
    "status": "success",
    "message": "Workspace created successfully",
    "data": {
      "id": "workspace_abc123",
      "name": "My Workspace",
      "owner": {
        "email": "owner@example.com",
        "id": "owner_id_123",
        "name": "John Doe",
        "avatar": "https://example.com/avatar.png"
      },
      "authToken": "9a1b2c3d4e5f60718293a4b5c6d7e8f9",
      "apiKeyList": {
        "velt_api_key_1": {
          "apiKeyName": "Owner Test API Key",
          "id": "velt_api_key_1",
          "type": "testing"
        }
      }
    }
  }
}
Use this API to programmatically create a new Velt workspace. Protected by IP-based rate limiting and disposable email domain blocking.
This is a public endpoint — no authentication headers are required.

​
Endpoint

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

​
Body

​
Params

​
data
object
required

​
Example Request

{
  "data": {
    "ownerEmail": "owner@example.com",
    "name": "John Doe",
    "workspaceName": "My Workspace",
    "avatar": "https://example.com/avatar.png"
  }
}

​
Example Response

​
Success Response

{
  "result": {
    "status": "success",
    "message": "Workspace created successfully",
    "data": {
      "id": "workspace_abc123",
      "name": "My Workspace",
      "owner": {
        "email": "owner@example.com",
        "id": "owner_id_123",
        "name": "John Doe",
        "avatar": "https://example.com/avatar.png"
      },
      "authToken": "9a1b2c3d4e5f60718293a4b5c6d7e8f9",
      "apiKeyList": {
        "velt_api_key_1": {
          "apiKeyName": "Owner Test API Key",
          "id": "velt_api_key_1",
          "type": "testing"
        }
      }
    }
  }
}
apiKeyList is a keyed object (not an array). Each key is the API key ID. To extract the first API key, use Object.keys(result.data.apiKeyList)[0] in JavaScript or iterate over the object keys.
The default apiKeyName is derived from the part of ownerEmail before the @ (capitalized), not from name. For example, owner@example.com produces "Owner Test API Key".

​
Failure Response

If email domain is disposable
{
  "error": {
    "status": "INVALID_ARGUMENT",
    "message": "This email domain is not supported."
  }
}
If rate limit exceeded
{
  "error": {
    "status": "RESOURCE_EXHAUSTED",
    "message": "Rate limit exceeded for this endpoint. Try again later."
  }
}
If the email already owns the maximum number of workspaces
An email address may own up to 5 workspaces. 
{
  "error": {
    "status": "RESOURCE_EXHAUSTED",
    "message": "You have reached the maximum number of workspaces allowed for this email address."
  }
}
If creating an additional workspace without a paid plan
The first workspace for an email is always allowed. Creating an additional workspace requires the email’s root workspace to be on a paid plan. 
{
  "error": {
    "status": "PERMISSION_DENIED",
    "message": "Creating an additional workspace requires your root workspace to be on a paid plan (a production API key)."
  }
}
If a workspace already exists for the email
{
  "error": {
    "status": "ALREADY_EXISTS",
    "message": "A workspace already exists for this email address"
  }
}
If workspace creation fails
{
  "error": {
    "status": "INTERNAL",
    "message": "Failed to create workspace"
  }
}

​
Next Steps

After creating a workspace, use the response values for subsequent API calls:
  • Workspace-level endpoints (e.g., Get Workspace, Create API Key): pass result.data.id as the x-velt-workspace-id header and result.data.authToken as the x-velt-workspace-auth-token header.
  • API-key-level endpoints (e.g., Add Domains, Update Email Config): extract the API key ID from Object.keys(result.data.apiKeyList)[0], then retrieve its auth token via Get Auth Tokens. Pass these as x-velt-api-key and x-velt-auth-token.
{
  "result": {
    "status": "success",
    "message": "Workspace created successfully",
    "data": {
      "id": "workspace_abc123",
      "name": "My Workspace",
      "owner": {
        "email": "owner@example.com",
        "id": "owner_id_123",
        "name": "John Doe",
        "avatar": "https://example.com/avatar.png"
      },
      "authToken": "9a1b2c3d4e5f60718293a4b5c6d7e8f9",
      "apiKeyList": {
        "velt_api_key_1": {
          "apiKeyName": "Owner Test API Key",
          "id": "velt_api_key_1",
          "type": "testing"
        }
      }
    }
  }
}