Test AI reply label prediction

Returns the AI-predicted lead label for a reply text. This simulates how AI auto-tagging would label an incoming reply for testing custom labels and descriptions. Rate limit: 500 requests per 30 days per workspace. This rate limit applies only to this testing endpoint; live reply processing does not use this limiter.

Requires one of the following scopes: lead-labels:read, lead-labels:all, all:read, all:all

POST /api/v2/lead-labels/ai-reply-label

Test AI reply label prediction

cURL

curl --request POST \
  --url https://api.instantly.ai/api/v2/lead-labels/ai-reply-label \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reply_text": "Thanks for reaching out. I am interested in learning more."
}
'

200

{
  "result": "Hot Lead",
  "custom_labels_considered": [
    "Hot Lead",
    "Needs Follow-up"
  ]
}

Authorizations

Authorization · string · header · required

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

Body

application/json

reply_text · string · required

The reply text to classify.

Example:

"Thanks for reaching out. I am interested in learning more."

Response

200

application/json

Default Response

result · string

The predicted lead label.

Example:

"Hot Lead"

custom_labels_considered · string[]

AI-enabled custom labels considered during classification.

Example:

["Hot Lead", "Needs Follow-up"]