Skip to main content
GET
/
training
/
{id}
Get a training
curl --request GET \
  --url https://api.open.cx/training/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "title": "<string>",
  "content": "<string>",
  "draft_title": "<string>",
  "draft_content": "<string>",
  "type": "BEHAVIORAL",
  "is_draft": true,
  "directory_id": "<string>",
  "restricted_to_channels": [
    "web"
  ],
  "restricted_to_segments": [
    "<string>"
  ],
  "current_version": 123,
  "published_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Response

Default Response

​
id
string
required

Unique training ID

​
title
string
required

The scenario title or trigger phrase (last published version)

​
content
string
required

The instruction body — how the AI should respond (last published version)

​
draft_title
string | null
required

Draft title being edited (null if no draft exists). Use draft_title ?? title.

​
draft_content
string | null
required

Draft body being edited (null if no draft exists). Use draft_content ?? content.

​
type
enum<string>
required

BEHAVIORAL (always active) or SCENARIO_SPECIFIC (semantic match)

Available options:
BEHAVIORAL,
SCENARIO_SPECIFIC
​
is_draft
boolean
required

Draft trainings are saved but not used by the AI

​
directory_id
string | null
required

Directory this training belongs to

​
restricted_to_channels
enum<string>[]
required

Channels this applies to (empty = all)

Available options:
web,
email,
phone_voice,
slack,
sms,
whatsapp,
instagram,
messenger,
api,
web_voice
​
restricted_to_segments
string[]
required

Contact segments this applies to (empty = all)

​
current_version
number | null
required

Active published version number (null if unpublished draft)

​
published_at
string<date-time> | null
required

When the current version was published

​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required