Skip to main content
GET
/
v2.0
/
aiagents
/
{aiAgentId}
/
jobs
Get AI Agent Jobs and their Tools
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": {}
      }
    ]
  }
]

Authorizations

ā€‹
X-API-Key
string
header
required

Supply the API Key in the HTTP-Header

Headers

ā€‹
Accept
enum<string>

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.

Available options:
application/json,
application/hal+json,
application/xml,
text/xml,
text/csv

Path Parameters

ā€‹
aiAgentId
string
required

The Id of the Ai Agent

Required string length: 24
Pattern: ^[a-z0-9]{24}$

Response

Returns an array of jobs, each with a tools array.

ā€‹
_id
string
ā€‹
referenceId
string
ā€‹
type
string
Example:

"aiAgentJob"

ā€‹
label
string
ā€‹
comment
string
ā€‹
commentColor
string
ā€‹
analyticsLabel
string | null
ā€‹
isDisabled
boolean
ā€‹
isEntryPoint
boolean
ā€‹
extension
string
ā€‹
config
object

Job node configuration (content varies by implementation)

ā€‹
tools
object[]