Skip to content
OnCoreDocs
Test Suites

PATCHhttps://core-api.heysadie.ai/test-suites/{id}/cases/{caseId}

id caseId name personaInstructions expectedOutcome sortOrder maxTurns seedMessages role content toolMocks assertions type tool required description valueType comparator expected success data suiteId createdAt updatedAt metadata timestamp version path error code message details field

Update test suites cas

Try it in the API Explorer

Example request

Terminal
curl -X PATCH "https://core-api.heysadie.ai/test-suites/TEST_SUITE_ID/cases/CASE_ID" \
  -H "Authorization: ApiKey YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "personaInstructions": "string",
    "expectedOutcome": "string"
  }'

Authentication

Authenticate with an API key in the Authorization header using the ApiKey scheme. See Authentication for how keys work and where to get them.

Authorizationstringrequired

API key in the ApiKey scheme: ApiKey YOUR_API_KEY. Tenant keys authorize their own tenant; organization keys can act on any tenant in the organization.

X-Tenant-Idstring (uuid)optional

Required when authenticating with an organization key: it selects the tenant the request acts on. Omit with tenant keys.

Request

Path parameters

idstringrequired

The resource's UUID.

caseIdstringrequired

Body application/json · required

namestringoptional
personaInstructionsstringoptional
expectedOutcomestringoptional
sortOrderstring (integer) | integeroptional
maxTurnsstring (integer) | integeroptional
seedMessagesobject[] | nulloptional
Show 2 item properties
roleenumrequired
Allowed values:"user""assistant"
contentstringrequired
toolMocksmap<string, any>optional
assertionsobject[]optional
Show 13 item properties
typeenumrequired
Allowed values:"tool_called"
toolstringrequired
requiredbooleanoptional
typeenumrequired
Allowed values:"tool_not_called"
toolstringrequired
requiredbooleanoptional
typeenumrequired
Allowed values:"extract"
namestringrequired
descriptionstringrequired
valueTypeenumrequired
Allowed values:"boolean""number""string"
comparatorenumrequired
Allowed values:"eq""neq""gt""gte""lt""lte""contains"
expectedboolean | number | stringrequired
requiredbooleanoptional

Responses

200
successbooleanrequired

true on every 2xx

dataobjectoptional

The result

Show 12 child properties
idstringrequired
suiteIdstringrequired
namestringrequired
sortOrdernumberrequired
personaInstructionsstringrequired
expectedOutcomestringrequired
maxTurnsnumberrequired
seedMessagesobject[] | nullrequired
Show 2 item properties
roleenumrequired
Allowed values:"user""assistant"
contentstringrequired
toolMocksmap<string, any>required
assertionsobject[]required
Show 13 item properties
typeenumrequired
Allowed values:"tool_called"
toolstringrequired
requiredbooleanoptional
typeenumrequired
Allowed values:"tool_not_called"
toolstringrequired
requiredbooleanoptional
typeenumrequired
Allowed values:"extract"
namestringrequired
descriptionstringrequired
valueTypeenumrequired
Allowed values:"boolean""number""string"
comparatorenumrequired
Allowed values:"eq""neq""gt""gte""lt""lte""contains"
expectedboolean | number | stringrequired
requiredbooleanoptional
createdAtstring (date-time) | string (date) | number | string | nullrequired
updatedAtstring (date-time) | string (date) | number | string | nullrequired
metadataobjectoptional

Request metadata

Show 3 child properties
timestampstringrequired

When the server answered, ISO 8601 UTC

versionstringrequired

API version

pathstringoptional

The URL that was requested

400The request is invalid. `details` lists each field that failed
successbooleanrequired

false on every error

errorobjectoptional

What went wrong: a stable `code` to branch on and a human-readable `message`

Show 3 child properties
codeenumrequired

A parameter or body field broke a rule

Allowed values:"VALIDATION_ERROR"
messagestringrequired

Human-readable explanation. Do not parse it; branch on `code`

detailsobject[]optional

One entry per field that failed

Show 2 item properties
fieldstringrequired

The offending field

messagestringrequired

The rule it broke

metadataobjectoptional

Request metadata

Show 3 child properties
timestampstringrequired

When the server answered, ISO 8601 UTC

versionstringrequired

API version

pathstringoptional

The URL that was requested

401Missing or invalid credentials
successbooleanrequired

false on every error

errorobjectoptional

What went wrong: a stable `code` to branch on and a human-readable `message`

Show 2 child properties
codeenumrequired

No valid credentials

Allowed values:"UNAUTHORIZED"
messagestringrequired

Human-readable explanation. Do not parse it; branch on `code`

metadataobjectoptional

Request metadata

Show 3 child properties
timestampstringrequired

When the server answered, ISO 8601 UTC

versionstringrequired

API version

pathstringoptional

The URL that was requested

403The credentials are valid but may not use this route
successbooleanrequired

false on every error

errorobjectoptional

What went wrong: a stable `code` to branch on and a human-readable `message`

Show 2 child properties
codeenumrequired

The credentials may not use this route

Allowed values:"FORBIDDEN"
messagestringrequired

Human-readable explanation. Do not parse it; branch on `code`

metadataobjectoptional

Request metadata

Show 3 child properties
timestampstringrequired

When the server answered, ISO 8601 UTC

versionstringrequired

API version

pathstringoptional

The URL that was requested

404Not found, or outside the caller's scope
successbooleanrequired

false on every error

errorobjectoptional

What went wrong: a stable `code` to branch on and a human-readable `message`

Show 2 child properties
codeenumrequired

An id names nothing the caller can see

Allowed values:"RESOURCE_NOT_FOUND"
messagestringrequired

Human-readable explanation. Do not parse it; branch on `code`

metadataobjectoptional

Request metadata

Show 3 child properties
timestampstringrequired

When the server answered, ISO 8601 UTC

versionstringrequired

API version

pathstringoptional

The URL that was requested

500An unexpected server error
successbooleanrequired

false on every error

errorobjectoptional

What went wrong: a stable `code` to branch on and a human-readable `message`

Show 2 child properties
codeenumrequired

An unexpected server failure

Allowed values:"INTERNAL_SERVER_ERROR"
messagestringrequired

Human-readable explanation. Do not parse it; branch on `code`

metadataobjectoptional

Request metadata

Show 3 child properties
timestampstringrequired

When the server answered, ISO 8601 UTC

versionstringrequired

API version

pathstringoptional

The URL that was requested