JSON Format and Guidelines

All responses are in JSON and use the following format and guidelines.

Header Values

The JSON headers use the following values:

• auth-token: client-identifier
• Authorization: Bearer your-auth-token
• Accept: application/json
• Content-Type: application/json

Replace client-identifier with your applicable identifier, and replace your-auth-token with a valid bearer token. Refer to Establishing a Connection for steps to retrieve required authentication resources to provide as header values.

JSON Format

The well-formed JSON adheres to the following standards and guidelines.

• Requests and responses use application/json.
• Keys and strings must be double-quoted.
• Arrays represent lists.
• Timestamps are numeric (epoch).
• The conversations array must contain at least one item.

Request Schema

The following are general requirements for the request schema.

Required fields:

• conversationId (string)
• configId (string)
• conversations (array with at least one item)

Optional fields:

• formatInstructions (object)