Get an agent
Get a single agent by ID — includes live activity stats.
curl -X GET "https://api.autopil.ai/v1/agents/example_string" \
-H "Content-Type: application/json" \
-H "X-API-Key: YOUR_API_KEY"
import requests
import json
url = "https://api.autopil.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.autopil.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.autopil.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.autopil.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
{
"agent_id": "example_string",
"agent_role": "example_string",
"display_name": "John Doe",
"description": "example_string",
"owner": "example_string",
"framework": "example_string",
"permitted_roles": [
"example_string"
],
"credential_type": "api_key",
"bound_key_id": "example_string",
"status": "draft"
}
{
"error": "Not Found",
"message": "The requested resource was not found",
"code": 404
}
/v1/agents/{agent_id}Target server for requests. Edit to use your own host.
API key with admin, read, or evaluate scope. Missing key → 401; invalid or revoked key → 403.
admin, read, or evaluate scope. Missing key → 401; invalid or revoked key → 403.
Request Preview
Response
Response will appear here after sending the request
Authentication
API Key for authentication. API key with admin, read, or evaluate scope. Missing key → 401; invalid or revoked key → 403.
Path Parameters
Responses
The role this agent will claim in evaluate calls. Must match a policy.
Human-readable name shown in the dashboard.
Purpose and data access rationale. Used during approval review.
Team or individual responsible for this agent.
Runtime framework: langgraph, openai_agents, bedrock, etc.
Roles this agent is allowed to claim. Defaults to [agent_role].
Authentication method. Defaults to api_key.
api_keyjwt_oidcmtlsconjurIf set, only the key with this ID may present this agent's identity.
draftpending_approvalapproveddeprecated