Skip to main content
POST
/
v2.0
/
aiagents
/
hire
Hires an existing AI Agent.
curl --request POST \
  --url https://api-trial.cognigy.ai/new/v2.0/aiagents/hire \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "templateId": "airline-support-agent-en",
  "overrideAiAgentReferenceId": "5f7b1b1b-7b1b-4b1b-9b1b-7b1b1b1b1b1b",
  "projectId": "<string>"
}'
{
  "_id": "<string>",
  "status": "queued",
  "type": "trainIntents",
  "parameters": {},
  "lastChangedAt": 1594243850,
  "lastCreatedAt": 1594243850,
  "currentStep": 0,
  "totalStep": 100
}

Authorizations

​
X-API-Key
string
header
required

Supply the API Key in the HTTP-Header

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

​
api_key
string
query
required

Supply the API Key in the Url-Query

Headers

​
Accept
enum<string>

The default media type is application/hal+json. Use application/json for pure data results.

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

Body

application/json
​
templateId
string

The ID of the AI Agent template to hire.

Example:

"airline-support-agent-en"

​
overrideAiAgentReferenceId
string

The reference ID of the AI Agent to override the AI Agent from the hired package.

Example:

"5f7b1b1b-7b1b-4b1b-9b1b-7b1b1b1b1b1b"

​
projectId
string
Required string length: 24

Response

Successfully created a Task to hire the AI Agent.

​
_id
string
Required string length: 24
​
status
enum<string>

The status of the task

Available options:
queued,
active,
done,
cancelling,
cancelled,
error
Example:

"queued"

​
type
string
Example:

"trainIntents"

​
parameters
object
​
lastChangedAt
number
Example:

1594243850

​
lastCreatedAt
number
Example:

1594243850

​
currentStep
integer
Example:

0

​
totalStep
integer
Example:

100