REST API specification

Generated from the checked-in source. Do not edit this reference by hand.

Download the full OpenAPI JSON. Authentication, parameters, request bodies and response schemas below come from that same contract.

The contract includes endpoints with explicit limitations or stub status. Read the scope on each operation.

Model APIs

• GET /v1/branding — Read public branding and theme defaults
• POST /v1/chat/completions — Create an OpenAI-compatible chat completion
• GET /v1/currency — Read the configured platform currency
• POST /v1/embeddings — Create OpenAI-compatible text embeddings
• GET /v1/generations/{id} — Get generation usage, latency, and customer charge by ID
• GET /v1/key — Inspect the current workspace API key
• POST /v1/messages — Create a native text Message, optionally streamed
• GET /v1/models — List key-accessible model aliases and workspace customer prices
• POST /v1/responses — Create a text response
• POST /v1beta/models/{model_action} — Generate native buffered Gemini text

Video and media APIs

• GET /v1/media/assets — List saved workspace Provider assets
• POST /v1/media/assets — Create a Provider asset from a URL
• DELETE /v1/media/assets/{id} — Delete a Provider asset
• GET /v1/media/assets/{id} — Read a saved Provider asset
• PATCH /v1/media/assets/{id} — Rename a Provider asset
• POST /v1/media/assets/{id}/refresh — Refresh one owned Provider asset
• GET /v1/media/capabilities — Discover authorized model-specific native Provider tools
• GET /v1/media/groups — List saved workspace Provider groups
• POST /v1/media/groups — Create a Provider asset group
• DELETE /v1/media/groups/{id} — Delete a Provider asset group
• GET /v1/media/groups/{id} — Read a saved Provider group
• PATCH /v1/media/groups/{id} — Update Provider group metadata
• POST /v1/media/groups/{id}/refresh — Refresh one owned Provider group
• GET /v1/media/image-ingestions — Recover this API key’s saved ingestion history
• DELETE /v1/media/image-ingestions/{id} — Revoke source publication consent without erasing immutable history
• GET /v1/media/image-ingestions/{id} — Read customer-safe ingestion status under the original API key
• PUT /v1/media/image-ingestions/{id} — Consent to ingestion of one inspected image into one ordinary asset group
• POST /v1/media/image-ingestions/{id}/dispatch — Claim and dispatch one inspected image ingestion
• GET /v1/media/image-ingestions/{id}/readiness/{read_id} — Retrieve one persisted readiness observation without an upstream request
• POST /v1/media/image-ingestions/{id}/readiness/{read_id} — Observe accepted image status using its original account
• POST /v1/media/image-sources — Inspect and temporarily retain one exact inline image
• DELETE /v1/media/image-sources/{id} — Erase this API key’s retained source bytes
• GET /v1/media/operations — List saved Provider mutation operations
• GET /v1/media/operations/{id} — Read a saved Provider mutation operation
• POST /v1/media/operations/{id}/cancel — Cancel an unclaimed native material preparation
• POST /v1/media/operations/{id}/dispatch — Explicitly dispatch an existing native material preparation
• GET /v1/media/operations/by-idempotency/{id} — Read a saved Provider operation by request idempotency UUID
• POST /v1/media/operations/prepare — Prepare a native material operation without dispatch
• GET /v1/media/sources/{token} — Fetch exact approved image bytes using an expiring capability
• HEAD /v1/media/sources/{token} — Reject HEAD probes of image source capabilities
• GET /v1/media/verifications — List saved verification sessions
• POST /v1/media/verifications — Create upstream human verification session
• GET /v1/media/verifications/{id} — Read saved verification session
• GET /v1/media/verifications/{id}/link — Get authenticated upstream verification link
• POST /v1/media/verifications/{id}/refresh — Refresh upstream verification session
• POST /v1/video/estimate — Estimate a configured text-video request without submission
• GET /v1/video/jobs — List durable workspace video jobs
• POST /v1/video/jobs — Submit a schema-validated video job
• GET /v1/video/jobs/{id} — Read persisted video job state
• GET /v1/video/jobs/{id}/billing — Read saved customer video billing
• GET /v1/video/jobs/{id}/observations — Read saved video query observations
• POST /v1/video/jobs/{id}/refresh — Refresh one direct-channel video job
• DELETE /v1/video/jobs/{id}/results — Permanently remove locally saved result references
• GET /v1/video/jobs/{id}/results — Read saved result availability without downloading media
• GET /v1/video/jobs/{id}/results/{kind} — Retrieve a bounded saved video or last frame
• POST /v1/video/jobs/{id}/results/{kind}/refresh — Retrieve fresh output from the original Video task
• GET /v1/video/jobs/{id}/timings — Read measured gateway video transport spans
• GET /v1/video/models — Read customer-safe configured text-video capabilities

Providers and routing APIs

