Skip to main content

Core API reference

The project API: data, compute, encryption, streams, storage and the other platform primitives.

Data, Queries & Vectors

Your project's data, wherever you read it from: rows in your collections, the metadata index over them, vector and full-text search, raw queries, and the data streams and bridges that move records in and out.

The SDK entry point for rows is k9o.from('<collection>'), with select (filter, aggregate, single-row, vector and full-text variants), insert, update and delete.

Every read and write goes through the project's access policies at the gateway: a read returns only the rows the caller may see, and a write passes through the Maker-Checker policy graph, so a write awaiting approval stays invisible to standard reads until it commits.

Reserved columns (names beginning with _) cannot be written directly and return K9O_RESERVED_COLUMN_WRITE_PROHIBITED.

  • POSTInsert Record/data/{collection}

    Inserts a new record into the named user-collection.

  • GETQuery Records/data/{collection}

    Retrieves records from a named user-collection using cursor-based pagination and the full query-builder vocabulary:

  • POSTQuery with SQL/query

    Executes a parameterised raw SQL statement against the project's user-data schema (k9o_<proj_id>).

  • PATCHUpdate Record/data/{collection}/{id}

    Applies a partial update (delta) to the record identified by id in the named collection.

  • DELETEDelete Record/data/{collection}/{id}

    Permanently deletes the record identified by id from the named collection, returning {id} on success.

  • POSTSearch Records by Vector/data/{collection}/search

    The record list read with its query in the body, for a vector too long for a URL.

  • POSTUpsert Vectors/vectors/{collection}/upsert

    Upsert vectors.

  • POSTSearch Vectors/vectors/{collection}/search

    Search vectors.

  • POSTFind Nearest Vectors/metadata/vectors/nearest

    Create nearest.

  • PUTDeclare Metadata Index/metadata/index/{collection}

    Replace index by collection.

  • GETGet Metadata Index/metadata/index/{collection}

    Get index by collection.

  • POSTFilter Metadata/metadata/query

    Create query.

  • PATCHSet Metadata/metadata/collection/{collection}/{id}

    Update collection by id.

  • POSTSearch Metadata/metadata/search

    Create search.

  • GETSubscribe to Metadata Changes/metadata/subscribe

    List subscribe.

  • POSTDelete Vectors by Metadata/vectors/{collection}/delete

    Deletes the rows of a _-prefixed vector collection that match every equality in filters, and answers { deleted, collection } with the count removed.

Realtime Feeds & Streams

Events as they happen.

A stream is a named, append-only channel your project publishes to: create one, publish events, replay what it holds and subscribe for new ones.

The Pulse feed is the project's realtime subscription to its own changes, with replay of recent history.

A subscriber receives only what its role and your policies allow, and the realtime feed re-checks row access for every row change it delivers.

  • GETSubscribe to Realtime Feed/realtime/subscribe

    Upgrades the connection to a WebSocket or SSE stream to receive live events for a named topic.

  • POSTReplay Realtime Events/realtime/replay

    Returns one page of past events for a topic.

  • POSTCreate Stream/data-streams/user

    Creates a user stream in the project: a named, append-only message log that the project's own producers publish to and consumers read from.

  • GETList Streams/data-streams/user

    Lists the project's active user streams, oldest first.

  • GETGet Stream/data-streams/user/{streamSlug}

    Returns one active user stream by its slug.

  • DELETEDelete Stream/data-streams/user/{streamSlug}

    Deletes a user stream by its slug.

  • POSTPublish to Stream/data-streams/user/{streamSlug}/publish

    Appends one message to a user stream.

  • GETSubscribe to Stream/data-streams/user/{streamSlug}/subscribe

    Opens a Server-Sent Events stream of a user stream's messages, starting after a sequence number and following new messages as they arrive.

  • POSTReplay Stream/data-streams/user/{streamSlug}/replay

    Reads a page of a user stream's retained messages, oldest first, between two sequence numbers.

Storage & Schema

Where your project keeps files and how its data is shaped.

Storage is object storage in buckets (k9o.storage.*), platform-managed or backed by your own S3, GCS, Azure, MinIO, R2 or B2 bucket, with the same API either way.

