AutoGPT Agent Server API
The AutoGPT Platform's own backend API — 293 paths, 347 operations and 458 schemas covering graphs, executions, schedules, the library, the agent marketplace, credits and billing, organizations, workspaces, experts, copilot chat, OAuth applications, API keys and integrations. AutoGPT publishes this OpenAPI openly at backend.agpt.co/openapi.json but does not document it for third parties; the External API is the supported surface. Recorded here because it is published, parses, and is where the OAuth authorization server, the API-key management surface and the credit wallet actually live.
AutoGPT Agent Server API is one of 2 APIs that AutoGPT publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include AI Automation, Agent Execution, and Platform API. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 347 operations across 293 paths, organized into 13 resource areas, and defines 458 schemas. It is described by OpenAPI 3.1.0, at version 0.1.
Requests are made against the base URL https://backend.agpt.co.
347 operations
293 paths
458 schemas
29 DELETE176 GET18 PATCH120 POST4 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
AutoGPT Agent Server API declares
3 security schemes
for authenticating requests.
An API key is passed in the header as X-Postmark-Webhook-Token (APIKeyAuthenticator-X-Postmark-Webhook-Token).
It accepts HTTP bearer tokens (HTTPBearer).
It accepts HTTP bearer tokens (jwt) (HTTPBearerJWT).
Paths & Operations 347
Across 293 paths, the API surfaces 347 operations — 29 DELETE, 176 GET, 18 PATCH, 120 POST, 4 PUT. They span 13 resource areas, including v2, analytics, v1, auth-email, briefings, Operations, home, oauth, and 5 more. Each is listed below with its method, path, parameters, and response codes.
v2 208
GET
/api/admin/blocks/cost-estimates
Export Block Cost Estimates
GET
/api/admin/bot-analytics/command-usage
Command Usage Breakdown
GET
/api/admin/bot-analytics/guilds
Bot Server Roster
GET
/api/admin/bot-analytics/server-timeseries
Bot Server-Count Timeseries (sharding curve)
GET
/api/admin/bot-analytics/summary
Bot Usage Summary
GET
/api/admin/bot-analytics/timeseries
Bot Message Timeseries
GET
/api/admin/bot-analytics/top-servers
Top Servers by Activity
GET
/api/admin/diagnostics/agents
Get Agent Diagnostics
GET
/api/admin/diagnostics/executions
Get Execution Diagnostics
POST
/api/admin/diagnostics/executions/cleanup-all-orphaned
Cleanup ALL Orphaned Executions
POST
/api/admin/diagnostics/executions/cleanup-all-stuck-queued
Cleanup ALL Stuck Queued Executions
POST
/api/admin/diagnostics/executions/cleanup-orphaned
Cleanup Orphaned Executions
GET
/api/admin/diagnostics/executions/failed
List Failed Executions
GET
/api/admin/diagnostics/executions/invalid
List Invalid Executions
GET
/api/admin/diagnostics/executions/long-running
List Long-Running Executions
GET
/api/admin/diagnostics/executions/orphaned
List Orphaned Executions
POST
/api/admin/diagnostics/executions/requeue
Requeue Stuck Execution
POST
/api/admin/diagnostics/executions/requeue-all-stuck
Requeue ALL Stuck Queued Executions
POST
/api/admin/diagnostics/executions/requeue-bulk
Requeue Multiple Stuck Executions
GET
/api/admin/diagnostics/executions/running
List Running Executions
POST
/api/admin/diagnostics/executions/stop
Stop Single Execution
POST
/api/admin/diagnostics/executions/stop-all-long-running
Stop ALL Long-Running Executions
POST
/api/admin/diagnostics/executions/stop-bulk
Stop Multiple Executions
GET
/api/admin/diagnostics/executions/stuck-queued
List Stuck Queued Executions
GET
/api/admin/diagnostics/schedules
Get Schedule Diagnostics
GET
/api/admin/diagnostics/schedules/all
List All User Schedules
POST
/api/admin/diagnostics/schedules/cleanup-orphaned
Cleanup Orphaned Schedules
GET
/api/admin/diagnostics/schedules/orphaned
List Orphaned Schedules
GET
/api/admin/memory/{user_id}/communities
List Communities
POST
/api/admin/memory/{user_id}/communities/rebuild
Rebuild Communities
GET
/api/admin/memory/{user_id}/communities/rebuild/{job_id}
Get Community Rebuild Status
POST
/api/admin/memory/{user_id}/dream
Trigger Dream Pass
GET
/api/admin/memory/{user_id}/dream/{job_id}
Get Dream Pass Status
GET
/api/admin/memory/{user_id}/entities
List Entities
GET
/api/admin/memory/{user_id}/experts/{expert_id}/communities
List Expert Communities
GET
/api/admin/memory/{user_id}/experts/{expert_id}/entities
List Expert Entities
GET
/api/admin/memory/{user_id}/experts/{expert_id}/facts
List Expert Facts
GET
/api/admin/memory/{user_id}/experts/{expert_id}/graph
Get Expert Graph
GET
/api/admin/memory/{user_id}/experts/{expert_id}/overview
Get Expert Memory Overview
GET
/api/admin/memory/{user_id}/facts
List Facts
GET
/api/admin/memory/{user_id}/graph
Get Graph
POST
/api/admin/memory/{user_id}/nightly
Trigger Nightly Batch
GET
/api/admin/memory/{user_id}/nightly/{job_id}
Get Nightly Batch Status
GET
/api/admin/memory/{user_id}/overview
Get Memory Overview
POST
/api/admin/memory/{user_id}/ratification
Trigger Ratification Pass
GET
/api/admin/platform-costs/dashboard
Get Platform Cost Dashboard
GET
/api/admin/platform-costs/logs
Get Platform Cost Logs
GET
/api/admin/platform-costs/logs/export
Export Platform Cost Logs
GET
/api/builder/blocks
Get Builder blocks
GET
/api/builder/blocks/batch
Get specific blocks
GET
/api/builder/categories
Get Builder block categories
GET
/api/builder/counts
Get Builder item counts
GET
/api/builder/providers
Get Builder integration providers
GET
/api/builder/search
Builder search
GET
/api/builder/suggestions
Get Builder suggestions
GET
/api/chat/config/ttl
Get Ttl Config
GET
/api/chat/health
Health Check
GET
/api/chat/schema/tool-responses
[Dummy] Tool response type export for codegen
GET
/api/chat/sessions
List Sessions
POST
/api/chat/sessions
Create Session
DELETE
/api/chat/sessions/{session_id}
Delete Session
GET
/api/chat/sessions/{session_id}
Get Session
PATCH
/api/chat/sessions/{session_id}/assign-user
Session Assign User
POST
/api/chat/sessions/{session_id}/cancel
Cancel Session Task
GET
/api/chat/sessions/{session_id}/messages/pending
Get Pending Messages
POST
/api/chat/sessions/{session_id}/messages/pending
Queue Pending Message
PATCH
/api/chat/sessions/{session_id}/pinned
Update session pinned
DELETE
/api/chat/sessions/{session_id}/share
Disable Chat Sharing
POST
/api/chat/sessions/{session_id}/share
Enable Chat Sharing
GET
/api/chat/sessions/{session_id}/share/state
Get Chat Share State
DELETE
/api/chat/sessions/{session_id}/stream
Disconnect Session Stream
GET
/api/chat/sessions/{session_id}/stream
Resume Session Stream
POST
/api/chat/sessions/{session_id}/stream
Stream Chat Post
PATCH
/api/chat/sessions/{session_id}/title
Update session title
GET
/api/chat/suggested-prompts
Get Suggested Prompts
GET
/api/chat/transports
List Chat Transports
GET
/api/chat/usage
Get Copilot Usage
POST
/api/chat/usage/reset
Reset Copilot Usage
GET
/api/copilot/admin/rate_limit
Get User Rate Limit
POST
/api/copilot/admin/rate_limit/reset
Reset User Rate Limit Usage
GET
/api/copilot/admin/rate_limit/search_users
Search Users by Name or Email
GET
/api/copilot/admin/rate_limit/tier
Get User Rate Limit Tier
POST
/api/copilot/admin/rate_limit/tier
Set User Rate Limit Tier
POST
/api/credits/admin/add_credits
Add Credits to User
GET
/api/credits/admin/copilot-usage/export
Export Copilot Weekly Usage vs Rate Limit
GET
/api/credits/admin/transactions/export
Export Credit Transactions
GET
/api/credits/admin/users_history
Get All Users History
GET
/api/executions/admin/execution_accuracy_trends
Get Execution Accuracy Trends and Alerts
POST
/api/executions/admin/execution_analytics
Generate Execution Analytics
GET
/api/executions/admin/execution_analytics/config
Get Execution Analytics Configuration
GET
/api/experts
List Experts
POST
/api/experts
Hire Expert
GET
/api/experts/identities
List Expert Identities
GET
/api/experts/pods
List Expert Pods
POST
/api/experts/pods
Create Expert Pod
POST
/api/experts/raise
Create Raised Expert
GET
/api/experts/templates
List Expert Templates
DELETE
/api/experts/{expert_id}
Archive Expert
GET
/api/experts/{expert_id}
Get Expert
GET
/api/experts/{expert_id}/detach-preview
Get Expert Detach Preview
PATCH
/api/experts/{expert_id}/pod
Assign Expert Pod
GET
/api/experts/{expert_id}/runs
List Expert Runs
POST
/api/experts/{expert_id}/schedules/resume
Resume Expert Schedules
PATCH
/api/experts/{expert_id}/soul
Update Expert Soul
POST
/api/experts/{expert_id}/workflows
Install Expert Workflow
GET
/api/invitations/pending
List pending invitations for current user
POST
/api/invitations/{token}/accept
Accept invitation
POST
/api/invitations/{token}/decline
Decline invitation
GET
/api/library/agents
List Library Agents
POST
/api/library/agents
Add Marketplace Agent
GET
/api/library/agents/by-graph/{graph_id}
Get Library Agent By Graph Id
GET
/api/library/agents/favorites
List Favorite Library Agents
GET
/api/library/agents/marketplace/{store_listing_version_id}
Get Agent By Store ID
DELETE
/api/library/agents/{library_agent_id}
Delete Library Agent
GET
/api/library/agents/{library_agent_id}
Get Library Agent
PATCH
/api/library/agents/{library_agent_id}
Update Library Agent
POST
/api/library/agents/{library_agent_id}/fork
Fork Library Agent
GET
/api/library/agents/{library_agent_id}/triggers
List Trigger Agents
GET
/api/library/folders
List Library Folders
POST
/api/library/folders
Create Folder
POST
/api/library/folders/agents/bulk-move
Bulk Move Agents
GET
/api/library/folders/tree
Get Folder Tree
DELETE
/api/library/folders/{folder_id}
Delete Folder
GET
/api/library/folders/{folder_id}
Get Folder
PATCH
/api/library/folders/{folder_id}
Update Folder
POST
/api/library/folders/{folder_id}/move
Move Folder
GET
/api/library/presets
List presets
POST
/api/library/presets
Create a new preset
POST
/api/library/presets/setup-trigger
Setup Trigger
DELETE
/api/library/presets/{preset_id}
Delete a preset
GET
/api/library/presets/{preset_id}
Get a specific preset
PATCH
/api/library/presets/{preset_id}
Update an existing preset
POST
/api/library/presets/{preset_id}/execute
Execute a preset
POST
/api/mcp/discover-tools
Discover available tools on an MCP server
POST
/api/mcp/oauth/callback
Exchange OAuth code for MCP tokens
POST
/api/mcp/oauth/login
Initiate OAuth login for an MCP server
POST
/api/mcp/token
Store a bearer token for an MCP server
DELETE
/api/memory
Erase My Memory
DELETE
/api/memory/experts/{expert_id}
Erase My Expert Memory
GET
/api/memory/experts/{expert_id}/facts
List My Expert Memory Facts
DELETE
/api/memory/experts/{expert_id}/facts/{fact_uuid}
Forget My Expert Memory Fact
GET
/api/memory/experts/{expert_id}/overview
Get My Expert Memory Overview
GET
/api/memory/facts
List My Memory Facts
DELETE
/api/memory/facts/{fact_uuid}
Forget My Memory Fact
GET
/api/memory/overview
Get My Memory Overview
GET
/api/orgs
List user organizations
POST
/api/orgs
Create organization
DELETE
/api/orgs/{org_id}
Delete organization
GET
/api/orgs/{org_id}
Get organization details
PATCH
/api/orgs/{org_id}
Update organization
GET
/api/orgs/{org_id}/aliases
List organization aliases
POST
/api/orgs/{org_id}/aliases
Create organization alias
POST
/api/orgs/{org_id}/convert
Convert personal org to team org
GET
/api/orgs/{org_id}/invitations
List pending invitations
POST
/api/orgs/{org_id}/invitations
Create invitation
DELETE
/api/orgs/{org_id}/invitations/{invitation_id}
Revoke invitation
GET
/api/orgs/{org_id}/members
List organization members
POST
/api/orgs/{org_id}/members
Add member to organization
DELETE
/api/orgs/{org_id}/members/{uid}
Remove member from organization
PATCH
/api/orgs/{org_id}/members/{uid}
Update member role
POST
/api/orgs/{org_id}/transfer-ownership
Transfer organization ownership
GET
/api/orgs/{org_id}/workspaces
List workspaces
POST
/api/orgs/{org_id}/workspaces
Create workspace
DELETE
/api/orgs/{org_id}/workspaces/{ws_id}
Delete workspace
GET
/api/orgs/{org_id}/workspaces/{ws_id}
Get workspace details
PATCH
/api/orgs/{org_id}/workspaces/{ws_id}
Update workspace
POST
/api/orgs/{org_id}/workspaces/{ws_id}/join
Self-join open workspace
POST
/api/orgs/{org_id}/workspaces/{ws_id}/leave
Leave workspace
GET
/api/orgs/{org_id}/workspaces/{ws_id}/members
List workspace members
POST
/api/orgs/{org_id}/workspaces/{ws_id}/members
Add member to workspace
DELETE
/api/orgs/{org_id}/workspaces/{ws_id}/members/{uid}
Remove member from workspace
PATCH
/api/orgs/{org_id}/workspaces/{ws_id}/members/{uid}
Update workspace member role
POST
/api/otto/ask
Proxy Otto Chat Request
GET
/api/public/shared/chats/{share_token}
Get Shared Chat
GET
/api/public/shared/chats/{share_token}/files/{file_id}/download
Download a file from a shared chat
GET
/api/public/shared/chats/{share_token}/messages
Get Shared Chat Messages
POST
/api/review/action
Process Review Action
GET
/api/review/execution/{graph_exec_id}
Get Pending Reviews for Execution
GET
/api/review/pending
Get Pending Reviews
GET
/api/store/admin/listings
Get Admin Listings History
GET
/api/store/admin/submissions/download/{store_listing_version_id}
Admin Download Agent File
POST
/api/store/admin/submissions/{store_listing_version_id}/add-to-library
Admin Add Pending Agent to Library
GET
/api/store/admin/submissions/{store_listing_version_id}/preview
Admin Preview Submission Listing
POST
/api/store/admin/submissions/{store_listing_version_id}/review
Review Store Submission
GET
/api/store/agents
List store agents
GET
/api/store/agents/{username}/{agent_name}
Get specific agent
POST
/api/store/agents/{username}/{agent_name}/review
Create agent review
GET
/api/store/creators
List store creators
GET
/api/store/creators/{username}
Get creator details
GET
/api/store/listings/versions/{store_listing_version_id}
Get agent by version
GET
/api/store/listings/versions/{store_listing_version_id}/graph
Get agent graph
GET
/api/store/listings/versions/{store_listing_version_id}/graph/download
Download agent file
GET
/api/store/metrics/cache
Get cache metrics in Prometheus format
GET
/api/store/my-unpublished-agents
Get my agents
GET
/api/store/profile
Get user profile
POST
/api/store/profile
Update user profile
GET
/api/store/search
Unified search across all content types
GET
/api/store/submissions
List my submissions
POST
/api/store/submissions
Create store submission
POST
/api/store/submissions/generate_image
Generate submission image
POST
/api/store/submissions/media
Upload submission media
PUT
/api/store/submissions/{store_listing_version_id}
Edit store submission
DELETE
/api/store/submissions/{submission_id}
Delete store submission
GET
/api/transfers
List transfers for active organization
POST
/api/transfers
Create transfer request
POST
/api/transfers/{transfer_id}/approve
Approve transfer request
POST
/api/transfers/{transfer_id}/execute
Execute approved transfer
POST
/api/transfers/{transfer_id}/reject
Reject transfer request
analytics 2
POST
/api/analytics/log_raw_analytics
Log Raw Analytics
POST
/api/analytics/log_raw_metric
Log Raw Metric
v1 95
GET
/api/api-keys
List user API keys
POST
/api/api-keys
Create new API key
DELETE
/api/api-keys/{key_id}
Revoke API key
GET
/api/api-keys/{key_id}
Get specific API key
PUT
/api/api-keys/{key_id}/permissions
Update key permissions
POST
/api/api-keys/{key_id}/suspend
Suspend API key
POST
/api/auth/user
Get or create user
POST
/api/auth/user/email
Update user email
GET
/api/auth/user/preferences
Get notification preferences
POST
/api/auth/user/preferences
Update notification preferences
POST
/api/auth/user/preferences/from-email
Apply a volume-knob choice from a Briefing footer link
GET
/api/auth/user/timezone
Get user timezone
POST
/api/auth/user/timezone
Update user timezone
GET
/api/blocks
List available blocks
POST
/api/blocks/{block_id}/execute
Execute graph block
GET
/api/credits
Get user credits
PATCH
/api/credits
Fulfill checkout session
POST
/api/credits
Request credit top up
GET
/api/credits/auto-top-up
Get auto top up
POST
/api/credits/auto-top-up
Configure auto top up
GET
/api/credits/invoices
List Stripe invoices
GET
/api/credits/manage
Manage payment methods
GET
/api/credits/refunds
Get refund requests
POST
/api/credits/stripe_webhook
Handle Stripe webhooks
GET
/api/credits/subscription
Get subscription tier, current cost, and all tier costs
POST
/api/credits/subscription
Update subscription tier or start a Stripe Checkout session
GET
/api/credits/transactions
Get credit history
POST
/api/credits/{transaction_key}/refund
Refund credit transaction
POST
/api/email/
Handle Postmark Email Webhooks
POST
/api/email/unsubscribe
One Click Email Unsubscribe
GET
/api/executions
List all executions
GET
/api/executions/cost-summary
User cost summary
DELETE
/api/executions/{graph_exec_id}
Delete graph execution
POST
/api/files/upload
Upload file to cloud storage
GET
/api/graphs
List user graphs
POST
/api/graphs
Create new graph
DELETE
/api/graphs/{graph_id}
Delete graph permanently
GET
/api/graphs/{graph_id}
Get specific graph
PUT
/api/graphs/{graph_id}
Update graph version
POST
/api/graphs/{graph_id}/execute/{graph_version}
Execute graph agent
GET
/api/graphs/{graph_id}/executions
List graph executions
GET
/api/graphs/{graph_id}/executions/{graph_exec_id}
Get execution details
DELETE
/api/graphs/{graph_id}/executions/{graph_exec_id}/share
Disable Execution Sharing
POST
/api/graphs/{graph_id}/executions/{graph_exec_id}/share
Enable Execution Sharing
POST
/api/graphs/{graph_id}/executions/{graph_exec_id}/stop
Stop graph execution
GET
/api/graphs/{graph_id}/schedules
List execution schedules for a graph
POST
/api/graphs/{graph_id}/schedules
Create execution schedule
PATCH
/api/graphs/{graph_id}/settings
Update graph settings
GET
/api/graphs/{graph_id}/versions
Get all graph versions
PUT
/api/graphs/{graph_id}/versions/active
Set active graph version
GET
/api/graphs/{graph_id}/versions/{version}
Get graph version
GET
/api/integrations/ayrshare/sso_url
Get Ayrshare Sso Url
GET
/api/integrations/codex/credentials/{credential_id}/account
Codex Account
GET
/api/integrations/codex/credentials/{credential_id}/rate-limits
Codex Rate Limits
GET
/api/integrations/credentials
List Credentials
GET
/api/integrations/providers
List Providers
GET
/api/integrations/providers/constants
Get Provider Constants
GET
/api/integrations/providers/enum-example
Get Provider Enum Example
GET
/api/integrations/providers/names
Get Provider Names
GET
/api/integrations/providers/system
List System Providers
POST
/api/integrations/webhooks/{webhook_id}/ping
Webhook Ping
POST
/api/integrations/{provider}/callback
Exchange OAuth code for tokens
GET
/api/integrations/{provider}/credentials
List Credentials By Provider
POST
/api/integrations/{provider}/credentials
Create Credentials
DELETE
/api/integrations/{provider}/credentials/{cred_id}
Delete Credentials
GET
/api/integrations/{provider}/credentials/{cred_id}
Get Specific Credential By ID
POST
/api/integrations/{provider}/credentials/{cred_id}/picker-token
Issue a short-lived access token for a provider-hosted picker
POST
/api/integrations/{provider}/device-auth/initiate
Initiate device code OAuth flow
POST
/api/integrations/{provider}/device-auth/poll
Poll device code OAuth flow for completion
GET
/api/integrations/{provider}/login
Initiate OAuth flow
POST
/api/integrations/{provider}/webhooks/{webhook_id}/ingress
Webhook Ingress Generic
GET
/api/onboarding
Onboarding state
PATCH
/api/onboarding
Update onboarding state
GET
/api/onboarding/agents
Recommended onboarding agents
DELETE
/api/onboarding/brain-dump
Discard Brain Dump
POST
/api/onboarding/brain-dump/finalize
Finalize Brain Dump
GET
/api/onboarding/brain-dump/intro
Get Brain Dump Intro
POST
/api/onboarding/brain-dump/intro/complete
Complete Brain Dump Greeting
POST
/api/onboarding/brain-dump/parts
Upload Brain Dump Part
GET
/api/onboarding/brain-dump/recommended-providers
Get Brain Dump Recommended Providers
GET
/api/onboarding/brain-dump/recording
Download Brain Dump Recording
GET
/api/onboarding/brain-dump/status
Get Brain Dump Status
GET
/api/onboarding/completed
Check if onboarding is completed
POST
/api/onboarding/profile
Submit onboarding profile
POST
/api/onboarding/reset
Reset onboarding progress
POST
/api/onboarding/step
Complete onboarding step
GET
/api/public/shared/{share_token}
Get Shared Execution
GET
/api/public/shared/{share_token}/files/{file_id}/download
Download a file from a shared execution
GET
/api/schedules
List execution schedules for a user
GET
/api/schedules/followups
List copilot follow-up schedules for a user
DELETE
/api/schedules/{schedule_id}
Delete execution schedule
GET
/api/skills
List user-distilled copilot skills
POST
/api/skills
Upload a copilot skill from a SKILL.md file
DELETE
/api/skills/{name}
Delete a user-distilled copilot skill
GET
/api/skills/{name}
Read a single copilot skill with its full SKILL.md body
auth-email 1
POST
/api/auth/email/send
Send a Better Auth transactional email via the backend mailer
briefings 1
GET
/api/briefings/latest
Get Latest Briefing
Operations 6
POST
/api/copilot-webhooks/slack/commands
Handle Command Request
POST
/api/copilot-webhooks/slack/events
Handle Event Request
GET
/api/copilot-webhooks/slack/install
Handle Install
GET
/api/copilot-webhooks/slack/oauth/callback
Callback
POST
/api/copilot-webhooks/teams/messages
Handle Messages Request
POST
/api/copilot-webhooks/telegram/updates
Handle Update Request
home 1
GET
/api/home
Get Home Dashboard
oauth 9
GET
/api/oauth/app/{client_id}
Get Oauth App Info
GET
/api/oauth/apps/mine
List My Oauth Apps
PATCH
/api/oauth/apps/{app_id}/logo
Update App Logo
POST
/api/oauth/apps/{app_id}/logo/upload
Upload App Logo
PATCH
/api/oauth/apps/{app_id}/status
Update App Status
POST
/api/oauth/authorize
Authorize
POST
/api/oauth/introspect
Introspect
POST
/api/oauth/revoke
Revoke
POST
/api/oauth/token
Token
platform-linking 8
GET
/api/platform-linking/links
List all platform servers linked to the authenticated user
DELETE
/api/platform-linking/links/{link_id}
Unlink a platform server
GET
/api/platform-linking/platforms
List bot platforms enabled on this deployment plus the caller's links
POST
/api/platform-linking/tokens/{token}/confirm
Confirm a SERVER link token (user must be authenticated)
GET
/api/platform-linking/tokens/{token}/info
Get display info for a link token
GET
/api/platform-linking/user-links
List all DM links for the authenticated user
DELETE
/api/platform-linking/user-links/{link_id}
Unlink a DM / user link
POST
/api/platform-linking/user-tokens/{token}/confirm
Confirm a USER link token (user must be authenticated)
push 3
POST
/api/push/subscribe
Register a push subscription for the current user
POST
/api/push/unsubscribe
Remove a push subscription
GET
/api/push/vapid-key
Get VAPID public key for push subscription
search 1
GET
/api/search/global
Global search
workspace 11
GET
/api/workspace/files
List workspace files
POST
/api/workspace/files/upload
Upload file to workspace
DELETE
/api/workspace/files/{file_id}
Delete a workspace file
GET
/api/workspace/files/{file_id}/download
Download file by ID
GET
/api/workspace/files/{file_id}/preview
Preview file by ID
GET
/api/workspace/folders
List workspace folders
POST
/api/workspace/folders
Create workspace folder
POST
/api/workspace/folders/files/bulk-move
Move workspace files to a folder
DELETE
/api/workspace/folders/{folder_id}
Delete workspace folder
PATCH
/api/workspace/folders/{folder_id}
Update workspace folder
GET
/api/workspace/storage/usage
Get workspace storage usage
health 1
GET
/health
Health
Schemas 458
The contract defines 458 schemas that model the data the API accepts and returns. The most detailed are LibraryAgent (37 properties), StoreSubmissionAdminView (25 properties), StoreSubmission (24 properties), Expert (23 properties). Each schema is shown below with its type and property counts.
APIKeyCredentials
object
8 properties
2 required
APIKeyInfo
object
16 properties
8 required
APIKeyPermission
string
APIKeyStatus
string
AccuracyAlertData
object
Alert data when accuracy drops significantly.
6 properties
6 required
AccuracyLatestData
object
Latest execution accuracy data point.
5 properties
5 required
AccuracyTrendsResponse
object
Response model for accuracy trends and alerts.
3 properties
2 required
ActiveStreamInfo
object
Information about an active stream for reconnection.
3 properties
2 required
AddMemberRequest
object
3 properties
1 required
AddTeamMemberRequest
object
3 properties
1 required
AddUserCreditsResponse
object
2 properties
2 required
AgentDetails
object
Detailed agent information.
8 properties
3 required
AgentDetailsResponse
object
Response for getdetails action.
7 properties
2 required
AgentDiagnosticsResponse
object
Response model for agent diagnostics
2 properties
2 required
AgentExecutionStatus
string
AgentInfo
object
Information about an agent.
22 properties
4 required
AgentOutputResponse
object
Response for agentoutput tool.
10 properties
3 required
AgentPreviewResponse
object
Response for previewing a generated agent before saving.
8 properties
5 required
AgentSavedResponse
object
Response when an agent is saved to the library.
9 properties
6 required
AgentsFoundResponse
object
Response for findagent tool.
7 properties
3 required
ApiResponse
object
3 properties
3 required
AssignPodRequest
object
1 property
1 required
AuthEmailRequest
object
3 properties
3 required
AuthorizeRequest
object
OAuth 2.0 authorization request
7 properties
5 required
AuthorizeResponse
object
OAuth 2.0 authorization response with redirect URL
1 property
1 required
AutoTopUpConfig
object
2 properties
2 required
AyrshareSSOResponse
object
2 properties
2 required
BaseGraph-Input
object
Graph with nodes, links, and computed I/O schema fields. Used to represent sub-graphs within a Graph. Contains the full graph structure including nodes and lin…
11 properties
2 required
BaseGraph-Output
object
Graph with nodes, links, and computed I/O schema fields. Used to represent sub-graphs within a Graph. Contains the full graph structure including nodes and lin…
17 properties
8 required
BlockCategoryResponse
object
3 properties
3 required
BlockCost
object
5 properties
3 required
BlockCostEstimateRow
object
7 properties
7 required
BlockCostEstimatesResponse
object
6 properties
6 required
BlockCostType
string
BlockDetails
object
Detailed block information.
6 properties
3 required
BlockDetailsResponse
object
Response for block details (first runblock attempt).
5 properties
2 required
BlockInfo
object
10 properties
10 required
BlockInfoSummary
object
Summary of a block for search results.
9 properties
4 required
BlockInputFieldInfo
object
Information about a block input field.
5 properties
2 required
BlockListResponse
object
Response for findblock tool.
7 properties
4 required
BlockOutputResponse
object
Response for runblock tool.
9 properties
4 required
BlockResponse
object
2 properties
2 required
Body_patchOauthUpdateAppStatus
object
1 property
1 required
Body_postAnalyticsLogRawAnalytics
object
3 properties
3 required
Body_postOauthIntrospect
object
4 properties
3 required
Body_postOauthRevoke
object
4 properties
3 required
Body_postOauthUploadAppLogo
object
1 property
1 required
Body_postV1Exchange_oauth_code_for_tokens
object
2 properties
2 required
Body_postV1Execute_graph_agent
object
4 properties
Body_postV1Upload_file_to_cloud_storage
object
1 property
1 required
Body_postV2Add_credits_to_user
object
3 properties
3 required
Body_postV2Add_marketplace_agent
object
2 properties
1 required
Body_postV2Execute_a_preset
object
2 properties
Body_postV2Reset_user_rate_limit_usage
object
2 properties
1 required
Body_postV2Upload_submission_media
object
1 property
1 required
Body_uploadWorkspaceFile
object
1 property
1 required
Body_upload_brain_dump_part
object
3 properties
3 required
BotAnalyticsSummary
object
9 properties
9 required
BotCommandUsage
object
3 properties
3 required
BotGuildInfo
object
6 properties
6 required
BotPlatformInfo
object
A bot platform enabled on this deployment plus the caller's links to it. Platforms whose adapter isn't configured (missing token/credentials) are omitted from…
8 properties
3 required
BotServerActivity
object
5 properties
5 required
BotServerCountPoint
object
2 properties
2 required
BotTimeseriesPoint
object
4 properties
4 required
BrainDumpInputMode
string
BrainDumpStatus
string
BriefingContent
object
9 properties
5 required
BriefingDecisionItem
object
7 properties
7 required
BriefingFrequency
string
BriefingResponse
object
5 properties
5 required
BriefingRunItem
object
16 properties
10 required
BulkMoveAgentsRequest
object
Request model for moving multiple agents to a folder.
2 properties
1 required
BulkMoveFilesRequest
object
2 properties
1 required
CancelSessionResponse
object
Response model for the cancel session endpoint.
2 properties
1 required
ChangelogEntry
object
3 properties
3 required
ChatRequest
object
5 properties
3 required
ChatSessionMetadata
object
Typed metadata stored in the metadata JSON column of ChatSession. Add new session-level flags here instead of adding DB columns — no migration required for new…
12 properties
ChatShareStateResponse
object
Surfaces the chat's current share state so the modal can open in the right mode (share-vs-revoke) without an extra round-trip. The three counts power the conse…
6 properties
ChatTransportResponse
object
5 properties
5 required
ChatTransportsResponse
object
1 property
1 required
ClarificationNeededResponse
object
Response when the LLM needs more information from the user.
4 properties
1 required
ClarifyingQuestion
object
A question that needs user clarification.
4 properties
2 required
CoPilotUsagePublic
object
Current usage status for a user — public (client-safe) shape.
4 properties
CodexAccountSnapshot
object
5 properties
2 required
CodexRateLimitWindow
object
3 properties
1 required
CodexRateLimitsSnapshot
object
9 properties
CommunityListResponse
object
2 properties
2 required
CommunityRebuildJobStatus
object
JobStatus envelope for kind="rebuild".
11 properties
6 required
CommunitySummary
object
4 properties
1 required
ConfirmLinkRequest
object
Optional confirm payload. telegramauth carries the signed identity Telegram appends when the user reached this page via a loginurl button — when present it mus…
1 property
ConfirmLinkResponse
object
6 properties
4 required
ConfirmUserLinkResponse
object
5 properties
3 required
ContentType
string
CopilotSkillDetail
object
Full SKILL.md content surfaced to the library expand-to-view UI.
7 properties
3 required
CopilotSkillInfo
object
User-distilled copilot skill metadata for the library UI. Defaults (built-in agent-building / MCP-tool guides) are intentionally excluded — they cannot be edit…
3 properties
2 required
CopilotTurnJobInfo
object
17 properties
5 required
CopilotUsageExportResponse
object
4 properties
4 required
CopilotWeeklyUsageRow
object
8 properties
7 required
CostBucket
object
2 properties
2 required
CostLogRow
object
18 properties
4 required
CountResponse
object
7 properties
7 required
CreateAPIKeyRequest
object
3 properties
2 required
CreateAPIKeyResponse
object
2 properties
2 required
CreateAliasRequest
object
1 property
1 required
CreateGraph
object
2 properties
1 required
CreateInvitationRequest
object
4 properties
1 required
CreateOrgRequest
object
3 properties
2 required
CreatePodRequest
object
1 property
1 required
CreateRaisedExpertRequest
object
8 properties
1 required
CreateSessionRequest
object
Request model for creating (or get-or-creating) a chat session. Two modes, selected by the body: - Default: create a fresh session. dryrun is a top-level field…
6 properties
CreateSessionResponse
object
Response model containing information on a newly created chat session.
5 properties
3 required
CreateTeamRequest
object
3 properties
1 required
CreateTransferRequest
object
4 properties
3 required
CreatorDetails
object
Marketplace creator profile details, including aggregated stats
10 properties
10 required
CreatorsResponse
object
2 properties
2 required
CredentialsDeletionNeedsConfirmationResponse
object
3 properties
1 required
CredentialsDeletionResponse
object
2 properties
1 required
CredentialsMetaInput
object
4 properties
3 required
CredentialsMetaResponse
object
8 properties
6 required
CreditTransactionItem
object
10 properties
1 required
CreditTransactionType
string
CreditTransactionsExportResponse
object
4 properties
4 required
DecompositionStepModel
object
A single step in a decomposed agent-building plan.
5 properties
3 required
DeleteFileResponse
object
1 property
1 required
DeleteGraphResponse
object
1 property
1 required
DeleteLinkResponse
object
1 property
1 required
DemotionSummary
object
One line per demoted RELATESTO edge.
4 properties
3 required
DeviceAuthInitiateResponse
object
6 properties
5 required
DeviceAuthPollRequest
object
1 property
1 required
DeviceAuthPollResponse
object
2 properties
1 required
DiscoverToolsRequest
object
Request to discover tools on an MCP server.
2 properties
1 required
DiscoverToolsResponse
object
Response containing the list of tools available on an MCP server.
3 properties
1 required
DocPageResponse
object
Response for getdocpage tool.
7 properties
4 required
DocSearchResult
object
A single documentation search result.
6 properties
5 required
DocSearchResultsResponse
object
Response for searchdocs tool.
6 properties
4 required
Document
object
2 properties
2 required
DreamJobStatus
object
JobStatus envelope for kind="dreampass".
11 properties
6 required
DreamOperationsSnapshot
object
Detailed per-operation rollup of a single dream pass. Shape used by three downstream consumers: 1. The admin memory-visualizer UI (renders the per-edge detail)…
4 properties
DreamPassResult
object
Return value of executedreampass and the admin API. Mirrors RebuildResponse from the community-rebuild endpoint so the admin frontend can render both with the…
18 properties
2 required
DreamPassUsage
object
Aggregate usage across all phases of one dream pass. Surfaced on DreamPassResult.usage so eval / admin UI / billing can read tokens + cost without recomputing.…
7 properties
DumpStatusResponse
object
5 properties
EnableShareRequest
object
Whether to auto-link every runagent execution in this chat. When true, the backend creates ChatLinkedShare rows for every existing agent run AND auto-links any…
1 property
EntityInvalidationSummary
object
Per-entity invalidation rollup.
3 properties
2 required
EntityListResponse
object
2 properties
2 required
EntitySummary
object
3 properties
2 required
EraseMemoryResponse
object
Result of a scope wipe. deletednodes counts every node removed — entities, episodes (raw text included), and communities.
3 properties
2 required
ErrorResponse
object
Response for errors.
6 properties
1 required
ExecutionAnalyticsConfig
object
4 properties
4 required
ExecutionAnalyticsRequest
object
9 properties
1 required
ExecutionAnalyticsResponse
object
6 properties
6 required
ExecutionAnalyticsResult
object
10 properties
7 required
ExecutionDiagnosticsResponse
object
Response model for execution diagnostics
20 properties
20 required
ExecutionFailureReason
string
Structured reasons for terminal graph execution failures.
ExecutionOptions
object
Available execution options for an agent.
3 properties
ExecutionOutputInfo
object
Summary of a single execution's outputs.
8 properties
3 required
ExecutionStartedResponse
object
Response for run/schedule actions.
10 properties
4 required
Expert
object
23 properties
15 required
ExpertDetachPreview
object
What archiving the expert would pause — drives the confirm dialog.
2 properties
2 required
ExpertIdentity
object
5 properties
5 required
ExpertPod
object
A named group of hired experts, scoped to the owner.
3 properties
3 required
ExpertRun
object
One expert-attributed execution, for the /team Work surface.
11 properties
11 required
ExpertSoulUpdate
object
4 properties
4 required
ExpertSoulUpdatedResponse
object
Response for the two-step Soul edit tools. Carries the diff so the model must surface exactly what changed. applied is False for the updateexpertsoul preview (…
6 properties
1 required
ExpertWorkflowRef
object
8 properties
6 required
FactListResponse
object
2 properties
2 required
FactSummary
object
10 properties
3 required
FailedExecutionDetail
object
Details about a failed execution for admin view
11 properties
11 required
FailedExecutionsListResponse
object
Response model for list of failed executions
2 properties
2 required
FinalizeRequest
object
Finalize one take. text is the typed fallback: when set, no audio is expected and the dump is stored with inputmode=typed. inputmode=skipped records the delibe…
5 properties
1 required
FinalizeResponse
object
4 properties
2 required
FolderCreateRequest
object
Request model for creating a folder.
4 properties
1 required
FolderListResponse
object
Response schema for a list of folders.
2 properties
2 required
FolderMoveRequest
object
Request model for moving a folder to a new parent.
1 property
FolderTreeResponse
object
Response schema for folder tree structure.
1 property
1 required
FolderUpdateRequest
object
Request model for updating a folder.
3 properties
ForgetFactResponse
object
2 properties
2 required
GlobalSearchResponse
object
Top-N hits bucketed by item type. For a non-empty query this contains hybrid-search results. For an empty query this contains the most-recently-updated items p…
3 properties
Graph
object
Creatable graph model used in API create/update endpoints.
12 properties
2 required
GraphEdge
object
An edge in the visualizer graph payload.
8 properties
4 required
GraphExecution
object
19 properties
11 required
GraphExecutionJobInfo
object
16 properties
8 required
GraphExecutionMeta
object
18 properties
10 required
GraphExecutionWithNodes
object
20 properties
12 required
GraphExecutionsPaginated
object
Response schema for paginated graph executions.
2 properties
2 required
GraphMeta
object
Lightweight graph metadata model representing an existing graph from the database, for use in listings and summaries. Lacks GraphModel's nodes, links, and expe…
13 properties
6 required
GraphModel
object
Full graph model representing an existing graph from the database. This is the primary model for working with persisted graphs. Includes all graph data (nodes,…
23 properties
11 required
GraphModelWithoutNodes
object
GraphModel variant that excludes nodes, links, and sub-graphs from serialization. Used in contexts like the store where exposing internal graph structure is no…
20 properties
11 required
GraphNode
object
A node in the visualizer graph payload. label is the primary FalkorDB label (Entity / Episodic / Community); type (if present) is the more-specific custom enti…
5 properties
2 required
GraphResponse
object
6 properties
4 required
GraphSettings
object
3 properties
GraphTriggerInfo
object
3 properties
3 required
GreetingDoneResponse
object
1 property
1 required
HTTPValidationError
object
1 property
HireRequest
object
2 properties
1 required
HireResult
object
2 properties
2 required
HomeAction
object
2 properties
2 required
HomeActiveTask
object
6 properties
3 required
HomeAgentStatus
object
5 properties
3 required
HomeAttentionItem
object
13 properties
7 required
HomeBriefing
object
8 properties
6 required
HomeBriefingOutcome
object
10 properties
5 required
HomeDailyActivity
object
4 properties
4 required
HomeDashboardResponse
object
9 properties
9 required
HomeExpert
object
4 properties
4 required
HomeTeamSummary
object
5 properties
4 required
HomeUpcomingTask
object
5 properties
4 required
HomeWeekSummary
object
9 properties
9 required
HostScopedCredentials
object
8 properties
2 required
ImageURLResponse
object
1 property
1 required
IngestionDrainStatus
string
Fate of a dream pass's enqueued graph writes at the moment the pass was reported complete. Three distinct states, so consumers (and a future Memory Visualizer)…
InputValidationErrorResponse
object
Response when runagent receives unknown input fields.
7 properties
3 required
InstallWorkflowRequest
object
1 property
1 required
IntroCardResponse
object
Content for the copilot home's onboarding greeting. path is "A" when we have something to reflect back and "B" when the greeting's job is to invite a recording…
6 properties
2 required
InvitationCreateResponse
object
Extended response returned only from POST /invitations -- includes the token.
8 properties
8 required
InvitationResponse
object
7 properties
7 required
InvoiceListItem
object
A single invoice surfaced from Stripe for the billing UI. Mirrors the subset of stripe.Invoice we expose to the client. hostedinvoiceurl opens the Stripe-hoste…
10 properties
5 required
JobTriggerResponse
object
202 response from a fire-and-forget admin trigger. Frontend captures jobid and polls GET .../{jobid} for progress. state is always "queued" at this point — the…
5 properties
5 required
LibraryAgent
object
Represents an agent in the library, including metadata for display and user interaction within the system.
37 properties
21 required
LibraryAgentPreset
object
Represents a preset configuration for a library agent.
16 properties
11 required
LibraryAgentPresetCreatable
object
Request model used when creating a new preset for a library agent. A preset's webhook is never caller-specified here; webhook-triggered presets are created thr…
7 properties
6 required
LibraryAgentPresetCreatableFromGraphExecution
object
Request model used when creating a new preset for a library agent.
4 properties
3 required
LibraryAgentPresetResponse
object
Response schema for a list of agent presets and pagination info.
2 properties
2 required
LibraryAgentPresetUpdatable
object
Request model used when updating a preset for a library agent.
5 properties
LibraryAgentResponse
object
Response schema for a list of library agents and pagination info.
2 properties
2 required
LibraryAgentSort
string
Possible sort options for sorting library agents.
LibraryAgentStatus
string
LibraryAgentUpdateRequest
object
Schema for updating a library agent via PUT. Includes flags for auto-updating version, marking as favorite, archiving, or deleting.
7 properties
LibraryFolder
object
Represents a folder for organizing library agents.
10 properties
5 required
LibraryFolderTree
object
Folder with nested children for tree view.
11 properties
5 required
Link
object
6 properties
4 required
LinkTokenInfoResponse
object
4 properties
2 required
LinkType
string
ListFilesResponse
object
3 properties
1 required
ListSessionsResponse
object
Response model for listing chat sessions.
2 properties
2 required
LogRawMetricRequest
object
3 properties
3 required
LoginResponse
object
3 properties
2 required
MCPOAuthCallbackRequest
object
Request to exchange an OAuth code for tokens.
2 properties
2 required
MCPOAuthLoginRequest
object
Request to start an OAuth flow for an MCP server.
1 property
1 required
MCPOAuthLoginResponse
object
Response with the OAuth login URL for the user to authenticate.
2 properties
2 required
MCPStoreTokenRequest
object
Request to store a bearer token for an MCP server that doesn't support OAuth.
2 properties
2 required
MCPToolInfo
object
Information about a single MCP tool discovered from a server.
4 properties
2 required
MCPToolOutputResponse
object
Response after executing an MCP tool.
7 properties
3 required
MCPToolResponse
object
A single MCP tool returned by discovery.
3 properties
3 required
MCPToolsDiscoveredResponse
object
Response when MCP tools are discovered from a server (agent-internal).
5 properties
3 required
MarketplaceListing
object
Marketplace listing information for a library agent.
4 properties
4 required
MarketplaceListingCreator
object
Creator information for a marketplace listing.
3 properties
3 required
MemoryFact
object
One live fact edge, as shown in the recent-memories list.
6 properties
3 required
MemoryFactListResponse
object
2 properties
1 required
MemoryForgetCandidatesResponse
object
Response with candidate memories to forget.
4 properties
1 required
MemoryForgetConfirmResponse
object
Response after deleting specific memory edges.
6 properties
1 required
MemoryForgetFailure
object
One edge that could not be deleted, with an actionable reason. Surfaced so the assistant (and user) can tell why a delete failed — e.g. the edge was not found…
3 properties
3 required
MemoryForgetFailureCode
string
Stable, machine-switchable reason a forget delete failed. The frontend/model can branch on this code (retry vs. give up) without parsing the free-text reason.…
MemoryOverview
object
Counts surfaced in the visualizer's header strip.
8 properties
7 required
MemoryScopeOverview
object
Counts for one memory scope, shown on the settings page and in the erase-confirmation dialog.
4 properties
3 required
MemorySearchResponse
object
Response when memories are searched.
5 properties
1 required
MemoryStoreResponse
object
Response when a memory is stored.
4 properties
2 required
Message
object
2 properties
2 required
ModelInfo
object
3 properties
3 required
MyAgentsSortBy
string
MyUnpublishedAgent
object
7 properties
5 required
MyUnpublishedAgentsResponse
object
2 properties
2 required
NeedLoginResponse
object
Response when login is needed.
4 properties
1 required
NightlyBatchResult
object
Structured outcome of one nightly-batch-submit pass. Surfaced via the scheduler wrapper + admin endpoint so we can audit "what fired tonight for this user" wit…
11 properties
3 required
NightlyJobStatus
object
JobStatus envelope for kind="nightly".
11 properties
6 required
NoResultsResponse
object
Response when no agents found.
5 properties
1 required
Node
object
6 properties
1 required
NodeExecutionResult
object
14 properties
14 required
NodeFailureSummary
object
3 properties
3 required
NodeModel
object
9 properties
3 required
NotificationPreference
object
The volume knob from the Briefing footer, not a checkbox list. Billing and account messages are service mail and are not represented here — they are sent regar…
6 properties
2 required
NotificationPreferenceDTO
object
5 properties
4 required
OAuth2Credentials
object
15 properties
3 required
OAuthApplicationInfo
object
OAuth application information (without client secret hash)
12 properties
10 required
OAuthApplicationPublicInfo
object
Public information about an OAuth application (for consent screen)
4 properties
2 required
OnboardingProfileRequest
object
Request body for onboarding profile submission.
3 properties
2 required
OnboardingStatusResponse
object
Response for onboarding completion check.
1 property
1 required
OnboardingStep
string
Application-level onboarding step identifiers.
OrgAliasResponse
object
4 properties
4 required
OrgMemberResponse
object
8 properties
8 required
OrgResponse
object
8 properties
8 required
OrphanedScheduleDetail
object
Details about an orphaned schedule
8 properties
8 required
OrphanedSchedulesListResponse
object
Response model for list of orphaned schedules
2 properties
2 required
Pagination
object
4 properties
4 required
PeekPendingMessagesResponse
object
Response for the pending-message peek (GET) endpoint. Returns a read-only view of the pending buffer — messages are NOT consumed. The frontend uses this to res…
2 properties
2 required
PendingHumanReviewModel
object
Response model for pending human review data. Represents a human review request that is awaiting user action. Contains all necessary information for a user to…
22 properties
9 required
PendingInstallInfo
object
The caller added the bot to a server but hasn't linked an account yet. openboturl deep-links into the bot's chat on the platform, where the next step (the bot'…
2 properties
1 required
PendingQuestion
object
The last unanswered question a session asked the user.
2 properties
2 required
PhaseUsage
object
Per-phase token + cost telemetry.
7 properties
2 required
PickerTokenResponse
object
Short-lived OAuth access token shipped to the browser for rendering a provider-hosted picker UI (e.g. Google Drive Picker). Deliberately narrow: only the field…
2 properties
1 required
Platform
string
Mirror of the Prisma PlatformType enum.
PlatformCostDashboard
object
15 properties
5 required
PlatformCostExportResponse
object
3 properties
3 required
PlatformCostLogsResponse
object
2 properties
2 required
PlatformLinkInfo
object
6 properties
6 required
PlatformUserLinkInfo
object
5 properties
5 required
PostmarkBounceEnum
integer
PostmarkBounceWebhook
object
20 properties
19 required
PostmarkClickWebhook
object
14 properties
13 required
PostmarkDeliveryWebhook
object
9 properties
8 required
PostmarkOpenWebhook
object
14 properties
13 required
PostmarkSpamComplaintWebhook
object
20 properties
19 required
PostmarkSubscriptionChangeWebhook
object
11 properties
10 required
PresetDeletedResponse
object
Response confirming a preset was deleted.
5 properties
3 required
PresetListResponse
object
Response listing the user's presets.
7 properties
5 required
PresetSummary
object
Summary of a single preset (saved run config / webhook trigger).
9 properties
5 required
PresetUpdatedResponse
object
Response confirming a preset was updated.
7 properties
4 required
Profile
object
Marketplace user profile (only attributes that the user can update)
5 properties
5 required
ProfileDetails
object
Marketplace user profile (including read-only fields)
6 properties
6 required
Provider
object
3 properties
3 required
ProviderConstants
object
Model that exposes all provider names as a constant in the OpenAPI schema. This is designed to be converted by Orval into a TypeScript constant.
1 property
ProviderCostSummary
object
11 properties
5 required
ProviderEnumResponse
object
Response containing a provider from the enum.
1 property
1 required
ProviderMetadata
object
Display metadata for a provider, shown in the settings integrations UI.
3 properties
1 required
ProviderNamesResponse
object
Response containing list of all provider names.
1 property
ProviderResponse
object
2 properties
2 required
PushSubscribeRequest
object
3 properties
2 required
PushSubscriptionKeys
object
2 properties
2 required
PushUnsubscribeRequest
object
1 property
1 required
QueuePendingMessageRequest
object
Request model for queueing a follow-up while a turn is running.
3 properties
1 required
QueuePendingMessageResponse
object
Response returned when a message is queued because the session already has a turn in flight. - bufferlength: how many messages are now in the session's pending…
3 properties
3 required
RaiseAttachment
object
One workflow or skill to attach while raising an expert. id is a store listing version UUID (marketplace), a library agent UUID (library workflow), or a copilo…
3 properties
3 required
RaiseAttachmentFailure
object
4 properties
4 required
RaiseResult
object
Result of raising a blank expert. Attachments are validated before the expert row is created. A later install failure is non-fatal and listed in failedattachme…
2 properties
1 required
RateLimitResetResponse
object
Response from resetting the daily rate limit.
4 properties
4 required
RatificationResult
object
Structured outcome of a single ratification pass. Surfaced via the scheduler wrapper so admin / future metrics can read promotion vs. supersession counts witho…
10 properties
2 required
RebuildResult
object
Typed envelope around rebuildcommunitiesforuser's return dict. Lives here (admin routes) rather than in copilot/graphiti/communities.py because the dict-return…
10 properties
1 required
RecentExecution
object
Summary of a recent execution for quality assessment. Used by the LLM to understand the agent's recent performance with specific examples rather than just aggr…
3 properties
1 required
RecommendedProvider
object
One provider Claude picked from the transcript. provider is a registry id (validated against the live provider list before storage); reason is the one-liner sh…
2 properties
1 required
RecommendedProvidersResponse
object
Recommendations for the "Connect your tools" panel. ready is false while the background job is still running — the client keeps polling. Once true, providers i…
2 properties
1 required
RefundRequest
object
9 properties
8 required
RequestTopUp
object
1 property
1 required
RequeueExecutionResponse
object
Response model for requeue execution operations
3 properties
2 required
ResponseType
string
Types of tool responses.
ReviewItem
object
Single review item for processing.
5 properties
2 required
ReviewRequest
object
Request model for processing ALL pending reviews for an execution. This request must include ALL pending reviews for a graph execution. Each review will be eit…
1 property
1 required
ReviewResponse
object
Response from review endpoint.
4 properties
3 required
ReviewStatus
string
ReviewSubmissionRequest
object
4 properties
3 required
RunningExecutionDetail
object
Details about a running execution for admin view
10 properties
9 required
RunningExecutionsListResponse
object
Response model for list of running executions
2 properties
2 required
ScheduleCleanupRequest
object
Request model for cleaning up schedules
1 property
1 required
ScheduleCleanupResponse
object
Response model for schedule cleanup operations
3 properties
2 required
ScheduleCreationRequest
object
7 properties
3 required
ScheduleDeletedResponse
object
Response confirming a schedule was deleted.
4 properties
2 required
ScheduleDetail
object
Details about a schedule for admin view
11 properties
10 required
ScheduleHealthMetrics
object
Summary of schedule health diagnostics
13 properties
13 required
ScheduleListResponse
object
Response containing a list of schedules.
4 properties
2 required
ScheduleSummary
object
Summary of a single schedule (either a graph run or copilot turn).
11 properties
5 required
SchedulesListResponse
object
Response model for list of schedules
2 properties
2 required
SearchEntry
object
4 properties
SearchResponse
object
4 properties
4 required
SearchResultItem
object
One row in a /search/global bucket. Kept intentionally generic so the frontend can render all three buckets through a single component. Type-specific details l…
7 properties
3 required
SessionDetailResponse
object
Response model providing complete details for a chat session, including messages.
13 properties
5 required
SessionSummaryResponse
object
Response model for a session summary (without messages).
9 properties
4 required
SetActiveGraphVersionResponse
object
Response for activating an existing graph version. Carries any webhook presets that were left pinned to their old version because the newly activated version's…
1 property
SetGraphActiveVersion
object
1 property
1 required
SetUserTierRequest
object
2 properties
2 required
SetupInfo
object
Complete setup information.
4 properties
2 required
SetupRequirementsResponse
object
Response for validate action.
6 properties
2 required
ShareRequest
object
Optional request body for share endpoint.
SharedChatLinkedExecution
object
Drill-in pointer for an AgentGraphExecution shared alongside a chat.
4 properties
4 required
SharedChatMessage
object
Public-safe projection of a single chat message.
9 properties
9 required
SharedChatMessagesPage
object
Paginated message window for the public viewer.
3 properties
3 required
SharedChatSession
object
Public-safe projection of a chat session (header only).
6 properties
6 required
SharedExecutionResponse
object
Public-safe response for shared executions
6 properties
6 required
SkippedWebhookPreset
object
A webhook preset that was left pinned to its old version because the newly activated version swaps or reconfigures the trigger block. The user needs to reconfi…
3 properties
3 required
SoulFieldChange
object
One field's before/after values for an expert soul edit.
3 properties
3 required
Stats
object
11 properties
StopExecutionRequest
object
Request model for stopping a single execution
1 property
1 required
StopExecutionResponse
object
Response model for stop execution operations
3 properties
2 required
StopExecutionsRequest
object
Request model for stopping multiple executions
1 property
1 required
StorageUsageResponse
object
4 properties
4 required
StoreAgent
object
10 properties
10 required
StoreAgentDetails
object
23 properties
19 required
StoreAgentsResponse
object
2 properties
2 required
StoreAgentsSortOptions
string
StoreCreatorsSortOptions
string
StoreListingWithVersionsAdminView
object
A store listing with its version history
8 properties
3 required
StoreListingsWithVersionsAdminViewResponse
object
Response model for listings with version history
2 properties
2 required
StoreReview
object
2 properties
1 required
StoreReviewCreate
object
3 properties
2 required
StoreSubmission
object
24 properties
18 required
StoreSubmissionAdminView
object
25 properties
19 required
StoreSubmissionEditRequest
object
10 properties
2 required
StoreSubmissionRequest
object
13 properties
5 required
StoreSubmissionsResponse
object
3 properties
3 required
StreamChatRequest
object
Request model for streaming chat with optional context.
8 properties
1 required
SubmissionStats
object
Creator-wide aggregates over a user's non-deleted submissions. Computed server-side so values stay accurate regardless of pagination — summing client-side over…
5 properties
5 required
SubmissionStatus
string
SubscriptionStatusResponse
object
13 properties
4 required
SubscriptionTier
string
Subscription tiers with increasing cost allowances. Mirrors the SubscriptionTier enum in schema.prisma. Once prisma generate is run, this can be replaced with:…
SubscriptionTierRequest
object
4 properties
1 required
SuggestedGoalResponse
object
Response when the goal needs refinement with a suggested alternative.
7 properties
2 required
SuggestedPrompt
object
One pickable prompt under the greeting. title is the short line the user sees; prompt is the full message that gets sent when they pick it. icon is a Phosphor…
3 properties
2 required
SuggestedPromptsResponse
object
Response model for user-specific suggested prompts grouped by theme.
1 property
1 required
SuggestedTheme
object
A themed group of suggested prompts.
2 properties
2 required
SuggestionsResponse
object
3 properties
3 required
TaskDecompositionResponse
object
Response for decomposegoal tool — shows the plan to the user.
6 properties
3 required
TeamMemberResponse
object
7 properties
7 required
TeamResponse
object
9 properties
9 required
TimezoneResponse
object
1 property
1 required
TodoItem
object
One entry in a TodoWrite checklist. Mirrors the schema used by Claude Code's built-in TodoWrite tool so the frontend's GenericTool accordion renders baseline-e…
3 properties
2 required
TodoWriteResponse
object
Ack returned by TodoWrite. The tool is effectively stateless — the authoritative task list lives in the assistant's latest tool-call arguments, which are repla…
4 properties
1 required
TokenIntrospectionResult
object
Result of token introspection (RFC 7662)
6 properties
1 required
TokenRateDisplay
object
Public per-1M-token USD rates surfaced to the builder UI. Populated only on LLM block costs whose model has a TOKENCOST rate. cache fields are set only when th…
4 properties
2 required
TokenRequestByCode
object
6 properties
6 required
TokenRequestByRefreshToken
object
4 properties
4 required
TokenResponse
object
OAuth 2.0 token response
6 properties
5 required
TransactionHistory
object
2 properties
2 required
TransferOwnershipRequest
object
1 property
1 required
TransferResponse
object
12 properties
12 required
TriggeredPresetSetupRequest
object
6 properties
4 required
UnderstandingUpdatedResponse
object
Response for addunderstanding tool.
5 properties
1 required
UnifiedSearchResponse
object
Response model for unified search across all content types.
2 properties
2 required
UnifiedSearchResult
object
A single result from unified hybrid search across all content types.
8 properties
3 required
UpdateAppLogoRequest
object
1 property
1 required
UpdateGraphResponse
object
Response for creating/activating a new graph version. Carries the new graph version plus any webhook presets that were left pinned to their old version because…
2 properties
1 required
UpdateMemberRequest
object
2 properties
UpdateOrgRequest
object
4 properties
UpdatePermissionsRequest
object
1 property
1 required
UpdateSessionPinnedRequest
object
Request model for pinning/unpinning a session.
1 property
1 required
UpdateSessionTitleRequest
object
Request model for updating a session's title.
1 property
1 required
UpdateTeamMemberRequest
object
2 properties
UpdateTeamRequest
object
3 properties
UpdateTimezoneRequest
object
1 property
1 required
UploadCopilotSkillRequest
object
Body for the library UI's "upload skill" action. Carries the raw SKILL.md text (YAML frontmatter + markdown body) the user picked from disk; the server parses…
1 property
1 required
UploadPartResponse
object
4 properties
4 required
UsageWindowPublic
object
Public view of a usage window — only the percentage and reset time. Hides the raw spend and the cap so clients cannot derive per-turn cost or reverse-engineer…
2 properties
2 required
UserAgentCostRollup
object
3 properties
3 required
UserCostSummary
object
9 properties
4 required
UserDailyCost
object
6 properties
3 required
UserExecutionCostSummary
object
13 properties
7 required
UserExpertCostRollup
object
3 properties
3 required
UserHistoryResponse
object
Response model for listings with version history
2 properties
2 required
UserOnboarding
object
14 properties
14 required
UserOnboardingUpdate
object
8 properties
UserPasswordCredentials
object
8 properties
3 required
UserRateLimitResponse
object
8 properties
6 required
UserReadiness
object
User readiness status.
3 properties
UserSearchResult
object
2 properties
1 required
UserTierResponse
object
2 properties
2 required
UserTopRun
object
7 properties
7 required
UserTransaction
object
16 properties
1 required
ValidationError
object
5 properties
3 required
VapidPublicKeyResponse
object
1 property
1 required
VoiceSample
object
A short writing sample in a persona's own voice, offered as a pick in the hire or raise flow. The first sample is choice "a", the second choice "b".
2 properties
2 required
Webhook
object
13 properties
9 required
WorkspaceFile
object
Pydantic model for UserWorkspaceFile, safe for RPC transport.
14 properties
9 required
WorkspaceFileItem
object
9 properties
7 required
WorkspaceFolder
object
Pydantic model for UserWorkspaceFolder, safe for RPC transport.
7 properties
5 required
WorkspaceFolderCreateRequest
object
2 properties
1 required
WorkspaceFolderListResponse
object
1 property
1 required
WorkspaceFolderUpdateRequest
object
2 properties
WriteSummary
object
One line per envelope written by apply.py. Carries the durable Graphiti edge uuid so the eval / admin UI / the future inline chat-stream dream.operations event…
7 properties
1 required
backend__api__features__chat__share__ShareResponse
object
2 properties
2 required
backend__api__features__v1__ShareResponse
object
Response from share endpoints.
2 properties
2 required
backend__api__features__workspace__routes__UploadFileResponse
object
5 properties
5 required
backend__api__model__UploadFileResponse
object
5 properties
5 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from AutoGPT 1
Other APIs AutoGPT publishes across the network.
AutoGPT External API
#AI Automation#Agent Execution#Platform API
Where this information came from
This is an independent, third-party profile of AutoGPT Agent Server API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.