Skip to content
OpenBot

Overview

OpenBot API 0.1.0

Section titled “OpenBot API 0.1.0”

Headless REST API for OpenBot. To authenticate, send Authorization: Bearer <user token>. Create tokens at /v1/user/tokens. Every call needs a permission from a role or policy. Browser clients on the same origin can use the session Cookie instead. Then every write must send the exact public Origin.

This reference is made from the same contract that the server and the TypeScript client use, so it always matches the running OpenBot. Download the OpenAPI document to use it with your own tools, such as a code generator. Every OpenBot also serves it at /openapi.json. See Authentication and Permissions.

Information

  • OpenAPI version: 3.1.0

Operations

Section titled “Operations”
GET
/auth/session
GET
/v1/user/tokens
POST
/v1/user/tokens
DELETE
/v1/user/tokens/{tokenId}
GET
/v1/tokens/verify
GET
/v1/organization
PATCH
/v1/organization
GET
/v1/organization/members
GET
/v1/organization/members/{userId}
DELETE
/v1/organization/members/{userId}
PATCH
/v1/organization/members/{userId}
GET
/v1/organization/permission_groups
GET
/v1/organization/roles
GET
/v1/organization/audit_logs
GET
/v1/agents
POST
/v1/agents
GET
/v1/agents/{agentId}
PATCH
/v1/agents/{agentId}
POST
/v1/agents/{agentId}/promote
GET
/v1/agents/{agentId}/memory
POST
/v1/agents/{agentId}/memory
GET
/v1/agents/{agentId}/memory/log
GET
/v1/agents/{agentId}/rules
POST
/v1/agents/{agentId}/rules
PATCH
/v1/agents/{agentId}/rules/{ruleId}
GET
/v1/agents/{agentId}/grants
POST
/v1/agents/{agentId}/grants
DELETE
/v1/agents/{agentId}/grants/{grantId}
GET
/v1/sessions/{sessionId}/versions
GET
/v1/sessions
POST
/v1/sessions
GET
/v1/sessions/{sessionId}/turns
POST
/v1/sessions/{sessionId}/turns
GET
/v1/sessions/{sessionId}
DELETE
/v1/sessions/{sessionId}
PATCH
/v1/sessions/{sessionId}
PUT
/v1/sessions/{sessionId}/mode
GET
/v1/sessions/{sessionId}/models
PUT
/v1/sessions/{sessionId}/model
GET
/v1/sessions/{sessionId}/memory
POST
/v1/sessions/{sessionId}/memory
POST
/v1/sessions/{sessionId}/fork
GET
/v1/sessions/{sessionId}/history
GET
/v1/sessions/{sessionId}/record
PUT
/v1/sessions/{sessionId}/record
GET
/v1/sessions/{sessionId}/wait
POST
/v1/sessions/{sessionId}/resume
PUT
/v1/sessions/{sessionId}/settings
GET
/v1/sessions/{sessionId}/turns/{turnId}
GET
/v1/sessions/{sessionId}/turns/{turnId}/items
POST
/v1/sessions/{sessionId}/turns/{turnId}/steer
POST
/v1/sessions/{sessionId}/queue
GET
/v1/sessions/{sessionId}/delegations
POST
/v1/sessions/{sessionId}/turns/{turnId}/interrupt
GET
/v1/requests
GET
/v1/requests/{requestId}
POST
/v1/requests/{requestId}
POST
/v1/apps/discover
POST
/v1/connections/manual
PUT
/v1/connections/{connectionId}/manual
POST
/v1/connections/{connectionId}/verify
POST
/v1/connections/{connectionId}/refresh
POST
/v1/connections/{connectionId}/revalidate
GET
/v1/connections
POST
/v1/connections
POST
/v1/connection-drafts
GET
/v1/connection-drafts/{draftId}
GET
/v1/connections/{connectionId}
PUT
/v1/connections/{connectionId}
DELETE
/v1/connections/{connectionId}
POST
/v1/connections/{connectionId}/authorization
DELETE
/v1/connections/{connectionId}/authorization
GET
/v1/app-authorizations/{flowId}
POST
/v1/app-authorizations/{flowId}/complete
GET
/v1/apps/client-metadata
GET
/auth/apps/callback
GET
/v1/app-operations/{id}
GET
/v1/sessions/{sessionId}/app-operations
POST
/v1/app-operations/{id}/inputs
POST
/v1/app-operations/{operationId}/view
GET
/v1/app-views/{viewId}
DELETE
/v1/app-views/{viewId}
POST
/v1/app-views/{viewId}/read
POST
/v1/app-views/{viewId}/actions
GET
/v1/app-views/{viewId}/actions/{requestId}
PUT
/v1/app-views/{viewId}/context
GET
/v1/app-operations/{operationId}/interaction
POST
/v1/app-views/{viewId}/messages
GET
/v1/app-experience/export
POST
/v1/app-experience/import
POST
/v1/app-experience/reset
GET
/v1/app-index/sources
GET
/v1/app-index/apps
GET
/v1/app-index/app
GET
/v1/developer/personal-reports
GET
/v1/developer/notifications
POST
/v1/developer/notifications/{id}/read
GET
/v1/developer/subscriptions
PUT
/v1/developer/subscriptions
GET
/v1/developer/indexing
POST
/v1/developer/indexing
GET
/v1/developer/indexing/{id}
GET
/v1/developer/tests
POST
/v1/developer/tests
GET
/v1/developer/tests/{id}
DELETE
/v1/developer/tests/{id}
PUT
/v1/developer/tests/{id}/configuration
POST
/v1/developer/tests/{id}/run
POST
/v1/developer/tests/{id}/cancel
POST
/v1/developer/tests/{id}/cleanup
POST
/v1/developer/tests/{id}/authorization
POST
/v1/developer/tests/{id}/authorization/complete
GET
/v1/developer
POST
/v1/developer/claims
GET
/v1/developer/claims/{id}
POST
/v1/developer/claims/{id}/verify
POST
/v1/developer/claims/{id}/revoke
POST
/v1/developer/proofs/{id}/verify
POST
/v1/developer/proofs/{id}/relinquish
GET
/v1/developer/proofs/{id}/members
POST
/v1/developer/proofs/{id}/invitations
GET
/v1/developer/invitations/{id}
POST
/v1/developer/invitations/{id}/accept
POST
/v1/developer/invitations/{id}/revoke
PUT
/v1/developer/members/{id}
DELETE
/v1/developer/members/{id}
GET
/v1/developer/reports
POST
/v1/developer/reports
GET
/v1/developer/reports/{id}
DELETE
/v1/developer/reports/{id}
GET
/v1/developer/reports/{id}/compare
GET
/auth/developer/apps/callback
POST
/v1/developer/inspect
GET
/
GET
/health

Authentication

Section titled “Authentication”

token

Section titled “token”

Security scheme type: http

session

Section titled “session”

Security scheme type: apiKey

Cookie parameter name: __Host-openbot-session