Schema is introspection of your collections and columns, and migrations (k9o.migrations.*, CLI k9o migrations) are versioned DDL you propose, review and apply transactionally; a migration that embeds policy declarations may pass through approval before it takes effect.

  • POSTCreate Bucket/storage/buckets

    Creates a bucket in the project.

  • GETList Buckets/storage/buckets

    Returns all logical buckets defined within the project.

  • GETGet Bucket/storage/buckets/{bucketName}

    Returns one bucket, including its mode (private, public or custom).

  • PATCHUpdate Bucket/storage/buckets/{bucketName}

    Updates a bucket's settings; only the fields sent change.

  • DELETEDelete Bucket/storage/buckets/{bucketName}

    Permanently deletes a storage bucket and its configuration.

  • POSTUpload Object/storage/buckets/{bucketName}/objects

    Uploads one object into the bucket as multipart/form-data.

  • GETList Objects/storage/buckets/{bucketName}/objects

    Lists the objects in the bucket, optionally under a prefix.

  • DELETEDelete Object/storage/buckets/{bucketName}/objects

    Deletes the object at the path query parameter (a query parameter because paths contain slashes).

  • POSTCreate Signed URL/storage/buckets/{bucketName}/objects/sign

    Mints a pre-authenticated GET URL for one object in the bucket.

  • GETList Storage Locations/storage/locations

    Lists the project's active storage locations: the customer's own object stores (bring your own store) that buckets and datasets can be linked to.

  • POSTCreate Storage Location/storage/locations

    Registers one of the customer's own object stores as a storage location for the project.

  • GETGet Storage Location/storage/locations/{locationId}

    Gets one active storage location of the project by id.

  • PATCHUpdate Storage Location/storage/locations/{locationId}

    Updates a storage location.

  • DELETERetire Storage Location/storage/locations/{locationId}

    Retires a storage location: it stops being listed and can't be linked again.

  • GETList Collections/schema/collections

    Returns a paginated list of all user-defined collections in the project, sourced from the project's k9o_<proj_id> schema.

  • GETGet Collection/schema/collections/{name}

    Returns full schema detail for a single named collection, including:

  • POSTApply Migrations/migrations/apply

    Applies all pending migration files to the project's schema, executing each atomically in a Postgres transaction.

  • Returns the migration history for the project — the ordered list of migrations that have been applied to the project's schema, corresponding to the k9o migration status CLI command.

  • GETGet Migration/migrations/{version}

    Returns the record for a single applied migration identified by its version number.

  • POSTQueue Migration/migrations/queue

    Proposes one or more migration files for admin approval by inserting them into the pending-migration queue with status queued.

  • GETList Pending Migrations/migrations/pending

    Returns the list of pending-migration records for the project, filterable by status (queued, applied, rejected, or cancelled) via the ?status= query parameter.

  • POSTApply Pending Migration/migrations/pending/{pendingId}/apply

    Approves and executes a queued pending migration, transitioning it from queued to applied and running its DDL atomically against the project's schema.

  • POSTReject Pending Migration/migrations/pending/{pendingId}/reject

    Declines a queued pending migration, transitioning it from queued to rejected without executing any DDL.

  • DELETECancel Pending Migration/migrations/pending/{pendingId}

    Cancels a queued pending migration that the calling user authored, transitioning it from queued to cancelled without executing any DDL.

Compute & Automation

Code and automation that runs inside your project: Functions, their triggers and invocations, multi-step workflows, realtime channels, hosted model calls and the MCP servers an agent reaches.

The SDK surface is k9o.functions.* (notably k9o.functions.invoke(name, ...)), and the CLI deploys with k9o functions deploy.

A function runs on a gateway tier for light work or a sandbox tier of isolated MicroVMs for heavier work; callers never choose the tier.

