STACK
MENU
DOCS / API REFERENCE / EVERY ROUTE

Every Route

Every route a customer or an agent can call, with the OAuth scope a signed-in client needs, the name of the request body where it has one, and its query parameters. The list is made from the API description, so it is complete for this release. The description itself, with every schema, is at /openapi.json (OpenAPI 3.1).

A route marked no OAuth cannot be called with an OAuth token: it takes an API key, an agent's own credential or a signed-in browser. A route marked no sign-in is public.

a2a

  • POST /v1/a2a/jsonrpc dropoffs:write

accounts

Explained in Agent Accounts.

  • GET /v1/accounts accounts:read, query limit
  • POST /v1/accounts accounts:write, body OpenAgentAccountInput
  • GET /v1/accounts/{id} accounts:read
  • DELETE /v1/accounts/{id} accounts:write
  • POST /v1/accounts/{id}/browser/sessions accounts:act, body OpenBrowserSessionInput
  • DELETE /v1/accounts/{id}/browser/sessions/{sid} accounts:write
  • POST /v1/accounts/{id}/browser/sessions/{sid}/act accounts:act, body BrowserActInput
  • POST /v1/accounts/{id}/browser/sessions/{sid}/checkout accounts:act, body BrowserCheckoutInput
  • POST /v1/accounts/{id}/browser/sessions/{sid}/navigate accounts:act, body BrowserNavigateInput
  • POST /v1/accounts/{id}/browser/sessions/{sid}/read accounts:act
  • POST /v1/accounts/{id}/browser/sessions/{sid}/screenshot accounts:act
  • PUT /v1/accounts/{id}/budget accounts:manage, body SetAccountBudgetInput
  • GET /v1/accounts/{id}/calendar/agenda accounts:read, query from, to, time_zone, limit, cursor
  • GET /v1/accounts/{id}/calendar/events accounts:read, query role, response, limit, cursor
  • POST /v1/accounts/{id}/calendar/events accounts:act, body CreateCalendarEventInput
  • GET /v1/accounts/{id}/calendar/events/{eventId} accounts:read
  • PATCH /v1/accounts/{id}/calendar/events/{eventId} accounts:act, body UpdateCalendarEventInput
  • POST /v1/accounts/{id}/calendar/events/{eventId}/cancel accounts:act, body CancelCalendarEventInput
  • POST /v1/accounts/{id}/calendar/events/{eventId}/counters/{counterId}/decline accounts:act, body DeclineCalendarCounterInput
  • POST /v1/accounts/{id}/calendar/events/{eventId}/respond accounts:act, body RespondCalendarEventInput
  • GET /v1/accounts/{id}/calendar/feed accounts:read
  • POST /v1/accounts/{id}/calendar/feed accounts:manage
  • DELETE /v1/accounts/{id}/calendar/feed accounts:manage
  • GET /v1/accounts/{id}/calls accounts:read, query limit, cursor
  • POST /v1/accounts/{id}/calls accounts:act, body StartAgentCallInput
  • GET /v1/accounts/{id}/calls/{callId} accounts:read
  • POST /v1/accounts/{id}/calls/{callId}/answer accounts:act, body AnswerAgentCallInput
  • POST /v1/accounts/{id}/calls/{callId}/decline accounts:act
  • POST /v1/accounts/{id}/calls/{callId}/hang-up accounts:act
  • POST /v1/accounts/{id}/calls/{callId}/keys accounts:act, body AgentCallPressKeysInput
  • GET /v1/accounts/{id}/calls/{callId}/live accounts:act
  • POST /v1/accounts/{id}/calls/{callId}/say accounts:act, body AgentCallSayInput
  • POST /v1/accounts/{id}/calls/{callId}/voice accounts:act, body AgentCallSetVoiceInput
  • GET /v1/accounts/{id}/catalogue accounts:read
  • POST /v1/accounts/{id}/email/send accounts:act, body SendAgentEmailInput
  • GET /v1/accounts/{id}/identity accounts:read
  • PUT /v1/accounts/{id}/identity accounts:manage, body SetAgentIdentityInput
  • GET /v1/accounts/{id}/making/designs accounts:read, query limit
  • POST /v1/accounts/{id}/making/designs accounts:act, body MakingUploadDesignInput
  • GET /v1/accounts/{id}/making/designs/{designId} accounts:read
  • GET /v1/accounts/{id}/making/orders accounts:read, query limit
  • POST /v1/accounts/{id}/making/orders accounts:act, body MakingOrderInput
  • GET /v1/accounts/{id}/making/orders/{orderId} accounts:read
  • POST /v1/accounts/{id}/making/orders/{orderId}/approve accounts:manage
  • POST /v1/accounts/{id}/making/orders/{orderId}/cancel accounts:act
  • POST /v1/accounts/{id}/making/orders/{orderId}/reject accounts:manage
  • POST /v1/accounts/{id}/making/quotes accounts:act, body MakingQuoteInput
  • GET /v1/accounts/{id}/making/quotes/{quoteId} accounts:read
  • GET /v1/accounts/{id}/meetings accounts:read, query status, limit, cursor
  • POST /v1/accounts/{id}/meetings accounts:act, body JoinMeetingInput
  • GET /v1/accounts/{id}/meetings/{meetingId} accounts:read
  • POST /v1/accounts/{id}/meetings/{meetingId}/chat accounts:act, body ChatMeetingInput
  • POST /v1/accounts/{id}/meetings/{meetingId}/leave accounts:act
  • GET /v1/accounts/{id}/meetings/{meetingId}/live accounts:act
  • POST /v1/accounts/{id}/meetings/{meetingId}/say accounts:act, body SayMeetingInput
  • GET /v1/accounts/{id}/meetings/voice accounts:read
  • PUT /v1/accounts/{id}/meetings/voice accounts:manage, body MeetingVoice
  • GET /v1/accounts/{id}/messages accounts:read, query limit, cursor, channel
  • GET /v1/accounts/{id}/messages/{messageId} accounts:read
  • DELETE /v1/accounts/{id}/messages/{messageId} accounts:manage
  • GET /v1/accounts/{id}/messages/{messageId}/attachments/{fileId} accounts:read
  • POST /v1/accounts/{id}/messages/{messageId}/forward accounts:act, body ForwardAgentEmailInput
  • POST /v1/accounts/{id}/messages/{messageId}/reply accounts:act, body ReplyAgentEmailInput
  • GET /v1/accounts/{id}/payments accounts:read, query rail, limit, cursor
  • GET /v1/accounts/{id}/payments/{paymentId} accounts:read
  • POST /v1/accounts/{id}/payments/checkout-sessions accounts:act, body CreateCheckoutSessionInput
  • GET /v1/accounts/{id}/payments/links accounts:read, query limit
  • POST /v1/accounts/{id}/payments/links accounts:act, body CreatePaymentLinkInput
  • POST /v1/accounts/{id}/payments/links/{linkId}/deactivate accounts:act
  • GET /v1/accounts/{id}/payments/stripe accounts:read
  • POST /v1/accounts/{id}/payments/stripe accounts:act
  • DELETE /v1/accounts/{id}/payments/stripe accounts:manage
  • GET /v1/accounts/{id}/phone/toll-free-verification accounts:read
  • POST /v1/accounts/{id}/phone/toll-free-verification accounts:manage, body TollFreeVerificationInput
  • GET /v1/accounts/{id}/phone/voice accounts:read
  • PUT /v1/accounts/{id}/phone/voice accounts:manage, body AccountCallVoiceInput
  • POST /v1/accounts/{id}/pieces accounts:manage, body AddAccountPieceInput
  • POST /v1/accounts/{id}/pieces/resume accounts:manage, body ResumeAccountPieceInput
  • GET /v1/accounts/{id}/post/address accounts:read
  • POST /v1/accounts/{id}/post/address-check accounts:act, body VerifyPostalAddressInput
  • GET /v1/accounts/{id}/post/items accounts:read, query limit, cursor, routing
  • GET /v1/accounts/{id}/post/items/{itemId} accounts:read
  • POST /v1/accounts/{id}/post/items/{itemId}/forward accounts:act
  • POST /v1/accounts/{id}/post/items/{itemId}/scan accounts:act
  • POST /v1/accounts/{id}/post/items/{itemId}/shred accounts:act
  • GET /v1/accounts/{id}/post/letters accounts:read, query limit, cursor
  • POST /v1/accounts/{id}/post/letters accounts:act
  • GET /v1/accounts/{id}/post/letters/{letterId} accounts:read
  • GET /v1/accounts/{id}/purchases/{pid} accounts:read
  • POST /v1/accounts/{id}/purchases/{pid}/merchant-result accounts:act, body PurchaseMerchantResultInput
  • GET /v1/accounts/{id}/rentahuman accounts:read
  • POST /v1/accounts/{id}/rentahuman/fund accounts:act, body RentAHumanFundInput
  • POST /v1/accounts/{id}/rentahuman/fund/complete no OAuth, body RentAHumanFundCompleteInput
  • POST /v1/accounts/{id}/rentahuman/join accounts:act, body RentAHumanJoinInput
  • POST /v1/accounts/{id}/rentahuman/join/complete no OAuth, body RentAHumanJoinCompleteInput
  • POST /v1/accounts/{id}/sandbox/runs accounts:act
  • GET /v1/accounts/{id}/sandbox/runs/{runId} accounts:read
  • GET /v1/accounts/{id}/signing-keys accounts:read
  • POST /v1/accounts/{id}/signing-keys/rotate accounts:manage
  • POST /v1/accounts/{id}/sms/send accounts:act, body SendAgentSmsInput
  • GET /v1/accounts/{id}/telegram accounts:manage
  • PUT /v1/accounts/{id}/telegram no OAuth, body ConnectTelegramBotInput
  • DELETE /v1/accounts/{id}/telegram accounts:manage
  • GET /v1/accounts/{id}/telegram/chats accounts:manage
  • POST /v1/accounts/{id}/telegram/messages accounts:act, body SendTelegramMessageInput
  • POST /v1/accounts/{id}/telegram/start accounts:manage, body StartManagedTelegramBotInput
  • POST /v1/accounts/{id}/tools/discover accounts:act, body ToolDiscoverInput
  • POST /v1/accounts/{id}/tools/inspect accounts:act, body ToolInspectInput
  • POST /v1/accounts/{id}/tools/run accounts:act, body ToolRunInput
  • GET /v1/accounts/{id}/tools/runs/{runId} accounts:read
  • PUT /v1/accounts/{id}/wallet/caps accounts:manage, body WalletCapsInput
  • POST /v1/accounts/{id}/wallet/owner-transfers no OAuth, body OwnerTransferInput
  • POST /v1/accounts/{id}/wallet/payments no OAuth, body WalletPaymentInput
  • POST /v1/accounts/{id}/wallet/signer-policy no OAuth, body SignerPolicyUpdateInput
  • POST /v1/accounts/{id}/wallet/signer-removal no OAuth, body SignerPolicyUpdateInput
  • GET /v1/accounts/{id}/website accounts:read
  • GET /v1/accounts/{id}/website/deploys accounts:read, query limit
  • POST /v1/accounts/{id}/website/deploys accounts:act, body PublishSiteInput
  • GET /v1/accounts/{id}/website/deploys/{deployId} accounts:read
  • GET /v1/accounts/{id}/website/hostnames accounts:read
  • POST /v1/accounts/{id}/website/hostnames accounts:act, body AddSiteHostnameInput
  • DELETE /v1/accounts/{id}/website/hostnames/{hostnameId} accounts:act
  • POST /v1/accounts/{id}/website/hostnames/{hostnameId}/check accounts:act
  • GET /v1/accounts/{id}/website/prices accounts:read
  • PUT /v1/accounts/{id}/website/prices accounts:act, body SetSitePricesInput
  • POST /v1/accounts/{id}/website/suspension accounts:manage, body SiteSuspendInput
  • DELETE /v1/accounts/{id}/website/suspension accounts:manage
  • POST /v1/accounts/{id}/website/uploads accounts:act, body SiteUploadLinkInput
  • GET /v1/accounts/{id}/workspace/settings accounts:manage
  • PUT /v1/accounts/{id}/workspace/settings accounts:manage, body SetWorkspaceSettingsInput
  • GET /v1/accounts/{id}/workspaces accounts:read
  • POST /v1/accounts/{id}/workspaces/{wid}/commands/read accounts:act, body WorkspaceCommandReadInput
  • POST /v1/accounts/{id}/workspaces/{wid}/files/read accounts:act, body WorkspaceReadFileInput
  • POST /v1/accounts/{id}/workspaces/{wid}/files/save accounts:act, body WorkspaceSaveFileInput
  • POST /v1/accounts/{id}/workspaces/{wid}/files/write accounts:act, body WorkspaceWriteFileInput
  • PUT /v1/accounts/{id}/workspaces/{wid}/sharing accounts:manage, body SetWorkspaceSharingInput
  • POST /v1/accounts/{id}/workspaces/{wid}/stop accounts:write, body WorkspaceStopInput
  • POST /v1/accounts/{id}/workspaces/exec accounts:act, body WorkspaceExecInput
  • GET /v1/accounts/mail-domains accounts:read
  • POST /v1/accounts/mail-domains accounts:manage
  • POST /v1/accounts/mail-domains/{id}/verify accounts:manage
  • GET /v1/accounts/making/suppliers accounts:manage
  • PUT /v1/accounts/making/suppliers/{supplier} accounts:manage, body MakingSupplierCredentialInput
  • DELETE /v1/accounts/making/suppliers/{supplier} accounts:manage
  • POST /v1/accounts/making/suppliers/printful/connect accounts:manage
  • GET /v1/accounts/wallet-owner billing:read
  • POST /v1/accounts/wallet-owner no OAuth, body WalletOwnerInput
  • GET /v1/accounts/wallet-owner/funds no OAuth
  • GET /v1/accounts/wallet-owner/policies no OAuth
  • GET /v1/accounts/wallet-owner/wallets no OAuth