• GET /api/v1/pools — List platform-managed model route pools
• PUT /api/v1/pools — Create or revise a model candidate pool
• GET /api/v1/pools/{reference} — Read an installation-managed model candidate pool
• GET /api/v1/pools/{reference}/audit — Audit routing and billing strategy for a model route pool
• GET /api/v1/pools/{reference}/history — Read immutable model candidate pool revisions
• POST /api/v1/pools/{reference}/preview — Dry-run routing preview for a model route pool
• GET /api/v1/pools/history — Read immutable model candidate pool revisions
• GET /api/v1/pools/index — List platform-managed model route pools
• GET /api/v1/provider-memberships — List the signed-in operator’s complete active Provider memberships
• GET /api/v1/providers — List active Provider business identities
• POST /api/v1/providers — Create a Provider business identity
• DELETE /api/v1/providers/{provider} — Remove an unconfigured Provider from the directory
• GET /api/v1/providers/{provider} — Read Provider business profile
• PATCH /api/v1/providers/{provider} — Update Provider business profile
• GET /api/v1/providers/{provider}/administration — Explicit installation oversight of the Provider dashboard
• GET /api/v1/providers/{provider}/configuration-usage — Inspect operational usage of Provider-owned configurations
• GET /api/v1/providers/{provider}/dashboard — Provider-scoped earnings and operations; active explicit membership required
• GET /api/v1/providers/{provider}/earnings — Page platform Provider accrued and paid obligations
• GET /api/v1/providers/{provider}/integration — Read provider integration identity
• PUT /api/v1/providers/{provider}/integration — Set provider integration identity
• GET /api/v1/providers/{provider}/media-offer-models — List named draft media offer bindings
• POST /api/v1/providers/{provider}/media-offers — Save an inactive versioned media offer without text-token prices
• GET /api/v1/providers/{provider}/media-rate-models — List current media pricing configuration choices
• GET /api/v1/providers/{provider}/media-rates — Read this Provider’s agreed media purchase schedules
• POST /api/v1/providers/{provider}/media-rates — Publish confidential agreed Provider media purchase terms
• POST /api/v1/providers/{provider}/media-rates/{revision}/retire — End a Provider purchase schedule’s eligibility
• POST /api/v1/providers/{provider}/media-rates/replace — Atomically replace agreed media purchase terms
• GET /api/v1/providers/{provider}/members — List Provider business members
• PUT /api/v1/providers/{provider}/members/{operator} — Grant, change or disable a Provider membership
• GET /api/v1/providers/{provider}/offers — Page current Provider offers and rate revisions
• POST /api/v1/providers/{provider}/offers — Publish an immutable agreed Provider payout schedule
• PATCH /api/v1/providers/{provider}/offers/{offer} — A Provider manager can pause or resume an owned offer
• PUT /api/v1/providers/{provider}/offers/{offer}/qualification — Record a Provider offer qualification review
• POST /api/v1/providers/{provider}/offers/{offer}/qualification/revoke — Revoke the current Provider offer qualification
• GET /api/v1/providers/{provider}/offers/{offer}/revisions — List immutable Provider quote history
• GET /api/v1/providers/{provider}/offers/{offer}/revisions/{revision} — Read an immutable Provider procurement quote
• PUT /api/v1/providers/{provider}/qualification — Record a Provider business qualification review
• POST /api/v1/providers/{provider}/qualification/revoke — Revoke the current Provider business qualification
• GET /api/v1/providers/{provider}/settlements — Page Provider settlement history
• POST /api/v1/providers/{provider}/settlements — Record an already completed external Provider payment
• GET /api/v1/providers/{supplier}/offers/{offer}/media-liability-bounds — List immutable route media liability qualifications
• POST /api/v1/providers/{supplier}/offers/{offer}/media-liability-bounds — Publish an evidenced route media liability bound
• POST /api/v1/providers/{supplier}/offers/{offer}/media-liability-bounds/{revision}/retire — Retire a route media liability bound
• GET /api/v1/routing-registry — Read the active routing generation
• GET /api/v1/vendors — List Provider API-key configurations without credentials
• POST /api/v1/vendors — Create an encrypted Provider API-key configuration
• PUT /api/v1/vendors/{id} — Update one Provider API-key configuration or rotate its credential
• DELETE /api/v1/vendors/{id}/asset-management — Revoke locally saved asset-management credentials
• GET /api/v1/vendors/{id}/asset-management — Read installation asset-management configuration metadata
• PUT /api/v1/vendors/{id}/asset-management — Save an encrypted asset-management credential revision
• GET /api/v1/vendors/{id}/asset-management/authorizations — List one account’s qualification records
• POST /api/v1/vendors/{id}/asset-management/authorizations — Record administrator-reviewed ordinary asset qualification
• DELETE /api/v1/vendors/{id}/asset-management/authorizations/{authorization} — Revoke one account’s asset qualification
• POST /api/v1/vendors/{id}/asset-management/group-deletion-consents — Record specific cascading-deletion consent without dispatch
• DELETE /api/v1/vendors/{id}/asset-management/group-deletion-consents/{consent} — Revoke local deletion consent without erasing history
• GET /api/v1/vendors/{id}/asset-management/group-deletion-consents/{consent} — Read safe local consent and outcome status
• POST /api/v1/vendors/{id}/asset-management/group-deletion-consents/{consent}/dispatch — Dispatch one irreversible ordinary-group cascading deletion
• GET /api/v1/vendors/{id}/asset-management/group-reads — List scoped ordinary group-read outcomes and timing
• POST /api/v1/vendors/{id}/asset-management/group-reads — Read a saved ordinary asset group using its original account
• DELETE /api/v1/vendors/{id}/asset-management/group-reads/{read} — Erase retained group-read content
• GET /api/v1/vendors/{id}/asset-management/group-reads/{read} — Recover an encrypted ordinary group read result
• GET /api/v1/vendors/{id}/asset-management/group-updates — Retrieve scoped metadata-update audit history
• POST /api/v1/vendors/{id}/asset-management/group-updates — Prepare an encrypted metadata patch for a saved ordinary group
• DELETE /api/v1/vendors/{id}/asset-management/group-updates/{update} — Erase retained metadata-update patch
• POST /api/v1/vendors/{id}/asset-management/group-updates/{update}/dispatch — Dispatch a prepared ordinary-group metadata update once
• POST /api/v1/vendors/{id}/asset-management/group-updates/{update}/reconcile — Read back and reconcile an acknowledged ordinary-group update
• POST /api/v1/vendors/{id}/asset-management/groups — Create an ordinary asset group through platform administration
• GET /api/v1/vendors/{id}/asset-management/listings — List scoped ordinary asset-listing outcomes and timing
• POST /api/v1/vendors/{id}/asset-management/listings — List one bounded page of assets in a saved ordinary group
• DELETE /api/v1/vendors/{id}/asset-management/listings/{listing} — Erase retained ordinary asset listing content
• GET /api/v1/vendors/{id}/asset-management/listings/{listing} — Recover a retained ordinary asset listing locally
• GET /api/v1/vendors/{id}/asset-management/lookups — List durable asset lookup audit history
• POST /api/v1/vendors/{id}/asset-management/lookups — Look up one asset from a retained original-group listing
• DELETE /api/v1/vendors/{id}/asset-management/lookups/{lookup} — Erase retained asset lookup content
• GET /api/v1/vendors/{id}/asset-management/lookups/{lookup} — Recover one encrypted asset lookup result
• GET /api/v1/vendors/{id}/catalog — Discover upstream models for a Provider API-key configuration
• POST /api/v1/vendors/{id}/catalog — Refresh descriptive metadata for existing vendor model mappings
• POST /api/v1/vendors/{id}/check — Check provider reachability and whether a mapped model is listed
• GET /api/v1/vendors/{id}/integration — Read vendor integration identity
• PUT /api/v1/vendors/{id}/integration — Set vendor integration identity
• GET /api/v1/vendors/{id}/models — List model bindings for one Provider API-key configuration
• POST /api/v1/vendors/{id}/models — Create or update a model mapping with optimistic revision checks
• PUT /api/v1/vendors/{id}/personal-owner — Assign a configured personal credential to its account
• GET /api/v1/vendors/{id}/supplier — Read the Provider owning an API configuration
• PUT /api/v1/vendors/{id}/supplier — Associate an API configuration with a Provider
• GET /api/v1/vendors/{vendor}/cooldown — Read credential safe-failure cooldown
• GET /api/v1/vendors/{vendor}/request-rate-limit — Read upstream credential request limit
• PUT /api/v1/vendors/{vendor}/request-rate-limit — Set upstream credential request limit
• GET /api/v1/vendors/{vendor}/request-rate-limit/history — Read credential request-limit history

