klink-developers-logo

AI Agent

Listing

GET/api/v1/ai-agents

Lists the AI agents in your workspace.

Request

Authorization

Bearer Token

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

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

Query Params
  • statusstringoptional

    all (default), draft (has a saved draft) or live (has been published).

    Allowed values:"all", "draft", "live"

    Default:"all"

    Example:all

  • pageintegeroptional

    Default 1.

    Default:1

    Example:1

  • pageSizeintegeroptional

    Default 10, max 100.

    Default:10

    Example:10

Responses

200

OK

  • pageintegerrequired
  • pageSizeintegerrequired
  • totalintegerrequired
  • lastPageintegerrequired
  • dataarray[object]required
    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