List Journeys

(v2)

GET

Lists the journeys in your Confident AI project one page at a time, newest first. Each journey is returned with its id, name, and how many states and goldens it has; retrieve one by id to read its states, edges and paths.

GET/v2/journeys

curl -X GET "https://api.confident-ai.com/v2/journeys" \
  -H "CONFIDENT_API_KEY: <PROJECT-API-KEY>"

200

{
  "success": true,
  "data": {
    "journeys": [
      {
        "id": "<JOURNEY-ID>",
        "name": "Refund request",
        "stateCount": 4,
        "goldenCount": 10
      }
    ],
    "totalJourneys": 3,
    "page": 1,
    "pageSize": 25
  },
  "link": "https://app.confident-ai.com/project/<PROJECT-ID>/journeys",
  "deprecated": false
}

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Query parameters

pageintegerdefault: 1
The page to return. Defaults to 1.
pageSizeintegerdefault: 25
The number of journeys per page, at most 100. Defaults to 25.

Response

List Journeys succeeded.

successboolean
Indicates if the request was successful.
dataobject
One page of journeys, with the total across all pages.
Show 4 propertiesHide 4 properties
- journeyslist of objects
  The journeys for the current page, newest first.
  Show 4 propertiesHide 4 properties
  - idstring
    The id of the journey, generated by Confident AI.
  - namestring
    The name of the journey.
  - stateCountinteger
    The number of states in the journey, including its root.
  - goldenCountinteger
    The number of goldens generated from the journey.
- totalJourneysinteger
  The total number of journeys in this project.
- pageinteger
  The page this response covers.
- pageSizeinteger
  The number of journeys per page.
linkstring
This is the URL of the resource on the Confident AI platform.
deprecatedboolean
Indicates if this endpoint is deprecated.

Built byConfident AI