klink-developers-logo

AI Agent

Create

POST/api/v1/ai-agents

Creates an AI agent with no flow. Next, save a flow with Update Flow and publish it with Publish.

A new agent does not answer any channel by itself. A workflow rule in the dashboard (Automation → Workflows, action Assign AI Agent) decides which conversations it handles.

Request

Authorization

Bearer Token

Provide your API token in the Authorization header. See Authentication to issue one.

Example:Authorization: Bearer ********************

Body Paramsapplication/json
  • namestringrequired

    1-200 characters.

  • inactivityTimeoutintegeroptional

    Seconds of customer silence before the conversation session expires. Default 180.

    Default:180

Responses

201

Created

  • requestIdstringrequired

    Unique ID for this request. Quote it when reporting a problem.

  • dataobjectrequired
    Child attributes
    • idstringrequired

      AI agent ID. Use it in every /ai-agents/{id} path.

    • namestringrequired
    • inactivityTimeoutintegerrequired

      Seconds of customer silence before the conversation session expires and the next message starts fresh.

    • hasDraftbooleanrequired

      True once a draft flow has been saved.

    • hasLivebooleanrequired

      True once a flow has been published. Only live agents answer customers.

400

Invalid body or parameters, e.g. an empty name, an unknown node type or a malformed ID.

  • messagestringrequired
401

API key missing, invalid, revoked or expired.

  • messagestringrequired
429

Rate limit reached. Retry after a short pause.

  • messagestringrequired
502

The AI agent service is temporarily unavailable. Retry shortly.

  • messagestringrequired