Skip to main content
Get Agent
curl --request GET \
  --url https://api.example.com/labs.chonkie.ai/api/v1/agents/{agent_slug}
{
  "agent": {}
}
Get detailed information about a specific agent.

​
Examples

import requests

agent_slug = "documentation-assistant"
url = f"https://labs.chonkie.ai/api/v1/agents/{agent_slug}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY"
}

response = requests.get(url, headers=headers)
data = response.json()
agent = data["agent"]

print(f"Agent: {agent['name']}")
print(f"Model: {agent['model']}")
print(f"Temperature: {agent['temperature']}")

​
Request

​
Path Parameters

​
agent_slug
string
required
The slug of the agent to retrieve.

​
Response

​
Returns

​
agent
object
Complete agent configuration and metadata.
Each agent object contains the following fields Basic Information
​
id
string
Unique agent identifier.
​
slug
string
URL-friendly unique identifier for the agent.
​
name
string
Display name of the agent.
​
description
string
Description of the agent’s purpose and capabilities.
​
status
string
Agent status (active, inactive, etc.).
Model Configuration
​
model
string
The LLM model used by the agent.
​
systemPrompt
string
System prompt that defines the agent’s behavior and personality.
​
temperature
float
Temperature setting for response randomness (0.0-2.0).
Knowledge Integration
​
useContext
boolean
Whether knowledge base context injection is enabled.
​
knowledge
string
Slug of the connected knowledge base (if any).
​
maxContextChunks
integer
Maximum number of knowledge base chunks to include in context.
Metadata
​
organizationSlug
string
Organization that owns this agent.
​
metadata
object
Additional custom metadata.
​
createdAt
string
Timestamp when the agent was created.
​
updatedAt
string
Timestamp when the agent was last updated.