openapi: 3.2.0 info: title: KnoxCall Client Management Workflows API version: '1.0' description: 'The KnoxCall Client Management API provides programmatic access to manage your API gateway resources including routes, secrets, clients, environments, webhooks, and API keys. ## Authentication All requests must include an OAuth 2.1 access token **or** a legacy API key. The recommended path for new integrations is the first-party SDKs, which mint, cache, and refresh OAuth tokens for you (start with `knoxcall login` on a developer machine, or `KNOXCALL_CLIENT_ID` / `KNOXCALL_CLIENT_SECRET` in CI). You can authenticate using any of: - **Authorization header (OAuth 2.1 bearer token — recommended)**: `Authorization: Bearer ` - **Authorization header (legacy API key)**: `Authorization: Bearer tk_xxx_yyy` - **x-api-key header (legacy API key)**: `x-api-key: tk_xxx_yyy` OAuth 2.1 access tokens (`kc_` prefix) are minted at the root-host token endpoint `https://api.knoxcall.com/oauth/token` (not under `/v1`) using the `client_credentials` or `authorization_code` grant. See the `OAuth2` security scheme and the `/oauth/*` endpoints. Some resources that are managed exclusively through OAuth reject API-key auth with a `403 use_oauth` error. Long-lived API keys remain fully supported. They come in three types: - **Standard keys** (`tk_` prefix) are used on the production API (`api.knoxcall.com`). - **Test keys** (`tk_` prefix, type=test) are used on the sandbox API (`sandbox.knoxcall.com`). - **Enterprise Access Keys** (`AKE` prefix) follow the format `AKE[16chars]:[40chars]`. Using a test key on the production API (or vice versa) will return a `403 wrong_key_type` error. ## Request IDs Every response — success or error — includes an `X-Request-Id` response header (a UUID). Its value is identical to the `request_id` field in the response body (`meta.request_id` on success, `error.request_id` on error). Quote it when contacting support. ## API Versioning The API is versioned on two axes: - **Major version — the `/v1` path prefix.** Breaking changes ship under a new major (`/v2`). `/v1` never receives a breaking change. - **Minor version — the `KnoxCall-Version` header (dated, `YYYY-MM-DD`).** Send `KnoxCall-Version: 2026-08-05` to pin the behaviour of a specific dated release. Omit the header to get the newest minor version. Every response echoes the resolved version back in a `KnoxCall-Version` response header. Within a major version, **additive changes are not breaking** and may appear without a new dated version: new endpoints, new optional request fields, new response fields, new `error.type` values, and new enum members. Clients must tolerate unknown response fields and unknown `error.type` values (see the `ErrorResponse` schema). An **unknown or malformed** `KnoxCall-Version` value returns `400` with `error.type: invalid_api_version`. ## Rate Limiting API keys can have optional rate limits configured. When a limit is configured, the following headers are emitted on **every** response (not only `429`s): - `X-RateLimit-Limit` -- maximum requests allowed per window - `X-RateLimit-Remaining` -- remaining requests in the current window - `X-RateLimit-Reset` -- epoch seconds at which the window resets When the limit is exceeded the API returns `429` (`rate_limit_exceeded` / `rate_limited`) and additionally sets `Retry-After` (seconds until the window resets). ## DPoP sender-constrained tokens, and the server nonce A token minted with a `cnf.jkt` binding (DPoP, RFC 9449) requires a `DPoP` proof header on every request, signed over the request''s method and canonical public URL. **Every response to a request that carried a `DPoP` header also carries a `DPoP-Nonce` response header** -- mints, refusals and successful calls alike, on `POST /oauth/token`, `/v1`, the tenant data plane, the self-hosted proxy and the AI gateway. The value is stateless and changes every minute; the server accepts the current and the previous minute''s, so a nonce is good for 60-120 seconds.' contact: name: KnoxCall Support url: https://knoxcall.com email: support@knoxcall.com license: name: Proprietary url: https://knoxcall.com/terms servers: - url: https://api.knoxcall.com/v1 description: Production - url: https://sandbox.knoxcall.com/v1 description: Sandbox (test keys only) security: - OAuth2: [] - BearerAuth: [] - ApiKeyAuth: [] tags: - name: Workflows description: Create, manage, and run workflows. Executions are asynchronous; poll executions or subscribe a webhook to workflow.execution.completed|failed. paths: /workflows: get: operationId: listWorkflows summary: List workflows description: Returns a paginated list of workflows for the authenticated tenant and mode. Requires the workflow list scope. tags: - Workflows parameters: - $ref: '#/components/parameters/PageParam' - $ref: '#/components/parameters/PerPageParam' responses: '200': description: A page of workflows. content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/Workflow' meta: $ref: '#/components/schemas/PaginationMeta' '401': $ref: '#/components/responses/Unauthorized' post: operationId: createWorkflow summary: Create a workflow description: 'Creates a workflow from a graph definition. The definition is validated for structure (a reachable trigger, no cycles, no dangling edges) and for credential custody — a definition that stores a credential in cleartext is refused, because every member of the tenant can read a workflow definition; reference a Secret instead. Steps that are not yet complete are accepted, but the workflow is then created with `enabled: false` (check the `enabled` field of the response): an unpublishable definition is never the running one. Requires the workflow create scope.' tags: - Workflows parameters: - $ref: '#/components/parameters/IdempotencyKeyParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateWorkflowRequest' responses: '200': description: The created workflow. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/Workflow' meta: $ref: '#/components/schemas/RequestMeta' '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/Unauthorized' '409': $ref: '#/components/responses/RequestInProgress' '422': description: 'The workflow definition was refused (`invalid_definition`) — the graph is structurally invalid (no trigger, a cycle, an edge to a node that does not exist), or the definition stores a credential in cleartext, which is refused on every write: move it to a Secret and reference that Secret from the step. A definition whose STEPS are merely incomplete is not refused; the workflow is created with `enabled: false` instead, and publishing it is what makes it live. Also returned when the idempotency key was reused with a different request (`idempotency_key_reuse`).' headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' /workflows/{id}: get: operationId: getWorkflow summary: Get a workflow description: Returns a single workflow by id. tags: - Workflows parameters: - $ref: '#/components/parameters/WorkflowId' responses: '200': description: The workflow. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/Workflow' meta: $ref: '#/components/schemas/RequestMeta' '404': $ref: '#/components/responses/NotFound' patch: operationId: updateWorkflow summary: Update a workflow description: 'Updates a workflow''s name, description, enabled state, or definition. A new definition bumps the version. A workflow may never be LIVE with a definition that cannot be published, so `enabled: true` re-evaluates the STORED definition, and a definition that replaces the one on an already-enabled workflow must itself publish. Unlike create — which keeps your data and returns `enabled: false` — an update refuses (422) rather than switching a running workflow off. Requires the workflow update scope.' tags: - Workflows parameters: - $ref: '#/components/parameters/IdempotencyKeyParam' - $ref: '#/components/parameters/WorkflowId' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateWorkflowRequest' responses: '200': description: The updated workflow. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/Workflow' meta: $ref: '#/components/schemas/RequestMeta' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/RequestInProgress' '422': description: 'The workflow definition was refused (`invalid_definition`) — the graph is structurally invalid (no trigger, a cycle, an edge to a node that does not exist), or the definition stores a credential in cleartext, which is refused on every write: move it to a Secret and reference that Secret from the step. A definition whose STEPS are merely incomplete is not refused by that storage rule. The same status and the same `invalid_definition` type also answer the LIVE rule: `enabled: true` on a workflow whose stored definition could not be published, or a definition that introduces a publish blocker onto a workflow that is already enabled. The message names which of the two refused. Also returned when the idempotency key was reused with a different request (`idempotency_key_reuse`).' headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' delete: operationId: deleteWorkflow summary: Delete a workflow description: Deletes a workflow and its executions. Requires the workflow delete scope. tags: - Workflows parameters: - $ref: '#/components/parameters/IdempotencyKeyParam' - $ref: '#/components/parameters/WorkflowId' responses: '200': description: Deletion acknowledgement. content: application/json: schema: type: object properties: data: type: object properties: id: type: string format: uuid deleted: type: boolean meta: $ref: '#/components/schemas/RequestMeta' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/RequestInProgress' '422': $ref: '#/components/responses/IdempotencyKeyReuse' /workflows/{id}/execute: post: operationId: executeWorkflow summary: Execute a workflow description: 'Queues an asynchronous workflow run and returns the execution acknowledgement. Idempotent — send X-Idempotency-Key to make a replay return the same execution. Requires the workflow execute scope. Subject to a per-tenant launch budget of 60 runs/minute with a burst of 30, shared with every other way of starting a run by hand (the dashboard included) — it bounds what one tenant''s credentials and the shared run queue can be made to do, so the two surfaces do not each get their own allowance. Over-spend answers 429; if the counter store itself is unreachable the run is refused with 503 rather than launched unmetered.' tags: - Workflows parameters: - $ref: '#/components/parameters/WorkflowId' requestBody: required: false content: application/json: schema: type: object properties: input: type: object additionalProperties: true description: Trigger input passed to the workflow. example: input: example: data responses: '201': description: The queued execution. content: application/json: schema: type: object properties: data: type: object properties: id: type: string format: uuid workflow_id: type: string format: uuid status: type: string example: queued meta: $ref: '#/components/schemas/RequestMeta' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/RateLimited' '503': $ref: '#/components/responses/RateLimiterUnavailable' /workflows/{id}/executions: get: operationId: listWorkflowExecutions summary: List workflow executions description: Returns a paginated run history for a workflow — the polling-trigger source for automation platforms. tags: - Workflows parameters: - $ref: '#/components/parameters/WorkflowId' - $ref: '#/components/parameters/PageParam' - $ref: '#/components/parameters/PerPageParam' responses: '200': description: A page of executions. content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/WorkflowExecution' meta: $ref: '#/components/schemas/PaginationMeta' '404': $ref: '#/components/responses/NotFound' /workflows/executions/{executionId}: get: operationId: getWorkflowExecution summary: Get a workflow execution description: Returns one execution's status and composed step details. tags: - Workflows parameters: - name: executionId in: path required: true schema: type: string format: uuid description: The execution id. responses: '200': description: The execution. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/WorkflowExecution' meta: $ref: '#/components/schemas/RequestMeta' '404': $ref: '#/components/responses/NotFound' /workflows/executions/{executionId}/cancel: post: operationId: cancelWorkflowExecution summary: Cancel a workflow execution description: Requests cancellation of a running execution. Requires the workflow execute scope. tags: - Workflows parameters: - name: executionId in: path required: true schema: type: string format: uuid description: The execution id. responses: '200': description: Cancellation acknowledgement. content: application/json: schema: type: object properties: data: type: object properties: id: type: string status: type: string meta: $ref: '#/components/schemas/RequestMeta' '404': $ref: '#/components/responses/NotFound' components: parameters: WorkflowId: name: id in: path required: true schema: type: string format: uuid description: The workflow id. PageParam: name: page in: query schema: type: integer minimum: 1 default: 1 description: Page number for pagination. Clamped server-side so the derived offset never exceeds 100,000 rows -- the effective maximum is `floor(100000 / per_page) + 1`, i.e. 1,001 at `per_page=100`. A larger value returns that last page, and `meta.page` reports it. PerPageParam: name: per_page in: query schema: type: integer minimum: 1 maximum: 100 default: 20 description: Number of items per page (max 100). IdempotencyKeyParam: name: X-Idempotency-Key in: header required: false schema: type: string maxLength: 255 description: 'Optional idempotency key so a retried mutating request is executed at most once. The standard `Idempotency-Key` spelling is also accepted. Replaying a completed request with the same key returns the original stored response with an `X-Idempotent-Replay: true` header. A key still in progress returns `409 request_in_progress`; the same key with a different body returns `422 idempotency_key_reuse`; a malformed key returns `400 invalid_idempotency_key`. ' example: 3f6c9b2e-1a4d-4c8e-9b0a-7d2e5f1c3a8b schemas: Workflow: type: object description: A workflow — a graph of nodes executed on a trigger. properties: id: type: string format: uuid name: type: string example: New customer onboarding description: type: - string - 'null' definition: type: object description: 'The workflow graph (nodes and edges). A webhook trigger node''s `data.config.authentication` is MASKED on read: the scheme (`type`, `format`, `header`) is returned, and every credential field (`token`, `secret`, ...) reads back as `***CONFIGURED***`. Submitting that sentinel on create/update means "leave the stored value unchanged", so a read-modify-write round trip is safe; on create, where there is no stored value, it is dropped.' additionalProperties: true environment: type: - string - 'null' enabled: type: boolean version: type: integer sandbox: type: boolean timeout_seconds: type: - integer - 'null' published_at: type: - string - 'null' format: date-time created_at: type: string format: date-time updated_at: type: string format: date-time run_count: type: integer description: Number of executions (present on list responses). required: - id - name - definition - enabled - version - sandbox - created_at - updated_at RequestMeta: type: object description: Metadata included with every API response. properties: request_id: type: string format: uuid description: Unique identifier for this API request, useful for support and debugging. example: 550e8400-e29b-41d4-a716-446655440000 required: - request_id PaginationMeta: type: object description: Pagination metadata for list endpoints. properties: total: type: integer description: Total number of records matching the query. example: 42 page: type: integer description: Current page number. example: 1 per_page: type: integer description: Number of records per page. example: 20 total_pages: type: integer description: Total number of pages, capped at the deepest page the 100,000-row offset ceiling allows -- `min(ceil(total / per_page), floor(100000 / per_page) + 1)`. When it is below `ceil(total / per_page)` the result set is larger than pagination can reach; narrow it with a filter. example: 3 request_id: type: string format: uuid description: Unique identifier for this API request. example: 550e8400-e29b-41d4-a716-446655440000 required: - total - page - per_page - total_pages - request_id ErrorResponse: type: object description: Standard error response envelope. properties: error: type: object properties: type: type: string description: 'Machine-readable error type. The set is OPEN — endpoints define specific types beyond the common ones below, so clients should branch on the types they know and fall back to the HTTP status class for anything unrecognized. Common values: authentication_required, invalid_api_key, wrong_key_type, subscription_inactive, rate_limit_exceeded, validation_error, forbidden, not_found, method_not_allowed (405, carries Allow), conflict, in_use, plan_limit, plan_feature, internal_error, dependency_unavailable (503, carries Retry-After), invalid_request, invalid_definition, not_cancellable, invalid_idempotency_key, idempotency_key_reuse, request_in_progress, system_client_protected, use_oauth, use_dpop_nonce (401 on /v1 and the data plane, 400 on POST /oauth/token; see "DPoP sender-constrained tokens").' example: validation_error message: type: string description: Human-readable error message. example: name and target_base_url are required. request_id: type: string format: uuid description: Unique identifier for this request. example: 550e8400-e29b-41d4-a716-446655440000 required: - type - message - request_id required: - error WorkflowExecution: type: object description: A single workflow run. properties: id: type: string format: uuid workflow_id: type: string format: uuid status: type: string enum: - queued - running - waiting - paused - completed - failed - cancelled - timed_out trigger_type: type: string started_at: type: - string - 'null' format: date-time completed_at: type: - string - 'null' format: date-time execution_time_ms: type: - integer - 'null' error_message: type: - string - 'null' workflow_version: type: - integer - 'null' created_at: type: string format: date-time node_executions: type: array items: type: object additionalProperties: true description: Composed per-node step details (present on single-execution responses). required: - id - workflow_id - status - created_at CreateWorkflowRequest: type: object description: Request body to create or update a workflow. properties: name: type: string example: New customer onboarding description: type: string definition: type: object description: The workflow graph. Must contain a nodes array with exactly one trigger node, and an edges array. A webhook trigger node's `data.config.authentication` credential fields may be sent as `***CONFIGURED***` to keep the stored value unchanged (see the Workflow schema); on create there is no stored value, so the field is dropped rather than persisted as the signing key. additionalProperties: true trigger_config: type: object additionalProperties: true environment: type: string enabled: type: boolean default: true required: - name - definition example: name: New customer onboarding enabled: true definition: nodes: - id: trigger-node type: trigger position: x: 0 y: 0 data: type: trigger label: Manual config: triggerType: manual edges: [] responses: NotFound: description: The requested resource was not found. headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' KnoxCall-Version: $ref: '#/components/headers/KnoxCall-Version' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: type: not_found message: Route not found. request_id: 550e8400-e29b-41d4-a716-446655440000 Unauthorized: description: Authentication is required or the provided API key is invalid. headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' KnoxCall-Version: $ref: '#/components/headers/KnoxCall-Version' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: missing_key: summary: No API key provided value: error: type: authentication_required message: 'API key is required. Use Authorization: Bearer or x-api-key header.' request_id: 550e8400-e29b-41d4-a716-446655440000 invalid_key: summary: Invalid API key value: error: type: invalid_api_key message: Invalid API key. request_id: 550e8400-e29b-41d4-a716-446655440000 RequestInProgress: description: 'A request with the same idempotency key is still being processed. Retry after a short delay; do not change the request body. ' headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' KnoxCall-Version: $ref: '#/components/headers/KnoxCall-Version' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: type: request_in_progress message: A request with this idempotency key is already in progress. request_id: 550e8400-e29b-41d4-a716-446655440000 IdempotencyKeyReuse: description: 'The supplied idempotency key was already used for a request with a different body. Idempotency keys may only be reused with an identical request. ' headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' KnoxCall-Version: $ref: '#/components/headers/KnoxCall-Version' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: type: idempotency_key_reuse message: This idempotency key was already used with a different request body. request_id: 550e8400-e29b-41d4-a716-446655440000 ValidationError: description: The request failed validation (always `400 validation_error`). A malformed idempotency key returns `400 invalid_idempotency_key`. headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' KnoxCall-Version: $ref: '#/components/headers/KnoxCall-Version' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: validation_error: summary: Request body failed validation value: error: type: validation_error message: name and target_base_url are required. request_id: 550e8400-e29b-41d4-a716-446655440000 invalid_idempotency_key: summary: Malformed idempotency key value: error: type: invalid_idempotency_key message: X-Idempotency-Key must be a non-empty string of at most 255 characters. request_id: 550e8400-e29b-41d4-a716-446655440000 RateLimiterUnavailable: description: 'The rate-limit counter store is unreachable, so the request was refused rather than admitted unmetered. This is NOT an over-spend — the limit was never measured — which is why it is a 503 and not a 429: an SDK should treat it as a transient server fault and retry with backoff, honouring `Retry-After`. ' headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' KnoxCall-Version: $ref: '#/components/headers/KnoxCall-Version' Retry-After: $ref: '#/components/headers/Retry-After' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: type: rate_limiter_unavailable message: The workflow execution rate-limit store is unavailable. Runs are refused rather than launched unmetered. request_id: 550e8400-e29b-41d4-a716-446655440000 RateLimited: description: 'Too many requests. Retry after the indicated time. The `X-RateLimit-*` headers are also present on non-429 responses whenever a limit is configured. ' headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' KnoxCall-Version: $ref: '#/components/headers/KnoxCall-Version' X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-RateLimit-Reset: $ref: '#/components/headers/X-RateLimit-Reset' Retry-After: $ref: '#/components/headers/Retry-After' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: type: rate_limit_exceeded message: API rate limit exceeded. Please retry later. request_id: 550e8400-e29b-41d4-a716-446655440000 headers: X-RateLimit-Remaining: description: 'Remaining requests in the current window. Emitted on every response whenever a rate limit is configured for the authenticated key. ' schema: type: integer example: 999 KnoxCall-Version: description: 'The dated API version (`YYYY-MM-DD`) that served this response. Equals the value of the `KnoxCall-Version` request header when supplied, otherwise the newest version. ' schema: type: string pattern: ^\d{4}-\d{2}-\d{2}$ example: '2026-08-05' X-Request-Id: description: 'Unique identifier for this request (UUID). Present on **every** response and equal to the `request_id` field in the response body. Quote it when contacting support. ' schema: type: string format: uuid example: 550e8400-e29b-41d4-a716-446655440000 Retry-After: description: Seconds to wait before retrying. Set on `429` responses. schema: type: integer example: 30 X-RateLimit-Reset: description: 'Epoch seconds at which the current rate-limit window resets. Emitted on every response whenever a rate limit is configured for the authenticated key. ' schema: type: integer example: 1735689600 X-RateLimit-Limit: description: 'Maximum requests allowed per window. Emitted on every response whenever a rate limit is configured for the authenticated key. ' schema: type: integer example: 1000 securitySchemes: OAuth2: type: oauth2 description: 'OAuth 2.1 authentication — recommended for new integrations. Access tokens (`kc_` prefix) are minted at the root-host token endpoint `https://api.knoxcall.com/oauth/token` and passed as `Authorization: Bearer `. Public clients must use PKCE with the `authorization_code` grant; confidential clients may use `client_credentials`. The first-party SDKs and the `knoxcall login` CLI handle token minting, caching, refresh, and DPoP for you. ' flows: clientCredentials: tokenUrl: https://api.knoxcall.com/oauth/token refreshUrl: https://api.knoxcall.com/oauth/token scopes: routes:read: Read routes. routes:write: Create, update, and delete routes. secrets:read: Read secret metadata. Does NOT include retrieving a live OAuth2 access token. secrets:oauth_token: Retrieve a live upstream OAuth2 access token (GET /v1/secrets/{id}/oauth2/token). Distinct from secrets:read because the call refreshes the credential at the provider. secrets:write: Create, update, and delete secrets. vaults:detokenize: Turn a vault token back into its original value. Required by GET /v1/vaults/{vault}/tokens/{token}, by a token template reference in a /v1/proxy body, and by creating a `detokenize` route action. Distinct from vaults:read, which lists vaults and token metadata and never returns a value. transit:decrypt: Open a portable `kc:` ciphertext with a tenant transit key. Required by creating a `decrypt` route action, which stores a standing instruction to open every matching field on every later request through that route. It is the same capability name the policy engine uses for POST /v1/decrypt. No routes scope satisfies it — managing a route is not permission to open the data flowing through it. proxy:invoke: Call the one-shot ephemeral proxy (any method on /v1/proxy). Required for EVERY verb — the proxy is one capability behind one handler, and a bodyless GET spends an escrowed credential exactly as a POST does. Neither proxy:read nor proxy:write satisfies it. clients:read: Read clients. clients:write: Manage clients. webhooks:write: Manage webhooks. workflows:write: Manage and execute workflows. '*:*': Full access (all scopes). authorizationCode: authorizationUrl: https://api.knoxcall.com/oauth/authorize tokenUrl: https://api.knoxcall.com/oauth/token refreshUrl: https://api.knoxcall.com/oauth/token scopes: routes:read: Read routes. routes:write: Create, update, and delete routes. secrets:read: Read secret metadata. Does NOT include retrieving a live OAuth2 access token. secrets:oauth_token: Retrieve a live upstream OAuth2 access token (GET /v1/secrets/{id}/oauth2/token). Distinct from secrets:read because the call refreshes the credential at the provider. secrets:write: Create, update, and delete secrets. vaults:detokenize: Turn a vault token back into its original value. Required by GET /v1/vaults/{vault}/tokens/{token}, by a token template reference in a /v1/proxy body, and by creating a `detokenize` route action. Distinct from vaults:read, which lists vaults and token metadata and never returns a value. transit:decrypt: Open a portable `kc:` ciphertext with a tenant transit key. Required by creating a `decrypt` route action, which stores a standing instruction to open every matching field on every later request through that route. It is the same capability name the policy engine uses for POST /v1/decrypt. No routes scope satisfies it — managing a route is not permission to open the data flowing through it. proxy:invoke: Call the one-shot ephemeral proxy (any method on /v1/proxy). Required for EVERY verb — the proxy is one capability behind one handler, and a bodyless GET spends an escrowed credential exactly as a POST does. Neither proxy:read nor proxy:write satisfies it. clients:read: Read clients. clients:write: Manage clients. webhooks:write: Manage webhooks. workflows:write: Manage and execute workflows. '*:*': Full access (all scopes). PhantomToken: type: http scheme: bearer description: "The AI **data plane** credential — a `kp_`-prefixed capability token, not a\nManagement API credential. It is minted per agent (or per MCP resource) at\n`POST /v1/ai-gateway/agents/{agentId}/tokens`, or exchanged from a CI workload's\nOIDC token at `POST /v1/oauth/token`, and it is the ONLY credential `/v1/ai/*`\naccepts: an OAuth `kc_` access token or a `tk_` API key is refused there, and a\n`kp_` token is refused on `api.knoxcall.com`.\n\nThree header spellings are accepted, so an existing provider SDK can be pointed at\nthe agent URL without rewriting its auth:\n\n Authorization: Bearer kp_live_a_...\n x-api-key: kp_live_a_...\n x-knox-ai-key: kp_live_a_...\n\n`kp_live_` is refused on the sandbox host and `kp_test_` on the Live host — the env\nsegment is enforced, not cosmetic. DPoP-bound tokens additionally require a valid\n`DPoP` proof header on every request, signed over the canonical public URL rather\nthan a rewritten `Host`.\n\nA rejected credential answers `401`/`403` in the data-plane error envelope with the\ncause in `code` and in the `X-Auth-Failure` response header.\n" BearerAuth: type: http scheme: bearer description: 'Legacy long-lived API key authentication via the Authorization header. Pass your API key as: `Authorization: Bearer tk_xxx_yyy`. Standard keys (`tk_` prefix) are accepted on `api.knoxcall.com`. Test keys (type=test) are accepted on `sandbox.knoxcall.com`. Enterprise Access Keys (`AKE` prefix) are accepted on both. Fully supported, but prefer the `OAuth2` scheme (or the SDKs, which handle OAuth for you) for new integrations. ' ApiKeyAuth: type: apiKey in: header name: x-api-key description: 'Legacy API key authentication via the `x-api-key` header. This is an alternative to Bearer token authentication for clients that cannot set the `Authorization` header. Prefer the `OAuth2` scheme for new integrations. ' CapabilityTokenAuth: type: http scheme: bearer description: 'Single-use client capability token (`kct_` prefix), passed as `Authorization: Bearer kct_...`. Minted server-side via `POST /client-tokens` and bound either to one exact payload + action (`decrypt`, `detokenize`) or to one vault + a closed set of page origins (`tokenize`). This is NOT an API key — it authenticates only the `POST /client/decrypt`, `POST /client/detokenize` and `POST /client/tokenize` consume endpoints and is invalidated after its first use. '