Create API Key | Captain API Documentation

Create a new API key for an organization (team shared key).

Authentication: Requires authenticated user via Auth0/Bearer token

Headers:

Authorization: Bearer {auth_token} - User authentication token

Parameters:

organization_id: Organization UUID (required)
user_id: User UUID (required)
key_name: Human-readable name for the key (optional, default: ‘Default’)
tier: API tier (optional, default: ‘standard’, options: ‘standard’, ‘premium’)
environment: Environment scope (optional, default: ‘development’, options: ‘development’, ‘staging’, ‘production’)
expires_days: Expiration in days (optional, 1-3650)
permissions: Comma-separated permissions (optional, options: ‘query’, ‘index’, or both)

Returns:

ApiKeyResponse with api_key, management_id, and metadata

Create a new API key for an organization (team shared key). Authentication: Requires authenticated user via Auth0/Bearer token Headers: - Authorization: Bearer {auth_token} - User authentication token Parameters: - organization_id: Organization UUID (required) - user_id: User UUID (required) - key_name: Human-readable name for the key (optional, default: 'Default') - tier: API tier (optional, default: 'standard', options: 'standard', 'premium') - environment: Environment scope (optional, default: 'development', options: 'development', 'staging', 'production') - expires_days: Expiration in days (optional, 1-3650) - permissions: Comma-separated permissions (optional, options: 'query', 'index', or both) Returns: - ApiKeyResponse with api_key, management_id, and metadata

Headers

AuthorizationstringRequired

User authentication token

Request

This endpoint expects an object.

organization_idstringRequired

user_idstringRequired

key_namestring or nullOptionalDefaults to Default

tierstring or nullOptionalDefaults to standard

environmentstring or nullOptionalDefaults to development

expires_daysinteger or nullOptional

permissionsstring or nullOptional

created_by_emailstring or nullOptional

created_by_first_namestring or nullOptional

created_by_last_namestring or nullOptional

Response

Successful Response

successboolean

messagestring

management_idstring

api_keystring

created_atstring

key_namestring

errorstring or null

expires_atstring or null

Errors

Create a new API key for an organization (team shared key).

Authentication: Requires authenticated user via Auth0/Bearer token

Headers:

Authorization: Bearer {auth_token} - User authentication token

Parameters:

organization_id: Organization UUID (required)
user_id: User UUID (required)
key_name: Human-readable name for the key (optional, default: ‘Default’)
tier: API tier (optional, default: ‘standard’, options: ‘standard’, ‘premium’)
environment: Environment scope (optional, default: ‘development’, options: ‘development’, ‘staging’, ‘production’)
expires_days: Expiration in days (optional, 1-3650)
permissions: Comma-separated permissions (optional, options: ‘query’, ‘index’, or both)

Returns:

ApiKeyResponse with api_key, management_id, and metadata

1	curl -X POST https://api.runcaptain.com/v1/api-keys \
2	-H "Authorization: Bearer YOUR_AUTH_TOKEN" \
3	-H "Content-Type: application/x-www-form-urlencoded" \
4	-d "organization_id=org_abc123" \
5	-d "user_id=user_xyz789" \
6	-d "key_name=Production%20API%20Key" \
7	-d "tier=standard" \
8	-d "environment=production" \
9	-d "permissions=query%2Cindex"

1	{
2	"success": true,
3	"message": "API key created successfully",
4	"management_id": "mgmt_abc123",
5	"api_key": "sk_captain_abc123xyz789",
6	"created_at": "2024-01-15T10:30:00Z",
7	"key_name": "Production API Key"
8	}