Getting Started
Control Plane API
- GETHealth Check
- GETReadiness Check
- GETDetailed Health Check
- GETEvent Bus Health Check
- GETList Models
- POSTCreate Model
- GETGet Default Model
- GETList Providers
- GETGet Model
- DELDelete Model
- PATCHUpdate Model
- GETList Projects
- POSTCreate Project
- GETGet Default Project
- GETGet Project
- DELDelete Project
- PATCHUpdate Project
- GETList Project Agents
- POSTAdd Agent To Project
- DELRemove Agent From Project
- GETList Project Teams
- POSTAdd Team To Project
- DELRemove Team From Project
- GETList Environments
- POSTCreate Environment
- GETGet Environment
- DELDelete Environment
- PATCHUpdate Environment
- GETGet Worker Registration Command
- GETList Task Queues
- POSTCreate Task Queue
- GETGet Task Queue
- DELDelete Task Queue
- PATCHUpdate Task Queue
- GETList Queue Workers
- GETGet Worker Registration Command
- GETList All Worker Queues
- GETList Worker Queues
- POSTCreate Worker Queue
- GETGet Worker Queue
- DELDelete Worker Queue
- PATCHUpdate Worker Queue
- GETGet Installation Script
- POSTStart Worker For Queue
- GETList Queue Workers
- GETGet Worker Queue Command
- GETGet Worker Queue Config
- POSTAcquire Update Lock
- DELRelease Update Lock
- GETGet Update Lock Status
- GETList Queue Executions
- GETGet Environment Context
- PUTUpdate Environment Context
- DELClear Environment Context
- GETGet Team Context
- PUTUpdate Team Context
- DELClear Team Context
- GETGet Context
- PUTUpdate Context
- DELClear Context
- GETResolve Context
- GETResolve Agent Context
- GETResolve Team Context
- GETList Skill Definitions
- GETGet Skill Definition
- GETList Skill Variants
- GETGet Skill Templates
- POSTValidate Skill Configuration
- GETList Skills
- POSTCreate Skill
- GETGet Skill Endpoint
- DELDelete Skill
- PATCHUpdate Skill
- GETList Entity Skills
- POSTAssociate Skill
- DELDissociate Skill
- GETResolve Agent Skills
- GETResolve Agent Toolsets Legacy
- GETResolve Team Skills
- GETResolve Team Toolsets Legacy
- GETGet Skill Types
- GETCheck Policy Enforcer Health
- GETList Policies
- POSTCreate Policy
- GETGet Policy
- PUTUpdate Policy
- DELDelete Policy
- POSTValidate Policy
- GETList Policy Associations
- POSTCreate Policy Association
- GETGet Policy Association
- DELDelete Policy Association
- PATCHUpdate Policy Association
- GETResolve Entity Policies
- POSTEvaluate Entity Policies
- POSTCheck Entity Authorization
- POSTPlan Task
- POSTPlan Task Stream
- GETPlanning Health
- GETList Agents
- POSTCreate Agent
- GETGet Agent
- DELDelete Agent
- PATCHUpdate Agent
- POSTExecute Agent
- GETList Runners
- GETGet Runner Health
- GETList Workers
- GETGet Workers For Runner
- POSTRegister Worker
- POSTWorker Heartbeat
- POSTStart Worker
- POSTWorker Heartbeat Simple
- POSTWorker Disconnect
- GETList Teams
- POSTCreate Team
- GETGet Team
- DELDelete Team
- PATCHUpdate Team
- POSTAdd Agent To Team
- DELRemove Agent From Team
- POSTExecute Team
- POSTExecute Team Stream
- GETList Workflows
- POSTCreate Workflow
- GETGet Workflow
- DELDelete Workflow
- PATCHUpdate Workflow
- POSTStart Workflow
- POSTPause Workflow
- POSTResume Workflow
- POSTCancel Workflow
- POSTComplete Workflow
- POSTCreate Execution Record
- GETList Executions
- POSTCreate Job Execution
- POSTUpdate Job Execution Status V2
- GETGet Execution
- DELDelete Execution
- PATCHUpdate Execution
- POSTSend Message To Execution
- POSTPause Execution
- POSTResume Execution
- POSTCancel Execution
- POSTCancel Workflow
- GETGet Session History
- POSTPersist Session History
- POSTMark Execution As Done
- POSTPublish Execution Event
- GETStream Execution
- GETGet Execution Transitions
- POSTOverride Execution State
- POSTUpdate Presence Heartbeat
- GETGet Agent Presence
- DELLeave Presence
- GETList Jobs
- POSTCreate Job
- GETGet Job
- DELDelete Job
- PATCHUpdate Job
- POSTTrigger Job
- POSTEnable Job
- POSTDisable Job
- GETGet Job Executions
- POSTTrigger Webhook
- POSTCreate Turn Metrics
- POSTCreate Tool Call
- POSTCreate Task
- POSTCreate Batch Analytics
- PATCHUpdate Task
- GETGet Execution Analytics
- GETGet Organization Analytics Summary
- GETGet Cost Breakdown
- GETGet Aem Summary
- GETGet Aem Trends
- GETGet Storage Analytics Summary
- POSTUpload File
- GETDownload File
- DELDelete File
- GETList Files
- POSTSearch Files
- POSTBatch Download Files
- POSTMove File
- POSTCopy File
- GETGet File Metadata
- PUTUpdate File Metadata
- POSTCreate Folder
- GETGet Storage Usage
- GETGet Storage Analytics
- GETApi Root
- GETDiagnostic
- GET
Health Check
Copy
Ask AI
curl --request GET \
--url https://control-plane.kubiya.ai/api/health \
--header 'Authorization: Bearer <token>'API Reference
Health Check
Health check endpoint (no authentication required).
Returns health status - all services shown as operational by default. External service health is checked in background, not blocking.
GET
/
api
/
health
Health Check
Copy
Ask AI
curl --request GET \
--url https://control-plane.kubiya.ai/api/health \
--header 'Authorization: Bearer <token>'Authorizations
Enter your Kubiya API token (format: Bearer
Response
200 - application/json
Successful Response
Was this page helpful?
⌘I