Authentication and sessions

• POST /api/v1/auth/browser/demo — Sign in to the configured shared demo account
• POST /api/v1/auth/browser/login — Sign in with a secure HttpOnly member cookie
• POST /api/v1/auth/browser/logout — Revoke and clear the current browser member session
• POST /api/v1/auth/browser/token — Use an existing user access token in the browser
• GET /api/v1/auth/config — Discover member sign-in availability
• POST /api/v1/auth/login — Exchange member credentials for a scoped eight-hour session
• POST /api/v1/auth/logout — Sign out the member session supplied in Authorization
• PUT /api/v1/auth/password — Change the signed-in member’s password with current-password proof
• GET /api/v1/auth/preferences — Read current member appearance preference
• PUT /api/v1/auth/preferences — Save current member appearance preference
• GET /api/v1/auth/profile — Read current member profile
• PUT /api/v1/auth/profile — Update current member profile
• GET /api/v1/operators — List operator identities without session credentials
• POST /api/v1/operators — Create an operator and issue its first session token
• DELETE /api/v1/operators/{operator} — Revoke an operator and all of its sessions
• PATCH /api/v1/operators/{operator} — Change a scoped customer member role
• GET /api/v1/operators/{operator}/events — Read immutable operator and session lifecycle events
• GET /api/v1/operators/{operator}/password — Read a member’s sign-in configuration
• PUT /api/v1/operators/{operator}/password — Provision or reset an existing member password
• GET /api/v1/operators/{operator}/sessions — List session expiry and revocation metadata
• POST /api/v1/operators/{operator}/sessions — Issue an additional one-time operator session token
• DELETE /api/v1/operators/{operator}/sessions/{session} — Revoke one operator session
• GET /api/v1/session — Read the current administrator’s scope and permissions

Workspace and company APIs

