Get an Agent
curl --request GET \
--url https://api.getnexor.ai/api/public/workflows/{id} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.getnexor.ai/api/public/workflows/{id}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.getnexor.ai/api/public/workflows/{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.getnexor.ai/api/public/workflows/{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 => [
"X-API-Key: <api-key>"
],
]);
$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.getnexor.ai/api/public/workflows/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
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.getnexor.ai/api/public/workflows/{id}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getnexor.ai/api/public/workflows/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"workflow": {
"fields": [
{
"key": "<string>",
"label": "<string>",
"type": "text",
"required": false,
"options": [
"<string>"
],
"extraction_hints": "<string>",
"sort_order": 123,
"metadata_key": "<string>",
"intake_value_map": {}
}
],
"channel_prompts": {},
"prompt_sha256": "<string>"
}
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>",
"code": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>",
"code": "<string>"
}Consultar un agente
Esta operación permite consultar un agente en la cuenta autenticada de Nexor. Esta referencia documenta campos verificados de ruta, consulta y cuerpo JSON de nivel superior, códigos de estado observados y campos de respuesta de nivel superior. Las respuestas del proveedor o con estructuras anidadas profundas pueden permanecer abiertas.
GET
/
workflows
/
{id}
Get an Agent
curl --request GET \
--url https://api.getnexor.ai/api/public/workflows/{id} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.getnexor.ai/api/public/workflows/{id}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.getnexor.ai/api/public/workflows/{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.getnexor.ai/api/public/workflows/{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 => [
"X-API-Key: <api-key>"
],
]);
$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.getnexor.ai/api/public/workflows/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
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.getnexor.ai/api/public/workflows/{id}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getnexor.ai/api/public/workflows/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"workflow": {
"fields": [
{
"key": "<string>",
"label": "<string>",
"type": "text",
"required": false,
"options": [
"<string>"
],
"extraction_hints": "<string>",
"sort_order": 123,
"metadata_key": "<string>",
"intake_value_map": {}
}
],
"channel_prompts": {},
"prompt_sha256": "<string>"
}
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>",
"code": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>",
"code": "<string>"
}GET
Ver Autenticación.
/workflows/:id
Obtiene el árbol completo de un agente: configuración base, statuses del funnel, campos personalizados y tools personalizadas.
Parámetros de Ruta
| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
id | string (uuid) | Sí | ID del agente |
Respuestas
200 — Respuesta exitosa
{
"workflow": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Sales Agent",
"description": "Qualifies inbound leads and books demo calls",
"goal_type": "appointment",
"global_prompt": "You are Iris, a friendly sales rep for Acme...",
"channel_prompts": {
"whatsapp": "Escribe mensajes de máximo dos líneas..."
},
"prompt_sha256": "7e0225eb7915dc01ec70a8c3dc75a543ee568c202c23d2b93d598aa73008d917",
"is_paused": false,
"is_active": true,
"timezone": "America/Santiago",
"created_at": "2026-01-15T09:00:00Z",
"updated_at": "2026-02-01T12:00:00Z",
"statuses": [
{ "key": "new", "label": "New", "category": "active", "is_initial": true, "is_terminal": false, "sort_order": 0 },
{ "key": "won", "label": "Won", "category": "won", "is_initial": false, "is_terminal": true, "sort_order": 1 }
],
"fields": [
{
"key": "employee_count",
"label": "Employee count",
"type": "number",
"required": false,
"metadata_key": "company.employee_count",
"intake_value_map": { "unknown": "0" }
}
],
"tools": [
{ "name": "check_availability", "is_active": true }
]
}
}
Campos de Respuesta — Workflow
| Campo | Tipo | Descripción |
|---|---|---|
id | string (uuid) | Identificador del agente |
name | string | Nombre del agente |
description | string | null | Descripción del agente |
goal_type | string | Ver Crear Agente para los valores válidos |
global_prompt | string | El prompt base |
prompt_sha256 | string | SHA-256 (hex en minúsculas) de los bytes UTF-8 de global_prompt; un agente sin prompt usa el hash del texto vacío. Envíalo como expected_prompt_sha256 en Configurar el prompt para que la escritura falle en vez de sobrescribir un prompt más nuevo |
channel_prompts | object | null | Prompts por canal, con el nombre del canal como clave (por ejemplo whatsapp o email). Vacío o null cuando el agente no tiene ninguno. Léelo antes de reemplazar el prompt de un canal con Configurar el prompt de un canal |
is_paused | boolean | Si el agente está pausado actualmente |
inbound_only | boolean | Interruptor “solo responde”: true cuando el agente nunca inicia el contacto y solo contesta mensajes entrantes |
is_active | boolean | Si el agente está activo (vs. archivado) |
timezone | string | Timezone IANA usado para agendar la cadencia |
statuses | array | Statuses del funnel, ordenados por sort_order |
fields | array | Campos personalizados que este agente recolecta. Cada campo devuelve metadata_key e intake_value_map; ambos pueden ser null cuando el prellenado desde metadata no está configurado |
tools | array | Tools personalizadas que este agente puede llamar, solo con name e is_active — ver Listar Workflow Tools para el detalle completo |
401 — Error de autenticación
Ver Autenticación.
404 — No encontrado
{
"error": "Not found",
"message": "Workflow not found"
}
500 — Error interno del servidor
Autorizaciones
API key for authentication. Keys are prefixed with nxr_live_.
Parámetros de ruta
Workflow identifier.
Respuesta
Successful response.
Complete tenant-scoped workflow tree returned by getWorkflowTree.
Show child attributes
Show child attributes
Última modificación el 13 de octubre de 2026
⌘I