Help us improve our product documentation on docs.cognigy.com by sharing your thoughts in a quick survey. Your feedback shapes the future of our content!
Help us improve our product documentation on docs.cognigy.com by sharing your thoughts in a quick survey. Your feedback shapes the future of our content!
Get AI Agent Jobs and their Tools
Gets all jobs and associated tools for an AI Agent by its ID.
curl --request GET \
--url https://api-trial.cognigy.ai/new/v2.0/aiagents/{aiAgentId}/jobs \
--header 'X-API-Key: <api-key>'[
{
"_id": "<string>",
"referenceId": "<string>",
"type": "aiAgentJob",
"label": "<string>",
"comment": "<string>",
"commentColor": "<string>",
"analyticsLabel": "<string>",
"isDisabled": true,
"isEntryPoint": true,
"extension": "<string>",
"config": {},
"tools": [
{
"_id": "<string>",
"referenceId": "<string>",
"type": "<string>",
"label": "<string>",
"comment": "<string>",
"commentColor": "<string>",
"analyticsLabel": "<string>",
"isDisabled": true,
"isEntryPoint": true,
"extension": "<string>",
"config": {}
}
]
}
]Documentation Index
Fetch the complete documentation index at: https://docs.cognigy.com/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Supply the API Key in the HTTP-Header
Headers
The Accept header specifies the media type that the client expects in the response. Available options: application/json, application/hal+json, application/xml, text/xml, text/csv. The default value is application/json.
application/json, application/hal+json, application/xml, text/xml, text/csv Path Parameters
The Id of the Ai Agent
24^[a-z0-9]{24}$Response
Returns an array of jobs, each with a tools array.
"aiAgentJob"
Job node configuration (content varies by implementation)
Show child attributes
Show child attributes
curl --request GET \
--url https://api-trial.cognigy.ai/new/v2.0/aiagents/{aiAgentId}/jobs \
--header 'X-API-Key: <api-key>'[
{
"_id": "<string>",
"referenceId": "<string>",
"type": "aiAgentJob",
"label": "<string>",
"comment": "<string>",
"commentColor": "<string>",
"analyticsLabel": "<string>",
"isDisabled": true,
"isEntryPoint": true,
"extension": "<string>",
"config": {},
"tools": [
{
"_id": "<string>",
"referenceId": "<string>",
"type": "<string>",
"label": "<string>",
"comment": "<string>",
"commentColor": "<string>",
"analyticsLabel": "<string>",
"isDisabled": true,
"isEntryPoint": true,
"extension": "<string>",
"config": {}
}
]
}
]