Skip to main content
POST
Register a background agent

Body

application/json

Register the served agent or an agent spec for background work.

agent_id
string | null

Agent id. Defaults to OmniServe background_agent_id.

replace
boolean
default:false

Replace an existing agent spec

spec
BackgroundAgentSpec · object | null

Optional agent spec. Omit to register the served agent.

Response

Successful Response

agent_id
string
required
agent_config
Agent Config · object
created_at
string<date-time>
local_tools_ref
string | null
mcp_tools
Mcp Tools · object[]
metadata
Metadata · object
model_config
Model Config · object | null
name
string | null
system_instruction
string | null
updated_at
string<date-time>
workspace_config
Workspace Config · object | null