Workflows compose data writes, function calls and approval gates, and are started by events or by signed inbound webhooks.

  • POSTDeploy Function/functions

    Registers a new function or redeploys an existing one within the specified project.

  • GETList Functions/functions

    Returns the cursor-paginated function registry for the specified project.

  • GETGet Function/functions/{name}

    Retrieves the full registry entry for a single named function in the specified project, including status, tier, runtime, version, source, deployed_at, and error_detail.

  • POSTInvoke Function/functions/{name}/invoke

    Invokes the named function with a caller-supplied payload.

  • DELETERetire Function/functions/{name}

    Transitions a developer-deployed function's status to retired, making it no longer invocable.

  • POSTCreate Function Trigger/functions/{name}/triggers

    Attaches an EVENT trigger to the named function: it fires on writes to a collection.

  • GETList Function Triggers/functions/{name}/triggers

    Returns the named function's EVENT triggers, newest first.

  • PATCHUpdate Function Trigger/functions/{name}/triggers/{triggerId}

    Partially updates an EVENT trigger.

  • DELETEDelete Function Trigger/functions/{name}/triggers/{triggerId}

    Permanently removes the EVENT trigger triggerId from the named function, so writes to its collection no longer invoke the function.

  • POSTCreate Workflow/workflows

    Creates a new workflow in the project with a name, trigger type (one of view_row_event, form_submission, scheduled, manual, or webhook), trigger configuration, and an ordered actions chai…

  • GETList Workflows/workflows

    Returns the paginated list of workflows in the specified project, ordered by authored date descending.

  • GETGet Workflow/workflows/{wflId}

    Retrieves the full definition of a single workflow by its wfl_<base62> identifier, including its trigger configuration, actions chain, and current status.

  • PATCHUpdate Workflow/workflows/{wflId}

    Partially updates a workflow's definition — including its name, description, status (active, archived, or draft), trigger configuration, or actions chain.

  • DELETEDelete Workflow/workflows/{wflId}

    Permanently deletes a workflow by its wfl_<base62> identifier.

  • POSTRun Workflow/workflows/{wflId}/runs

    Manually triggers a new execution run for a workflow whose trigger_type is manual, returning a run record with status: 'pending'.

  • GETList Workflow Runs/workflows/{wflId}/runs

    Returns the cursor-paginated history of execution runs for a workflow, ordered by start time descending.

  • GETGet Workflow Run/workflows/{wflId}/runs/{wfrId}

    Retrieves the full detail of a single workflow run by its wfr_<base62> identifier, including per-step status, per-action cost subtotals, and any error context.

  • POSTCancel Workflow Run/workflows/{wflId}/runs/{wfrId}/cancel

    Cancels a workflow run that is in pending or running status, halting execution at the current step.

  • POSTTrigger Workflow Webhook/workflows/{wflId}/webhook

    Fires a workflow whose trigger_type is webhook by posting to its dedicated webhook endpoint.

  • GETList LLM Models/compute/llms

    Returns the curated library of LLM models available to the project; every model is available on every plan.

  • GETGet LLM Model/compute/llms/{modelId}

    Retrieves metadata for a single LLM model by its identifier, including name, provider class, modality, token cost (per million input and output tokens), and supported parameters.

  • POSTInvoke LLM/compute/llms/{modelId}/invoke

    Dispatches a synchronous inference request to the specified LLM model and returns { completion: string, tokensUsed: int, latencyMs: int }.

  • POSTStream LLM Response/compute/llms/{modelId}/invoke-stream

    Dispatches an inference request to the specified LLM model and streams the response as Server-Sent Events (SSE), delivering tokens incrementally for low-latency UX.

Analytics & Intelligence

Questions you ask of your project's activity: analytics datasets and their queries, rollups that fold a stream into windowed aggregates, and the project's own logs, metrics and traces.

A rollup's source is a stream slug: one of your streams, or logs, metrics or traces for the project's telemetry.

