Skip to main content
POST
/
auth
/
platform_keys
Create Platform API Key
curl --request POST \
  --url https://api.app.shinzo.ai/auth/platform_keys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>"
}
'

Documentation Index

Fetch the complete documentation index at: https://docs.shinzo.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Authentication

Requires JWT token authentication.

​
Request Body

​
name
string
required
A descriptive name for the API key

​
Example Request

curl -X POST https://api.app.shinzo.ai/auth/platform_keys \
  -H "Authorization: Bearer <jwt_token>" \
  -H "Content-Type: application/json" \
  -d '{"name": "CI/CD Pipeline Key"}'

​
Response

{
  "uuid": "key_abc123def456",
  "key": "sk_shinzo_abc123def456ghi789...",
  "name": "CI/CD Pipeline Key",
  "created_at": "2025-01-15T10:00:00Z",
  "status": "active"
}
The API key value is only displayed once at creation. Store it securely as it cannot be retrieved later.

​
Response Fields

FieldTypeDescription
uuidstringUnique identifier for the key
keystringThe API key value (shown only once)
namestringDescriptive name
created_atstringCreation timestamp (ISO 8601)
statusstringKey status (active)

​
Status Codes

CodeDescription
200Key created successfully
401Invalid or missing JWT token