Get an agent

GET

/api/v2/agents/{agent_id}

One agent's definition, as the agent editor saves it. An agent that is not in the workspace, or one of the AI Builder's own, is a 404.

Authorization

apiKey

headerAuthorizationBearer <token>

An API key, sk-syn- and 32 characters. On SynapseOrch Cloud an owner or admin makes it under Settings → Developer; on a self-hosted install, under Settings → API Keys.

Path Parameters

agent_id*string

The agent's id.

Response Body

The agent.

application/json

response

id?string

name?string

description?string

curl -X GET "https://api.synapseorch.com/api/v2/agents/agent_01a10b7e2c4d6f8a0b1c3d5e7f9a2b4c" \  -H "Authorization: Bearer sk-syn-..."

{  "id": "agent_01a10b7e2c4d6f8a0b1c3d5e7f9a2b4c",  "name": "Order desk",  "description": "Answers stockists' order and account questions.",  "...": "..."}