Reference

API reference

159 endpoints across 35 resources. Pick a resource for full request and response shapes, or scan the table below.

All endpoints

DELETE/api/account/avatarSession only
POST/api/account/avatarSession only
GET/api/account/avatar/:userIdAPI key or session
GET/api/activityAPI key or session
GET/api/admin/agentsAdmin
GET/api/admin/billingAdmin
GET/api/admin/billing/:orgIdAdmin
GET/api/admin/bridgeAdmin
GET/api/admin/bridge/:orgIdAdmin
GET/api/admin/calendarAdmin
GET/api/admin/contactsAdmin
GET/api/admin/creditsAdmin
POST/api/admin/creditsAdmin
GET/api/admin/domainsAdmin
GET/api/admin/drawAdmin
GET/api/admin/draw/:idAdmin
GET/api/admin/emailsAdmin
GET/api/admin/emails/:idAdmin
GET/api/admin/feedbackAdmin
GET/api/admin/feedback/:idAdmin
PATCH/api/admin/feedback/:idAdmin
GET/api/admin/feedback/screenshotAdmin
GET/api/admin/funnelAdmin
GET/api/admin/goalsAdmin
GET/api/admin/goals/:idAdmin
GET/api/admin/healthAdmin
GET/api/admin/orgsAdmin
GET/api/admin/orgs/:idAdmin
POST/api/admin/orgs/:id/restoreAdmin
POST/api/admin/orgs/purgeAdmin
GET/api/admin/referralsAdmin
GET/api/admin/referrals/:codeAdmin
GET/api/admin/runsAdmin
GET/api/admin/runs/:idAdmin
GET/api/admin/sandboxesAdmin
GET/api/admin/statsAdmin
GET/api/admin/telephonyAdmin
GET/api/admin/usersAdmin
GET/api/admin/users/:idAdmin
GET/api/agentsAPI key or session
POST/api/agentsAPI key or session
DELETE/api/agents/:idAPI key or session
GET/api/agents/:idAPI key or session
PATCH/api/agents/:idAPI key or session
GET/api/agents/:id/runsAPI key or session
POST/api/auth/agent-signupPublic
GET/api/auth/google/callbackPublic
GET/api/auth/google/startPublic
POST/api/auth/google/startPublic
DELETE/api/auth/keysAPI key or session
GET/api/auth/keysAPI key or session
POST/api/auth/keysSession only
GET/api/auth/verifyPublic
POST/api/auth/webauthn/login/optionsPublic
POST/api/auth/webauthn/login/verifyPublic
POST/api/auth/webauthn/register/optionsSession only
POST/api/auth/webauthn/register/verifySession only
POST/api/billing/webhookPublic
GET/api/browser/:sessionId/screenshotAPI key or session
GET/api/canvas/:canvasIdAPI key or session
PATCH/api/canvas/:canvasIdAPI key or session
GET/api/canvas/project/:projectIdAPI key or session
POST/api/chatAPI key or session
GET/api/chat/voice/transcribeAPI key or session
POST/api/chat/voice/transcribeAPI key or session
GET/api/chatsAPI key or session
GET/api/chats/:id/messagesAPI key or session
POST/api/chats/:id/push-requestSession only
POST/api/coding/github/reposAPI key or session
GET/api/coding/runs/:runId/diffsAPI key or session
GET/api/connectors/:slug/callbackAPI key or session
POST/api/connectors/:slug/connectAPI key or session
POST/api/connectors/:slug/disconnectAPI key or session
POST/api/connectors/telegram/connectAPI key or session
POST/api/connectors/telegram/disconnectAPI key or session
POST/api/connectors/telegram/webhook/:botIdPublic
POST/api/docs/refreshAdmin
GET/api/feedbackAPI key or session
POST/api/feedbackAPI key or session
GET/api/feedback/adminAdmin
GET/api/filesAPI key or session
POST/api/filesAPI key or session
DELETE/api/files/:idAPI key or session
GET/api/files/:idAPI key or session
PATCH/api/files/:idAPI key or session
GET/api/github/app/callbackAPI key or session
GET/api/github/app/installAPI key or session
GET/api/github/app/reposAPI key or session
GET/api/github/app/statusAPI key or session
POST/api/github/app/webhookPublic
GET/api/goalsAPI key or session
POST/api/goalsAPI key or session
GET/api/goals/:idAPI key or session
POST/api/goals/:id/cancelAPI key or session
POST/api/goals/:id/pauseAPI key or session
POST/api/goals/:id/resumeAPI key or session
POST/api/goals/:id/runAPI key or session
POST/api/goals/tickAPI key or session
GET/api/healthPublic
GET/api/health/readyPublic
GET/api/health/ready/docs-refreshPublic
GET/api/health/ready/docs-refresh/preconditionsPublic
POST/api/help/searchPublic
GET/api/img-proxyAPI key or session
GET/api/lab/runs/:runIdAPI key or session
GET/api/media-proxyAPI key or session
GET/api/modelsAPI key or session
GET/api/models/catalogAPI key or session
GET/api/notificationsAPI key or session
GET/api/notifications/prefsAPI key or session
PUT/api/notifications/prefsAPI key or session
POST/api/notifications/readAPI key or session
GET/api/onboardingAPI key or session
POST/api/onboarding/startAPI key or session
GET/api/orgsAPI key or session
POST/api/orgsAPI key or session
DELETE/api/orgs/:slug/invitations/:invitationIdAPI key or session
GET/api/orgs/:slug/invitesAPI key or session
POST/api/orgs/:slug/invitesAPI key or session
DELETE/api/orgs/:slug/invites/:idAPI key or session
POST/api/orgs/:slug/invites/acceptAPI key or session
DELETE/api/orgs/:slug/membersAPI key or session
GET/api/orgs/:slug/membersAPI key or session
PATCH/api/orgs/:slug/membersAPI key or session
POST/api/orgs/:slug/membersAPI key or session
POST/api/plugins/:slug/connectAPI key or session
DELETE/api/plugins/:slug/installAPI key or session
POST/api/plugins/:slug/installAPI key or session
POST/api/referralAPI key or session
GET/api/reposAPI key or session
POST/api/reposAPI key or session
DELETE/api/repos/:idAPI key or session
PATCH/api/repos/:idAPI key or session
POST/api/repos/:id/pushAPI key or session
GET/api/rulesAPI key or session
PATCH/api/rulesAPI key or session
POST/api/rulesAPI key or session
DELETE/api/rules/:idAPI key or session
PATCH/api/rules/:idAPI key or session
GET/api/runs/:idAPI key or session
POST/api/runs/:id/approveSession only
POST/api/runs/:id/denySession only
POST/api/runs/:id/reconcileSession only
GET/api/schedulesAPI key or session
POST/api/schedulesAPI key or session
POST/api/schedules/:id/runAPI key or session
GET/api/schedules/:id/runsAPI key or session
POST/api/schedules/tickAPI key or session
GET/api/searchAPI key or session
GET/api/sitesAPI key or session
POST/api/sitesAPI key or session
DELETE/api/sites/:siteIdAPI key or session
GET/api/sites/:siteIdAPI key or session
PATCH/api/sites/:siteIdAPI key or session
POST/api/sites/:siteId/deployAPI key or session
GET/api/sites/:siteId/previewAPI key or session
GET/api/sites/:siteId/versionsAPI key or session
POST/api/sites/:siteId/versionsAPI key or session
POST/api/webhooks/sesPublic