API ReferenceEvaluations

Match Calls To Action

View as Markdown
Finds matching CTAs based on conversation context, user, session, device, or messages

Authentication

x-api-keystring
API key for authentication
OR
AuthorizationBearer
Bearer token authentication

Request

This endpoint expects an object.
conversationstring or nullOptional1-100 characters
clientstring or nullOptional1-11 characters
devicestring or nullOptional1-100 characters
languagestring or nullOptional2-10 characters

ISO language code, or auto to detect from the prompt.

limitinteger or nullOptional
messageslist of objects or nullOptional
Chat messages in OpenAI format.
sessionstring or nullOptional1-100 characters
userstring or nullOptional1-100 characters
variablesmap from strings to strings or nullOptional

Flat string key/value pairs substituted into {key} placeholders in evaluator prompts run during CTA matching. Not persisted.

Response

Matched CTAs
ctaslist of objectsOptional

Errors

403
Forbidden Error
422
Unprocessable Entity Error
500
Internal Server Error
503
Service Unavailable Error