Update Evaluation Case

Beta

PATCH

https://api.speechify.ai/v1/agents/knowledge-bases/:kb_id/eval-cases/:case_id

Change a case. Omitted fields keep their value. Past evaluations keep the question and expectation they ran against.

Authentication

AuthorizationBearer

Enter your API key with the Bearer prefix, e.g. ‘Bearer sk_…’.

Path parameters

kb_idstringRequired

Knowledge base id (prefixed external id, kb_...).

case_idstringRequired

Evaluation case id (prefixed external id, kbcase_...).

Request

This endpoint expects an object.

querystringOptional<=500 characters

expected_document_idslist of stringsOptional

unanswerablebooleanOptional

notestringOptional<=1000 characters

Response headers

Speechify-Request-IdstringOptional

Unique identifier for this request, present on every response (2xx and non-2xx alike). If the caller sends a Speechify-Request-Id request header the server echoes it back (sanitized and length-capped) so one logical request can be traced end-to-end; otherwise the server generates a fresh value. Log it on every response and quote it in support requests

it is the stable handle that ties your observation to Speechify’s server-side logs, and it matches the request_id field in the error envelope.

The legacy alias X-Request-ID carries the same value and is still accepted on requests, until 2027-07-24. Prefer the un-prefixed name (RFC 6648).

Unique identifier for this request, present on every response (2xx and non-2xx alike). If the caller sends a `Speechify-Request-Id` request header the server echoes it back (sanitized and length-capped) so one logical request can be traced end-to-end; otherwise the server generates a fresh value. Log it on every response and quote it in support requests - it is the stable handle that ties your observation to Speechify's server-side logs, and it matches the `request_id` field in the error envelope. The legacy alias `X-Request-ID` carries the same value and is still accepted on requests, until 2027-07-24. Prefer the un-prefixed name (RFC 6648).

Response

The updated case.

idstringformat: "^kbcase_[0-9a-hjkmnp-tv-z]{26}$"

kb_idstringformat: "^kb_[0-9a-hjkmnp-tv-z]{26}$"

querystring

expected_document_idslist of strings

The documents whose passages answer the question. Empty for an unanswerable case.

unanswerableboolean

Nothing in the knowledge base should answer this; retrieval is expected to say so.

notestring

created_atdatetime

updated_atdatetime

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

$	curl -X PATCH https://api.speechify.ai/v1/agents/knowledge-bases/kb_01jqr8x9zg5k2m3n4p5q6r7s8t/eval-cases/kbcase_01jqr8x9zg5k2m3n4p5q6r7s8t \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"id": "kbcase_01jqr8x9zg5k2m3n4p5q6r7s8t",
3	"kb_id": "kb_01jqr8x9zg5k2m3n4p5q6r7s8t",
4	"query": "how do I reset my password",
5	"expected_document_ids": [
6	"doc_01jqr8x9zg5k2m3n4p5q6r7s8t"
7	],
8	"unanswerable": true,
9	"note": "From the September support review",
10	"created_at": "2024-01-15T09:30:00Z",
11	"updated_at": "2024-01-15T09:30:00Z"
12	}