Skip to content

Mint an API key

POST
/me/api-tokens

Creates a user key (ptl_u_…) that acts as you across every org you belong to.
The secret is returned once — copy it now. Pass read_only: true for a key that
can never mutate.

Authorizations

bearer
Type
HTTP (bearer)

Request Body

application/json
JSON
{
  
"name": "CI deploy",
  
"read_only": false,
  
"expires_at": "string"
}

Responses

Created — includes the one-time secret.

application/json
JSON
{
  
"id": "018f0a5e-1c2b-7e3a-9b4c-0000000f0001",
  
"name": "CLI · device login",
  
"kind": "string",
  
"prefix": "ptl_u_0727c24e…",
  
"read_only": true,
  
"created_at": "string",
  
"last_used_at": "string",
  
"secret": "ptl_u_0727c24e_9f83a1c0d24e7b…"
}

Playground

Authorization
Body

Samples

Powered by VitePress OpenAPI

One vocabulary, every door.