Sign in
Agents

List agents

Changed on

Items are ordered by created_at descending, then id descending.

get/orgs/{orgID}/projects/{projectID}/agents

Request

  • Base URL: https://api.omnara.com/v1
  • URL: https://api.omnara.com/v1/orgs/{orgID}/projects/{projectID}/agents
  • Auth: one of:
    • HTTP bearer
    • API key in cookie __Host-omnara_session

Query parameters

namestring

Case-insensitive glob over the list's logical name. * matches zero or more characters, ? matches one character, and \ escapes a wildcard.

agent_profile_idstring

Return only agents launched from this agent profile.

parent_agent_idstring

Return only subagents spawned by this agent.

include_subagentsboolean

Include subagents alongside top-level agents. Defaults to false, so only agents without a parent are returned unless parent_agent_id is set.

include_archivedboolean

Include archived agents. Defaults to false.

include_usageboolean

Include each agent's usage, so a list can show costs without a request per agent.

sort'name' | '-name' | '-updated_at' | 'updated_at' | '-created_at' | 'created_at'

Sort order for named resources that expose created and modified timestamps.

limitinteger

Maximum number of items to return in one page.

cursorstring

Opaque pagination cursor from a previous response's next_cursor. Omit for the first page.

Response

Agents in the project, newest first.

next_cursorstring nullable required

Opaque cursor for the next page, or null when this is the last page.

Changes

  • 680248a0ba72Revision changes
    • breaking

      removed the required property /// from the response with the status

    • breaking

      removed the required property /// from the response with the status

    • info

      added the required property /// to the response with the status

  • 0a5562d0d229Revision changes
    • info

      added the new optional query request parameter include_usage

    • info

      added the optional property // to the response with the status