agent-identity

Explained in Signed Requests and Agent Identity.

  • GET /v1/agent-identity no sign-in, query key_id, site, agent_id
  • GET /v1/agent-identity/agents/{agent_id}/agent-card.json no sign-in
  • GET /v1/agent-identity/agents/{agent_id}/http-message-signatures-directory no sign-in
  • GET /v1/agent-identity/agents/{agent_id}/mcp-server-card.json no sign-in

agents

Explained in Agents.

  • GET /v1/agents agents:read
  • POST /v1/agents/{agentId}/dismiss-warnings reviews:write
  • GET /v1/agents/{agentId}/message-access accounts:manage
  • PUT /v1/agents/{agentId}/message-access accounts:manage, body SetMessageAccessInput
  • GET /v1/agents/{agentId}/permissions agents:read
  • GET /v1/agents/{agentId}/trust accounts:manage
  • PUT /v1/agents/{agentId}/trust accounts:manage, body SetAgentTrustInput
  • GET /v1/agents/{agentId}/wake/rules accounts:manage
  • POST /v1/agents/{agentId}/wake/rules accounts:manage, body SetWakeRuleInput
  • GET /v1/agents/{agentId}/wake/schedules accounts:manage
  • POST /v1/agents/{agentId}/wake/schedules accounts:manage, body SetWakeScheduleInput
  • PUT /v1/agents/{agentId}/wake/schedules/{scheduleId} accounts:manage, body SetWakeScheduleInput
  • DELETE /v1/agents/{agentId}/wake/schedules/{scheduleId} accounts:manage
  • GET /v1/agents/{agentId}/wake/settings accounts:manage
  • PUT /v1/agents/{agentId}/wake/settings accounts:manage, body SetWakeSettingsInput
  • POST /v1/agents/{agentId}/wake/webhook/rotate-secret accounts:manage
  • POST /v1/agents/{agentId}/wake/webhook/test accounts:manage
  • GET /v1/agents/{agentId}/wakes accounts:read, query status, limit, cursor
  • GET /v1/agents/{agentId}/wakes/{wakeId} accounts:read
  • POST /v1/agents/{agentId}/wakes/{wakeId}/acknowledge accounts:write
  • GET /v1/agents/{id} agents:read
  • PATCH /v1/agents/{id} agents:write, body UpdateAgentInput
  • DELETE /v1/agents/{id} agents:write
  • GET /v1/agents/{id}/.well-known/jwks.json no sign-in
  • POST /v1/agents/{id}/allowed-skills agents:write
  • DELETE /v1/agents/{id}/allowed-skills/{skillId} agents:write
  • POST /v1/agents/{id}/enroll no sign-in, body AgentEnrollInput
  • POST /v1/agents/{id}/enrollment-challenge no sign-in
  • POST /v1/agents/{id}/enrollment-tickets agents:write
  • GET /v1/agents/{id}/stats agents:read
  • POST /v1/agents/{id}/unblock agents:write
  • GET /v1/agents/overview accounts:manage, query limit, cursor
  • POST /v1/agents/register agents:write, body RegisterAgentInput
  • POST /v1/agents/setup agents:write, body AgentSetupInput

