Create workspace API key

Creates an API key for the authenticated user and scopes it to the workspace via metadata.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

a non empty string

Length1 <= length

permissions?

Resource permissions map for the API key

Example

{
  "objects": [
    "read",
    "write"
  ],
  "workspaces": [
    "read"
  ]
}

expiresInMs?integer

a positive number

Range0 < value

Response Body

`application/json`

curl -X POST "https://loading/api/workspaces/{workspaceHandle}/api-keys" \  -H "Content-Type: application/json" \  -d '{    "name": "Workspace integration key",    "permissions": {      "objects": [        "read",        "write"      ],      "workspaces": [        "read"      ]    },    "expiresInMs": 2592000000  }'

{
  "key": "andi_live_3x7X7uPKnd2m4WQNkfC2fZb3TW4nYJd1",
  "apiKey": {
    "id": "key_6ZW0qF8cXTWETrdFM3A7yv",
    "name": "Workspace integration key",
    "start": "andi_l",
    "prefix": "andi_",
    "enabled": true,
    "permissions": {
      "objects": [
        "read",
        "write"
      ],
      "workspaces": [
        "read"
      ]
    },
    "createdAt": "2026-03-05T19:00:00.000Z",
    "updatedAt": "2026-03-05T19:00:00.000Z",
    "expiresAt": null,
    "lastRequest": null
  }
}

{
  "issues": [
    {
      "_tag": "Pointer",
      "path": [
        "string"
      ],
      "message": "string"
    }
  ],
  "message": "string",
  "_tag": "HttpApiDecodeError"
}

Empty

Create workspace API key

Request Body

Response Body

201application/json

400application/json

401

404

409

500

`application/json`

`application/json`