StateSet API Docs

curl --request POST \
  --url 'https://response.stateset.com/api/v1/evals' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --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": "string",
  "description": "string",
  "reason_type": "string",
  "customer_impact": "string"
}'

POST

api

evals

curl --request POST \
  --url 'https://response.stateset.com/api/v1/evals' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --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": "string",
  "description": "string",
  "reason_type": "string",
  "customer_impact": "string"
}'

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.

Request body

CreateEval

string (uuid)

string

required

string

string (uuid)

string

Response

Returns object.

Status codes

Code	Meaning
`201`	The eval
`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

curl --request POST \
  --url 'https://response.stateset.com/api/v1/evals' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --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": "string",
  "description": "string",
  "reason_type": "string",
  "customer_impact": "string"
}'

Overview

Workspace

Agents

Rules

Functions

Knowledge

Conversations

Responses

Evals

Analytics

Integrations

Changes

Record what the agent should have said

Request body

Response

Status codes

Access

​Request body

​Response

​Status codes

​Access

Request body

Response

Status codes

Access