• GET /api/v1/commercial-position — Compare installation commercial Provider positions
• GET /api/v1/financial-summary — Read platform customer revenue and cash receipt summary
• GET /api/v1/guardrails/detectors/{detector} — Read installation text detector processing declaration
• POST /api/v1/guardrails/detectors/{detector}/preview — Preview installation text detector transport
• GET /api/v1/metrics — Read in-process request and token counters
• GET /api/v1/models — List configured model routes
• GET /api/v1/organizations — List authorized company metadata
• POST /api/v1/organizations — Create a company and its initial zero-funded account
• POST /api/v1/organizations/{organization}/billing/accounts/{currency}/grants — Issue administrator noncash customer credit
• GET /api/v1/organizations/{organization}/billing/accounts/{currency}/grants/{grant} — Read one original noncash gift and its correction
• POST /api/v1/organizations/{organization}/billing/accounts/{currency}/grants/{grant}/correction — Correct a wholly unused noncash gift
• GET /api/v1/organizations/{organization}/billing/accounts/{currency}/grants/issued — List issued noncash gifts and corrections
• POST /api/v1/organizations/{organization}/billing/accounts/{currency}/grants/prepare — Prepare a durable noncash gift intent
• GET /api/v1/organizations/{organization}/billing/accounts/{currency}/grants/prepared — Recover saved noncash grant publication intents
• GET /api/v1/organizations/{organization}/billing/accounts/{currency}/grants/prepared/{key} — Read original noncash gift intent by idempotency key
• PUT /api/v1/organizations/{organization}/billing/accounts/{currency}/policy — Configure approved credit and low-balance threshold
• GET /api/v1/organizations/{organization}/billing/accounts/{currency}/policy/history — Read immutable company credit and warning policy revisions
• PUT /api/v1/organizations/{organization}/billing/accounts/{currency}/warning-threshold — Set company low-balance warning threshold
• GET /api/v1/organizations/{organization}/billing/balance — Read shared company account balances
• GET /api/v1/organizations/{organization}/billing/charge-reconciliation — Compare customer charge records with prepaid ledger debits
• POST /api/v1/organizations/{organization}/billing/entries/{entry}/reversal — Record a balance refund or settled-funding reversal
• POST /api/v1/organizations/{organization}/billing/funding/settled — Record an externally verified settled customer payment
• GET /api/v1/organizations/{organization}/billing/media-rate-models — Read named qualified commercial video configuration choices
• GET /api/v1/organizations/{organization}/billing/media-rates — Read bounded immutable customer selling history
• POST /api/v1/organizations/{organization}/billing/media-rates — Publish an immutable customer video selling schedule
• POST /api/v1/organizations/{organization}/billing/media-rates/{revision}/retire — End a published customer media rate’s eligibility
• POST /api/v1/organizations/{organization}/billing/media-rates/replace — Atomically replace a customer media selling schedule
• GET /api/v1/organizations/{organization}/billing/payment-methods — Read company checkout availability
• POST /api/v1/organizations/{organization}/billing/quotes — Prepare an exact versioned Credits purchase quote
• GET /api/v1/organizations/{organization}/billing/quotes/{quote} — Read a saved Credits purchase quote
• GET /api/v1/organizations/{organization}/billing/reservations — Inspect open customer balance reservations
• GET /api/v1/organizations/{organization}/billing/topups — Recover company checkout history
• POST /api/v1/organizations/{organization}/billing/topups — Create or recover a company prepaid top-up
• GET /api/v1/organizations/{organization}/billing/topups/{order} — Read saved company top-up status
• POST /api/v1/organizations/{organization}/billing/topups/{order}/reconcile — Independently reconcile a saved payment
• GET /api/v1/organizations/{organization}/billing/transactions — Read a company balance transaction page
• GET /api/v1/organizations/{organization}/billing/units — Read exact Credits quantities by original definition and provenance
• POST /api/v1/organizations/{organization}/billing/units/charges/{attempt}/refunds — Restore original consumed Credits ranges
• POST /api/v1/organizations/{organization}/billing/units/grants — Issue noncash Credits with an immutable provenance and expiry
• GET /api/v1/organizations/{organization}/billing/units/purchases/{order}/reversals — Preview a Credits purchase reversal and read committed reversal receipts
• POST /api/v1/organizations/{organization}/billing/units/purchases/{order}/reversals — Reverse unoccupied Credits purchase ranges at processor minor-unit precision
• GET /api/v1/organizations/{organization}/projects — List scoped company workspaces
• POST /api/v1/organizations/{organization}/projects — Create a workspace in the selected company
• DELETE /api/v1/organizations/{organization}/projects/{project} — Delete an empty workspace
• PATCH /api/v1/organizations/{organization}/projects/{project} — Rename a workspace
• GET /api/v1/organizations/{organization}/projects/{project}/accounts — List account metadata without credential references
• POST /api/v1/organizations/{organization}/projects/{project}/accounts — Register an unverified account
• GET /api/v1/organizations/{organization}/projects/{project}/asset-group-intents — Discover saved asset group creation requests
• DELETE /api/v1/organizations/{organization}/projects/{project}/asset-group-intents/{intent}/request — Delete saved asset-creation request content
• GET /api/v1/organizations/{organization}/projects/{project}/asset-group-intents/{intent}/request — Read customer-safe asset request content and retention status
• GET /api/v1/organizations/{organization}/projects/{project}/assets — List saved workspace materials
• POST /api/v1/organizations/{organization}/projects/{project}/assets — Save a workspace material
• DELETE /api/v1/organizations/{organization}/projects/{project}/assets/{asset} — Delete a saved workspace material
• GET /api/v1/organizations/{organization}/projects/{project}/assets/{asset} — Read workspace material metadata
• PATCH /api/v1/organizations/{organization}/projects/{project}/assets/{asset} — Rename a saved workspace material
• GET /api/v1/organizations/{organization}/projects/{project}/assets/{asset}/content — Download saved workspace material bytes
• GET /api/v1/organizations/{organization}/projects/{project}/billing — Read workspace customer charges, tariffs and latest 100 invoices
• GET /api/v1/organizations/{organization}/projects/{project}/billing/invoices — Page complete workspace customer invoice history
• POST /api/v1/organizations/{organization}/projects/{project}/billing/invoices — Issue an immutable itemized usage statement
• GET /api/v1/organizations/{organization}/projects/{project}/billing/invoices/{invoice} — Read invoice lines grouped by model and pinned rate revision
• POST /api/v1/organizations/{organization}/projects/{project}/billing/invoices/{invoice}/payment — Record one confirmed full external invoice payment
• GET /api/v1/organizations/{organization}/projects/{project}/billing/media-retail-price-enrollment — Read workspace media selling-price enrollment
• POST /api/v1/organizations/{organization}/projects/{project}/billing/media-retail-price-enrollment — Set workspace media selling-price enrollment
• GET /api/v1/organizations/{organization}/projects/{project}/billing/retail-price-enrollment — Read own workspace retail pricing mode
• POST /api/v1/organizations/{organization}/projects/{project}/billing/retail-price-enrollment — Enroll a workspace model in a platform selling price
• POST /api/v1/organizations/{organization}/projects/{project}/billing/tariffs — Publish an immutable customer selling rate revision
• GET /api/v1/organizations/{organization}/projects/{project}/billing/tariffs/{model}/history — Read immutable customer text price history
• GET /api/v1/organizations/{organization}/projects/{project}/budget — Read the platform upstream cost budget (installation only)
• POST /api/v1/organizations/{organization}/projects/{project}/budget — Create a platform upstream cost budget (installation only)
• GET /api/v1/organizations/{organization}/projects/{project}/chats — List personal saved Chat history or one continuation page
• DELETE /api/v1/organizations/{organization}/projects/{project}/chats/{id} — Delete an owned Chat session in a workspace
• GET /api/v1/organizations/{organization}/projects/{project}/chats/{id} — Read one complete owned saved Chat conversation
• PUT /api/v1/organizations/{organization}/projects/{project}/chats/{id} — Save an owned Chat session in a workspace
• PUT /api/v1/organizations/{organization}/projects/{project}/chats/{id}/archive — Archive or restore the authenticated owner’s Chat session
• GET /api/v1/organizations/{organization}/projects/{project}/chats/{id}/export — Export one owned saved conversation
• GET /api/v1/organizations/{organization}/projects/{project}/chats/draft — Read the persistent personal Chat draft
• PUT /api/v1/organizations/{organization}/projects/{project}/chats/draft — Save or clear the personal Chat draft with an expected revision
• GET /api/v1/organizations/{organization}/projects/{project}/costs — Read platform upstream cost entries (installation only)
• GET /api/v1/organizations/{organization}/projects/{project}/generations — List private generations sessions
• GET /api/v1/organizations/{organization}/projects/{project}/generations/{session} — Read a private saved generations timeline
• PATCH /api/v1/organizations/{organization}/projects/{project}/generations/{session} — Rename or archive a private video session
• PUT /api/v1/organizations/{organization}/projects/{project}/generations/{session} — Create a private video generations session
• DELETE /api/v1/organizations/{organization}/projects/{project}/generations/{session}/turns/{turn} — Delete retained instruction content
• PUT /api/v1/organizations/{organization}/projects/{project}/generations/{session}/turns/{turn} — Append one retained video instruction
• PUT /api/v1/organizations/{organization}/projects/{project}/generations/{session}/turns/{turn}/intent — Bind a saved Video intent to a private turn
• PUT /api/v1/organizations/{organization}/projects/{project}/generations/{session}/turns/{turn}/task — Attach an existing authorized video task
• GET /api/v1/organizations/{organization}/projects/{project}/generations/artifacts — List actual saved output references
• GET /api/v1/organizations/{organization}/projects/{project}/generations/artifacts/{task}/{kind} — Read an output availability record
• GET /api/v1/organizations/{organization}/projects/{project}/generations/artifacts/{task}/{kind}/capture — Read saved artifact capture status
• POST /api/v1/organizations/{organization}/projects/{project}/generations/artifacts/{task}/{kind}/capture — Explicitly save a generated output into workspace materials
• GET /api/v1/organizations/{organization}/projects/{project}/generations/artifacts/{task}/{kind}/content — Download an authorized retained output
• GET /api/v1/organizations/{organization}/projects/{project}/generations/tasks — List saved Video tasks across workspace keys
• GET /api/v1/organizations/{organization}/projects/{project}/generations/tasks/{task} — Read a saved Video task
• GET /api/v1/organizations/{organization}/projects/{project}/generations/tasks/{task}/diagnostics — Read saved customer billing and transport diagnostics
• POST /api/v1/organizations/{organization}/projects/{project}/generations/tasks/{task}/refresh — Explicitly refresh the original Video task
• POST /api/v1/organizations/{organization}/projects/{project}/generations/tasks/{task}/results/{kind}/refresh — Retrieve fresh output from the original Video task
• GET /api/v1/organizations/{organization}/projects/{project}/guardrails — Read active workspace access policy
• PUT /api/v1/organizations/{organization}/projects/{project}/guardrails — Activate a validated workspace access-policy revision
• GET /api/v1/organizations/{organization}/projects/{project}/guardrails/denials — Read latest 100 workspace preparation refusals
• GET /api/v1/organizations/{organization}/projects/{project}/guardrails/detector-decisions — Read latest 100 workspace input detector decisions
• GET /api/v1/organizations/{organization}/projects/{project}/guardrails/detectors — List authorized workspace text detector declarations
• GET /api/v1/organizations/{organization}/projects/{project}/guardrails/dispatch-denials — Read latest 100 workspace dispatch policy exceptions
• GET /api/v1/organizations/{organization}/projects/{project}/guardrails/history — Browse immutable workspace policy revision metadata
• GET /api/v1/organizations/{organization}/projects/{project}/guardrails/image-detectors — List authorized workspace image detector declarations
• POST /api/v1/organizations/{organization}/projects/{project}/guardrails/image-detectors/{detector}/preview — Preview explicitly consented workspace image processing
• POST /api/v1/organizations/{organization}/projects/{project}/guardrails/input-preview — Test synthetic input against local text rules without enforcement
• GET /api/v1/organizations/{organization}/projects/{project}/guardrails/media-detectors — List workspace-authorized media inspection configurations
• POST /api/v1/organizations/{organization}/projects/{project}/guardrails/output-preview — Test synthetic output against local text rules without enforcement
• POST /api/v1/organizations/{organization}/projects/{project}/guardrails/preview — Preview draft model and Provider access without persistence
• GET /api/v1/organizations/{organization}/projects/{project}/guardrails/revisions/{revision} — Inspect a preserved workspace policy version before restoring
• POST /api/v1/organizations/{organization}/projects/{project}/guardrails/rollback — Restore a preserved policy as a new active revision
• GET /api/v1/organizations/{organization}/projects/{project}/keys — List saved workspace API-key metadata
• POST /api/v1/organizations/{organization}/projects/{project}/keys — Issue a workspace API key and return its secret once
• DELETE /api/v1/organizations/{organization}/projects/{project}/keys/{key} — Revoke a workspace API key
• PATCH /api/v1/organizations/{organization}/projects/{project}/keys/{key} — Update workspace API key name and model grants
• GET /api/v1/organizations/{organization}/projects/{project}/keys/{key}/capacity — Inspect requests contributing unresolved key capacity
• GET /api/v1/organizations/{organization}/projects/{project}/keys/{key}/concurrency-limit — Read API key concurrency policy
• PUT /api/v1/organizations/{organization}/projects/{project}/keys/{key}/concurrency-limit — Set API key concurrency policy
• GET /api/v1/organizations/{organization}/projects/{project}/keys/{key}/concurrency-limit/history — List API key concurrency policy history
• GET /api/v1/organizations/{organization}/projects/{project}/keys/{key}/guardrail — Read a workspace-scoped key policy assignment
• PUT /api/v1/organizations/{organization}/projects/{project}/keys/{key}/guardrail — Assign a preserved workspace policy revision to an active key
• GET /api/v1/organizations/{organization}/projects/{project}/keys/{key}/guardrail/history — Read immutable key policy assignment history
• GET /api/v1/organizations/{organization}/projects/{project}/keys/{key}/ip-policy — Read API key source policy
• PUT /api/v1/organizations/{organization}/projects/{project}/keys/{key}/ip-policy — Set API key source policy
• GET /api/v1/organizations/{organization}/projects/{project}/keys/{key}/ip-policy/history — List API key source policy history
• GET /api/v1/organizations/{organization}/projects/{project}/keys/{key}/request-rate-limit — Read API key request rate policy
• PUT /api/v1/organizations/{organization}/projects/{project}/keys/{key}/request-rate-limit — Set API key request rate policy
• GET /api/v1/organizations/{organization}/projects/{project}/keys/{key}/request-rate-limit/history — List API key request rate policy history
• POST /api/v1/organizations/{organization}/projects/{project}/keys/{key}/rotate — Atomically replace a key while preserving its grants and expiry
• GET /api/v1/organizations/{organization}/projects/{project}/keys/{key}/spending-limit — List API key spending limits
• PUT /api/v1/organizations/{organization}/projects/{project}/keys/{key}/spending-limit/{currency} — Set API key spending limit
• GET /api/v1/organizations/{organization}/projects/{project}/keys/{key}/spending-limit/{currency}/history — List API key spending history
• GET /api/v1/organizations/{organization}/projects/{project}/keys/{key}/token-rate-limit — Read API key token rate policy
• PUT /api/v1/organizations/{organization}/projects/{project}/keys/{key}/token-rate-limit — Set API key token rate policy
• GET /api/v1/organizations/{organization}/projects/{project}/keys/{key}/token-rate-limit/history — List API key token rate policy history
• GET /api/v1/organizations/{organization}/projects/{project}/keys/{key}/token-usage-window — Read API key token usage window
• GET /api/v1/organizations/{organization}/projects/{project}/keys/{key}/units/limit — Read an API key’s Credits spending limit and commitment
• PUT /api/v1/organizations/{organization}/projects/{project}/keys/{key}/units/limit — Set an API key’s Credits spending limit
• GET /api/v1/organizations/{organization}/projects/{project}/keys/{key}/units/limit/history — List API key Credits spending limit history
• GET /api/v1/organizations/{organization}/projects/{project}/media/asset-operation-models — Discover saved native-operation model contexts
• GET /api/v1/organizations/{organization}/projects/{project}/media/operations — List historical native material operations
• GET /api/v1/organizations/{organization}/projects/{project}/media/operations/{id} — Read historical native material operations
• POST /api/v1/organizations/{organization}/projects/{project}/media/operations/{id}/cancel — Abandon an unclaimed native operation after key expiry
• GET /api/v1/organizations/{organization}/projects/{project}/media/operations/by-idempotency/{id} — Read historical native material operations
• GET /api/v1/organizations/{organization}/projects/{project}/requests — Read automatically retained gateway request activity
• GET /api/v1/organizations/{organization}/projects/{project}/requests/{attempt} — Read a recorded gateway request
• GET /api/v1/organizations/{organization}/projects/{project}/requests/{attempt}/guardrails — Read immutable policy attribution for an allowed dispatch
• DELETE /api/v1/organizations/{organization}/projects/{project}/requests/{attempt}/payloads — Delete retained content without deleting accounting records
• GET /api/v1/organizations/{organization}/projects/{project}/requests/{attempt}/payloads — Read retained request content in an authorized workspace
• GET /api/v1/organizations/{organization}/projects/{project}/requests/{attempt}/usage-reconciliation — Read recorded supplemental request usage
• POST /api/v1/organizations/{organization}/projects/{project}/requests/{attempt}/usage-reconciliation — Supplement missing native request usage from captured OpenRouter evidence
• GET /api/v1/organizations/{organization}/projects/{project}/requests/export — Export filtered customer-safe request metadata as CSV
• GET /api/v1/organizations/{organization}/projects/{project}/spending-limit — List workspace spending currencies
• GET /api/v1/organizations/{organization}/projects/{project}/spending-limit/{currency} — Read a workspace spending limit
• PUT /api/v1/organizations/{organization}/projects/{project}/spending-limit/{currency} — Set a workspace spending limit
• GET /api/v1/organizations/{organization}/projects/{project}/spending-limit/{currency}/history — List workspace spending revisions
• GET /api/v1/organizations/{organization}/projects/{project}/units/limit — Read the workspace Credits spending limit and commitment
• PUT /api/v1/organizations/{organization}/projects/{project}/units/limit — Set the workspace Credits spending limit
• GET /api/v1/organizations/{organization}/projects/{project}/units/limit/history — List workspace Credits spending limit history
• GET /api/v1/organizations/{organization}/projects/{project}/video/draft — Read a mutable personal Video composer
• PUT /api/v1/organizations/{organization}/projects/{project}/video/draft — Save or clear a mutable personal Video composer
• GET /api/v1/organizations/{organization}/projects/{project}/video/intents — List the current actor video intent index
• DELETE /api/v1/organizations/{organization}/projects/{project}/video/intents/{intent} — Erase saved intent content without cancelling its job
• GET /api/v1/organizations/{organization}/projects/{project}/video/intents/{intent} — Restore a saved video intent and its historical job
• PUT /api/v1/organizations/{organization}/projects/{project}/video/intents/{intent} — Save an immutable video submission intent with typed Niu references
• POST /api/v1/organizations/{organization}/projects/{project}/video/intents/{intent}/submit — Explicitly submit or replay an immutable saved video intent
• GET /api/v1/pricing/customers — List named companies for customer-specific promotions
• GET /api/v1/pricing/models — List models eligible for customer tariff publication
• GET /api/v1/pricing/organizations/{organization}/workspaces/{project}/tariffs — Page current customer selling tariffs
• GET /api/v1/pricing/organizations/{organization}/workspaces/{project}/tariffs/{model}/history — Read platform customer selling-price history
• GET /api/v1/pricing/standard-prices — List current platform standard prices
• POST /api/v1/pricing/standard-prices — Publish a platform standard selling-price revision
• GET /api/v1/pricing/standard-prices/{price}/history — Read immutable standard and promotion history
• GET /api/v1/pricing/standard-prices/{price}/preview — Preview a customer applicable price
• GET /api/v1/pricing/standard-prices/{price}/promotions — Read promotion periods with complete retirement coverage
• POST /api/v1/pricing/standard-prices/{price}/promotions — Publish one finite global or customer price
• POST /api/v1/pricing/standard-prices/{price}/promotions/{promotion}/retire — Append a promotion eligibility cutoff
• GET /api/v1/pricing/standard-prices/models — List registered shared models for standard-price preparation
• GET /api/v1/pricing/targets — Discover named platform pricing targets
• POST /api/v1/setup/default-workspace — Get or create the installation default workspace
• GET /api/v1/workspaces — List an authorized page of workspaces
• POST /api/v1/workspaces — Create a workspace with retry-safe identity
• DELETE /api/v1/workspaces/{workspace} — Delete an empty workspace by identity
• PATCH /api/v1/workspaces/{workspace} — Rename a workspace by identity
• GET /api/v1/workspaces/{workspace}/artifacts — List actual saved output references
• GET /api/v1/workspaces/{workspace}/artifacts/{task}/{kind} — Read an output availability record
• GET /api/v1/workspaces/{workspace}/artifacts/{task}/{kind}/capture — Read saved artifact capture status
• POST /api/v1/workspaces/{workspace}/artifacts/{task}/{kind}/capture — Explicitly save a generated output into workspace materials
• GET /api/v1/workspaces/{workspace}/artifacts/{task}/{kind}/content — Download an authorized retained output
• GET /api/v1/workspaces/{workspace}/assets — List saved workspace materials
• POST /api/v1/workspaces/{workspace}/assets — Save a workspace material
• DELETE /api/v1/workspaces/{workspace}/assets/{asset} — Delete a saved workspace material
• GET /api/v1/workspaces/{workspace}/assets/{asset} — Read workspace material metadata
• PATCH /api/v1/workspaces/{workspace}/assets/{asset} — Rename a saved workspace material
• GET /api/v1/workspaces/{workspace}/assets/{asset}/content — Download saved workspace material bytes
• GET /api/v1/workspaces/{workspace}/billing — Read workspace customer charges, tariffs and latest 100 invoices
• GET /api/v1/workspaces/{workspace}/chats — List personal saved Chat history or one continuation page
• DELETE /api/v1/workspaces/{workspace}/chats/{id} — Delete an owned Chat session in a workspace
• GET /api/v1/workspaces/{workspace}/chats/{id} — Read one complete owned saved Chat conversation
• PUT /api/v1/workspaces/{workspace}/chats/{id} — Save an owned Chat session in a workspace
• PUT /api/v1/workspaces/{workspace}/chats/{id}/archive — Archive or restore the authenticated owner’s Chat session
• GET /api/v1/workspaces/{workspace}/chats/{id}/export — Export one owned saved conversation
• GET /api/v1/workspaces/{workspace}/chats/draft — Read the persistent personal Chat draft
• PUT /api/v1/workspaces/{workspace}/chats/draft — Save or clear the personal Chat draft with an expected revision
• GET /api/v1/workspaces/{workspace}/keys — List workspace API keys with aggregated limits and policies
• POST /api/v1/workspaces/{workspace}/keys — Create a workspace API key with optional initial limits and policies
• DELETE /api/v1/workspaces/{workspace}/keys/{key} — Revoke a workspace API key
• GET /api/v1/workspaces/{workspace}/keys/{key} — Retrieve a workspace API key with its policies and usage window
• PATCH /api/v1/workspaces/{workspace}/keys/{key} — Update workspace API key metadata and policies
• GET /api/v1/workspaces/{workspace}/keys/{key}/capacity — Inspect requests contributing unresolved key capacity
• GET /api/v1/workspaces/{workspace}/keys/{key}/concurrency-limit — Read API key concurrency policy
• PUT /api/v1/workspaces/{workspace}/keys/{key}/concurrency-limit — Set API key concurrency policy
• GET /api/v1/workspaces/{workspace}/keys/{key}/concurrency-limit/history — List API key concurrency policy history
• GET /api/v1/workspaces/{workspace}/keys/{key}/ip-policy — Read API key source policy
• PUT /api/v1/workspaces/{workspace}/keys/{key}/ip-policy — Set API key source policy
• GET /api/v1/workspaces/{workspace}/keys/{key}/ip-policy/history — List API key source policy history
• GET /api/v1/workspaces/{workspace}/keys/{key}/request-rate-limit — Read API key request rate policy
• PUT /api/v1/workspaces/{workspace}/keys/{key}/request-rate-limit — Set API key request rate policy
• GET /api/v1/workspaces/{workspace}/keys/{key}/request-rate-limit/history — List API key request rate policy history
• POST /api/v1/workspaces/{workspace}/keys/{key}/rotate — Rotate a workspace API key while preserving its policies and expiry
• GET /api/v1/workspaces/{workspace}/keys/{key}/spending-limit — List API key spending limits
• PUT /api/v1/workspaces/{workspace}/keys/{key}/spending-limit/{currency} — Set API key spending limit
• GET /api/v1/workspaces/{workspace}/keys/{key}/spending-limit/{currency}/history — List API key spending history
• GET /api/v1/workspaces/{workspace}/keys/{key}/token-rate-limit — Read API key token rate policy
• PUT /api/v1/workspaces/{workspace}/keys/{key}/token-rate-limit — Set API key token rate policy
• GET /api/v1/workspaces/{workspace}/keys/{key}/token-rate-limit/history — List API key token rate policy history
• GET /api/v1/workspaces/{workspace}/keys/{key}/token-usage-window — Read API key token usage window
• GET /api/v1/workspaces/{workspace}/keys/{key}/units/limit — Read an API key’s Credits spending limit and commitment
• PUT /api/v1/workspaces/{workspace}/keys/{key}/units/limit — Set an API key’s Credits spending limit
• GET /api/v1/workspaces/{workspace}/keys/{key}/units/limit/history — List API key Credits spending limit history
• GET /api/v1/workspaces/{workspace}/keys/requests/{request} — Reconcile an API key creation or rotation request
• GET /api/v1/workspaces/{workspace}/requests — Read automatically retained gateway request activity
• GET /api/v1/workspaces/{workspace}/requests/{attempt} — Read a recorded gateway request
• GET /api/v1/workspaces/{workspace}/requests/{attempt}/usage-reconciliation — Read recorded supplemental request usage
• POST /api/v1/workspaces/{workspace}/requests/{attempt}/usage-reconciliation — Supplement missing native request usage from captured OpenRouter evidence
• GET /api/v1/workspaces/{workspace}/sessions — List private generations sessions
• GET /api/v1/workspaces/{workspace}/sessions/{session} — Read a private saved generations timeline
• PATCH /api/v1/workspaces/{workspace}/sessions/{session} — Rename or archive a private video session
• PUT /api/v1/workspaces/{workspace}/sessions/{session} — Create a private video generations session
• DELETE /api/v1/workspaces/{workspace}/sessions/{session}/turns/{turn} — Delete retained instruction content
• PUT /api/v1/workspaces/{workspace}/sessions/{session}/turns/{turn} — Append one retained video instruction
• PUT /api/v1/workspaces/{workspace}/sessions/{session}/turns/{turn}/intent — Bind a saved Video intent to a private turn
• PUT /api/v1/workspaces/{workspace}/sessions/{session}/turns/{turn}/task — Attach an existing authorized video task
• GET /api/v1/workspaces/{workspace}/spending-limit — List workspace spending currencies
• GET /api/v1/workspaces/{workspace}/spending-limit/{currency} — Read a workspace spending limit
• PUT /api/v1/workspaces/{workspace}/spending-limit/{currency} — Set a workspace spending limit
• GET /api/v1/workspaces/{workspace}/spending-limit/{currency}/history — List workspace spending revisions
• GET /api/v1/workspaces/{workspace}/tasks — List saved Video tasks across workspace keys
• GET /api/v1/workspaces/{workspace}/tasks/{task} — Read a saved Video task
• GET /api/v1/workspaces/{workspace}/tasks/{task}/diagnostics — Read saved customer billing and transport diagnostics
• POST /api/v1/workspaces/{workspace}/tasks/{task}/refresh — Explicitly refresh the original Video task
• POST /api/v1/workspaces/{workspace}/tasks/{task}/results/{kind}/refresh — Retrieve fresh output from the original Video task
• GET /api/v1/workspaces/{workspace}/units/limit — Read the workspace Credits spending limit and commitment
• PUT /api/v1/workspaces/{workspace}/units/limit — Set the workspace Credits spending limit
• GET /api/v1/workspaces/{workspace}/units/limit/history — List workspace Credits spending limit history
• GET /api/v1/workspaces/{workspace}/video/draft — Read a mutable personal Video composer
• PUT /api/v1/workspaces/{workspace}/video/draft — Save or clear a mutable personal Video composer
• GET /api/v1/workspaces/{workspace}/video/intents — List the current actor video intent index
• DELETE /api/v1/workspaces/{workspace}/video/intents/{intent} — Erase saved intent content without cancelling its job
• GET /api/v1/workspaces/{workspace}/video/intents/{intent} — Restore a saved video intent and its historical job
• PUT /api/v1/workspaces/{workspace}/video/intents/{intent} — Save an immutable video submission intent with typed Niu references
• POST /api/v1/workspaces/{workspace}/video/intents/{intent}/submit — Explicitly submit or replay an immutable saved video intent
• GET /api/v1/workspaces/by-route/{route_slug} — Resolve an authorized canonical workspace route

