Skip to main content
POST
Run an AI chat completion on a conversation

Authorizations

Authorization
string
header
required

Your v3 API key, e.g. ask_live_…

Headers

X-Subaccount-Id
string

Target subaccount for the request. Required unless the API key is authorized for exactly one subaccount (then it defaults to that one). Alternatively pass subaccount_id (or legacy location_id) in the request body. Omitting it on a multi-subaccount key returns 400 subaccount_required.

Body

application/json
assistant_id
string
required
Minimum string length: 1
conversation_id
string
required
Minimum string length: 1
additional_instructions
string
require_active_tag
boolean

When true, skip the reply unless the contact has one of this assistant's Active Tags (assistants without Active Tags always reply). A skipped run returns 200 with status skipped and error contact_missing_active_tag. Applies to GHL subaccounts only; Direct subaccounts ignore it. Defaults to false.

subaccount_id
string

Target subaccount id. Prefer the X-Subaccount-Id header; this body field is a fallback.

location_id
string

Alias for subaccount_id (GHL location id).

Response

Success

data
object
required
request_id
string
required
error
null