klink-developers-logo

AI Agent

Update

PATCH/api/v1/ai-agents/{id}

Renames an AI agent or changes its session timeout. Send only the fields you want to change; anything you leave out stays as it is. To change the flow, use Update Flow.

Request

Authorization

Bearer Token

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

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

Path Params
  • idstringrequired

    AI agent ID.

    Example:6ad97ee52845b4f2c8daca55

Body Paramsapplication/json
  • namestringoptional

    1-200 characters.

  • inactivityTimeoutintegeroptional

Responses

200

OK

  • 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
404

No AI agent with this ID in your workspace.

  • messagestringrequired
429

Rate limit reached. Retry after a short pause.

  • messagestringrequired
502

The AI agent service is temporarily unavailable. Retry shortly.

  • messagestringrequired