audit

Explained in Audit.

  • GET /v1/audit audit:read, query limit, since, agent_id, passport_jti
  • GET /v1/audit/chain-head audit:read
  • GET /v1/audit/export audit:read, query from, to, format, limit, offset
  • GET /v1/audit/verify-chain audit:read, query from, to, limit

auth

  • GET /v1/auth/context account:read

authority

Explained in Authority.

  • POST /v1/authority/approval-requests/{approvalId}/decide no sign-in, body AuthorityApprovalDecisionInput
  • GET /v1/authority/bindings authority:read, query agent_id, page, limit, binding_id, binding_version
  • POST /v1/authority/bindings authority:write, body CreateAuthorityBindingInput
  • GET /v1/authority/bindings/{bindingId} authority:read, query version
  • POST /v1/authority/bindings/{bindingId}/activate authority:write, body EmptyBody, query version
  • GET /v1/authority/bindings/{bindingId}/approval-requests authority:read
  • POST /v1/authority/bindings/{bindingId}/approval-requests authority:write, body CreateAuthorityApprovalRequestsInput
  • POST /v1/authority/bindings/{bindingId}/delegate authority:write, body DelegateAuthorityBindingInput
  • POST /v1/authority/bindings/{bindingId}/erase authority:write, body EmptyBody
  • POST /v1/authority/bindings/{bindingId}/revoke authority:write, body ReasonBody
  • POST /v1/authority/enterprise-oidc/requests authority:write, body CreateEnterpriseOidcAuthoritySetupInput
  • GET /v1/authority/enterprise-oidc/requests/{requestId} authority:read
  • POST /v1/authority/enterprise-oidc/requests/{requestId}/complete no sign-in, body AuthoritySetupCompleteBody
  • POST /v1/authority/enterprise-oidc/requests/{requestId}/reject no sign-in, body EmptyBody
  • GET /v1/authority/enterprise-oidc/requests/{requestId}/review no sign-in
  • POST /v1/authority/enterprise-oidc/requests/{requestId}/start no sign-in, body AuthoritySetupStartBody
  • POST /v1/authority/presentation-requests no sign-in, body ReceiverChallengeInput
  • GET /v1/authority/presentation-requests/{presentationId} no sign-in
  • GET /v1/authority/presentations authority:read
  • GET /v1/authority/presentations/{presentationId} authority:read
  • POST /v1/authority/presentations/{presentationId}/erase authority:write, body EmptyBody
  • POST /v1/authority/presentations/{presentationId}/receipts no sign-in, body ReceiverReceiptInput
  • GET /v1/authority/principals authority:read
  • POST /v1/authority/principals authority:write, body CreateAuthorityPrincipalInput
  • GET /v1/authority/principals/{principalId} authority:read
  • POST /v1/authority/principals/{principalId}/archive authority:write, body ReasonBody
  • POST /v1/authority/principals/{principalId}/erase authority:write, body EmptyBody
  • POST /v1/authority/profile-versions authority:write, body CreateAuthorityProfileVersionInput
  • POST /v1/authority/profile-versions/{profileId}/activate authority:write, body ProfileActivationBody
  • POST /v1/authority/proof-collection-sessions authority:write, body CreateAuthorityProofCollectionSessionInput
  • GET /v1/authority/proof-collection-sessions/{sessionId} authority:read
  • GET /v1/authority/proofs authority:read
  • GET /v1/authority/proofs/{proofId} authority:read, query version
  • POST /v1/authority/proofs/{proofId}/erase authority:write, body EmptyBody
  • POST /v1/authority/proofs/{proofId}/revoke authority:write, body ReasonBody
  • POST /v1/authority/proofs/import authority:write, body AttachAuthorityProofInput
  • GET /v1/authority/receivers authority:read
  • POST /v1/authority/receivers authority:write, body CreateAuthorityReceiverInput
  • GET /v1/authority/receivers/{receiverId} authority:read
  • POST /v1/authority/receivers/{receiverId}/keys authority:write, body AddAuthorityReceiverKeyInput
  • POST /v1/authority/receivers/{receiverId}/keys/{keyId}/revoke authority:write, body ReasonBody
  • POST /v1/authority/receivers/{receiverId}/verification-challenges authority:write, body EmptyBody
  • POST /v1/authority/receivers/{receiverId}/verify authority:write, body EmptyBody
  • POST /v1/authority/status-checks no sign-in, body AuthorityStatusCheckInput
  • GET /v1/authority/uses authority:read, query agent_id, page, limit, binding_id, binding_version
  • GET /v1/authority/uses/{useId} authority:read

