Skip to content
Everruns
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Get Started
Built-ins
Integrations
Tutorials
Reference
Operations
Get Started
Built-ins
Integrations
Tutorials
Reference
Operations
Event Reference
API Reference
Overview
agents
Overview
GET /v1/agents - List all active agents
POST /v1/agents - Create a new agent
POST /v1/agents/import - Import agent from file or built-in example
POST /v1/agents/preview - Preview the final agent shape with capabilities applied
GET /v1/agents/{agent_id} - Get agent by ID or name
PUT /v1/agents/{agent_id} - Create or update agent (upsert)
DELETE /v1/agents/{agent_id} - Archive agent
PATCH /v1/agents/{agent_id} - Update agent
POST /v1/agents/{agent_id}/copy - Copy an agent
GET /v1/agents/{agent_id}/export - Export agent in Markdown format with YAML front matter
GET /v1/agents/{agent_id}/stats - Get aggregate usage stats for an agent
GET /v1/agents/{agent_id}/versions - List saved agent versions
POST /v1/agents/{agent_id}/versions - Save the current agent configuration as a version
POST /v1/agents/{agent_id}/versions/default - Set the default version for an agent
GET /v1/agents/{agent_id}/versions/{from_version_id}/diff/{to_version_id} - Diff two agent versions
POST /v1/agents/{agent_id}/versions/{version_id}/fork - Create a new agent from a saved version
POST /v1/agents/{agent_id}/versions/{version_id}/rollback - Restore an agent from a saved version
sessions
Overview
GET /v1/sessions - List sessions in organization
POST /v1/sessions - Create a new session
POST /v1/sessions/chat - Get or create global chat session
GET /v1/sessions/{session_id} - Get session
DELETE /v1/sessions/{session_id} - Delete session
PATCH /v1/sessions/{session_id} - Update session
POST /v1/sessions/{session_id}/cancel - Cancel current turn
GET /v1/sessions/{session_id}/context-report - Latest context breakdown
Export session messages as a JSONL file
PUT /v1/sessions/{session_id}/pin - Pin session for current user
DELETE /v1/sessions/{session_id}/pin - Unpin session for current user
POST /v1/sessions/{session_id}/tool-results - Submit client-side tool results
messages
Overview
GET /v1/sessions/{session_id}/messages - List messages (PRIMARY data)
POST /v1/sessions/{session_id}/messages - Create message (user message triggers workflow)
voice
Overview
create_agent_voice_session
create_chat_voice_session
create_call
create_client_secret
attach_call
end_call
events
Overview
GET /v1/sessions/{session_id}/events - List events (JSON)
GET /v1/sessions/{session_id}/events/summary - one-shot debug summary
GET /v1/sessions/{session_id}/sse - Stream events (SSE notifications)
llm-providers
Overview
List all LLM providers
Create a new LLM provider
Get a specific LLM provider
Delete an LLM provider
Update an LLM provider
Sync models from an LLM provider
llm-models
Overview
List all models across all providers
Get a specific model with provider info and profile
Delete a model
Update a model
List models for a specific provider
Create a new model for a provider
capabilities
Overview
GET /v1/capabilities - List available capabilities with pagination
POST /v1/capabilities - Create a persisted declarative capability.
GET /v1/capabilities/declarative - List persisted declarative resources.
GET /v1/capabilities/declarative/config
GET /v1/capabilities/declarative/{capability_id} - Get a declarative resource.
DELETE /v1/capabilities/declarative/{capability_id} - Archive a declarative resource.
PATCH /v1/capabilities/declarative/{capability_id} - Update a declarative resource.
POST /v1/capabilities/declarative/{capability_id}/delete - Permanently delete archived resource.
GET /v1/capabilities/{capability_id} - Get a specific capability
users
Overview
GET /v1/users - List users in current organization
POST /v1/users/me/switch-org - Switch current organization
filesystem
Overview
GET /fs - Get root directory listing
POST /fs/_/copy - Copy file
GET /fs/_/download/*path - Download raw file bytes
POST /fs/_/grep - Search files
POST /fs/_/move - Move/rename file
POST /fs/_/stat - Get file or directory stat
GET /fs/*path - Get file content or directory listing
PUT /fs/*path - Update file content
POST /fs/*path - Create file or directory
DELETE /fs/*path - Delete file or directory
session-resources
Overview
List all resources registered in the session resource registry.
session-sandbox
Overview
get_sandbox
manage_sandbox
mcp-servers
Overview
GET /v1/mcp-servers - List all MCP servers
POST /v1/mcp-servers - Create a new MCP server
GET /v1/mcp-servers/{server_id} - Get MCP server by ID
DELETE /v1/mcp-servers/{server_id} - Delete MCP server
PATCH /v1/mcp-servers/{server_id} - Update MCP server
durable-schedules
Overview
GET /v1/durable/executions/:execution_id - Get execution details
GET /v1/durable/schedules - List schedules
POST /v1/durable/schedules - Create a new schedule
GET /v1/durable/schedules/:schedule_id - Get schedule details
DELETE /v1/durable/schedules/:schedule_id - Delete schedule
PATCH /v1/durable/schedules/:schedule_id - Update schedule
GET /v1/durable/schedules/:schedule_id/executions - List schedule executions
POST /v1/durable/schedules/:schedule_id/pause - Pause schedule
POST /v1/durable/schedules/:schedule_id/resume - Resume schedule
GET /v1/durable/schedules/:schedule_id/stats - Get schedule statistics
POST /v1/durable/schedules/:schedule_id/trigger - Manually trigger schedule
volumes
Overview
list_volumes
create_volume
get_volume
delete_volume
update_volume
sync_volume_now
memory_stores
Overview
list_memory_stores
create_memory_store
get_memory_store
update_memory_store
list_memories
forget_memory
knowledge_bases
Overview
list_kbs
create_kb
get_kb
delete_kb
update_kb
list_entries
create_entry
get_entry
delete_entry
update_entry
images
Overview
GET /v1/images - List images
POST /v1/images - Upload an image
GET /v1/images/{image_id} - Get image (returns binary data)
DELETE /v1/images/{image_id} - Delete an image
GET /v1/images/{image_id}/thumbnail - Get image thumbnail
session-databases
Overview
GET /v1/sessions/{session_id}/databases
POST /v1/sessions/{session_id}/databases
GET /v1/sessions/{session_id}/databases/{name}
DELETE /v1/sessions/{session_id}/databases/{name}
GET /v1/sessions/{session_id}/databases/{name}/schema
session-storage
Overview
GET /v1/sessions/{session_id}/storage/keys - List all key-value pairs
GET /v1/sessions/{session_id}/storage/secrets - List all secrets (names only)
harnesses
Overview
GET /v1/harnesses
POST /v1/harnesses
GET /v1/harnesses/config
POST /v1/harnesses/import - Adopt a harness example as a regular org-owned harness.
POST /v1/harnesses/preview
GET /v1/harnesses/{harness_id}
DELETE /v1/harnesses/{harness_id}
PATCH /v1/harnesses/{harness_id}
POST /v1/harnesses/{harness_id}/copy - Copy a harness
GET /v1/harnesses/{harness_id}/stats - Get aggregate usage stats for a harness
skills
Overview
GET /v1/skills - List all skills
POST /v1/skills - Create skill from SKILL.md
POST /v1/skills/upload - Create skill from ZIP archive
POST /v1/skills/validate - Validate SKILL.md content
GET /v1/skills/{skill_id} - Get skill by ID
DELETE /v1/skills/{skill_id} - Delete skill
PATCH /v1/skills/{skill_id} - Update skill
GET /v1/skills/{skill_id}/content - Get full skill content
payments
Overview
list_payment_accounts
create_payment_account
get_payment_account
disable_payment_account
update_payment_account
list_payment_attempts
list_payment_policies
create_payment_policy
get_payment_policy
disable_payment_policy
update_payment_policy
reporting
Overview
get_catalog
run_projector
run_query
apps
POST /v1/apps/{app_id}/a2a-channels - Add an A2A channel (returns plaintext key once).
Regenerate an A2A channel API key. Returns the new plaintext key exactly once and invalidates the previous key.
POST /v1/apps/{app_id}/a2a/{channel_id}
GET /v1/apps/{app_id}/a2a/{channel_id}/.well-known/agent-card.json
invoke_webhook
durable
GET /v1/durable/config - Durable policy results for UI gating.
harness-examples
GET /v1/harness-examples — list all available harness examples.
Organizations
GET /v1/orgs - List organizations the current user belongs to
POST /v1/orgs - Create a new organization
GET /v1/orgs/:org - Get organization details
PATCH /v1/orgs/:org - Update organization
Session Git
POST /v1/sessions/{session_id}/git/branches
DELETE /v1/sessions/{session_id}/git/branches/{name}
POST /v1/sessions/{session_id}/git/commit
GET /v1/sessions/{session_id}/git/diff
GET /v1/sessions/{session_id}/git/log
GET /v1/sessions/{session_id}/git/refs
GitHub
Select theme
Dark
Light
Auto
REST API Endpoints and Schemas
Everruns API (0.2.0)
Section titled “Everruns API (0.2.0)”
API for managing AI agents, sessions, messages, and events
License:
MIT
OpenAPI version: 3.1.0
