Field manual
API reference
Every endpoint, 569 in all, read from the OpenAPI document the code generates. Open one for its fields, an example and the errors it answers, and try it with your key.
No endpoint matches the search.
API
The keyed inference surface.
- GET/v1/filesList the account's files API key
- POST/v1/filesUpload a batch input file (OpenAI wire format) API key
- GET/v1/files/{id}Retrieve a file API key
- DELETE/v1/files/{id}Delete a file API key
- GET/v1/files/{id}/contentDownload a file's contents API key
- GET/v1/batchesList the account's batches API key
- POST/v1/batchesCreate a batch (OpenAI wire format) API key
- GET/v1/batches/{id}Retrieve a batch API key
- POST/v1/batches/{id}/cancelCancel a batch API key
- GET/v1/streams/{id}Resume a stream API key
- POST/v1/images/generationsGenerate images (OpenAI wire format) API key
- POST/v1/audio/speechCreate speech (OpenAI wire format) API key
- POST/v1/audio/transcriptionsTranscribe audio (OpenAI wire format) API key
- GET/v1/models/{id}Retrieve one model No key
- GET/v1/embeddings/modelsList the embedding models No key
- POST/v1/messages/count_tokensCount a message's input tokens (Anthropic wire format), an estimate API key
- GET/v1/creditsThe balance this key spends API key
- GET/v1/requests/{id}One request, by its id API key
- GET/mcpNot served: the server is stateless and opens no event stream API key
- POST/mcpThe hosted MCP server (Streamable HTTP) API key
- DELETE/mcpNot served: there is no session to end API key
- POST/v1/ensembleAsk several models at once and combine the answers API key
- GET/v1/realtimeRealtime voice (WebSocket) API key
- GET/v1/videosList this account's video jobs API key
- POST/v1/videosMake a video as a job API key
- GET/v1/videos/{id}One video job API key
- DELETE/v1/videos/{id}Delete a finished video job's record API key
- GET/v1/videos/{id}/contentThe video file API key
- POST/v1/videos/{id}/cancelStop a video job API key
- GET/v1/soundsList this account's music or sound jobs API key
- POST/v1/soundsMake a music or sound as a job API key
- GET/v1/sounds/{id}One music or sound job API key
- DELETE/v1/sounds/{id}Delete a finished music or sound job's record API key
- GET/v1/sounds/{id}/contentThe music or sound file API key
- POST/v1/sounds/{id}/cancelStop a music or sound job API key
- GET/v1/meshesList this account's 3D model jobs API key
- POST/v1/meshesMake a 3D model as a job API key
- GET/v1/meshes/{id}One 3D model job API key
- DELETE/v1/meshes/{id}Delete a finished 3D model job's record API key
- GET/v1/meshes/{id}/contentThe 3D model file API key
- POST/v1/meshes/{id}/cancelStop a 3D model job API key
- GET/v1/stillsList this account's still picture jobs API key
- POST/v1/stillsMake a still picture as a job API key
- GET/v1/stills/{id}One still picture job API key
- DELETE/v1/stills/{id}Delete a finished still picture job's record API key
- GET/v1/stills/{id}/contentThe still picture file API key
- POST/v1/stills/{id}/cancelStop a still picture job API key
- POST/v1/studio/quoteThe billed price of exactly this shot API key
- GET/v1/studio/jobsThe account's own studio jobs among these ids API key
- POST/v1/studio/jobsMake one shot, billed to the key API key
- GET/v1/studio/projectsThe account's Nova Studio projects API key
- POST/v1/studio/projectsKeep a project API key
- GET/v1/studio/projects/{id}One project with its document API key
- PUT/v1/studio/projects/{id}Replace a project's document API key
- DELETE/v1/studio/projects/{id}Delete a project API key
- POST/v1/studio/projects/{id}/duplicateCopy a project API key
- GET/v1/studio/projects/{id}/mediaThe document's assets mapped onto stored media API key
- GET/v1/studio/projects/{id}/eventsA project's progress API key
- POST/v1/studio/projects/{id}/plans/quoteWhat a render plan would be held at API key
- GET/v1/studio/projects/{id}/plansA project's plans API key
- POST/v1/studio/projects/{id}/plansStart a render plan API key
- GET/v1/studio/plans/{id}One render plan with its shots API key
- POST/v1/studio/plans/{id}/cancelStop a render plan API key
- GET/v1/studio/assetsStored files API key
- POST/v1/studio/assetsStore a file API key
- GET/v1/studio/assets/{id}A stored file's record API key
- DELETE/v1/studio/assets/{id}Delete a stored file API key
- GET/v1/studio/assets/{id}/contentA stored file's bytes API key
- GET/v1/studio/storageWhat the account keeps stored API key
- GET/v1/studio/charactersThe account's characters API key
- POST/v1/studio/charactersKeep a character API key
- GET/v1/studio/characters/{id}One character API key
- PATCH/v1/studio/characters/{id}Rename a character or change its pictures API key
- DELETE/v1/studio/characters/{id}Delete a character API key
- GET/v1/evalsList test suites API key
- POST/v1/evalsCreate a test suite API key
- GET/v1/evals/{id}One test suite, its route and its evidence API key
- PUT/v1/evals/{id}Replace a test suite API key
- DELETE/v1/evals/{id}Delete a test suite API key
- GET/v1/evals/{id}/runsA suite's runs API key
- POST/v1/evals/{id}/runsRun a suite against models API key
- GET/v1/evals/{id}/runs/{runId}One run: pass rates, cost, latency, the frontier and the failures API key
- POST/v1/evals/{id}/runs/{runId}/cancelCancel a run API key
- GET/v1/requests/{id}/proofThe Merkle proof of one request API key
- GET/v1/shadowThis key's shadow tests API key
- POST/v1/shadowShadow test a model on this key's own captured traffic API key
- GET/v1/shadow/{id}One shadow test API key
- GET/v1/shadow/{id}/reportA shadow test's report API key
- POST/v1/shadow/{id}/switchRoute the test's model to a candidate on this key API key
- POST/v1/shadow/{id}/revertUndo the test's switch API key
- POST/v1/shadow/{id}/autoOpt the test in to auto savings, or out API key
- POST/v1/shadow/{id}/stopStop a shadow test API key
- GET/v1/responses/{id}A stored response API key
- DELETE/v1/responses/{id}Delete a stored response API key
- GET/v1/memoriesA space's memories, newest first API key
- POST/v1/memoriesRemember texts, or the facts in a conversation API key
- POST/v1/memories/searchSearch a memory space by meaning API key
- GET/v1/memories/{id}One memory API key
- PATCH/v1/memories/{id}Change a memory's words or metadata API key
- DELETE/v1/memories/{id}Forget a memory API key
- GET/v1/memories/{id}/historyA memory's history API key
- GET/v1/memory_spacesThis key's memory spaces API key
- POST/v1/memory_spacesMake a memory space API key
- GET/v1/memory_spaces/{id}One memory space API key
- POST/v1/memory_spaces/{id}Modify a memory space API key
- PATCH/v1/memory_spaces/{id}Modify a memory space API key
- DELETE/v1/memory_spaces/{id}Delete a memory space API key
- GET/v1/memory_extractions/{id}A queued extraction API key
- POST/v1/pay/fetchFetch a URL, paying its x402 terms API key
- GET/v1/pay/paymentsThis key's account's payments API key
- POST/v1/distill/estimateWhat distilling this key's captured traffic would make and cost API key
- GET/v1/distillThis key's distillations API key
- POST/v1/distillDistill this key's captured traffic into a small fine tuned model API key
- GET/v1/distill/{id}One distillation API key
- DELETE/v1/distill/{id}Delete a finished distillation API key
- POST/v1/distill/{id}/cancelCancel a distillation API key
- POST/v1/distill/{id}/lightLight the distilled world API key
- POST/v1/distill/{id}/darkenPut the distilled world out API key
- GET/v1/toolsEvery tool on the tools market API key
- POST/v1/tools/{server}/{tool}/callCall one market tool, paid per call API key
- POST/mcp/toolsEvery market tool behind one MCP endpoint API key
- GET/v1/agents/{id}/identityAn agent's passport API key
- GET/v1/vector_storesList vector stores API key
- POST/v1/vector_storesCreate a vector store (OpenAI wire format) API key
- GET/v1/vector_stores/{id}Retrieve a vector store API key
- POST/v1/vector_stores/{id}Modify a vector store API key
- DELETE/v1/vector_stores/{id}Delete a vector store, with every chunk API key
- GET/v1/vector_stores/{id}/filesList a vector store's files API key
- POST/v1/vector_stores/{id}/filesAttach a file to a vector store API key
- GET/v1/vector_stores/{id}/files/{fileId}Retrieve a vector store file API key
- POST/v1/vector_stores/{id}/files/{fileId}Update a vector store file's attributes API key
- DELETE/v1/vector_stores/{id}/files/{fileId}Remove a file from a vector store, with its chunks API key
- GET/v1/vector_stores/{id}/files/{fileId}/contentA vector store file's chunks, in order API key
- POST/v1/vector_stores/{id}/searchSearch a vector store API key
- POST/v1/vector_stores/{id}/file_batchesAttach several files at once API key
- GET/v1/vector_stores/{id}/file_batches/{batchId}Retrieve a file batch API key
- POST/v1/vector_stores/{id}/file_batches/{batchId}/cancelCancel a file batch API key
- GET/v1/vector_stores/{id}/file_batches/{batchId}/filesList a file batch's files API key
- POST/v1/requests/{id}/disputeReport a request API key
- POST/v1/embeddingsCreate embeddings (OpenAI wire format) API keyNo key
- GET/v1/modelsList the live model catalog No key
- POST/v1/chat/completionsCreate a chat completion (OpenAI wire format) API keyNo key
- POST/v1/messagesCreate a message (Anthropic wire format) API keyNo key
- POST/v1/responsesCreate a response (OpenAI Responses wire format) API keyNo key
Public
No key required.
- GET/api/planet/historyPrice and latency history for one model No key
- GET/api/og/shareOpen Graph card for a shared conversation No key
- GET/api/badge/priceEmbeddable SVG badge with one model's live price No key
- GET/api/images/sampleOne image model's sample picture No key
- GET/api/brand/files/{name}One file of the brand kit No key
- GET/llms.txtThe API summarised for AI agents No key
- GET/api/media/sampleOne video, sound or 3D model's sample No key
- GET/api/studio/modelsWhat Nova Studio can make, at billed prices No key
- GET/api/studio/samplesOne of Nova Studio's own sample takes No key
- GET/api/studio/signed/{parts}A stored file, for a provider No key
- GET/api/studio/feedThe public feed of shared takes No key
- POST/api/studio/feed/{id}/viewCount a watch of a listed take No key
- POST/api/studio/feed/{id}/reportReport a take in the public feed No key
- GET/api/og/studio-shareOpen Graph card for a shared take No key
- GET/api/studio/like/{id}The words and settings a shared take was made with No key
- POST/api/studio/pricing/quotePrice a film, shot by shot No key
- GET/api/studio/recipesRecipes creators published and Antimatter listed API key
- GET/api/studio/recipes/{id}One published recipe API key
- GET/api/studio/galleryOne prompt on every video model API key
- GET/api/studio/gallery/clipOne gallery take's bytes API key
- GET/api/receipts/commitmentsThe sealed days, newest first No key
- GET/api/receipts/commitments/{day}One sealed day No key
- GET/api/agents/idListed passports No key
- GET/api/agents/id/{slug}One public passport No key
- GET/api/agents/id/{slug}/days/{day}A sealed day of a passport's evidence No key
- GET/api/agents/id/attesterThe passport attester No key
- GET/agents/id/{slug}/agent.jsonAn agent's registration file No key
- GET/api/og/agentOpen Graph card for one agent passport No key
- GET/.well-known/agent-registration.jsonThis domain's registrations No key
- POST/api/compareAnonymous single model completion No key
- GET/api/tokenThe token's numbers No key
- GET/api/x402x402 pay per request: whether it is on, and on what terms No key
- GET/api/healthDeployment health No key
- GET/api/relay/statusThe shape this instance is running in No key
- GET/api/openapiThis document No key
- GET/api/tokensEstimate a token count No key
- POST/api/tokensEstimate a token count No key
- GET/api/rankingsModel rankings from measured traffic No key
- GET/api/observatoryMeasured latency and error rate per model No key
- GET/api/badge/modelEmbeddable SVG badge for one model No key
- GET/api/og/planetOpen Graph card for one model No key
- GET/api/og/platformOpen Graph card for the platform page No key
- GET/api/og/studioOpen Graph card for Nova Studio No key
- GET/api/bridgeThe bridge deck in one read No key
Identity
Wallet sign in.
- GET/api/auth/nonceIssue a single use sign in nonce No key
- POST/api/auth/verifyVerify a wallet signature and start a session No key
- POST/api/auth/logoutEnd the session No key
- GET/api/meWho am I No key
- GET/.well-known/security.txtWhere to report a security problem (RFC 9116) No key
- POST/api/auth/step-up/challengeAsk for a confirmation to sign before a risky act Signed in session
- POST/api/auth/step-upSend the signed confirmation Signed in session
Keys
Minting, revoking, and per key policy.
- POST/api/keys/{id}/policy/testWould this request be allowed? Signed in session
- GET/api/keysList API keys Signed in session
- POST/api/keysMint an API key Signed in session
- PATCH/api/keys/{id}Change a key's name, scopes, expiry or address allowlist Signed in session
- DELETE/api/keys/{id}Revoke an API key Signed in session
- GET/api/keys/{id}/policyRead a key's policy Signed in session
- PATCH/api/keys/{id}/policySet a key's policy Signed in session
- POST/api/keys/{id}/rotateRotate a key with a grace period Signed in session
- GET/api/keys/{id}/seriesFourteen day request sparkline for one key Signed in session
Usage
Metering readouts.
Account
Account wide settings and export.
- GET/api/sharesYour shared chat links Signed in session
- POST/api/sharesShare a saved conversation as a read only page Signed in session
- DELETE/api/shares/{id}Revoke a shared chat link Signed in session
- GET/api/account/pushNotifications for the installed app Signed in session
- POST/api/account/pushKeep this browser's push subscription Signed in session
- DELETE/api/account/pushForget one device Signed in session
- POST/api/account/push/testSend a test notification to this account's devices Signed in session
- GET/api/account/savingsWhat the same usage would cost on cheaper comparable models Signed in session
- GET/api/account/my-usageThe account's own usage per model, for pricing it on every model Signed in session
- GET/api/account/spend-forecastThe month's spend forecast for the account and each key Signed in session
- GET/api/account/spend-analysisMetered spend over a window, by model, key, project or day Signed in session
- POST/api/studio/quoteThe billed price of exactly this job Signed in session
- POST/api/studio/free-shotMake the first shot on us Signed in session
- GET/api/studio/jobsThe account's own jobs among these ids Signed in session
- POST/api/studio/jobsMake a video or sound job on the signed in account Signed in session
- GET/api/studio/jobs/openEvery take the account has on its way, across every film Signed in session
- GET/api/studio/jobs/{id}One of the account's studio jobs Signed in session
- GET/api/studio/jobs/{id}/contentA finished job's file Signed in session
- POST/api/studio/jobs/{id}/cancelStop a studio job Signed in session
- POST/api/studio/storyboardAn idea written as a shot list Signed in session
- GET/api/studio/projectsThe account's Nova Studio projects Signed in session
- POST/api/studio/projectsKeep a project Signed in session
- GET/api/studio/projects/{id}One project with its document Signed in session
- PUT/api/studio/projects/{id}Replace a project's document Signed in session
- DELETE/api/studio/projects/{id}Delete a project Signed in session
- POST/api/studio/projects/{id}/duplicateCopy a project Signed in session
- GET/api/studio/projects/{id}/mediaThe document's assets mapped onto stored media Signed in session
- GET/api/studio/projects/{id}/eventsA project's progress Signed in session
- POST/api/studio/projects/{id}/plans/quoteWhat a render plan would be held at Signed in session
- GET/api/studio/projects/{id}/plansA project's plans Signed in session
- POST/api/studio/projects/{id}/plansStart a render plan Signed in session
- GET/api/studio/plans/{id}One render plan with its shots Signed in session
- POST/api/studio/plans/{id}/cancelStop a render plan Signed in session
- GET/api/studio/assetsStored files Signed in session
- POST/api/studio/assetsStore a file Signed in session
- GET/api/studio/assets/{id}A stored file's record Signed in session
- DELETE/api/studio/assets/{id}Delete a stored file Signed in session
- GET/api/studio/assets/{id}/contentA stored file's bytes Signed in session
- GET/api/studio/storageWhat the account keeps stored Signed in session
- GET/api/studio/sharesThe account's public links to its takes Signed in session
- POST/api/studio/sharesMake a public link to a take Signed in session
- GET/api/studio/noticesHow the person is told a take landed Signed in session
- POST/api/studio/noticesA studio tab heard these jobs end Signed in session
- PUT/api/studio/noticesTurn Web Push or Telegram landing notices on or off Signed in session
- GET/api/studio/planWhat the account's paid plan grants in the studio this period Signed in session
- PATCH/api/studio/shares/{id}Name a link, or list it in the public feed Signed in session
- DELETE/api/studio/shares/{id}Stop sharing a take Signed in session
- GET/api/studio/shares/{id}/posterA shared take's poster frame, for anyone with the link No key
- PUT/api/studio/shares/{id}/posterKeep a poster frame for a link Signed in session
- GET/api/studio/charactersThe account's characters Signed in session
- POST/api/studio/charactersKeep a character Signed in session
- GET/api/studio/characters/{id}One character Signed in session
- PATCH/api/studio/characters/{id}Rename a character or change its pictures Signed in session
- DELETE/api/studio/characters/{id}Delete a character Signed in session
- POST/api/studio/characters/{id}/sheet/quotePrice a character's sheet Signed in session
- POST/api/studio/characters/{id}/sheetMake a character's sheet Signed in session
- GET/api/studio/shares/{id}/contentA shared take's bytes, for anyone with the link No key
- GET/api/studio/projects/{id}/versionsA film's earlier versions Signed in session
- GET/api/studio/projects/{id}/versions/{vid}One earlier version with its document Signed in session
- POST/api/studio/projects/{id}/versions/{vid}/restoreRestore an earlier version Signed in session
- GET/api/studio/projects/{id}/commentsA film's comments Signed in session
- POST/api/studio/projects/{id}/commentsComment on a film Signed in session
- PATCH/api/studio/projects/{id}/comments/{cid}Resolve a comment, or open it again Signed in session
- DELETE/api/studio/projects/{id}/comments/{cid}Delete a comment Signed in session
- GET/api/studio/projects/{id}/teamWho a film is with Signed in session
- POST/api/studio/projects/{id}/teamGive a film to a team, or take it back Signed in session
- POST/api/studio/uploadsStart a file sent in parts Signed in session
- DELETE/api/studio/uploads/{id}Abandon a file sent in parts Signed in session
- PUT/api/studio/uploads/{id}/parts/{n}Send one part Signed in session
- POST/api/studio/uploads/{id}/completeJoin the parts into one stored file Signed in session
- GET/api/studio/storage/filmsWhat each film keeps in stored media, and what a day of it costs Signed in session
- POST/api/studio/storage/cleanDelete stored files no film uses Signed in session
- GET/studio/embed/{id}A shared take's player, for any site to frame No key
- GET/api/studio/oembedoEmbed for a shared take No key
- POST/api/studio/projects/{id}/presenceSay where you are in a team's film, and hear who else is Signed in session
- POST/api/studio/like/{id}Count a remix of a shared take Signed in session
- GET/api/studio/creatorThe person's own page in the studio Signed in session
- PUT/api/studio/creatorSave the person's page Signed in session
- DELETE/api/studio/creatorTake the person's page away Signed in session
- GET/api/studio/publishThe platforms a share can be posted to Signed in session
- POST/api/studio/publishPost a share to the person's own account Signed in session
- GET/api/studio/publish/{platform}TikTok's choices for the linked account Signed in session
- DELETE/api/studio/publish/{platform}Disconnect a platform Signed in session
- GET/api/studio/publish/{platform}/startGo to a platform's sign in to link it Signed in session
- GET/api/studio/publish/{platform}/callbackWhere a platform's sign in returns Signed in session
- GET/api/studio/publish/jobs/{id}One publish Signed in session
- POST/api/studio/directAn idea written as a director's shot plan Signed in session
- POST/api/studio/direct/quoteThe most a director's plan could cost Signed in session
- POST/api/studio/direct/scriptA pasted script broken into scenes and shots Signed in session
- POST/api/studio/direct/script/quoteThe most breaking a script into shots could cost Signed in session
- POST/api/studio/direct/refineA shot's words rewritten for the model it is made with Signed in session
- POST/api/studio/direct/refine/quoteThe most rewriting a shot's words could cost Signed in session
- GET/api/studio/presetsThe account's own presets Signed in session
- POST/api/studio/presetsKeep a preset Signed in session
- PATCH/api/studio/presets/{id}Rename a preset or replace its recipe Signed in session
- DELETE/api/studio/presets/{id}Delete a preset Signed in session
- POST/api/studio/dub/translateA dub's heard words written in another language Signed in session
- POST/api/studio/dub/translate/quoteThe most writing a dub's words could cost Signed in session
- POST/api/studio/film/quoteThe most a film from one idea could cost Signed in session
- POST/api/studio/filmOne idea to a finished film Signed in session
- GET/api/studio/ratingsThe account's thumbs on its own takes Signed in session
- PUT/api/studio/ratingsA thumb on one of the account's finished takes Signed in session
- GET/api/studio/models/evidenceWhat the studio has measured of each model it offers Signed in session
- GET/api/studio/brand-kitThe account's brand kit Signed in session
- PUT/api/studio/brand-kitKeep the brand kit Signed in session
- DELETE/api/studio/brand-kitForget the brand kit and its logo Signed in session
- GET/api/studio/brand-kit/logoThe brand kit's logo Signed in session
- PUT/api/studio/brand-kit/logoKeep a logo Signed in session
- DELETE/api/studio/brand-kit/logoTake the logo off the brand kit Signed in session
- POST/api/studio/recipesPublish a recipe from your own film Signed in session
- GET/api/studio/recipes/mineThe account's own published recipes, with their state Signed in session
- DELETE/api/studio/recipes/{id}Remove one of your own recipes Signed in session
- GET/api/account/walletsThe wallets that sign in to this account Signed in session
- POST/api/account/walletsLink a wallet Signed in session
- DELETE/api/account/walletsRemove a linked wallet Signed in session
- POST/api/account/wallets/challengeThe message a wallet signs to link or unlink Signed in session
- GET/api/account/emailThe account's email address Signed in session
- PUT/api/account/emailSet the address and send it a one time link Signed in session
- DELETE/api/account/emailForget the address Signed in session
- POST/api/account/email/verifyConfirm an address with the token from its link No key
- POST/api/account/team-joinTeams to join by a proven email address, or ask to join one Signed in session
- DELETE/api/account/team-joinWithdraw a request to join Signed in session
- GET/api/suitesList test suites Signed in session
- POST/api/suitesCreate a test suite Signed in session
- GET/api/suites/{id}One test suite, its route and its evidence Signed in session
- PUT/api/suites/{id}Replace a test suite Signed in session
- DELETE/api/suites/{id}Delete a test suite Signed in session
- GET/api/suites/{id}/runsA suite's runs Signed in session
- POST/api/suites/{id}/runsRun a suite against models Signed in session
- GET/api/suites/{id}/runs/{runId}One run: pass rates, cost, latency, the frontier and the failures Signed in session
- POST/api/suites/{id}/runs/{runId}/cancelCancel a run Signed in session
- GET/api/account/receipts/{number}/proofThe Merkle proof of one of your receipts, as a file Signed in session
- GET/api/account/shadowThe signed in account's shadow tests Signed in session
- POST/api/account/shadowCreate a shadow test from the dashboard Signed in session
- GET/api/account/shadow/{id}One of the account's shadow tests Signed in session
- GET/api/account/shadow/{id}/{action}A shadow test's report, from the dashboard Signed in session
- POST/api/account/shadow/{id}/{action}Switch, revert, stop or opt in to auto savings, from the dashboard Signed in session
- GET/api/account/otlpThe account's own OpenTelemetry collector Signed in session
- PUT/api/account/otlpSet the collector Signed in session
- DELETE/api/account/otlpRemove the collector Signed in session
- POST/api/account/otlp/testSend one test span to the collector Signed in session
- GET/api/account/memoryThe signed in account's memory spaces Signed in session
- GET/api/account/memory/{id}One space as /memory draws it Signed in session
- DELETE/api/account/memory/{id}Forget one memory (?memory=) or delete the space Signed in session
- POST/api/account/memory/{id}/searchSearch a space from /memory Signed in session
- GET/api/account/agent-payThe signed in account's spending rules, agents and payments Signed in session
- PUT/api/account/agent-payWrite one spending rule Signed in session
- GET/api/account/distillThe signed in account's distillations, and the composer's choices Signed in session
- POST/api/account/distillStart a distillation from /distill Signed in session
- POST/api/account/distill/estimateEstimate a distillation from /distill Signed in session
- GET/api/account/distill/teachersThe models one key's captures name in a window Signed in session
- GET/api/account/distill/{id}One of the account's distillations Signed in session
- DELETE/api/account/distill/{id}Delete a finished distillation, from /distill Signed in session
- POST/api/account/distill/{id}/{action}Cancel, light, darken or keep lit, from /distill Signed in session
- GET/api/tools/serversThe account's tools market listings Signed in session
- POST/api/tools/serversList an MCP server on the tools market Signed in session
- PATCH/api/tools/servers/{id}Change a listing Signed in session
- DELETE/api/tools/servers/{id}Withdraw a listing Signed in session
- POST/api/tools/inspectRead an MCP server's tools before pricing them Signed in session
- GET/api/tools/disputesThe account's reports about tool calls Signed in session
- POST/api/tools/disputesReport one of the account's own tool calls Signed in session
- GET/api/account/agents/{id}/identityAn agent's passport, for the dashboard Signed in session
- PUT/api/account/agents/{id}/identityOpen a passport or change its words Signed in session
- DELETE/api/account/agents/{id}/identityDelete the passport here Signed in session
- POST/api/account/agents/{id}/identity/{action}Register, confirm, transfer or refresh Signed in session
- GET/api/account/vector-storesThe signed in account's vector stores, for the dashboard Signed in session
- DELETE/api/account/vector-storesDelete one of the account's vector stores Signed in session
- GET/api/marketplace/providerYour provider record in the inference marketplace Signed in session
- POST/api/marketplace/providerApply to serve inference Signed in session
- PATCH/api/marketplace/providerChange your provider record Signed in session
- DELETE/api/marketplace/providerWithdraw as a provider Signed in session
- GET/api/marketplace/disputesYour reports about requests Signed in session
- POST/api/marketplace/disputesReport a request Signed in session
- GET/api/achievementsShip log achievements Signed in session
- GET/api/account/settingsRead the account monthly spend cap Signed in session
- PATCH/api/account/settingsSet the account monthly spend cap Signed in session
- GET/api/account/holderWhat the signed in wallet holds, and its holder tier Signed in session
- GET/api/account/anti-balanceThe signed in wallet's $ANTI, read live Signed in session
- GET/api/account/referralThis account's referral code, link and results Signed in session
- GET/api/account/telegramThe Telegram bot, and this account's link to it Signed in session
- POST/api/account/telegramMint a one time Telegram link code Signed in session
- DELETE/api/account/telegramUnlink Telegram and forget the conversation Signed in session
- DELETE/api/accountDelete this account and everything it holds Signed in session
- GET/api/account/exportExport everything this account holds Signed in session
- GET/api/account/auditThe audit trail Signed in session
- GET/api/account/alertsSpend alerts and where they stand Signed in session
- PUT/api/account/alertsReplace the set of spend alerts Signed in session
- GET/api/account/sessionsThe account's signed in devices Signed in session
- POST/api/account/sessions/othersSign out every other device Signed in session
- DELETE/api/account/sessions/{id}Sign out one device Signed in session
Credits
The ledger and on chain stablecoin deposits.
- GET/api/account/planPaid plans on offer, and this account's plan Signed in session
- POST/api/account/planSubscribe, switch, resume or cancel Signed in session
- GET/api/account/low-balanceThis account's low balance line Signed in session
- PUT/api/account/low-balanceSet or clear the low balance line Signed in session
- GET/api/deposit/intentWhat a first deposit buys today API key
- GET/api/account/price-locksThe price lock offer, and this account's locks Signed in session
- POST/api/account/price-locksBuy a price lock Signed in session
- GET/api/account/billing-detailsThe details invoices are made out to Signed in session
- PUT/api/account/billing-detailsSet the details invoices are made out to Signed in session
- DELETE/api/account/billing-detailsRemove the details Signed in session
- GET/api/creditsBalance and ledger Signed in session
- POST/api/credits/depositClaim a deposit by transaction hash Signed in session
- GET/api/credits/statementMonthly statement Signed in session
- GET/api/credits/receiptsReceipts for credited deposits Signed in session
Routing
Model routing, presets, and aliases.
- GET/api/presetsList presets Signed in session
- POST/api/presetsCreate or replace a preset Signed in session
- GET/api/presets/{name}Read one preset Signed in session
- DELETE/api/presets/{name}Delete a preset Signed in session
- GET/api/aliasesList model aliases Signed in session
- POST/api/aliasesPoint a short name at a model Signed in session
- DELETE/api/aliasesRemove an alias Signed in session
- GET/api/router/explainRecent routing decisions Signed in session
- POST/api/router/explainWhy the router would choose this world API key
- GET/api/router/healthUpstream health and circuit breaker state No key
- GET/api/router/cacheCache settings and savings Signed in session
- PUT/api/router/cacheTurn the semantic cache on for one key Signed in session
BYOK
Your own provider credentials.
Webhooks
Outbound event delivery.
- GET/api/account/model-watchThe models this account watches for outages Signed in session
- PUT/api/account/model-watchReplace the watch list Signed in session
- GET/api/webhooks/deliveriesThe account's webhook delivery log Signed in session
- POST/api/webhooks/deliveries/{id}/retrySend one delivery again Signed in session
- POST/api/webhooks/deliveries/retry-failedSend every failed delivery again Signed in session
- GET/api/webhooksList webhooks and the available events Signed in session
- POST/api/webhooksRegister a webhook Signed in session
- DELETE/api/webhooks/{id}Remove a webhook Signed in session
Playground
Conversation and prompt storage.
- GET/api/conversations/claimThe threads this browser wrote signed out Signed in session
- POST/api/conversations/claimMove them into the account Signed in session
- GET/api/chat/capabilitiesWhat chat offers here, and at what price No key
- POST/api/chat/turnA chat turn billed to the signed in account Signed in session
- POST/api/chat/imagesMake one image from chat Signed in session
- POST/api/chat/speechRead a reply aloud Signed in session
- POST/api/chat/transcribeWrite a dictation down Signed in session
- GET/api/conversations/searchSearch your saved threads Signed in sessionNo key
- GET/api/conversations/foldersYour thread folders Signed in session
- POST/api/conversations/foldersMake a folder Signed in session
- PATCH/api/conversations/folders/{id}Rename a folder Signed in session
- DELETE/api/conversations/folders/{id}Delete a folder; its threads are kept Signed in session
- PUT/api/conversations/{id}/folderFile a thread in a folder, or in none Signed in session
- GET/api/chat/agentsThe agents a thread may be answered by Signed in session
- GET/api/chat/memoryMemory in chat: which threads remember, and what is remembered Signed in session
- PUT/api/chat/memorySwitch memory on or off for one thread Signed in session
- GET/api/chat/pictures/{id}A picture a thread kept Signed in session
- DELETE/api/chat/pictures/{id}Delete a picture a thread kept Signed in session
- POST/api/conversations/folders/{id}/documentsAdd a document to a project Signed in session
- DELETE/api/conversations/folders/{id}/documentsRemove a document from a project Signed in session
- POST/api/conversations/from-shareContinue a shared thread as a new thread of your own Signed in sessionNo key
- POST/api/oracle/turnOne turn of the front page's black hole Signed in sessionNo key
- GET/api/oracle/wordsThe black hole's words in one language No key
- GET/api/sky/liveThe live sky: requests per model per closed minute No key
- GET/api/conversationsList playground conversations Signed in sessionNo key
- POST/api/conversationsStart a conversation Signed in sessionNo key
- GET/api/conversations/{id}Read a conversation and its messages Signed in sessionNo key
- POST/api/conversations/{id}Append a message Signed in sessionNo key
- PATCH/api/conversations/{id}Rename a conversation Signed in sessionNo key
- DELETE/api/conversations/{id}Delete a conversation, or trim its last reply Signed in sessionNo key
- GET/api/promptsList saved prompts Signed in session
- POST/api/promptsSave a prompt Signed in session
- PATCH/api/prompts/{id}Edit a saved prompt Signed in session
- DELETE/api/prompts/{id}Delete a saved prompt Signed in session
Recorder
Traces, capture, replay, and alerts.
- GET/api/tracesList your traces Signed in session
- GET/api/traces/{traceId}Read one trace, with its captured bodies Signed in session
- DELETE/api/traces/{traceId}Forget a captured body now Signed in session
- GET/api/traces/capturePer key capture settings Signed in session
- PATCH/api/traces/captureSwitch capture on or off for one key Signed in session
- POST/api/traces/replayReplay a captured request Signed in session
- GET/api/traces/exportYour spans in OpenTelemetry format Signed in session
- GET/api/alertsList alert rules Signed in session
- POST/api/alertsCreate an alert rule Signed in session
- PATCH/api/alerts/{id}Change an alert rule Signed in session
- DELETE/api/alerts/{id}Delete an alert rule Signed in session
- GET/api/alerts/notificationsIn product alert notifications Signed in session
- POST/api/alerts/notificationsMark notifications read Signed in session
Organizations
Teams, roles, invitations and shared credit.
- GET/api/orgs/{id}/usageSpend and traffic per member, key and world Signed in session
- POST/api/account/invite-linksPreview or accept a one time crew invite link Signed in session
- GET/api/orgs/{id}/invite-linksA crew's invite links Signed in session
- POST/api/orgs/{id}/invite-linksMake a one time invite link Signed in session
- DELETE/api/orgs/{id}/invite-linksWithdraw an open invite link Signed in session
- GET/api/orgs/{id}/projectsA crew's projects Signed in session
- POST/api/orgs/{id}/projectsCreate a project Signed in session
- GET/api/orgs/{id}/projects/{projectId}One project's month Signed in session
- PATCH/api/orgs/{id}/projects/{projectId}Rename a project or set its budgets and alert thresholds Signed in session
- DELETE/api/orgs/{id}/projects/{projectId}Archive a project Signed in session
- PUT/api/orgs/{id}/key-projectsFile a key under a project Signed in session
- GET/api/orgs/{id}/chargebackThe chargeback report for a month Signed in session
- GET/api/orgs/{id}/domainsA crew's email domains Signed in session
- POST/api/orgs/{id}/domainsClaim an email domain Signed in session
- PATCH/api/orgs/{id}/domainsProve a domain, or switch auto approve Signed in session
- DELETE/api/orgs/{id}/domainsDrop a domain claim Signed in session
- POST/api/team-domains/confirmConfirm a domain proof link No key
- GET/api/orgs/{id}/join-requestsRequests to join by email domain Signed in session
- POST/api/orgs/{id}/join-requestsApprove or decline a request to join Signed in session
- GET/api/orgs/{id}/auditA crew's audit trail, filtered Signed in session
- GET/api/orgsOrganizations this account belongs to Signed in session
- POST/api/orgsCreate an organization Signed in session
- GET/api/orgs/{id}One organization Signed in session
- PATCH/api/orgs/{id}Rename an organization Signed in session
- DELETE/api/orgs/{id}Delete an organization Signed in session
- GET/api/orgs/{id}/membersMembers and their budgets Signed in session
- POST/api/orgs/{id}/membersInvite a wallet Signed in session
- PATCH/api/orgs/{id}/membersChange a member's role or budget Signed in session
- DELETE/api/orgs/{id}/membersRemove a member, or leave Signed in session
- GET/api/orgs/{id}/invitesInvitations for this organization Signed in session
- DELETE/api/orgs/{id}/invitesRevoke an open invitation Signed in session
- GET/api/account/invitesInvitations addressed to your wallet Signed in session
- POST/api/account/invitesAccept or decline an invitation Signed in session
Agents
Agent wallets: sub balances with keys of their own.
- GET/v1/agentsList the account's agents API key
- POST/v1/agentsCreate an agent wallet API key
- GET/v1/agents/{id}One agent, with its last thirty days API key
- PATCH/v1/agents/{id}Change an agent's name, policy or status API key
- DELETE/v1/agents/{id}Delete an agent API key
- POST/v1/agents/{id}/top_upMove money from the account to an agent API key
- POST/v1/agents/{id}/drainMove an agent's money back to the account API key
- POST/v1/agents/{id}/rotate_keyA new key for an agent API key
- GET/v1/agents/{id}/walletThe message a funding wallet signs API key
- POST/v1/agents/{id}/walletLink the wallet an agent funds itself from API key
- POST/v1/agents/{id}/depositsClaim an on chain deposit for an agent API key
- GET/api/account/agentsThe signed in account's agents Signed in session
- POST/api/account/agentsCreate an agent from the dashboard Signed in session
- GET/api/account/agents/{id}One of the signed in account's agents Signed in session
- PATCH/api/account/agents/{id}Change an agent from the dashboard Signed in session
- DELETE/api/account/agents/{id}Delete an agent from the dashboard Signed in session
- POST/api/account/agents/{id}/{action}Top up, drain or rotate an agent's key from the dashboard Signed in session
- GET/v1/agents/{id}/definitionRead an agent's definition API key
- PUT/v1/agents/{id}/definitionReplace an agent's definition API key
- GET/v1/agents/{id}/runsList an agent's runs API key
- POST/v1/agents/{id}/runsStart a hosted run API key
- GET/v1/agents/{id}/runs/{run}Read a run API key
- GET/v1/agents/{id}/runs/{run}/eventsFollow a run's events API key
- POST/v1/agents/{id}/runs/{run}/cancelCancel a run API key
- POST/v1/agents/{id}/runs/{run}/tool_outputsAnswer a run's client function calls API key
- GET/api/account/agents/{id}/definitionRead an agent's definition from the dashboard Signed in session
- PUT/api/account/agents/{id}/definitionReplace an agent's definition from the dashboard Signed in session
- GET/api/account/agents/{id}/runsList an agent's runs from the dashboard Signed in session
- POST/api/account/agents/{id}/runsStart a hosted run from the dashboard Signed in session
- GET/api/account/agents/{id}/runs/{run}Read a run from the dashboard Signed in session
- GET/api/account/agents/{id}/runs/{run}/eventsA run's events from the dashboard Signed in session
- POST/api/account/agents/{id}/runs/{run}/{action}Cancel a run, or answer its tool calls, from the dashboard Signed in session
- GET/api/account/agents/{id}/triggersAn agent's schedules and webhooks Signed in session
- POST/api/account/agents/{id}/triggersAdd a schedule or a webhook Signed in session
- POST/api/account/agents/{id}/triggers/{trigger}Rotate a webhook's secret Signed in session
- PATCH/api/account/agents/{id}/triggers/{trigger}Turn a trigger on or off, or change it Signed in session
- DELETE/api/account/agents/{id}/triggers/{trigger}Remove a trigger Signed in session
- POST/api/agents/hooks/{trigger}A signed delivery that starts an agent's run No key
- GET/api/account/agents/{id}/publicationAn agent's public page, with its counts Signed in session
- PUT/api/account/agents/{id}/publicationPublish an agent, or change its public words Signed in session
- DELETE/api/account/agents/{id}/publicationTake an agent's public page down Signed in session
- GET/api/agents/public/{slug}A published agent's card No key
- POST/api/agents/public/{slug}/quoteWhat a run of a published agent would hold first Signed in session
- POST/api/agents/public/{slug}/runsRun a published agent on your own balance Signed in session
- GET/api/agents/public/{slug}/runs/{run}Your own run of a published agent, with its events Signed in session
Prompts
Versioned prompts with variables, called by id.
- GET/api/account/promptsThe account's prompts Signed in session
- POST/api/account/promptsKeep a prompt, with its first version Signed in session
- GET/api/account/prompts/{id}One prompt with every version Signed in session
- PATCH/api/account/prompts/{id}Rename a prompt or change its description Signed in session
- DELETE/api/account/prompts/{id}Delete a prompt with its versions and labels Signed in session
- POST/api/account/prompts/{id}/versionsWrite a new version Signed in session
- PUT/api/account/prompts/{id}/labelsPoint a label at a version, or take it off Signed in session
- POST/api/account/prompts/{id}/testPrice or run a version from the dashboard Signed in session