Sign in

v1

latestOpenAPI 3.0.0Cognigy Proprietary License2026-07-2239524.1 MB
AI Agents

Hire an AI Agent from the Job Market

Hires an AI Agent in a Project using a ready-made template (templateId) with predefined skills for a specific job. You can optionally override an existing AI Agent using overrideAiAgentReferenceId to adapt it to your needs. The method returns a task tracking the status of the hiring process.

post/v2.0/aiagents/hire

Headers

Accept'application/json' | 'application/hal+json' | 'application/xml' | 'text/xml' | 'text/csv'

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.

Request body

templateIdstring

The ID of the AI Agent template to hire.

overrideAiAgentReferenceIdstring

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

projectIdstring

The unique identifier for the Project.

Example request

{
  "templateId": "airline-support-agent-en",
  "overrideAiAgentReferenceId": "5f7b1b1b-7b1b-4b1b-9b1b-7b1b1b1b1b1b"
}

Response

Successfully created a Task to hire the AI Agent.

_idstring
status'queued' | 'active' | 'done' | 'cancelling' | 'cancelled' | 'error'

The status of the task

typestring
parametersobject
lastChangedAtnumber
lastCreatedAtnumber
currentStepinteger
totalStepinteger

Example response

{
  "status": "queued",
  "type": "trainIntents",
  "lastChangedAt": 1594243850,
  "lastCreatedAt": 1594243850,
  "totalStep": 100
}