Sign in
Agents

Configure

Changed on

Configure loads this agent's name, purpose, model, and tools.

get/v1/agents/{slug}

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /v1/agents/{slug}
  • Auth: HTTP bearer

Path parameters

slugstring required

Agent id.

Example:acme-follow-up

Response

The agent is ready to configure.

enabledToolsstring[] required

Tools this agent can use.

instructionsstring

Purpose shown for this agent.

modelstring

Model this agent uses.

namestring required

Name on the agents page.

providerstring

Where that model runs.

slugstring required

Agent id.

sourcestring required

tenant means this workspace owns the agent.

Example response

{
  "enabledTools": [
    "relationship.read"
  ],
  "instructions": "Draft the next follow-up for Acme.",
  "model": "openai/gpt-4.1-mini",
  "name": "Acme follow-up",
  "provider": "openrouter",
  "slug": "acme-follow-up",
  "source": "tenant"
}

Changes