Platform Solutions Developers API Reference Cookbook Help Center Changelog Business plan Company Partners

API Reference

Overview Authentication Errors Rate limits Versioning

Compatible

OpenAI-compatible API Create chat completion Create a response Retrieve a response Delete a response Cancel a responsePartial List input items Compact a responseUnsupported Count input tokensUnsupported Create a conversation Retrieve a conversation Update a conversation Delete a conversation Create conversation items List conversation items Retrieve a conversation item Delete a conversation item Create an image List models Retrieve model Create embeddings Create video List videos Retrieve video Download video content Delete video Remix videoUnsupported Transcribe audio Upload a filePartial List files Retrieve file Delete file Retrieve file content Vector stores

Anthropic-compatible API Create a Message Count tokens for a requestPartial List models Upload a file List files Get file metadata Delete a file Download file content

Claude Managed Agents

Claude Managed Agents API Create AgentPartial List Agents Get Agent Update AgentPartial List Agent Versions Archive Agent Create SessionPartial List SessionsPartial Get Session Send EventsPartial List Events Stream EventsPartial List Deployment RunsUnsupported Get Deployment RunUnsupported List DeploymentsUnsupported Create DeploymentUnsupported Get DeploymentUnsupported Update DeploymentUnsupported Archive DeploymentUnsupported Pause DeploymentUnsupported Run DeploymentUnsupported Unpause DeploymentUnsupported List EnvironmentsPartial Create EnvironmentPartial Delete EnvironmentUnsupported Get EnvironmentPartial Update EnvironmentPartial Archive EnvironmentPartial List Work ItemsUnsupported Get Work ItemUnsupported Update Work ItemUnsupported Acknowledge Work ItemUnsupported Heartbeat Work ItemUnsupported Stop Work ItemUnsupported Poll Work ItemsUnsupported Work Item StatsUnsupported List Memory StoresUnsupported Create Memory StoreUnsupported Delete Memory StoreUnsupported Get Memory StoreUnsupported Update Memory StoreUnsupported Archive Memory StoreUnsupported List MemoriesUnsupported Create MemoryUnsupported Delete MemoryUnsupported Get MemoryUnsupported Update MemoryUnsupported List Memory VersionsUnsupported Get Memory VersionUnsupported Redact Memory VersionUnsupported Delete SessionUnsupported Update SessionPartial Archive Session List Session ResourcesPartial Add Session ResourcePartial Delete Session ResourcePartial Get Session ResourcePartial Update Session ResourceUnsupported List ThreadsPartial Get ThreadPartial Archive ThreadPartial List Thread EventsPartial Stream Thread EventsPartial List SkillsUnsupported Create SkillUnsupported Delete SkillUnsupported Get SkillUnsupported List Skill VersionsUnsupported Create Skill VersionUnsupported Delete Skill VersionUnsupported Get Skill VersionUnsupported Download Skill Version ContentUnsupported List TunnelsUnsupported Create TunnelUnsupported Get TunnelUnsupported Archive TunnelUnsupported List Tunnel CertificatesUnsupported Create Tunnel CertificateUnsupported Get Tunnel CertificateUnsupported Archive Tunnel CertificateUnsupported Reveal Tunnel TokenUnsupported Rotate Tunnel TokenUnsupported List Vaults Create Vault Delete Vault Get Vault Update Vault Archive Vault List CredentialsPartial Create CredentialPartial Delete CredentialPartial Get CredentialPartial Update CredentialPartial Archive CredentialPartial Validate Credential MCP OAuthPartial

Google Gemini-compatible API Generate content Stream generated content Count tokensPartial Generate an embedding Generate batch embeddings List models Get a model

E2B-compatible API Create a sandbox List running sandboxes Get a sandbox Get sandbox metrics Set sandbox timeout Pause a sandbox Connect to a sandbox Kill a sandbox Create a sandbox (v2)List sandboxes (v2)Connect to a sandbox (v2)List templates List templates (v2)Create team volume List team volumes Team volume Delete team volume Fork a sandbox Create a snapshot List snapshots Delete a snapshot Update sandbox network Get sandbox logs

Tavily-compatible API Search Extract Crawl Map Submit feedback

Browserbase Create a session List sessions Get a session Close a session Get live URLs Get session logs Get session recording Create a context Get a context Delete a context

Native

Agent API Create EnvironmentPartial Update EnvironmentPartial Archive EnvironmentPartial ComputersCreate ComputersList ComputersRetrieve ComputersUpdate ComputersArchive Delete Archived Computer ComputersFilesList ComputersFilesContent Connect computer Upload Computer Attachment Add Session ResourcePartial List Session ResourcesPartial Get Session ResourcePartial Delete Session ResourcePartial List Agents Create AgentPartial Get Agent Update AgentPartial List Agent Versions Archive Agent List SessionsPartial Create SessionPartial Get Session Fork Session (Extension)Get Session Context (Extension)List Session Background Tasks (Extension)Get Background Task Output (Extension)Stop Background Task (Extension)Compact Session (Extension)Get Session Compaction (Extension)List Session Compactions (Extension)List Events Send EventsPartial Stream EventsPartial Subscribe to events over WebSocket Update SessionPartial Archive Session List ThreadsPartial Get ThreadPartial List Thread EventsPartial Stream Thread EventsPartial Archive ThreadPartial List EnvironmentsPartial Get EnvironmentPartial List Toolsets