Results are scoped to the project and read through the same access policies as the data they summarize.

  • POSTCreate Dataset/analytics/{datasetSlug}

    Creates a dataset at the slug in the path.

  • GETList Datasets/analytics

    Returns the project's active datasets, newest first: slug, display name, schema, partition keys (region is always the first), residency class, storage target and creation time.

  • GETGet Dataset/analytics/{datasetSlug}

    Returns one active dataset's metadata.

  • DELETEDelete Dataset/analytics/{datasetSlug}

    Retires the dataset: it reads as absent from then on and its slug is never reissued.

  • POSTWrite Dataset Rows/analytics/{datasetSlug}/write

    Appends rows: the body is newline-delimited JSON or a JSON array.

  • POSTUpload File/analytics/{datasetSlug}/upload

    Uploads a CSV or JSON file (raw body, or multipart with file and an optional manifest), up to 25 MiB.

  • GETDownload Original Upload/analytics/{datasetSlug}/upload/original

    Returns the original file of the dataset's stored upload as a download (text/csv, application/json or application/octet-stream), not a JSON envelope.

  • POSTMaterialize Collection/analytics/{datasetSlug}/materialize

    Copies rows into the dataset from exactly one source: fromCollection (a collection name) or fromQuery (a saved Studio query id that reads a single collection).

  • POSTRead Dataset Rows/analytics/{datasetSlug}/read

    Pages through a dataset's rows.

  • POSTQuery Datasets with SQL/analytics/query

    Runs a read-only SQL SELECT over the project's datasets and returns the rows.

  • POSTCreate Rollup/analytics/{datasetSlug}/rollups

    Creates a continuous rollup that folds a stream into this dataset over fixed windows.

  • GETList Rollups/rollups

    Returns every rollup in the project whose dataset the caller can read, with its read and subscribe endpoints.

  • GETList Dataset Rollups/analytics/{datasetSlug}/rollups

    Returns the dataset's rollups with their attestation state: attestedAt, expiresAt and attestationStatus (active, expiring_soon or expired; an expired rollup is paused, not deleted).

  • GETRead Rollup/rollups/{rollupSlug}/read

    Returns the rollup's cells for a time range.

  • GETSubscribe to Rollup/rollups/{rollupSlug}/subscribe

    Opens a server-sent events stream with one cell event per closed cell.

  • POSTRe-attest Rollup/analytics/{datasetSlug}/rollups/{rollupId}/reattest

    Confirms the rollup's configuration is still wanted: resets its attestation to now and, optionally, sets a new reattestIntervalDays (7, 30, 90 or 365).

  • DELETEDelete Rollup/analytics/{datasetSlug}/rollups/{rollupId}

    Deletes the rollup.

  • POSTCreate Schedule/analytics/{datasetSlug}/schedules

    Creates a recurring materialization from a collection into this dataset.

  • GETList Dataset Schedules/analytics/{datasetSlug}/schedules

    Returns the dataset's schedules with lastRunAt, lastRunStatus, nextRunAt and their attestation state (attestedAt, expiresAt, attestationStatus).

  • POSTRe-attest Schedule/analytics/{datasetSlug}/schedules/{scheduleId}/reattest

    Confirms the schedule is still wanted: resets its attestation to now and, optionally, sets a new reattestIntervalDays (7, 30, 90 or 365).

  • DELETEDelete Schedule/analytics/{datasetSlug}/schedules/{scheduleId}

    Deletes the schedule.

AI Safety

Checks on content an AI agent reads or writes, and rules on what agents may do.

Rampart classifies submitted content as clear, suspicious or malicious with a risk score and a signed classification receipt, as a signal for your own decision; its JWKS verifies those receipts.

The classification policy and tool rules set which agent tool calls a project allows.

  • POSTClassify Content/rampart/classify

    Classifies the submitted content and returns its classification, a risk score and a confidence (both in basis points, 0 to 10000), any categories, and the classifier's calibration version.

  • GETGet Rampart Signing Keys/rampart/jwks

    Returns the JSON Web Key Set (RFC 7517) that verifies Rampart classificationReceipt signatures.

Policy & Approvals

Who may do what, and what needs a second person.

Two families sit here.

Pending approvals (/pending-approvals) are the queue of held data and schema changes waiting on a reviewer; an approved change is applied for you, and a rejected one is discarded.

The change's author and its reviewers can discuss it in comments.

Approval policies (/approval-policies) are the rules that decide which changes are held.

Access policies, IAM policies and their bindings to principals live here too.

  • GETList Pending Approvals/pending-approvals

    Returns the caller's approver inbox: a cursor-paginated list of pending-change envelopes (pch_<base62>) where the caller is a member of the denormalized approver_set or holds an active approval…

  • GETGet Pending Approval/pending-approvals/{pendingId}

    Returns the full pending-change detail for a single pending-change envelope identified by pendingId (pch_<base62>), including the proposed diff, maker identity, denormalized approver set, statu…

  • POSTApprove Change/pending-approvals/{pendingId}/approve

    Records a checker approval decision on a pending change.

  • POSTReject Change/pending-approvals/{pendingId}/reject

    Records a checker rejection decision on a pending change, capturing an optional reason in status_reason.

  • POSTAdd Comment/pending-approvals/{pendingId}/comments

    Adds a comment to a pending change.

  • GETList Comments/pending-approvals/{pendingId}/comments

    Lists the comments on a pending change, oldest first, filtered by what the caller may see at the time of the request.

  • POSTDecide Changes in Bulk/pending-approvals/bulk

    Approves or rejects a batch of pending changes in a single atomic attestation using a batch criterion predicate (by maker session, by criteria predicate, by time window, or by table scope).

  • POSTCreate Approval Policy/approval-policies

    Creates a new draft policy bundle for the project, assigned a stable bundleId (bnd_<base62>).

  • GETList Approval Policies/approval-policies

    Lists the project's approval policies (apo_...), oldest first.

  • DELETEDelete Approval Policy/approval-policies/{policyId}

    Permanently deletes a draft policy bundle identified by policyId.

  • POSTCreate Policy Draft/policies

    Creates a new draft policy bundle for the project.

  • GETList Policies/policies

    Returns all policy bundles for the project, cursor-paginated and filterable by status (draft, published, superseded).

  • GETGet Policy/policies/{bundleId}

    Returns a single policy bundle by its bundleId.

  • Returns the currently published policy bundle for the project — the live bundle evaluated at runtime against all data operations.

  • PATCHUpdate Policy Draft/policies/{bundleId}

    Updates the policy document of a draft bundle.

  • POSTValidate Policy/policies/validate

    Validates a candidate policy bundle body against all schema and operator rules without persisting any state.

  • POSTPublish Policy/policies/{bundleId}/publish

    Atomically publishes a draft bundle, activating it as the project's live policy.

  • DELETEDelete Policy Draft/policies/{bundleId}

    Deletes a draft policy bundle.

