Skip to content
DashboardGet API key

Create flow

View .md
POST

Create a new flow for an agent.

Authorization

  • Authorizationheaderrequired

    Bearer YOUR_API_KEY. Create a key in the dashboard.

Path parameters

  • senderIdstringrequired

Body

application/json

  • namestringrequired
    Limitsmax length 100
  • descriptionstring
  • triggerobjectrequired
    3 properties
    • typestringrequired

      What starts a flow.

      • keyword: the message contains one of the words listed in keywords. Plain substring matching, so a word inside another word still counts.
      • intent: the message MEANS what intent describes, whatever words it uses.
      • always: any message starts it.
      • manual: reserved. Nothing starts a manual flow today — it is accepted and stored, and no message or endpoint runs it.
      One ofkeywordintentalwaysmanual
    • keywordsstring[]

      Words that start the flow, for keyword triggers. Matched as substrings, case-insensitively, against the whole message: a flow on info also starts on "no quiero info". Use intent when that matters.

    • intentstring

      One plain sentence describing what the contact wants, for intent triggers. Any language.

      The message is judged for meaning, not for words, so "kiero saber el presio" starts a flow whose intent is "quiere saber precios o cotizar", and "no quiero info de precios" starts nothing.

      A keyword or always flow with a higher priority is matched first and wins. At most 12 intent flows are considered per message, highest priority first. When the classification is unavailable or uncertain, the message is handled as if no intent matched, so a flow never starts on a guess.

  • stepsobject[]required

    The first step runs on the message that started the flow. It cannot be a condition without a defaultGoto: nothing has been collected yet, so its conditions evaluate the same way on every message, and the request is refused with 400 invalid_request.

    A flow that ends on that first message without replying hands the message to the agent, which answers it. A transfer step stays silent.

    Limitsmin items 1
    4 properties
    • idstringrequired

      Unique step identifier.

    • typestringrequired

      Type of flow step.

      One ofmessagecollectconditiontoolllmtransfer
    • configobjectrequired

      Step configuration (varies by type).

    • nextStepIdstringnullable

      ID of the next step to execute.

  • enabledboolean
    Defaultfalse
  • priorityinteger
    Default0

Responses

201Flow created.
  • flowobjectrequired
    10 properties
    • idstringrequired
    • agentIdstringrequired
    • namestringrequired
    • descriptionstringnullable
    • triggerobjectrequired
      3 properties
      • typestringrequired

        What starts a flow.

        • keyword: the message contains one of the words listed in keywords. Plain substring matching, so a word inside another word still counts.
        • intent: the message MEANS what intent describes, whatever words it uses.
        • always: any message starts it.
        • manual: reserved. Nothing starts a manual flow today — it is accepted and stored, and no message or endpoint runs it.
        One ofkeywordintentalwaysmanual
      • keywordsstring[]

        Words that start the flow, for keyword triggers. Matched as substrings, case-insensitively, against the whole message: a flow on info also starts on "no quiero info". Use intent when that matters.

      • intentstring

        One plain sentence describing what the contact wants, for intent triggers. Any language.

        The message is judged for meaning, not for words, so "kiero saber el presio" starts a flow whose intent is "quiere saber precios o cotizar", and "no quiero info de precios" starts nothing.

        A keyword or always flow with a higher priority is matched first and wins. At most 12 intent flows are considered per message, highest priority first. When the classification is unavailable or uncertain, the message is handled as if no intent matched, so a flow never starts on a guess.

    • stepsobject[]required
      4 properties
      • idstringrequired

        Unique step identifier.

      • typestringrequired

        Type of flow step.

        One ofmessagecollectconditiontoolllmtransfer
      • configobjectrequired

        Step configuration (varies by type).

      • nextStepIdstringnullable

        ID of the next step to execute.

    • enabledbooleanrequired
    • priorityintegerrequired

      Priority when multiple flows match (higher = more priority).

    • createdAtstring<date-time>required
    • updatedAtstring<date-time>required
400Invalid request.
  • codestringrequired
  • messagestringrequired
  • detailsobject
401Unauthorized.
  • codestringrequired
  • messagestringrequired
  • detailsobject
404Agent not found.
  • codestringrequired
  • messagestringrequired
  • detailsobject