billing

Explained in Billing.

  • GET /v1/billing/balance billing:read
  • POST /v1/billing/cancel-subscription billing:write
  • POST /v1/billing/controls/subscribe billing:write
  • POST /v1/billing/platform/subscribe billing:write
  • POST /v1/billing/portal billing:write
  • POST /v1/billing/refund/{transactionId} billing:write, body RefundInput
  • POST /v1/billing/seats billing:write
  • POST /v1/billing/subscribe billing:write
  • GET /v1/billing/subscriptions billing:read
  • POST /v1/billing/topup billing:write, body TopupInput
  • GET /v1/billing/transactions billing:read, query view, entry_kind, limit, cursor, type, direction, since, until
  • GET /v1/billing/usage billing:read

blocked-callers

  • GET /v1/blocked-callers accounts:manage
  • POST /v1/blocked-callers accounts:manage, body AddBlockedCallerInput
  • DELETE /v1/blocked-callers/{id} accounts:manage

brain

Explained in Brain.

  • GET /v1/brain/files accounts:read, query status, cursor, limit
  • POST /v1/brain/files accounts:act, body BrainAddInput
  • POST /v1/brain/notes accounts:manage, body BrainNoteInput
  • POST /v1/brain/remove accounts:act, body BrainRemoveInput
  • POST /v1/brain/search accounts:read, body BrainSearchInput

calendar

  • GET /v1/calendar/feeds/{token} no sign-in

catalogue

  • GET /v1/catalogue accounts:read
  • GET /v1/catalogue/search accounts:read, query q, kind, limit, offset
  • GET /v1/catalogue/tool-pieces accounts:read

chat-channels

Explained in Chat Channels.

  • GET /v1/chat-channels accounts:manage
  • POST /v1/chat-channels/identities accounts:manage, body CreateChatIdentityInput
  • DELETE /v1/chat-channels/identities/{id} accounts:manage
  • POST /v1/chat-channels/identities/{id}/confirm no OAuth
  • POST /v1/chat-channels/identities/{id}/verify no OAuth, body VerifyChatIdentityInput
  • DELETE /v1/chat-channels/slack accounts:manage
  • POST /v1/chat-channels/slack/install no OAuth, body InstallSlackInput
  • GET /v1/chat-channels/slack/install-url accounts:manage, query redirect_uri, state

control-decisions

  • GET /v1/control-decisions accounts:manage, query limit, account_id, verdict, before
  • GET /v1/control-decisions/{id} accounts:manage

control-policies

Explained in Controls.

  • GET /v1/control-policies accounts:manage
  • GET /v1/control-policies/{id}/revisions accounts:manage
  • GET /v1/control-policies/agents/{agentId} accounts:manage
  • PUT /v1/control-policies/agents/{agentId} accounts:manage, body SetControlPolicyInput
  • DELETE /v1/control-policies/agents/{agentId} accounts:manage, query expected_revision
  • POST /v1/control-policies/agents/{agentId}/start-from-current-access accounts:manage
  • GET /v1/control-policies/default accounts:manage
  • PUT /v1/control-policies/default accounts:manage, body SetControlPolicyInput
  • DELETE /v1/control-policies/default accounts:manage, query expected_revision
  • POST /v1/control-policies/simulate accounts:manage, body SimulateControlPolicyInput

