NInimbleway
Public API

Update Agent

Changed on

Update an agent with a JSON Patch document — an array of {op, path, value} operations applied to the agent, e.g. [{"op": "replace", "path": "/display_name", "value": "My agent"}]. Returns the updated agent.

patch/v2/agents/{agent_id}

Request

  • Base URL
    https://sdk.nimbleway.com
  • URL
    https://sdk.nimbleway.com/v2/agents/{agent_id}
  • Auth
    none declared

Path parameters

agent_idstring uuid required

Request body

fromstring nullable
op'add' | 'remove' | 'replace' | 'move' | 'copy' | 'test' required
pathstring required
valueunknown

Response

Successful Response

agent_namestring nullable

Stable agent name.

created_atstring date-time required

When the agent was created.

descriptionstring required

Agent description shown to users.

display_namestring required

Human-friendly agent name shown to users.

effort'low' | 'medium' | 'high' | 'x-high' | '5x-high' | 'max' required

Canonical effort tier names for the research graph.

iconstring required

Icon identifier used when presenting the agent.

idstring required

Unique web search agent identifier (wsa_<uuid>).

is_activeboolean required

Whether the agent can be used to start new runs.

output_schemaobject nullable required

JSON schema describing the structured output the agent should produce.

skillstring required

Skill or operating context for the agent.

updated_atstring date-time required

When the agent was last updated.

use_case'research' | 'enrichment' | 'dataset_building' required

Changes

  • 22c2a2291146Revision changes
    • warning

      added the new 5x-high enum value to the response property for the response status

  • b489cb71bc40Revision changes
    • breaking

      removed the required property from the response with the status

    • info

      added the required property to the response with the status