Deploy agent

View as Markdown

Deploys the latest build of an agent to Kubernetes. Creates or updates the K8s namespace, deployment, services, and ingress. Returns 200 on full success or 207 if some resources had errors.

Authentication

AuthorizationBearer
OAuth 2.0 device flow or session token from WorkOS

Request

This endpoint expects an object.
accountstringRequired
Account that owns the deployment
namestringRequired
Agent name
source_accountstringOptional

Source account for cross-account deploys (uses latest published version)

user_credentialsmap from strings to stringsOptional

Credential key-value pairs required by the agent

interfaceslist of stringsOptional

Interface adapter names to enable (e.g. [“slack”, “web”])

schedulesmap from strings to stringsOptional
Cron schedules keyed by ingestion name

Response

Deployment succeeded
statusenum or null
Allowed values:
namestring or null
build_idstring or null
k8s_namespacestring or null
deployed_atdatetime or null
resourceslist of maps from strings to any or null
Kubernetes resources created or updated
service_endpointslist of objects or null
errorslist of strings or null

Errors