Create Journey

(v2)

POST

Creates a journey with a root Start state and returns its id. Build it out by adding states and edges, or send graphSource as ai to have Confident AI draft them for you in the background. Names are unique within a project; reusing one returns a 409.

POST/v2/journeys

curl -X POST "https://api.confident-ai.com/v2/journeys" \
  -H "CONFIDENT_API_KEY: <PROJECT-API-KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Refund request",
  "description": "A customer asks for a refund on a recent order. The agent verifies who they are, then either issues the refund or hands the conversation to a human.",
  "graphSource": "ai"
}'

200

{
  "success": true,
  "data": {
    "id": "<JOURNEY-ID>"
  },
  "link": "https://app.confident-ai.com/project/<PROJECT-ID>/journeys/<JOURNEY-ID>",
  "deprecated": false
}

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Request body

namestringRequired
The name of the journey, unique within the project.
descriptionstring | null
What the user is trying to get done on this journey. When graphSource is ai, the draft is written from this and the name, so say how the conversation can end.
graphSourceenum
Send ai to have Confident AI draft the journey's states and edges in the background with your project's platform model. Omit it to start with only the root Start state. The draft lands shortly after the response, so retrieve the journey to see it; if drafting fails, the journey keeps only its Start state.
Show 1 enum valueHide 1 enum value
- ai

Response

Create Journey succeeded.

successboolean
Indicates if the request was successful.
dataobject
A reference to a journey by its id.
Show 1 propertyHide 1 property
- idstring
  The id of the journey, generated by Confident AI.
linkstring
This is the URL of the resource on the Confident AI platform.
deprecatedboolean
Indicates if this endpoint is deprecated.

Built byConfident AI