control-reviews

  • GET /v1/control-reviews accounts:manage, query status, limit
  • GET /v1/control-reviews/{id} accounts:manage

control-socket

Explained in Controls.

  • GET /v1/control-socket accounts:manage
  • DELETE /v1/control-socket/{target} accounts:manage
  • POST /v1/control-socket/{target}/secret/rotate accounts:manage
  • POST /v1/control-socket/{target}/test accounts:manage
  • POST /v1/control-socket/{target}/verify accounts:manage
  • PUT /v1/control-socket/checked-types accounts:manage, body SetControlCheckedTypesInput
  • PUT /v1/control-socket/decision accounts:manage, body SetControlDecisionAddressInput
  • PUT /v1/control-socket/events accounts:manage, body SetControlEventsAddressInput
  • PUT /v1/control-socket/mode accounts:manage, body SetControlModeInput
  • PUT /v1/control-socket/on-unavailable accounts:manage, body SetControlOnUnavailableInput
  • POST /v1/control-socket/secret/reveal no OAuth, body RevealBody

credentials

Explained in Credentials.

  • GET /v1/credentials/{provider} credentials:read, query connection
  • GET /v1/credentials/by-connection/{connectionId} credentials:read

detectors

  • GET /v1/detectors/{detector_key}/config detectors:read
  • PUT /v1/detectors/{detector_key}/config detectors:write, body DetectorConfigUpsertInput
  • DELETE /v1/detectors/{detector_key}/config detectors:write
  • GET /v1/detectors/config detectors:read

drive

