Skip to main content
GET
Get Omni Agent
Returns the Omni agent of the user who owns the API key. Each user has one Omni; if yours does not exist yet, this call creates it. Repeated calls return the same agent. Use the returned id with any /v1/agents/{agent_id} route, for example Run Conversation Turn to talk to Omni or Get Agent Tasks to read its history. Call it with your personal key, so the Omni returned is yours. A key with no user attached has no Omni, and the call returns 400. See Authentication for the two kinds of key.

Response

The same simplified agent view that Get Agent returns.
string
Omni’s agent UUID. Pass it as agent_id to the other agent routes.
string
Display name
string
What the agent does
string
DRAFT, ACTIVE (deployed) or INACTIVE
string
LLM provider (e.g., anthropic)
string
LLM model (e.g., claude-sonnet-5)
array
The agent’s attached skills, in the AgentTool shape described on Get Agent
string
ISO 8601 creation timestamp
string | null
UUID of the user the Omni belongs to

Errors

Authorizations

x-api-key
string
header
required

API Key for authentication

Response

Successful Response

Lean agent view exposing tools as one simple list, hiding low-level graph/oas internals.

name
string
required

Agent name.

id
string | null

Agent id.

description
string | null

Agent description.

icon
string | null

Agent icon.

type
enum<string> | null

Agent type.

Available options:
manager,
regular,
a2a,
curl,
orchestration
status
enum<string> | null

Agent status.

Available options:
DRAFT,
ACTIVE,
INACTIVE
model_provider
string | null

LLM provider.

model_name
string | null

LLM model.

framework
string | null

Runtime: agno (built-in) or external-harness (Claude Code / Codex / OpenCode).

deployment_type
enum<string> | null

serverless or container.

Available options:
serverless,
container
harness_settings
HarnessSettings · object | null

External harness settings (default CLI, per-CLI models, permission mode, per-turn resources ceilings); absent for built-in agents.

instructions
AIAgentInstructions · object | null

Agent instructions.

knowledge_base_ids
string[] | null

Attached knowledge base ids.

source_node_types
string[] | null

Trigger source types (sdk, webhook, slack, ...).

tools
AgentTool · object[]

Tools attached to this agent.

created_at
string<date-time> | null

Creation timestamp.

created_by
string | null

Creator user id.

created_by_details
CreatedByDetails · object | null

Creator details.