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"
import requests
import json
url = "https://api.sendkit.ai/v1/agents/example_string"
headers = {
"Content-Type": "application/json",
"X-Api-Key": "YOUR_API_KEY"
}
response = requests.get(url, headers=headers)
print(response.json())
const response = await fetch("https://api.sendkit.ai/v1/agents/example_string", {
method: "GET",
headers: {
"Content-Type": "application/json",
"X-Api-Key": "YOUR_API_KEY"
}
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
)
func main() {
req, err := http.NewRequest("GET", "https://api.sendkit.ai/v1/agents/example_string", nil)
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("X-Api-Key", "YOUR_API_KEY")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://api.sendkit.ai/v1/agents/example_string')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'
request['X-Api-Key'] = 'YOUR_API_KEY'
response = http.request(request)
puts response.body
{
"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"
}
}
{
"error": "Not Found",
"message": "The requested resource was not found",
"code": 404
}
GET
/v1/agents/{agentId}GET
API Key (header: X-Api-Key)
X-Api-Keystring
RequiredPlatform API key (sk_user_...) or Workspace API key (sk_...)
Platform API key (sk_user_...) or Workspace API key (sk_...)
path
agentIdstring
RequiredAI agent ID
Request Preview
Response
Response will appear here after sending the request
Authentication
header
X-Api-Keystring
RequiredAPI Key for authentication. Platform API key (sk_user_...) or Workspace API key (sk_...)
Path Parameters
agentIdstring
RequiredAI agent ID
Responses
successboolean
dataobject
_idstring
namestring
userIdstring
workspaceIdstring
companyInfoobject
namestring
descriptionstring
personaobject
tonestring
rolestring
communicationStylestring
customInstructionsstring
isDefaultboolean
isActiveboolean
usageobject
createdAtstring
updatedAtstring
successboolean
errorobject
codestring
messagestring
Was this page helpful?
Last updated today
Built with Documentation.AI