Explained in Drive.

  • GET /v1/drive/files accounts:read, query limit, cursor
  • POST /v1/drive/files accounts:act, body DriveUploadInput
  • PUT /v1/drive/files accounts:act, query name, content_type, visibility, expires_in_seconds
  • GET /v1/drive/files/{id} accounts:read
  • PATCH /v1/drive/files/{id} accounts:act, body DriveUpdateInput
  • DELETE /v1/drive/files/{id} accounts:act
  • GET /v1/drive/files/{id}/content accounts:read
  • POST /v1/drive/files/{id}/copy accounts:act, body DriveCopyInput
  • GET /v1/drive/files/{id}/links accounts:read
  • POST /v1/drive/files/{id}/links accounts:act, body DriveShareInput
  • DELETE /v1/drive/files/{id}/links/{linkId} accounts:act
  • POST /v1/drive/handoffs accounts:act, body DriveHandoffInput
  • GET /v1/drive/links/* no sign-in
  • POST /v1/drive/uploads accounts:act, body DriveUploadLinkInput
  • PUT /v1/drive/uploads/{token} no sign-in

dropoffs

Explained in Drop-offs.

  • GET /v1/dropoffs dropoffs:read
  • POST /v1/dropoffs dropoffs:write, body CreateDropoffInput
  • GET /v1/dropoffs/{id} dropoffs:read
  • POST /v1/dropoffs/{id}/collect dropoffs:write, body CollectBody
  • POST /v1/dropoffs/{id}/deposit dropoffs:write, body DepositBody
  • POST /v1/dropoffs/{id}/expire dropoffs:write

evidence-packs

Explained in Evidence.

  • GET /v1/evidence-packs evidence:read, query scope
  • POST /v1/evidence-packs evidence:write, body ExportBody
  • GET /v1/evidence-packs/{pack_id} evidence:read
  • GET /v1/evidence-packs/{pack_id}/download evidence:read

flagged-content

  • GET /v1/flagged-content/settings accounts:manage
  • PUT /v1/flagged-content/settings accounts:manage, body SetFlaggedContentSettingsInput

fleets

  • GET /v1/fleets agents:read, query page, limit
  • POST /v1/fleets agents:write, body FleetPolicyInput
  • GET /v1/fleets/{id} agents:read
  • PUT /v1/fleets/{id} agents:write, body FleetPolicyInput
  • POST /v1/fleets/{id}/enroll no OAuth, body FleetEnrollmentInput
  • POST /v1/fleets/{id}/enrollment-challenges no OAuth
  • GET /v1/fleets/{id}/members agents:read, query page, limit
  • POST /v1/fleets/{id}/members/{agentId}/revoke agents:write
  • POST /v1/fleets/{id}/revoke agents:write
  • POST /v1/fleets/{id}/workload/enroll no sign-in, body FleetEnrollmentInput
  • POST /v1/fleets/{id}/workload/enrollment-challenges no sign-in
  • GET /v1/fleets/membership/{agentId} agents:read
  • POST /v1/fleets/session no OAuth

governance

  • GET /v1/governance/approvals governance:read
  • GET /v1/governance/approvals/{id} governance:read
  • POST /v1/governance/approvals/{id}/chat-decision governance:decide, body GovernanceChatDecisionInput
  • POST /v1/governance/approvals/{id}/decide no sign-in, body GovernanceDecisionInput

health

  • GET /health no sign-in

identity

Explained in Identity.

  • GET /v1/identity/claims identity:read
  • DELETE /v1/identity/claims/{id} identity:write
  • POST /v1/identity/delegate identity:write, body GrantDelegationInput
  • GET /v1/identity/oidc/config identity:read
  • POST /v1/identity/oidc/config identity:write, body OidcIdpConfigCreateInput
  • PATCH /v1/identity/oidc/config/{id} identity:write, body OidcIdpConfigUpdateInput
  • DELETE /v1/identity/oidc/config/{id} identity:write
  • POST /v1/identity/oidc/config/{id}/test identity:write
  • GET /v1/identity/providers identity:read
  • GET /v1/identity/spiffe/trust-domains identity:read
  • POST /v1/identity/spiffe/trust-domains identity:write, body TrustDomainCreateInput
  • GET /v1/identity/spiffe/trust-domains/{id} identity:read
  • PATCH /v1/identity/spiffe/trust-domains/{id} identity:write, body TrustDomainUpdateInput
  • DELETE /v1/identity/spiffe/trust-domains/{id} identity:write
  • GET /v1/identity/sso-domains identity:read
  • POST /v1/identity/sso-domains identity:write, body SsoDomainAddInput
  • DELETE /v1/identity/sso-domains/{id} identity:write
  • POST /v1/identity/sso-domains/{id}/verify identity:write
  • GET /v1/identity/sso/{slug}/start no sign-in
  • POST /v1/identity/sso/handoff no sign-in
  • POST /v1/identity/verify/complete identity:write, body CompleteVerificationInput
  • POST /v1/identity/verify/initiate identity:write, body InitiateVerificationInput
  • GET /v1/identity/verify/sessions identity:read
  • GET /v1/identity/verify/sessions/{id} identity:read
  • POST /v1/identity/verify/sync identity:write, body SyncVerificationBody
  • POST /v1/identity/verify/token identity:write, body TokenVerificationBody
  • GET /v1/identity/wimse/issuers identity:read
  • POST /v1/identity/wimse/issuers identity:write, body WimseIssuerCreateInput
  • GET /v1/identity/wimse/issuers/{id} identity:read
  • PATCH /v1/identity/wimse/issuers/{id} identity:write, body WimseIssuerUpdateInput
  • DELETE /v1/identity/wimse/issuers/{id} identity:write

intents

Explained in Intents and Governance.

  • GET /v1/intents/{id} intents:read
  • POST /v1/intents/{id}/approve governance:write, body DecideBody
  • POST /v1/intents/{id}/reject governance:write, body DecideBody
  • GET /v1/intents/pending intents:read, query agent_id, page, limit
  • POST /v1/intents/simulate intents:write, body SimulateBody
  • POST /v1/intents/submit intents:write, body SubmitBody

licence

  • GET /v1/licence no OAuth

llm

Explained in LLM Gateway.

  • POST /v1/llm/anthropic/images llm:invoke
  • POST /v1/llm/anthropic/messages llm:invoke
  • POST /v1/llm/openai/chat/completions llm:invoke
  • POST /v1/llm/openai/images llm:invoke
  • GET /v1/llm/openrouter/* llm:invoke
  • POST /v1/llm/openrouter/* llm:invoke
  • PUT /v1/llm/openrouter/* llm:invoke
  • PATCH /v1/llm/openrouter/* llm:invoke
  • DELETE /v1/llm/openrouter/* llm:invoke
  • GET /v1/llm/usage llm:read, query limit, cursor, provider, passport_jti, mission_id, agent_id, surface, provider_payer, stack_fee_payer, since, until
  • GET /v1/llm/usage/summary llm:read, query provider, passport_jti, mission_id, agent_id, surface, provider_payer, stack_fee_payer, since, until, group_by_model

making

  • GET /v1/making/files/{token} no sign-in

memory

Explained in Memory.

  • GET /v1/memory/entity-types accounts:read
  • POST /v1/memory/entity-types accounts:act, body MemoryEntityTypeInput
  • PATCH /v1/memory/entity-types/{name} accounts:act, body MemoryEntityTypeChangeInput
  • DELETE /v1/memory/entity-types/{name} accounts:act
  • POST /v1/memory/episode-entities accounts:read, body MemoryEpisodeEntitiesInput
  • GET /v1/memory/episodes accounts:read, query max_episodes
  • POST /v1/memory/episodes accounts:act, body MemoryAddInput
  • DELETE /v1/memory/episodes/{uuid} accounts:act
  • GET /v1/memory/facts/{uuid} accounts:read
  • DELETE /v1/memory/facts/{uuid} accounts:act
  • POST /v1/memory/facts/search accounts:read, body MemorySearchFactsInput
  • GET /v1/memory/history accounts:read, query max_writes, cursor
  • POST /v1/memory/nodes/search accounts:read, body MemorySearchNodesInput
  • POST /v1/memory/sagas/summary accounts:act, body MemorySummarizeSagaInput
  • GET /v1/memory/settings accounts:read
  • PUT /v1/memory/settings accounts:manage, body MemorySettingsInput
  • POST /v1/memory/triplets accounts:act, body MemoryTripletInput
  • POST /v1/memory/writes/{id}/undo accounts:act, body MemoryUndoInput

message-access

  • GET /v1/message-access accounts:manage
  • PUT /v1/message-access accounts:manage, body SetMessageAccessInput

messages

  • GET /v1/messages accounts:read, query agent_id, channel, sender, recipient, thread_id, after, before, q, limit, cursor

missions

Explained in Missions.

  • GET /v1/missions missions:read, query agent_id, status, page, limit
  • POST /v1/missions missions:write
  • GET /v1/missions/{id} missions:read
  • POST /v1/missions/{id}/complete missions:write, body CompleteBody
  • POST /v1/missions/{id}/dossier missions:write, body DossierBody
  • GET /v1/missions/{id}/dossiers missions:read
  • PUT /v1/missions/{id}/making-allowance missions:write, body SetMissionMakingAllowanceInput
  • GET /v1/missions/{id}/operator-review-source reviews:read
  • GET /v1/missions/{id}/operator-reviews reviews:read
  • POST /v1/missions/{id}/operator-reviews reviews:write, body OperatorReviewInput
  • GET /v1/missions/{id}/operator-reviews/{claim_id}/download reviews:read
  • POST /v1/missions/{id}/operator-reviews/{claim_id}/revisions reviews:write, body OperatorReviewInput
  • GET /v1/missions/{id}/passports missions:read
  • POST /v1/missions/{id}/recipients missions:write, body AddRecipientsBody
  • POST /v1/missions/{id}/renew no OAuth
  • GET /v1/missions/{id}/replay missions:read
  • POST /v1/missions/{id}/review missions:write, body MissionReviewInput
  • POST /v1/missions/{id}/revoke missions:write, body RevokeBody
  • POST /v1/missions/start missions:write

notifications

Explained in Notifications.

  • GET /v1/notifications/channels notifications:read
  • POST /v1/notifications/channels notifications:write, body NotificationRuleRequestBody
  • PATCH /v1/notifications/channels/{id} notifications:write, body UpdateNotificationRuleInput
  • DELETE /v1/notifications/channels/{id} notifications:write
  • POST /v1/notifications/channels/{id}/send-code notifications:write
  • POST /v1/notifications/channels/{id}/test notifications:write
  • POST /v1/notifications/channels/{id}/verify notifications:write, body VerifyCodeBody
  • GET /v1/notifications/destinations notifications:read
  • POST /v1/notifications/destinations notifications:write, body AddDeliveryMethodInput
  • DELETE /v1/notifications/destinations/{id} notifications:write
  • POST /v1/notifications/destinations/{id}/rotate-secret notifications:write
  • POST /v1/notifications/destinations/{id}/send-code notifications:write
  • POST /v1/notifications/destinations/{id}/test notifications:write
  • POST /v1/notifications/destinations/{id}/verify notifications:write, body VerifyCodeBody

oauth

  • GET /oauth/authorize no sign-in
  • POST /oauth/authorize no sign-in, body OAuthParams
  • POST /oauth/device/approve no sign-in, body OAuthParams
  • POST /oauth/device/authorize no sign-in, body OAuthParams
  • POST /oauth/device/deny no sign-in, body OAuthParams
  • POST /oauth/register no sign-in, body ClientMetadata
  • POST /oauth/revoke no sign-in, body OAuthParams
  • POST /oauth/token no sign-in, body OAuthParams

oauth-apps

  • GET /v1/oauth-apps oauth-apps:read
  • POST /v1/oauth-apps oauth-apps:write, body CreateOauthAppInput
  • DELETE /v1/oauth-apps/{provider} oauth-apps:write

operator

  • GET /v1/operator/cmek cmek:read
  • POST /v1/operator/cmek cmek:write
  • DELETE /v1/operator/cmek cmek:write
  • GET /v1/operator/inbound-webhooks inbound-webhooks:read
  • POST /v1/operator/inbound-webhooks inbound-webhooks:write, body CreateInboundWebhookInput
  • GET /v1/operator/inbound-webhooks/{id} inbound-webhooks:read
  • DELETE /v1/operator/inbound-webhooks/{id} inbound-webhooks:write
  • PUT /v1/operator/inbound-webhooks/{id}/provider-signing-secret no OAuth
  • POST /v1/operator/inbound-webhooks/{id}/rotate-secret no OAuth
  • GET /v1/operator/partner-management no OAuth
  • POST /v1/operator/partner-release no OAuth, body Empty

operator-decisions

  • POST /v1/operator-decisions reviews:write, body DecisionBody

operators

  • GET /v1/operators/{operator_id}/jwks.json no sign-in
  • POST /v1/operators/email-change/cancel no sign-in
  • POST /v1/operators/email-change/confirm no sign-in
  • GET /v1/operators/me account:read
  • DELETE /v1/operators/me no OAuth, body DeleteAccountBody
  • GET /v1/operators/me/email-change account:read
  • POST /v1/operators/me/email-change no OAuth
  • GET /v1/operators/me/identity-settings account:read
  • PATCH /v1/operators/me/identity-settings account:write, body UpdateIdentitySettingsInput
  • GET /v1/operators/me/mcp-sessions account:read
  • DELETE /v1/operators/me/mcp-sessions/{familyId} account:write

opt-outs

  • GET /v1/opt-outs accounts:manage
  • POST /v1/opt-outs accounts:manage, body AddOptOutInput
  • DELETE /v1/opt-outs/{id} accounts:manage

partner

Explained in Partner API.

  • GET /v1/partner/accounts partner:read, query external_ref
  • POST /v1/partner/accounts partner:write, body CreateAccountBody
  • PUT /v1/partner/accounts/{account_id}/controls partner:write, body PartnerAccountControlsInput
  • GET /v1/partner/accounts/{account_id}/inbound-webhooks partner:read
  • POST /v1/partner/accounts/{account_id}/inbound-webhooks partner:write, body CreateInboundWebhookInput
  • DELETE /v1/partner/accounts/{account_id}/inbound-webhooks/{wh_id} partner:write
  • PUT /v1/partner/accounts/{account_id}/inbound-webhooks/{wh_id}/provider-signing-secret no OAuth
  • POST /v1/partner/accounts/{account_id}/inbound-webhooks/{wh_id}/rotate-secret no OAuth
  • POST /v1/partner/accounts/{account_id}/invite partner:write, body PartnerAccountInviteInput
  • POST /v1/partner/accounts/{account_id}/passports/issue partner:write, body IssuePassportInput
  • GET /v1/partner/accounts/{account_id}/release partner:read
  • POST /v1/partner/accounts/{account_id}/release partner:write, body PartnerReleaseInput
  • DELETE /v1/partner/accounts/{account_id}/release partner:write
  • POST /v1/partner/accounts/{account_id}/rotate-key no OAuth
  • GET /v1/partner/accounts/{id} partner:read
  • DELETE /v1/partner/accounts/{id} partner:write
  • GET /v1/partner/releases partner:read

passports

Explained in Passports.

  • POST /v1/passports/{jti}/checkout passports:write, body CheckoutInput
  • POST /v1/passports/{jti}/checkpoint passports:write, body CheckpointInput
  • GET /v1/passports/{jti}/report reviews:read
  • GET /v1/passports/active passports:read, query agent_id, session_id
  • POST /v1/passports/delegate passports:write, body DelegatePassportInput
  • POST /v1/passports/issue passports:write, body IssuePassportInput
  • POST /v1/passports/refresh passports:write, body RefreshPassportInput
  • GET /v1/passports/reviews reviews:read, query status, page, limit
  • POST /v1/passports/reviews/{checkoutId}/decide reviews:write, body ReviewDecisionInput
  • POST /v1/passports/revoke passports:write, body RevokePassportBody
  • POST /v1/passports/revoke-agent/{agentId} passports:write, body RevokeReasonBody
  • POST /v1/passports/revoke-all passports:write, body RevokeAllInput
  • POST /v1/passports/revoke-session/{sessionId} passports:write, body RevokeReasonBody
  • POST /v1/passports/verify no sign-in, body VerifyPassportInput

payouts

  • GET /v1/payouts/earnings payouts:read
  • GET /v1/payouts/history payouts:read
  • POST /v1/payouts/stripe-connect/onboard payouts:write
  • GET /v1/payouts/stripe-connect/status payouts:read

pii

  • GET /v1/pii/config pii:read
  • PUT /v1/pii/config pii:write, body PiiConfigUpsertInput
  • DELETE /v1/pii/config pii:write

post

Explained in Post.

  • GET /v1/post/address accounts:manage
  • POST /v1/post/address accounts:manage
  • DELETE /v1/post/address accounts:manage
  • POST /v1/post/address/connect accounts:manage, body ConnectPostalAddressInput
  • POST /v1/post/address/pause accounts:manage
  • POST /v1/post/address/refresh accounts:manage
  • POST /v1/post/address/resume accounts:manage
  • GET /v1/post/items accounts:manage, query limit, cursor, routing
  • POST /v1/post/items/{itemId}/assign accounts:manage, body AssignPostalItemInput

proxy

Explained in Proxy.

  • POST /v1/proxy proxy:write, body ProxyRequestInput
  • POST /v1/proxy/operations/authorize-replacement no sign-in, body ReplacementAuthorizationInput
  • POST /v1/proxy/operations/get proxy:read, body ProxyOperationLookupInput
  • POST /v1/proxy/operations/reconcile no sign-in, body HumanOperationLookupInput
  • GET /v1/proxy/usage proxy:read

scan

Explained in Scan.

  • POST /v1/scan scan:write, body ScanRequestInput
  • GET /v1/scan/usage scan:read

security-events

Explained in Security Events.

  • GET /v1/security-events security-events:read
  • GET /v1/security-events/{id} security-events:read
  • POST /v1/security-events/{id}/resolve security-events:write

services

Explained in Services.

  • GET /v1/services services:read
  • PATCH /v1/services/{id} services:write, body RenameConnectionBody
  • POST /v1/services/{id}/allowed-hosts services:write, body AllowedHostsBody
  • DELETE /v1/services/{id}/disconnect services:write
  • POST /v1/services/{id}/proxy-toggle services:write, body ProxyToggleBody
  • GET /v1/services/{id}/requirements services:read
  • POST /v1/services/{id}/requirements services:write, body SetServiceRequirementInput
  • PUT /v1/services/{id}/requirements services:write, body ReplaceServiceRequirementBody
  • DELETE /v1/services/{id}/requirements/{reqId} services:write
  • POST /v1/services/{id}/verify services:write
  • DELETE /v1/services/agents/{agentId}/revoke services:write
  • GET /v1/services/configurations services:read
  • DELETE /v1/services/configurations/{provider} services:write
  • POST /v1/services/configure services:write, body ConfigureBody
  • POST /v1/services/connect services:connect, body ConnectServiceBody
  • POST /v1/services/connect-application services:connect, body ConnectApplicationBody
  • GET /v1/services/connect-links services:read
  • POST /v1/services/connect-links services:write, body CreateConnectLinkInput
  • GET /v1/services/connect-links/{id} services:read
  • GET /v1/services/connected services:read
  • POST /v1/services/custom services:connect
  • POST /v1/services/grant services:write, body GrantAgentAccessInput
  • GET /v1/services/templates services:read

skill-requests

  • GET /v1/skill-requests skills:read, query status, limit, offset
  • POST /v1/skill-requests skills:write, body PostSkillRequestInput
  • GET /v1/skill-requests/{id} skills:read
  • PATCH /v1/skill-requests/{id} skills:write, body UpdateSkillRequestBody
  • GET /v1/skill-requests/{id}/matches skills:read
  • GET /v1/skill-requests/{id}/suggest skills:read

skills

Explained in Skills.

  • GET /v1/skills skills:read, query status, trust_level, tags, search, limit, offset
  • POST /v1/skills skills:publish, body PublishSkillInput
  • GET /v1/skills/{id} skills:read
  • PATCH /v1/skills/{id} skills:publish, body UpdateSkillInput
  • POST /v1/skills/{id}/activate skills:publish
  • POST /v1/skills/{id}/check-trust skills:read
  • POST /v1/skills/{id}/favorite skills:write
  • DELETE /v1/skills/{id}/favorite skills:write
  • POST /v1/skills/{id}/invoke skills:invoke, body InvokeBody
  • POST /v1/skills/{id}/rate skills:write, body RateSkillInput
  • GET /v1/skills/{id}/ratings skills:read
  • POST /v1/skills/{id}/suspend skills:publish
  • GET /v1/skills/favorites skills:read
  • GET /v1/skills/invocations/{id} skills:invoke
  • POST /v1/skills/invocations/{id}/claim skills:invoke
  • POST /v1/skills/invocations/{id}/complete skills:invoke
  • POST /v1/skills/invocations/{id}/fail skills:invoke
  • GET /v1/skills/invocations/mine skills:invoke
  • GET /v1/skills/invocations/pending skills:invoke, query skill_id
  • GET /v1/skills/mine skills:read

team

Explained in Team.

  • POST /v1/team/invites/accept no sign-in
  • GET /v1/team/members team:read
  • POST /v1/team/members team:write, body InviteMemberInput
  • PATCH /v1/team/members/{id} team:write, body UpdateMemberInput
  • DELETE /v1/team/members/{id} team:write
  • POST /v1/team/sso-bindings/clear team:write, body ClearSsoBindingsInput

trust

  • GET /v1/trust accounts:manage
  • PUT /v1/trust accounts:manage, body SetTrustInput

usage

Explained in Usage.

  • GET /v1/usage billing:read, query since, until

wake

Explained in Wake-ups, Calendar and Meetings.

  • GET /v1/wake/rules accounts:manage
  • POST /v1/wake/rules accounts:manage, body SetWakeRuleInput
  • PUT /v1/wake/rules/{ruleId} accounts:manage, body SetWakeRuleInput
  • DELETE /v1/wake/rules/{ruleId} accounts:manage
  • GET /v1/wake/settings accounts:manage
  • PUT /v1/wake/settings accounts:manage, body SetWakeSettingsInput

website

  • PUT /v1/website/uploads/{token} no sign-in

websites

  • POST /v1/websites/suspend-all accounts:manage, body SiteSuspendInput

well-known

  • GET /.well-known/agent.json no sign-in
  • GET /.well-known/http-message-signatures-directory no sign-in
  • GET /.well-known/oauth-authorization-server no sign-in
  • GET /v1/.well-known/jwks.json no sign-in

workload

  • POST /v1/workload/passport no sign-in, body WorkloadPassportBody
  • POST /v1/workload/wit no sign-in, body WorkloadPassportBody

workspace

  • GET /v1/workspace/settings accounts:manage
  • PUT /v1/workspace/settings accounts:manage, body SetWorkspaceSettingsInput

workspaces

  • GET /v1/workspaces accounts:read
Every Route | Docs