logo
AgentsGet agent detail
Agents

Get agent detail

Returns the full agent configuration including company info, persona, and usage stats.

curl -X GET "https://api.sendkit.ai/v1/agents/example_string" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "success": true,
  "data": {
    "_id": "664a1b2c3d4e5f6a7b8c9d0e",
    "name": "Sales Agent",
    "userId": "user_123",
    "workspaceId": "ws_123",
    "companyInfo": {
      "name": "Acme Inc",
      "description": "B2B SaaS platform for sales automation"
    },
    "persona": {
      "tone": "professional",
      "role": "sales representative",
      "communicationStyle": "concise",
      "customInstructions": ""
    },
    "isDefault": true,
    "isActive": true,
    "usage": {},
    "createdAt": "2024-06-01T10:00:00.000Z",
    "updatedAt": "2024-06-01T10:00:00.000Z"
  }
}
GET
/v1/agents/{id}
GET
API Key (header: X-Api-Key)
X-Api-Keystring
Required

Platform API key (sk_user_...) or Workspace API key (sk_...)

Platform API key (sk_user_...) or Workspace API key (sk_...)
Bearer Token
Bearer Tokenstring
Required

API key as Bearer token

API key as Bearer token
Request Preview
Response

Response will appear here after sending the request

Authentication

header
X-Api-Keystring
Required

API Key for authentication. Platform API key (sk_user_...) or Workspace API key (sk_...)

header
Authorizationstring
Required

Bearer token. API key as Bearer token

Path Parameters

idstring
Required

Resource ID

Responses

successboolean
dataobject