Entity API keys

Create, list, rotate, and revoke entity API keys (dashboard session).

List Entity Api Keys

GET

https://api.alk.work

/entity/api-keys

List Entity Api Keys › Headers

access-token

List Entity Api Keys › Responses

Successful Response

StandardResponse

status

string

Default: success

Create Entity Api Key

POST

https://api.alk.work

/entity/api-keys

Create Entity Api Key › Headers

access-token

Create Entity Api Key › Request Body

CreateEntityApiKeyRequest

name

string · minLength: 1 · maxLength: 200 · required

key_environment

string · enum

test → alk_test.* token; live → alk_live.* (default)

Enum values:

live

test

Default: live

Restrict key to these workflow IDs; omit for all entity workflows

Override default RPM cap

Create Entity Api Key › Responses

Successful Response

StandardResponse

status

string

Default: success

POST/entity/api-keys

curl --request POST \
  --url https://api.alk.work/entity/api-keys \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "key_environment": "live",
  "scopes": [
    "string"
  ],
  "allowed_workflow_ids": [
    "string"
  ],
  "expires_at": "2024-08-25T15:00:00Z",
  "rate_limit_rpm": 1
}
'

shell

Example Request Body

{
  "name": "name",
  "key_environment": "live",
  "scopes": [
    "string"
  ],
  "allowed_workflow_ids": [
    "string"
  ],
  "expires_at": "2024-08-25T15:00:00Z",
  "rate_limit_rpm": 1
}

json

Example Responses

{
  "status": "success",
  "message": "string",
  "data": {
    "item": {},
    "items": [
      {}
    ],
    "id": "string",
    "url": "string",
    "count": 0,
    "detail": "string"
  }
}

json

application/json

Revoke Entity Api Key

DELETE

https://api.alk.work

/entity/api-keys/{key_id}

Revoke Entity Api Key › path Parameters

key_id

string · required

Revoke Entity Api Key › Headers

access-token

Revoke Entity Api Key › Responses

Successful Response

No data returned

Rotate Entity Api Key

POST

https://api.alk.work

/entity/api-keys/{key_id}/rotate

Rotate Entity Api Key › path Parameters

key_id

string · required

Rotate Entity Api Key › Headers

access-token

Rotate Entity Api Key › Responses

Successful Response

StandardResponse

status

string

Default: success

Workflows Extractions

Create Entity Api Key

POST

https://api.alk.work

/entity/api-keys

Create Entity Api Key › Headers

access-token

Create Entity Api Key › Request Body

CreateEntityApiKeyRequest

name

string · minLength: 1 · maxLength: 200 · required

key_environment

string · enum

test → alk_test.* token; live → alk_live.* (default)

Enum values:

live

test

Default: live

Restrict key to these workflow IDs; omit for all entity workflows

Override default RPM cap

Create Entity Api Key › Responses

Successful Response

StandardResponse

status

string

Default: success

Rotate Entity Api Key

POST

https://api.alk.work

/entity/api-keys/{key_id}/rotate

Rotate Entity Api Key › path Parameters

key_id

string · required

Rotate Entity Api Key › Headers

access-token

Rotate Entity Api Key › Responses

Successful Response

StandardResponse

status

string

Default: success