XPxpander
API v1
Agents
Agents CRUD

Get Omni Agent

Return the API key owner's Omni agent (their personal router agent), creating it on first call. Requires a personal API key: Omni is per-user, so the organization's default key and a key with no user attached are rejected.

get/v1/agents/omni

Request

  • Base URL
    https://api.xpander.ai (the document declares no server; this is the origin it was published from)
  • Auth
    API key in header x-api-key

Response

Successful Response

idstring nullable

Agent id.

namestring required

Agent name.

descriptionstring nullable

Agent description.

iconstring nullable

Agent icon.

origin_templatestring nullable

Template id the agent was imported from.

type'manager' | 'regular' | 'a2a' | 'curl' | 'orchestration'

Enumeration of the agent types.

Attributes: Manager: marks the agent as a Managing agent. Regular: marks the agent as a regular agent. A2A: marks the agent as an external agent used via A2A protocol. Curl: marks the agent as an external agent used via a CURL. Orchestration: marks the agent as an Orchestration object.

status'DRAFT' | 'ACTIVE' | 'INACTIVE'

Enumeration of possible agent statuses.

Attributes: DRAFT: Agent is in a draft state. ACTIVE: Agent is active and operational. INACTIVE: Agent is inactive and not operational.

model_providerstring nullable

LLM provider.

model_namestring nullable

LLM model.

frameworkstring nullable

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

deployment_type'serverless' | 'container'
knowledge_base_idsstring[] nullable

Attached knowledge base ids.

source_node_typesstring[] nullable

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

created_atstring date-time nullable

Creation timestamp.

created_bystring nullable

Creator user id.

Changes

No recorded changes to this operation across all 6 revisions of this API.