API Keys

List API keys

get

https://internal-api.platform.amigo.aihttps://api.platform.amigo.ai

/v1/{workspace_id}/api-keys/

List all API keys for a workspace with pagination. Requires ApiKey.view permission.

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Query parameters

limitinteger · max: 20OptionalDefault: 10

continuation_tokenintegerOptionalDefault: 0

Responses

200

Successful Response

application/json

401

Missing or invalid API key.

403

Insufficient permissions.

422

Validation Error

application/json

get

/v1/{workspace_id}/api-keys/

HTTPcURLJavaScriptPython

GET /v1/{workspace_id}/api-keys/ HTTP/1.1
Host: internal-api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": "text",
      "workspace_id": "text",
      "key_id": "text",
      "name": "text",
      "role": "text",
      "expires_at": "2026-03-22T05:27:56.846Z",
      "created_at": "2026-03-22T05:27:56.846Z",
      "updated_at": "2026-03-22T05:27:56.846Z"
    }
  ],
  "has_more": true,
  "continuation_token": 1
}

Create an API key

post

https://internal-api.platform.amigo.aihttps://api.platform.amigo.ai

/v1/{workspace_id}/api-keys/

Create a new API key for a workspace. The response includes the plaintext api_key — store it securely, it cannot be retrieved again.

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

Body

application/json

nameany ofOptional

string · min: 1Optional

or

nullOptional

duration_daysinteger · min: 1 · max: 90Required

rolestringOptionalDefault: admin

Responses

201

Successful Response

application/json

key_idstringRequired

api_keystringRequired

nameany ofRequired

stringOptional

or

nullOptional

rolestringRequired

expires_atstring · date-timeRequired

404

Workspace not found.

422

Invalid request body or role.

post

/v1/{workspace_id}/api-keys/

HTTPcURLJavaScriptPython

POST /v1/{workspace_id}/api-keys/ HTTP/1.1
Host: internal-api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "name": "text",
  "duration_days": 1,
  "role": "admin"
}

{
  "key_id": "text",
  "api_key": "text",
  "name": "text",
  "role": "text",
  "expires_at": "2026-03-22T05:27:56.846Z"
}

Delete an API key

delete

https://internal-api.platform.amigo.aihttps://api.platform.amigo.ai

/v1/{workspace_id}/api-keys/{key_id}

Revoke an API key. Requires ApiKey.delete permission.

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

key_idstringRequired

Responses

204

Successful Response

401

Missing or invalid API key.

403

Insufficient permissions.

404

API key not found.

422

Validation Error

application/json

delete

/v1/{workspace_id}/api-keys/{key_id}

HTTPcURLJavaScriptPython

DELETE /v1/{workspace_id}/api-keys/{key_id} HTTP/1.1
Host: internal-api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content