Create a personal access token

Create a customer token with an interactive user JWT. The token value is returned once; preserve it before leaving the response.

POST /api/v1/users/{user_id}/personal-access-tokens

Create a personal access token

cURL

curl --request POST \
  --url https://sprites-gateway.api.synthlabs.ai/api/v1/users/{user_id}/personal-access-tokens \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>"
}
'

201

{
  "created_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "scopes": [
    "gateway:user"
  ],
  "token": "<string>",
  "token_ref": "<string>",
  "creation_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "last_used_at": "2023-11-07T05:31:56Z",
  "revoked_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

Synth customer access token for the current user and organization.

Path Parameters

user_id · string<uuid> · required

Body

application/json

Create a revocable user credential for headless Synth access.

name · string · required

Required string length: 1 - 80

creation_request_id · string<uuid> | null

Client-generated correlation ID for one logical create. While the correlated PAT is active, reuse returns a safe conflict summary for revoke-before-retry and never replays the raw token. Recent inactive rows remain correlatable until bounded history pruning removes them.

expires_in_days · integer · default: 30

Required range: 1 <= x <= 365

scopes · enum<string>[]

Required array length: 1 element

Available options: gateway:user

Allowed value: "gateway:user"

Response

201

application/json

Successful Response

Creation response; the raw token appears exactly once.

created_at · string<date-time> · required

expires_at · string<date-time> · required

id · string<uuid> · required

name · string · required

organization_id · string<uuid> · required

scopes · enum<string>[] · required

Available options: gateway:user, inference:invoke

token · string · required

Pattern: ^synth_pat_[A-Za-z0-9_-]{43}$

token_ref · string · required

Pattern: ^tok_[0-9a-f]{8}$

creation_request_id · string<uuid> | null

last_used_at · string<date-time> | null

revoked_at · string<date-time> | null