Skip to main content
POST
/
api
/
v3
/
keys
Create API key
curl --request POST \
  --url https://api.lighton.ai/api/v3/keys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "expires_at": "2023-11-07T05:31:56Z",
  "scopes": [
    {
      "workspace_id": 2
    }
  ]
}
'
{
  "id": "<string>",
  "name": "<string>",
  "prefix": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "scopes": [
    {
      "workspace_id": 123,
      "workspace_name": "<string>",
      "workspace_upload_method": "<string>",
      "workspace_datasource_type": "<string>",
      "role": "<string>"
    }
  ],
  "key": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

Reject any request fields not declared on the serializer.

​
name
string
required
Maximum string length: 250
​
expires_at
string<date-time> | null
required

Expiration datetime for the API key. Set to a future datetime to expire the key at that time, or null to create a key that never expires.

​
scopes
object[]

Optional list of {workspace_id, role} entries. Providing this field marks the key as workspace-scoped: it can only access the listed workspaces, with the per-workspace role shown. The requested role on each workspace is capped at the role you currently hold there.

Response

API key created. The key field contains the full key value — save it now, it will not be shown again.

​
id
string
required
​
name
string
required
​
prefix
string
required
​
created_at
string<date-time>
required
​
expires_at
string<date-time> | null
required
​
scopes
object[]
required
read-only
​
key
string
required