Skip to main content
POST
Ask an AI about a record's history

Authorizations

Authorization
string
header
required

Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.

Body

application/json
subjectType
enum<string>
required

Type of subject record

Available options:
sales_order,
fulfillment_order,
shipment
subjectId
integer
required

ID of the subject record

Required range: x >= 1
question
string
required

Free-text question to ask about the record's history

Maximum string length: 1000

Response

AI-generated answer

answer
string

Natural-language answer derived from the record's activity log