API referenceEndpointsAPI keys
apiKeys.create
RPC apiKeys.create · Scope control
AuthorizationBearer <token>
A Plane API key, pl_<env>_…. The key is the environment: everything it reads and writes is scoped to the environment it was minted in, and the two tenancy headers are ignored for one.
In: header
Header Parameters
x-plane-environment?string
The environment slug this request is about. Honoured only for a session cookie; ignored for an API key, whose environment is its identity.
x-plane-organization?string
The organization slug or id this request is about, resolved before the environment. Honoured only for a session cookie.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/apiKeys/create" \ -H "Content-Type: application/json" \ -d '{ "key": { "name": "string", "scopes": [ "read" ] } }'{ "key": { "id": "string", "environmentId": "string", "name": "string", "prefix": "string", "scopes": [ "read" ], "identityScopes": [ "string" ], "spend": { "agentMinutesPerMonth": 0, "tokensPerMonth": 0, "dailyUsd": 0 }, "createdBy": "string", "expiresAt": "string", "lastUsedAt": "string", "revokedAt": "string", "createdAt": "string" }, "token": "string"}