For AI agents and LLMs: a machine-readable index is available at llms.txt. A plain-Markdown version of any documentation page is available by appending .md to its URL.
Run conversational evaluation for the workflow's chat scenarios and persist the results. Poll GET /api/evaluation-results/{workflow_id} for the outcome.
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Path Parameters
workflow_idstringrequired
Body
application/json
workflow_idstringrequired
project_idstringrequired
Project ID associated with the workflow
requeststring
Request data for the evaluation (cURL command as JSON). Required if endpoint_profile_id is not provided.
responseSchemastring
Response schema for the evaluation as a JSON string
api_configobject
API configuration for the evaluation
metricsarray
List of metrics to evaluate. If not provided, all available metrics will be used.
suite_idstring
Optional suite_id for suite-based evaluations
endpoint_profile_idstring
ID of the endpoint profile to use for API configuration. If provided, 'request' field is ignored.
test_profile_idstring
ID of the test profile to use for variable data (e.g., mobile number, OTP).
scenario_idsarray
Optional list of specific scenario IDs to run — for example, to re-run only failed / NO-RESULTS scenarios. When provided, only these scenarios are packaged and run; composes with suite_id (suite filter applies first).