Get Agent
Read one agent and its full configuration.
GET
/
ai-gateway
/
agents
/
{id}
Get an agent
curl --request GET \
--url https://api.knoxcall.com/v1/ai-gateway/agents/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.knoxcall.com/v1/ai-gateway/agents/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.knoxcall.com/v1/ai-gateway/agents/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.knoxcall.com/v1/ai-gateway/agents/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.knoxcall.com/v1/ai-gateway/agents/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.knoxcall.com/v1/ai-gateway/agents/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.knoxcall.com/v1/ai-gateway/agents/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"gateway_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"slug": "<string>",
"status": "active",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"agent_url": "<string>",
"tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>",
"primary_route_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"fallback_route_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"model_allowlist": [
"<string>"
],
"model_denylist": [
"<string>"
],
"default_model": "<string>",
"model_rewrite": {},
"budget_daily_usd": 123,
"budget_monthly_usd": 123,
"budget_per_call_max_tokens": 123,
"budget_overage_action": "<string>",
"fallback_agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pii_redact_policy_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pii_detokenize_response": true,
"pii_request_mode": "off",
"pii_response_mode": "redact",
"pii_streaming_holdback_chars": 123,
"pii_streaming_mode": "<string>",
"cache_mode": "<string>",
"cache_ttl_seconds": 123,
"cache_similarity_threshold": 123,
"cache_embedding_model": "<string>",
"streaming_enabled": true,
"firewall_policy_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tool_allowlist": [
"<string>"
],
"output_schema": {},
"output_validation_action": "<string>",
"data_residency_region": "us",
"cmek_key_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"paused_reason": "<string>",
"tags": {},
"provider": "<string>",
"routing_policy": {
"retry_on": [
"429"
],
"max_attempts": 3,
"backoff_ms": 15000,
"backoff_multiplier": 5.5,
"max_backoff_ms": 15000,
"respect_retry_after": true,
"max_retry_after_ms": 30000,
"jitter": true,
"route_weights": {}
},
"guardrail_webhook_url": "<string>",
"guardrail_webhook_secret_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"guardrail_webhook_mode": "off",
"guardrail_webhook_timeout_ms": 5050,
"guardrail_webhook_failure_action": "fail_open",
"created_by": "<string>"
},
"meta": {
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}Returns the agent with every setting at its configured or default value —
routing, model policy, budgets, PII and firewall policy ids, cache mode, output
schema, residency.
An agent belonging to another tenant, or a KnoxCall system agent, returns
404 not_found: a probe cannot distinguish “not yours” from “does not exist”.
Requires the read capability on ai_gateway. See the control-plane overview for authentication, the {data, meta} envelope, pagination and error types.Authorizations
OAuth2BearerAuthApiKeyAuth
OAuth 2.1 authentication — recommended for new integrations. Access tokens
(kc_ prefix) are minted at the root-host token endpoint
https://api.knoxcall.com/oauth/token and passed as Authorization: Bearer <access_token>.
Public clients must use PKCE with the authorization_code grant; confidential
clients may use client_credentials. The first-party SDKs and the
knoxcall login CLI handle token minting, caching, refresh, and DPoP for you.
Path Parameters
The AI agent UUID.
Was this page helpful?
⌘I
Get an agent
curl --request GET \
--url https://api.knoxcall.com/v1/ai-gateway/agents/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.knoxcall.com/v1/ai-gateway/agents/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.knoxcall.com/v1/ai-gateway/agents/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.knoxcall.com/v1/ai-gateway/agents/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.knoxcall.com/v1/ai-gateway/agents/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.knoxcall.com/v1/ai-gateway/agents/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.knoxcall.com/v1/ai-gateway/agents/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"gateway_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"slug": "<string>",
"status": "active",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"agent_url": "<string>",
"tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>",
"primary_route_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"fallback_route_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"model_allowlist": [
"<string>"
],
"model_denylist": [
"<string>"
],
"default_model": "<string>",
"model_rewrite": {},
"budget_daily_usd": 123,
"budget_monthly_usd": 123,
"budget_per_call_max_tokens": 123,
"budget_overage_action": "<string>",
"fallback_agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pii_redact_policy_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pii_detokenize_response": true,
"pii_request_mode": "off",
"pii_response_mode": "redact",
"pii_streaming_holdback_chars": 123,
"pii_streaming_mode": "<string>",
"cache_mode": "<string>",
"cache_ttl_seconds": 123,
"cache_similarity_threshold": 123,
"cache_embedding_model": "<string>",
"streaming_enabled": true,
"firewall_policy_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tool_allowlist": [
"<string>"
],
"output_schema": {},
"output_validation_action": "<string>",
"data_residency_region": "us",
"cmek_key_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"paused_reason": "<string>",
"tags": {},
"provider": "<string>",
"routing_policy": {
"retry_on": [
"429"
],
"max_attempts": 3,
"backoff_ms": 15000,
"backoff_multiplier": 5.5,
"max_backoff_ms": 15000,
"respect_retry_after": true,
"max_retry_after_ms": 30000,
"jitter": true,
"route_weights": {}
},
"guardrail_webhook_url": "<string>",
"guardrail_webhook_secret_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"guardrail_webhook_mode": "off",
"guardrail_webhook_timeout_ms": 5050,
"guardrail_webhook_failure_action": "fail_open",
"created_by": "<string>"
},
"meta": {
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}