Encryption

Encrypt and decrypt data under your project's keys, rewrap ciphertext, and check who holds the keys.

The SDK surface is k9o.kibo.*.

A custody move runs as a job you can follow to completion.

  • POSTEncrypt/crypto/encrypt

    Encrypts up to 100 items with the project's key; the key never leaves the platform and you never choose one.

  • POSTDecrypt/crypto/decrypt

    Decrypts up to 100 ciphertexts made by this API, with the same crypt and context used to encrypt them.

  • POSTRewrap/crypto/rewrap

    Re-seals up to 100 ciphertexts under the project's current key in one call; the plaintext never leaves the platform.

  • GETGet Crypto Mode/crypto/mode

    Returns the project's key custody mode (PLATFORM_MANAGED, SKR, BYOK or HYOK), its route, and an opaque epoch that changes with every custody transition.

  • POSTGet Federation Token/crypto/federated-token

    Issues a short-lived signed identity for the client-side crypto path on a project that uses your own key (BYOK or HYOK): present it to your cloud's token exchange (AWS AssumeRoleWithWebIdentity, GC…

  • POSTRevoke Federation Keys/crypto/federation-keys/revoke

    Revokes every federation signing key of the project: tokens already issued stop verifying once your cloud's cached copy of the key set expires, and the next token is signed with a new key under the…

  • GETGet Custody Status/custody/status

    Read-only summary of the project's key custody: { mode, attached, provider, lastJob, hsm, kmsFederation }.

Members & End Users

The people in your project.

Members and invitations are the operators who work on it; end users are your application's own customers (eu_<base62>), with their groups (eug_<base62>) and role grants (eur_<base62>), managed through k9o.gate.admin.*.

The two are separate trust zones: an operator's access never comes from an end-user record, and an end user never holds an operator role.

Signing end users in is under the Gate tags.

  • POSTAdd Member/members

    Invites a new user or grants an existing org member a role on the project.

  • GETList Members/members

    Returns a list of members for the specified project.

  • PATCHUpdate Member Role/members/{userId}

    Changes the project role of an existing project member.

  • DELETERemove Member/members/{userId}

    Removes a user from the project.

  • POSTGrant End User Role/end-user-role-grants

    Grants a project-level role to an end-user, creating a eur_-prefixed role grant record.

  • GETList End User Roles/end-user-role-grants

    Returns all active role grants for project end-users, cursor-paginated.

  • DELETERevoke End User Role/end-user-role-grants/{grantId}

    Revokes a specific end-user role grant by its eur_-prefixed grant ID, setting revoked_at on the grant record.

Audit & Security

The record of what happened in your project and the controls around it: the audit log and its anchors, security settings such as SIEM delivery, notifications and alert rules, erasure triggers, legal attestations and project settings.

Audit entries are identity-attributed and append-only, and anchors let you check that the log you read is the log that was written.

Notification and alert events are the same events the audit trail records.

  • GETList Audit Log/audit-log

    Returns a paginated list of audit events for the specified project, covering auth, data-access, security, and lifecycle activity.

  • GETList Anchors/anchors

    Returns the cursor-paginated list of external transparency anchors for the project, ordered by capturedAt descending.

  • GETGet Anchor/anchors/{anchorId}

    Retrieves a single transparency anchor by its identifier (anc_<base62>).

