curl --silent --show-error --fail-with-body --request POST \
--url 'https://response.stateset.com/api/v1/evals' \
--header "Authorization: Bearer $RESPONSECX_API_KEY" \
--header "Idempotency-Key: ${IDEMPOTENCY_KEY:?Set a unique key for this operation; preserve it on retries}" \
--header 'Content-Type: application/json' \
--data '{
"response_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"preferred_output": "string",
"user_message": "string",
"non_preferred_output": "string",
"agent_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "Two-Person Tent",
"description": "Two-person tent, green — replacement for damaged pole set.",
"reason_type": "string",
"customer_impact": "string"
}'
{
"object": "eval",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "Two-Person Tent",
"type": "standard",
"status": "pending",
"description": "Two-person tent, green — replacement for damaged pole set.",
"user_message": "string",
"preferred_output": "string",
"non_preferred_output": "string",
"reason_type": "string",
"customer_impact": "string",
"response_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"agent_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"ticket_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"created_at": "2026-08-31T14:22:05Z",
"updated_at": "2026-08-31T14:22:05Z"
}
Record what the agent should have said
Stores a preference pair. When response_id is given, the customer message and the actual reply are read from the stored response rather than taken from the…
POST
/
api
/
v1
/
evals
curl --silent --show-error --fail-with-body --request POST \
--url 'https://response.stateset.com/api/v1/evals' \
--header "Authorization: Bearer $RESPONSECX_API_KEY" \
--header "Idempotency-Key: ${IDEMPOTENCY_KEY:?Set a unique key for this operation; preserve it on retries}" \
--header 'Content-Type: application/json' \
--data '{
"response_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"preferred_output": "string",
"user_message": "string",
"non_preferred_output": "string",
"agent_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "Two-Person Tent",
"description": "Two-person tent, green — replacement for damaged pole set.",
"reason_type": "string",
"customer_impact": "string"
}'
{
"object": "eval",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "Two-Person Tent",
"type": "standard",
"status": "pending",
"description": "Two-person tent, green — replacement for damaged pole set.",
"user_message": "string",
"preferred_output": "string",
"non_preferred_output": "string",
"reason_type": "string",
"customer_impact": "string",
"response_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"agent_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"ticket_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"created_at": "2026-08-31T14:22:05Z",
"updated_at": "2026-08-31T14:22:05Z"
}
Stores a preference pair. When response_id is given, the customer message and the actual reply are read from the stored response rather than taken from the request, so the recorded pair is authentic.
Headers
string
Optional client-generated key that makes the POST safe to retry: a repeat with the same key and body replays the original response instead of creating a duplicate.
Request body
CreateEval
string (uuid)
string
required
Minimum length:
1. Maximum length: 50000.string
Maximum length:
50000.string
Maximum length:
50000.string (uuid)
string
Maximum length:
200.string
Maximum length:
10000.string
Maximum length:
100.string
Maximum length:
100.Response
object
string
required
Allowed values:
'eval'.string (uuid)
required
string,null
required
From the stored
eval_name.string,null
required
Defaults to
preference on create.string,null
required
Defaults to
pending on create.string,null
required
string,null
required
The customer message to replay. Copied from the source response when
response_id was supplied.string,null
required
The reply the agent should have given.
string,null
required
The reply that was actually given. Copied from the source response when
response_id was supplied.string,null
required
string,null
required
string,null (uuid)
required
string,null (uuid)
required
string,null
required
Stored as a string; derived from the source response when not supplied.
string,null (date-time)
required
string,null (date-time)
required
Status codes
| Code | Meaning |
|---|---|
201 | The created eval. When response_id was supplied, user_message, non_preferred_output and ticket_id come from the stored response, not the request. |
400 | Invalid request. issues names the offending field(s). |
401 | Missing, invalid, or expired API key. |
403 | The key lacks a required scope. |
404 | Not found, or not in the organization that owns the key. |
409 | Conflict — either the creation ceiling was reached for this organization (agent_limit_reached), or a request with the same Idempotency-Key is still in flight (idempotency_in_progress); retry the latter after the first attempt settles. |
422 | The Idempotency-Key was already used with a DIFFERENT request body (idempotency_key_reused). Reuse a key only to retry the identical request. |
429 | Rate limit exceeded. |
Access
| Required scope | responses:write |
| Rate limit | 30 requests per minute |
Using this contract
Read the source OpenAPI document for declared schemas and alternatives. This page also includes documented corrections from the spec overlays. Example IDs and values are illustrative; replace them with records from your workspace.curl --silent --show-error --fail-with-body --request POST \
--url 'https://response.stateset.com/api/v1/evals' \
--header "Authorization: Bearer $RESPONSECX_API_KEY" \
--header "Idempotency-Key: ${IDEMPOTENCY_KEY:?Set a unique key for this operation; preserve it on retries}" \
--header 'Content-Type: application/json' \
--data '{
"response_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"preferred_output": "string",
"user_message": "string",
"non_preferred_output": "string",
"agent_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "Two-Person Tent",
"description": "Two-person tent, green — replacement for damaged pole set.",
"reason_type": "string",
"customer_impact": "string"
}'
{
"object": "eval",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "Two-Person Tent",
"type": "standard",
"status": "pending",
"description": "Two-person tent, green — replacement for damaged pole set.",
"user_message": "string",
"preferred_output": "string",
"non_preferred_output": "string",
"reason_type": "string",
"customer_impact": "string",
"response_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"agent_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"ticket_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"created_at": "2026-08-31T14:22:05Z",
"updated_at": "2026-08-31T14:22:05Z"
}
Last modified on September 21, 2026