ROroarkhq
Customer Flow Edge Case

Add an edge case

Changed on

Adds a variant to an IMPROV flow.

A scripted flow's variants are owned by the path engine, one per path through the graph, so they are created by editing the graph through PUT /v1/customer-flow/{flowId}/graph rather than here.

Leave personaOverrideId or environmentId unset to inherit the happy path's.

post/v1/customer-flow/{flowId}/edge-case

Request

  • Base URL
    https://api.roark.ai
  • URL
    https://api.roark.ai/v1/customer-flow/{flowId}/edge-case
  • Auth
    HTTP bearer

Path parameters

flowIdstring uuid required

Request body

titlestring required
environmentIdstring uuid nullable
promptstring nullable
precededByCustomerFlowIdstring uuid nullable
precededByCustomerFlowVariantIdstring uuid nullable
includeFlowExpectationsboolean

Whether this edge case is graded on the flow's agentExpectations as well as its own additionalExpectations. Defaults to true; false grades it on its additionalExpectations only.

personaOverrideIdstring uuid nullable

The persona this runs as. Omit to inherit the happy path's.

Example request

{
  "additionalExpectations": [
    {
      "prompt": "The agent confirmed the new appointment time back to the customer"
    }
  ]
}

Response

The edge case that was added

Example response

{
  "data": {
    "personaOverride": {
      "backstoryPrompt": "A busy professional calling during lunch break",
      "properties": {
        "age": 35,
        "zipCode": "94105",
        "occupation": "Software Engineer"
      },
      "phoneNumber": "+19312830919"
    }
  }
}

Changes

  • f747fc3e482cRevision changes
    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

  • e32b31fc8f98Revision changes
    • info

      added the optional property /// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status