Service endpoints

• GET /api/v1/payments/readiness — Read payment or scoped funding readiness
• GET /api/v1/platform/audit-events — List platform operation audit logs
• GET /api/v1/platform/branding — Read platform branding and theme configuration
• PUT /api/v1/platform/branding — Save platform branding and theme configuration
• GET /api/v1/platform/configuration — Read platform payment configuration presence
• PUT /api/v1/platform/currency — Configure the installation currency once
• GET /api/v1/platform/customer-accounts — Discover named customer accounts for platform financial administration
• GET /api/v1/platform/financial-recovery — Read committed financial recovery progress
• GET /api/v1/platform/payments/epay — Read EPay configuration with platform administrator read access
• PUT /api/v1/platform/payments/epay — Save encrypted EPay configuration with platform administrator write access
• GET /api/v1/platform/payments/integrations — List supported payment integrations
• GET /api/v1/platform/payments/stripe/verification — Read Stripe verification evidence
• POST /api/v1/platform/payments/stripe/verification — Check the configured Stripe account
• GET /api/v1/platform/units — Read branded-unit configuration
• POST /api/v1/platform/units/definitions — Publish an immutable consumption-unit definition
• GET /api/v1/platform/units/media/tariffs — List latest explicit Credits media tariffs
• POST /api/v1/platform/units/media/tariffs — Publish a versioned Credits media consumption tariff
• GET /api/v1/platform/units/mode — Preview installation billing-mode incompatibilities
• PUT /api/v1/platform/units/mode — Publish a preview-confirmed installation billing mode
• POST /api/v1/platform/units/mode/previews — Save a billing-mode change preview
• GET /api/v1/platform/units/mode/previews/{preview} — Read an original saved billing-mode preview
• POST /api/v1/platform/units/rules — Publish an immutable Credits purchase rule
• GET /api/v1/platform/units/tariffs — Read the latest explicit Credits text tariff for a model
• POST /api/v1/platform/units/tariffs — Publish a versioned Credits text consumption tariff
• GET /catalog/v1/models — List model aliases explicitly published by the gateway operator
• GET /enterprise/readyz — Check Enterprise module readiness
• GET /healthz — Check process health
• GET /payments/epay/notify — Receive a signed classic EPay query notification
• POST /payments/epay/notify — Receive a signed classic EPay form notification
• POST /payments/stripe/notify — Receive a signed Stripe checkout notification
• POST /payments/zhifux/notify — Receive signed merchant notification
• GET /readyz — Check gateway readiness