Extensions

Installing, configuring, enabling, disabling, and operating extensions within a project.

Extensions (ext_<base62>) add capabilities on top of the platform core — connectors, AI agents, identity surfaces, and automations — running in a sandboxed WASM/Bun runtime with per-extension isolation, gateway-mediated egress, and a declared manifest of capabilities and dependencies.

These endpoints manage the extension lifecycle (install, supply per-project configuration and secrets, enable, disable, uninstall) and the per-project state each extension maintains in its own _ext_<name> namespace.

Extensions are how a project is extended without forking the platform: they read feature flags rather than tier names, deploy functions into the shared _sys.functions registry under an extension:<slug> provenance, and are governed by the same policy and audit machinery as first-party code.

A manifest that violates the schema is hard-rejected with K9O_EXTENSION_MANIFEST_INVALID.

Integrators building, publishing, or installing marketplace capabilities manage their lifecycle and configuration here.

  • GETList Extensions/extensions-admin

    Returns the list of extensions currently enabled (or previously installed) on the specified project, including each extension's status, manifest version, enabled-at timestamp, and permission grants.

  • GETGet Extension/extensions-admin/{slug}

    Returns the per-project enable record for the specified extension on this project — including the enable status, current manifest version, permission grants, schema name, and the hookSecret (HMAC…

  • POSTEnable Extension/extensions-admin/{slug}/enable

    Enables a registered extension on the specified project.

  • DELETEDisable Extension/extensions-admin/{slug}/disable

    Disables an enabled extension on the specified project.

  • PATCHUpdate Extension Config/extensions-admin/{slug}/config

    Updates per-extension configuration for the specified project and fires the configure lifecycle hook (best-effort, single attempt).

  • GETList Extension Table Rows/extensions-admin/{slug}/tables/{table}/rows

    Lists the rows of one of an installed extension's own tables, a page at a time.

  • POSTCreate Extension Table Row/extensions-admin/{slug}/tables/{table}/rows

    Creates one row in an installed extension's own table from values, and answers 201 with the row as stored.

  • GETGet Extension Table Row/extensions-admin/{slug}/tables/{table}/rows/{rowId}

    Reads one row of an installed extension's own table by its id.

  • PATCHUpdate Extension Table Row/extensions-admin/{slug}/tables/{table}/rows/{rowId}

    Changes the columns named in set on one row, and answers with the row as stored.

  • DELETEDelete Extension Table Row/extensions-admin/{slug}/tables/{table}/rows/{rowId}

    Deletes one row of an installed extension's own table.

MCP

The project's inbound MCP (Model Context Protocol) endpoint, for AI agents and MCP clients.

A client reads the discovery document without a token, presents a token minted for a named set of tools, and calls those tools over JSON-RPC.

Each call runs under the minting operator's live role, so a token never grants more than that operator holds.

  • GETGet MCP Discovery/.well-known/oauth-protected-resource

    The project's OAuth 2.0 Protected Resource Metadata (RFC 9728) for its MCP endpoint.

  • The project's inbound MCP endpoint: Streamable HTTP, one JSON-RPC 2.0 request per POST.

  • POSTCreate MCP Token/mcp/tokens

    Mints the bearer token an MCP client presents to the project's MCP endpoint.

  • DELETERevoke MCP Token/mcp/tokens/{jti}

    Revokes an MCP token by its jti.

Operator Sign-in

The entry points by which an operator establishes identity with the platform:

  • sign-up
  • sign-in (password and federated)
  • token refresh
  • sign-out
  • the OAuth2 / OIDC / SAML callback and assertion-consumer flows that complete a federated handshake

Most are reachable before any session token exists — they mint the first credential — so they require no caller credential and are emitted with security: [].

A successful flow yields an operator session (a JWT plus refresh token) that every other operator-plane call presents.

This tag covers operators only — the people and machines that administer organizations, projects, and configuration.

Authentication for your own application's end-users is a separate trust zone entirely and is under the Gate tags; the two must not be conflated.

Integrators automating against the platform typically pass through here once to obtain a token, then prefer a Personal Access Token for long-lived programmatic access.

  • POSTRedeem Authorization Code/auth/oauth/token

    RFC 6749 token endpoint for the operator authorization code with PKCE.

  • POSTRevoke Client Token/auth/oauth/revoke

    RFC 7009 revocation for a token from Redeem Authorization Code.