Developer API credentials

Workspace API key lifecycle.

Create a workspace Developer API key

POST

https://saas.ha.knwl.me

/api/v1/credentials

sb-*-auth-token (cookie)

Creates a workspace API key from an authenticated web session. The plaintext secret is returned exactly once and is never persisted for replay.

Create a workspace Developer API key › Request Body

CreateCredentialRequest

workspaceId

string · uuid · required

name

string · minLength: 3 · maxLength: 120 · required

workspaceRole

enum · required

Enum values:

member

admin

DeveloperApiScope[] · minItems: 1 · required

Enum values:

conversations:read

conversations:write

agents:read

models:read

projects:read

documents:read

documents:write

artifacts:read

expiresAt

string | null · date-time

allowNoExpiry

boolean

environment

enum

Enum values:

prod

test

Default: prod

Create a workspace Developer API key › Responses

Credential created. The secret is included once in this response only.

CreateCredentialResponse

ok

const · required

Const value:

secret

string · required

Plaintext secret returned exactly once. Do not log it.

DeveloperApiCredentialSummary · required

POST/api/v1/credentials

curl --request POST \
  --url https://saas.ha.knwl.me/api/v1/credentials \
  --header 'Content-Type: application/json' \
  --data '
{
  "workspaceId": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "workspaceRole": "member",
  "scopes": [
    "conversations:read"
  ],
  "expiresAt": "2024-08-25T15:00:00Z",
  "allowNoExpiry": true,
  "environment": "prod"
}
'

Example Request Body

{
  "workspaceId": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "workspaceRole": "member",
  "scopes": [
    "conversations:read"
  ],
  "expiresAt": "2024-08-25T15:00:00Z",
  "allowNoExpiry": true,
  "environment": "prod"
}

json

Example Responses

{
  "ok": true,
  "secret": "secret",
  "credential": {
    "id": "00000000-0000-0000-0000-000000000000",
    "workspaceId": "00000000-0000-0000-0000-000000000000",
    "name": "name",
    "kind": "workspace_api_key",
    "workspaceRole": "member",
    "scopes": [
      "conversations:read"
    ],
    "fingerprint": "fingerprint",
    "status": "active",
    "expiresAt": "2024-08-25T15:00:00Z",
    "createdAt": "2024-08-25T15:00:00Z",
    "createdBy": "00000000-0000-0000-0000-000000000000",
    "revokedAt": "2024-08-25T15:00:00Z",
    "revokedBy": "00000000-0000-0000-0000-000000000000",
    "lastUsedAt": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Capabilities

Create a workspace Developer API key

POST

https://saas.ha.knwl.me

/api/v1/credentials

sb-*-auth-token (cookie)

Creates a workspace API key from an authenticated web session. The plaintext secret is returned exactly once and is never persisted for replay.

Create a workspace Developer API key › Request Body

CreateCredentialRequest

workspaceId

string · uuid · required

name

string · minLength: 3 · maxLength: 120 · required

workspaceRole

enum · required

Enum values:

member

admin

DeveloperApiScope[] · minItems: 1 · required

Enum values:

conversations:read

conversations:write

agents:read

models:read

projects:read

documents:read

documents:write

artifacts:read

expiresAt

string | null · date-time

allowNoExpiry

boolean

environment

enum

Enum values:

prod

test

Default: prod

Create a workspace Developer API key › Responses

Credential created. The secret is included once in this response only.

CreateCredentialResponse

ok

const · required

Const value:

secret

string · required

Plaintext secret returned exactly once. Do not log it.

DeveloperApiCredentialSummary · required