WAwarp
Agents

Retrieve an agent

Changed on

Retrieve a single agent by its unique identifier.

get/agent/identities/{uid}

Request

  • Base URL
    https://app.warp.dev/api/v1
  • Auth
    HTTP bearer

Path parameters

uidstring required

The unique identifier of the agent

Response

Agent details

uidstring required

Unique identifier for the agent

namestring required

Name of the agent

descriptionstring nullable

Optional description of the agent

promptstring nullable

Optional base prompt for this agent

environment_idstring

Default cloud environment ID for runs executed by this agent; the precedence order for environment resolution is:

  1. The environment specified on the run itself
  2. The agent's default environment
  3. An empty environment
default_runner_uidstring required

Default runner UID for runs executed by this agent; when set, it overrides the selected environment's default runner for runs that do not specify their own runner_id. The precedence order for runner resolution is:

  1. The runner specified on the run itself
  2. The agent's default runner
  3. The selected environment's default runner
  4. The environment's legacy inline compute fields
  5. System defaults
availableboolean required

Whether the agent is currently enabled. Defaults to true.

created_atstring date-time required

When the agent was created (RFC3339)

updated_atstring date-time required

When the agent was last updated (RFC3339)

skillsstring[] required

Ordered list of normalized skill specs associated with this agent. Always present; empty when no skills are attached.

base_modelstring

Base model for runs executed by this agent; the precedence order for model resolution is:

  1. The model specified on the run itself
  2. The agent's base model
  3. The team's default model
mcp_serversobject

MCP server configurations attached to this agent by default. Run-level MCP config takes precedence over this agent-level default.

base_harnessstring

Default harness for runs executed by this agent; the precedence order for harness resolution is:

  1. The harness specified on the run itself
  2. The agent's base harness
  3. Warp Deprecated: use harness instead, which carries the full {type, model_id, reasoning_level} default.
credential_strategy'CREATOR' | 'EXECUTOR'

Default credential strategy for runs executed by a named agent; an agent may leave this unset (see AgentResponse.credential_strategy for the full resolution order).

  • EXECUTOR: runs authenticate with the named agent's own credentials (e.g. a GitHub App installation token for the agent's team).
  • CREATOR: runs authenticate with the credentials of the principal that created the run.
on_behalf_of_enabledboolean

Whether runs created with this agent's API key may use the on_behalf_of field to attribute runs to another team member.

worker_hoststring

Default worker host for runs executed by this agent, or empty when unset; the precedence order for worker host resolution is:

  1. The host specified on the run itself
  2. The agent's default host
  3. The workspace default host

Changes

  • 2c45dcc0a13eRevision changes
    • breaking

      added subschema #1 to the ///// response property oneOf list for the response status

    • breaking

      the ///// response's property type changed from string to no type for status

    • info

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

    • info

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

    • info

      removed the claude enum value from the ///// response property for the response status

    • info

      removed the codex enum value from the ///// response property for the response status

    • info

      removed the gemini enum value from the ///// response property for the response status

    • info

      removed the oz enum value from the ///// response property for the response status

  • a0daf9e59774Revision changes
    • breaking

      removed the required property from the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      response property base_harness deprecated

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status