Skip to content
Covo Developers

Reference

Get configuration

The configuration document: identity (who it represents), personality (greeting, tone, guidance, boundaries), links, offers, hand-written knowledge and Places, each item with its id.

RESTGET /api/v1/agents/{agent_id}/configuration
MCP toolget_agent_configuration
ClassificationRead (changes nothing)
Scopeagents:read
Minimum role on the agenteditor
ConfirmationNot needed
Retry safetySafe to retry with the same input
Success status200

What it does

The configuration document: identity (who it represents), personality (greeting, tone, guidance, boundaries), links, offers, hand-written knowledge and Places, each item with its id. Long knowledge content is shortened unless expand_knowledge is true. Includes the revision to send back as expected_revision.

Side effects

None. It only reads.

Inputs

NameTypeRequiredInDescription
agent_idstringyespathThe agent id (agt_...), from list_agents.
expand_knowledgeboolean or "true" | "false"noquerytrue or false

Example

REST
curl "https://covo.lanaai.io/api/v1/agents/agt_4edc89bb2964/configuration" \
  -H "Authorization: Bearer $COVO_TOKEN"
MCP (POST /mcp)
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_agent_configuration",
    "arguments": {
      "agent_id": "agt_4edc89bb2964"
    }
  }
}

Response

Returns an object with agent_id, revision, configuration and knowledge_truncated. This is a real response, shortened to two items per list.

200 response
{
  "agent_id": "agt_4edc89bb2964",
  "revision": 4,
  "configuration": {
    "identity": {
      "display_name": "Avery Quinn",
      "represents": "individual",
      "headline": "Founder, Northwind Labs. Private AI for small firms.",
      "short_bio": "Avery builds private AI systems for small professional firms.",
      "long_bio": "",
      "avatar_url": null,
      "location": "",
      "occupation": "",
      "expertise": [],
      "interests": [],
      "contact_email": null,
      "contact_preferences": ""
    },
    "personality": {
      "agent_name": "",
      "assistant_label": "AI Concierge",
      "greeting": "I'm Avery Quinn's Concierge. I can help you learn about Avery Quinn's work, what's on offer, or anything else you're curious about.",
      "tone": "warm",
      "instructions": "",
      "boundaries": "",
      "prohibited_topics": [],
      "fallback_behavior": "offer_contact",
      "lead_capture_mode": "balanced",
      "suggested_prompts": []
    },
    "links": [],
    "offers": [],
    "knowledge": [
      {
        "id": "ae45522f-f757-4870-9053-4f4c7f43940e",
        "category": "company",
        "title": "Northwind Labs",
        "question": null,
        "content": "Northwind Labs builds private AI systems for small law firms. Engagements run six to ten weeks.",
        "tags": [],
        "visibility": "public",
        "priority": 0,
        "is_faq": false,
        "knowledge_base_id": null
      }
    ],
    "places": [
      {
        "id": "56a01a61-e1a5-4bdf-b1d7-533d280b81e9",
        "kind": "profile",
        "name": "Main link",
        "channel": "",
        "greeting": "",
        "suggested_prompts": [],
        "context": "",
        "embed_mode": "floating",
        "allowed_origins": [],
        "enabled": true,
        "key": "pl_a82927d351",
        "is_default": true
      }
    ]
  },
  "knowledge_truncated": true
}

Over MCP the same object comes back as the tool result, in structuredContent and as JSON text.

Errors

StatusCodeMeaning
401unauthorizedNo token, or it is unknown, revoked or expired. OAuth apps refresh or reconnect.
403account_suspendedThe account that owns the token is paused.
403insufficient_scopeThe token lacks agents:read.
404agent_not_foundUnknown agent, or not reachable with this token.
400bad_requestAn input is invalid; field names it.
429rate_limitedWait Retry-After seconds.