Skip to main content
POST

Authorizations

Authorization
string
header
required

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

Body

application/json
contact
string

Contact name

avatar
string

Contact photo

script
string

Conversation

bubble
enum<string>

Message type

Available options:
imessage,
sms
theme
enum<string>

Appearance

Available options:
light,
dark
statusTime
string

Status bar time

placeholder
string

Input bar text

delivered
boolean

Show Delivered under the last sent message

scrollPercent
number

Scroll position

Required range: 0 <= x <= 100

Response

Tool output

outputs
object
required
tool
string
required

The tool's slug, echoing the {slug} in the request path.

tool_version
string
required

Output-contract version for this tool.

credits_used
integer
required

Credits this call consumed, after any settlement refund. 0 when metering is disabled.

credits_remaining
integer | null
required

Credits left in the current monthly allowance, or null when metering is disabled.

request_id
string

Correlation id, also sent as x-request-id.