Nimble API
Nimble Docsnimbleway.com
HomeAPI ReferenceSDKsContext Plugin
Public A P I

Get Agent

GET
/v2/agents/{agent_id}

Retrieve a single Web Search Agent by ID.

Authorization

BearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

agent_id*Agent Id

Web Search Agent ID, format wsa_<uuid>.

Formatuuid

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v2/agents/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "agent_name": "string",  "created_at": "2019-08-24T14:15:22Z",  "description": "string",  "display_name": "string",  "effort": "low",  "goals": [    {      "goal": "string",      "id": "string",      "order": 0    }  ],  "icon": "string",  "id": "string",  "is_active": true,  "output_schema": {},  "skill": "string",  "sources": {    "allow": [      {        "domains": [          "string"        ],        "id": "string",        "order": 0,        "title": "string"      }    ],    "avoid": "string",    "block": [      {        "domains": [          "string"        ],        "id": "string",        "order": 0,        "title": "string"      }    ],    "prioritize": "string"  },  "suggested_questions": [    {      "id": "string",      "order": 0,      "question": "string"    }  ],  "updated_at": "2019-08-24T14:15:22Z",  "use_case": "research"}

Get Agent Template GET

Retrieve a single agent template by its stable `template_name`.

Update Agent PATCH

Update an agent with a [JSON Patch](https://datatracker.ietf.org/doc/html/rfc6902) 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.