curl --request GET \
--url https://api.erstan.com/v1/public/agents/{agentId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.erstan.com/v1/public/agents/{agentId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.erstan.com/v1/public/agents/{agentId}', 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.erstan.com/v1/public/agents/{agentId}",
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.erstan.com/v1/public/agents/{agentId}"
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.erstan.com/v1/public/agents/{agentId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.erstan.com/v1/public/agents/{agentId}")
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{
"agent": {
"id": "clx_agent_123",
"name": "OCR Quote Intake",
"description": "Extract quote data from emails and attachments.",
"behaviorType": "pipeline",
"updatedAt": "2026-05-26T00:00:00.000Z"
},
"lanes": [
{
"id": "start_ocr_quote_intake",
"name": "OCR Quote Intake",
"mode": "structured",
"inputSchema": {
"type": "object",
"additionalProperties": true,
"required": [
"sourceRecordType",
"sourceRecordId"
],
"properties": {
"sourceRecordType": {
"type": "string"
},
"sourceRecordId": {
"type": "string"
},
"senderEmail": {
"type": "string"
},
"emailSubject": {
"type": "string"
},
"emailBody": {
"type": "string"
}
}
},
"attachments": {
"supported": true,
"required": false,
"fields": [],
"acceptedTypes": [],
"maxRequestBytes": 26214400
}
},
{
"id": "start_quote_chat",
"name": "Quote Intake Chat",
"mode": "chat",
"inputSchema": {
"type": "object",
"additionalProperties": false,
"required": [
"message"
],
"properties": {
"message": {
"type": "string",
"minLength": 1,
"maxLength": 20000
}
}
},
"attachments": {
"supported": true,
"required": false,
"fields": [],
"acceptedTypes": [],
"maxRequestBytes": 26214400
}
}
]
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"field": "<string>"
}
],
"requestId": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"field": "<string>"
}
],
"requestId": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"field": "<string>"
}
],
"requestId": "<string>"
}
}Get agent
Returns public lane details and input schemas for a published agent the API key creator can currently read.
curl --request GET \
--url https://api.erstan.com/v1/public/agents/{agentId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.erstan.com/v1/public/agents/{agentId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.erstan.com/v1/public/agents/{agentId}', 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.erstan.com/v1/public/agents/{agentId}",
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.erstan.com/v1/public/agents/{agentId}"
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.erstan.com/v1/public/agents/{agentId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.erstan.com/v1/public/agents/{agentId}")
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{
"agent": {
"id": "clx_agent_123",
"name": "OCR Quote Intake",
"description": "Extract quote data from emails and attachments.",
"behaviorType": "pipeline",
"updatedAt": "2026-05-26T00:00:00.000Z"
},
"lanes": [
{
"id": "start_ocr_quote_intake",
"name": "OCR Quote Intake",
"mode": "structured",
"inputSchema": {
"type": "object",
"additionalProperties": true,
"required": [
"sourceRecordType",
"sourceRecordId"
],
"properties": {
"sourceRecordType": {
"type": "string"
},
"sourceRecordId": {
"type": "string"
},
"senderEmail": {
"type": "string"
},
"emailSubject": {
"type": "string"
},
"emailBody": {
"type": "string"
}
}
},
"attachments": {
"supported": true,
"required": false,
"fields": [],
"acceptedTypes": [],
"maxRequestBytes": 26214400
}
},
{
"id": "start_quote_chat",
"name": "Quote Intake Chat",
"mode": "chat",
"inputSchema": {
"type": "object",
"additionalProperties": false,
"required": [
"message"
],
"properties": {
"message": {
"type": "string",
"minLength": 1,
"maxLength": 20000
}
}
},
"attachments": {
"supported": true,
"required": false,
"fields": [],
"acceptedTypes": [],
"maxRequestBytes": 26214400
}
}
]
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"field": "<string>"
}
],
"requestId": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"field": "<string>"
}
],
"requestId": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"field": "<string>"
}
],
"requestId": "<string>"
}
}Authorizations
Workspace API key created in Erstan Settings. Keys carry scopes (agents:list, agents:read, agents:write, agents:run, runs:read, tasks:execute, documents:read, documents:write, files:read, files:write). Agent access follows the key creator's current workspace, team, and agent permissions. Agent draft creation requires agents:write; update, validation, and publishing require both agents:read and agents:write; draft testing also requires agents:run. Keys with tasks:execute must include at least one allowed project or team (allowedProjectIds / allowedTeamIds); keys with document or file scopes must include at least one allowed team. Empty allowlists mean no access — the API fails closed.
Path Parameters
Agent workflow ID returned by GET /v1/public/agents.