Skip to navigation

Get conversational process

View as Markdown

Returns one conversational process by its id. Secrets come back redacted.

Authentication

AuthorizationBearer

JWT bearer token authentication. Include the Configuration API key in the Authorization header as ‘Bearer <token>’.

Path parameters

idstringRequired

The id of the conversational process, as returned when it was created or listed.

Response

The conversational process
idstringOptionalRead-only
Unique identifier of the conversational process, assigned by the server. Cannot be changed.
signatureobjectOptional
Name and description of the conversational process. The internal name is derived from the display name. Required.
slotslist of objectsOptional

Input values (slots) the process collects from the user and uses as variables in the conversation flow.

conversation_flowobjectOptional

The control flow of the process, built from sequential, switch, activity, return and no-op blocks. Required.

updated_timedatetimeOptionalRead-only
When the configuration was last updated.
updated_bystringOptionalRead-only
Who last updated the configuration.
versionobjectOptional
Document version. On update, send back the num from your last read.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error