Model API Create chat completion Create a model response Retrieve a response Delete a response Cancel a responsePartial List input items Compact a responseUnsupported Count input tokensUnsupported Create embeddings Rerank documents Generate speech Transcribe audio Create image Create image edit Extract document text Create video List videos Retrieve video Download video content Delete video Remix videoUnsupported Create a Message Count tokensPartial List models Retrieve model Look up a generation Create a conversation Retrieve a conversation Update a conversation Create conversation items List conversation items Retrieve a conversation item Delete a conversation item Delete a conversation

Sandbox API Create a sandbox Upgrade to a full sandbox List running sandboxes Get a sandbox Rename a sandbox Get sandbox metrics Set sandbox timeout Pause a sandbox Connect to a sandbox Kill a sandbox List templates Create team volume List team volumes Team volume Delete team volume Fork a sandbox Create a snapshot List snapshots Delete a snapshot Update sandbox network Get sandbox logs Extend a running sandbox without shortening its deadline List live processes and retained observations Read bounded observed process output

Search API Search Extract Crawl Map

Actions

List actions Create an action Get an action Update an action List action revisions Get an action revision Roll back an action List action invocations List action dependents Archive an action Restore an action

Scripts

List scripts Create a script Get a script Update a script draft Archive a script Restore a script Publish a script version List script versions Get a script version Deprecate a script version List script tags Set a script tag Delete a script tag

Workflows

List workflows Create a workflow Get a workflow Update a workflow draft Archive a workflow Restore a workflow Publish a workflow version List workflow versions Get a workflow version Deprecate a workflow version List workflow tags Set a workflow tag Delete a workflow tag

Definition tools

Validate a definition Resolve a run target Search automation definitions

Runs

Create a run List runs Get a run Cancel a run Rerun a run Suspend a run Resume a run List run waits List run calls List run artifacts Complete a run wait List run tasks Read run events Read run logs Get run source

Triggers and inbound webhooks

List triggers Create a trigger Get a trigger Update a trigger Delete a trigger Pause a trigger Resume a trigger Fire a trigger now Rotate a webhook URL List trigger firings Preview a trigger schedule Receive a webhook

Organization API List costs List usage List usage events Get a usage event Export charges

Meta API Health check Search platform methods Retrieve a platform method

Cloud Browser API

Cloud Browser API Create a browser session List browser sessions Get a browser session Close a browser session Get live URLs List session events Request human takeover Complete human takeover Send a viewer heartbeat Create a context List contexts Get a context Update a context Delete a context Connect to a browser Open live view Stream session updates Selenium is unavailableUnsupported

Files and libraries

Files API Upload a filePartial List files Retrieve a file Download a file Delete a file

Media API Libraries Assets Understandings Search Folders Batches Events Error codes

Knowledge API Knowledge bases Files Batches Search Segments Events Errors

Database API Databases Tables Fields Events Read and write rows Error codes

Vault API Vaults Secrets Templates Authorizations Error codes

Application API Get account subdomain Change account subdomain List Workers Create Worker Get Worker Update Worker Delete Worker Restore Worker List versions Create version Get version List deployments Create deployment Get deployment List components List secrets Put secret Delete secret List grants Create grant Delete grant List events Create asset upload session Upload assets

Cloud Browser API

Open live view

Open the complete URL returned by debug. A URL carrying a t credential does not need an API key.

GET /browser/v1/live/{sessionId}/{pageId}● Supported

Request parameters

sessionIdstring必填
浏览器会话 ID；使用创建或列出会话返回的 id，以 bss_ 开头。
pageIdstring必填
实时观看地址中的标签页 ID；使用 debug 返回链接中的原值，_ 表示会话级画面。
tstring可选
实时观看地址自带的凭证。

Returns

302

Errors contain statusCode, error and message; the native API adds code. The request ID is in X-Request-Id. Errors

Connection guide

Response

This endpoint does not declare a successful response.

Open live view

Your key never leaves this browser.

Loading…

Connect to a browser

Connect over CDP WebSocket. Omit session and name to create a browser; session attaches to an existing browser; name attaches if present or creates one. session and name are mutually exclusive. Creation options are ignored when attaching. Authenticate with a Bearer API key or use the signed connectUrl returned by session creation.

Stream session updates

SSE events: snapshot, session, pages, action, event and end. The data field is JSON. A ping comment is sent every 15 seconds; end closes the stream. Historical replay is not available.