Get Agent
Return the current singleton agent.
GET
/
admin
/
api
/
v1
/
agent
Get Agent
curl --request GET \
--url https://api.example.com/admin/api/v1/agent{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"baseEngineConfig": {
"agent": {
"config": {
"name": "<string>",
"graph_definition": "<string>",
"observability": {
"provider": "<string>",
"enabled": false,
"options": {}
},
"checkpointer": {
"type": "<string>",
"db_url": "<string>"
},
"store": {}
}
},
"server": {
"api": {
"port": 8000
}
},
"mcpServers": [
{
"name": "<string>",
"transport": "streamable_http",
"url": "<string>",
"command": "<string>",
"args": [
"<string>"
],
"headers": {},
"env": {},
"cwd": "<string>",
"encoding": "<string>",
"timeoutSeconds": 123,
"sseReadTimeoutSeconds": 123,
"terminateOnClose": true,
"sessionKwargs": {}
}
],
"guardrails": {
"input": [
{
"banned_words": [
"<string>"
],
"config_id": "ban_list",
"api_key": "",
"reject_message": "ban!!",
"guard_url": "hub://guardrails/ban_list"
}
],
"output": [
{
"banned_words": [
"<string>"
],
"config_id": "ban_list",
"api_key": "",
"reject_message": "ban!!",
"guard_url": "hub://guardrails/ban_list"
}
]
},
"observability": [
{
"config": {
"provider": "LANGFUSE",
"host": "https://cloud.langfuse.com",
"publicKey": "",
"secretKey": "",
"runName": ""
},
"provider": "LANGFUSE",
"enabled": true
}
],
"sso": {
"issuer": "<string>",
"clientId": "<string>",
"enabled": true,
"audience": "<string>",
"allowedDomains": [
"<string>"
],
"allowedEmails": [
"<string>"
]
},
"integrations": [
{
"config": {
"accessToken": "<string>",
"phoneNumberId": "<string>",
"verifyToken": "<string>",
"apiVersion": "v21.0"
},
"enabled": true
}
],
"prompts": [
{
"promptId": "<string>",
"version": 123,
"content": "<string>",
"tags": [
"<string>"
]
}
]
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"slug": "<string>",
"description": "<string>",
"version": "<string>",
"baseUrl": "<string>"
}Documentation Index
Fetch the complete documentation index at: https://docs.idun-group.com/llms.txt
Use this file to discover all available pages before exploring further.
Response
200 - application/json
Successful Response
GET response and the data payload of PATCH responses.
Agent status enumeration.
Available options:
draft, active, inactive, deprecated, error Main engine configuration model for the entire Idun Agent Engine.
Show child attributes
Show child attributes
Last modified on May 22, 2026
Was this page helpful?
⌘I
Get Agent
curl --request GET \
--url https://api.example.com/admin/api/v1/agent{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"baseEngineConfig": {
"agent": {
"config": {
"name": "<string>",
"graph_definition": "<string>",
"observability": {
"provider": "<string>",
"enabled": false,
"options": {}
},
"checkpointer": {
"type": "<string>",
"db_url": "<string>"
},
"store": {}
}
},
"server": {
"api": {
"port": 8000
}
},
"mcpServers": [
{
"name": "<string>",
"transport": "streamable_http",
"url": "<string>",
"command": "<string>",
"args": [
"<string>"
],
"headers": {},
"env": {},
"cwd": "<string>",
"encoding": "<string>",
"timeoutSeconds": 123,
"sseReadTimeoutSeconds": 123,
"terminateOnClose": true,
"sessionKwargs": {}
}
],
"guardrails": {
"input": [
{
"banned_words": [
"<string>"
],
"config_id": "ban_list",
"api_key": "",
"reject_message": "ban!!",
"guard_url": "hub://guardrails/ban_list"
}
],
"output": [
{
"banned_words": [
"<string>"
],
"config_id": "ban_list",
"api_key": "",
"reject_message": "ban!!",
"guard_url": "hub://guardrails/ban_list"
}
]
},
"observability": [
{
"config": {
"provider": "LANGFUSE",
"host": "https://cloud.langfuse.com",
"publicKey": "",
"secretKey": "",
"runName": ""
},
"provider": "LANGFUSE",
"enabled": true
}
],
"sso": {
"issuer": "<string>",
"clientId": "<string>",
"enabled": true,
"audience": "<string>",
"allowedDomains": [
"<string>"
],
"allowedEmails": [
"<string>"
]
},
"integrations": [
{
"config": {
"accessToken": "<string>",
"phoneNumberId": "<string>",
"verifyToken": "<string>",
"apiVersion": "v21.0"
},
"enabled": true
}
],
"prompts": [
{
"promptId": "<string>",
"version": 123,
"content": "<string>",
"tags": [
"<string>"
]
}
]
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"slug": "<string>",
"description": "<string>",
"version": "<string>",
"baseUrl": "<string>"
}