AI Agent

Publish

POST/api/v1/ai-agents/{id}/publish

Publishes the current draft as a new live version. This affects real customers: new conversations get the new version right away, while conversations already in progress keep their version until they have been inactive for inactivityTimeout seconds.

Every publish is kept in List Versions. Takes about 4 seconds.

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

    Label for this version, 1-100 characters, e.g. v3 - pricing FAQ.

Responses

200

The agent, with live now pointing at the new version.

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

    • draftobject | nulloptional

      The working copy. Null until a flow is saved.

      Child attributes
      • idstringoptional

        Draft flow ID.

      • modelstringoptional
      • savedAtstring | nulloptional

        When the draft was last saved (ISO 8601).

    • liveobject | nulloptional

      The published version customers talk to. Null until the first publish.

      Child attributes
      • idstringoptional

        Live flow version ID.

      • versionstringoptional

        Label given when it was published.

      • modelstringoptional
      • publishedAtstring | nulloptional

        ISO 8601.

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
409

The agent has no draft flow. Save one with Update Flow first.

  • messagestringrequired
422

The draft flow is invalid; problems lists why.

  • messagestringrequired
429

Rate limit reached. Retry after a short pause.

  • messagestringrequired
502

The AI agent service is temporarily unavailable. Retry shortly.

  • messagestringrequired