Skip to main content
POST
Create a new service account

Authorizations

X-API-Key
string
header
required

API key authentication. Include your API key in the X-API-Key header as: X-API-Key YOUR_API_KEY

Example:

Authorization
string
header
required

JWT Bearer token authentication. Include your access token in the Authorization header as: Bearer YOUR_ACCESS_TOKEN

Example:

Body

application/json

Public API request payload for creating a new service account.

Note: API can only create organization-scoped service accounts.

name
string
required

Human-readable name for this service account.

Maximum string length: 255
Example:

"API Documentation"

description
string | null

Optional description explaining the purpose and usage of this account.

Example:

"Service account for API documentation generation"

Response

Service account created successfully

Response model for service account creation including the full token.

created_at
string<date-time>
required
id
string<uuid>
required
modified_by
string
required
name
string
required
status
string
required
updated_at
string<date-time>
required
description
string | null
organization_id
string<uuid> | null