Skip to main content
PATCH
Edit a case

Authorizations

Authorization
string
header
required

Send Authorization: Bearer YOUR_API_KEY. The key resolves to a single organization.

Path Parameters

id
string<uuid>
required

Benchmark id.

caseId
string<uuid>
required

Case id.

Body

application/json
title
string
Required string length: 1 - 160
tags
string[]

User tags (max 20); normalized to lowercase-kebab.

Maximum array length: 20
Maximum string length: 200
checkGroupId
string<uuid> | null
language
string | null
Required string length: 2 - 16
agentVersionId
string<uuid> | null

The agent version whose prompt and tools the case was written against. Null = prompt as recorded.

agentId
string<uuid>

The benchmark agent the case was written for (shown on the case). Default: the agent of agentVersionId.

draft
boolean

Draft cases are saved but never run until confirmed.

turns
object[]

turn: the conversation so far, ending with the caller turn the agent answers.

Maximum array length: 200
variables
object
expected
string | null

turn: the expected outcome.

Maximum string length: 20000
replyExpectation
object

How the spoken reply of a turn case is checked.

toolExpectation
object

Which tool call(s) a turn case expects.

tools
object[]
Maximum array length: 50
toolMocks
object[]
Maximum array length: 50
conversation
object

conversation: the simulated caller.

referenceTranscript
string | null

audio: the reference.

Maximum string length: 20000
keyTerms
string[]
Maximum array length: 50
Required string length: 1 - 200
referenceVerified
boolean

audio: true marks the reference transcript as checked by a person; false flags it as unverified (it still runs).

skippedJudgeIds
string<uuid>[]
Maximum array length: 100
judgeParamOverrides
object

Response

Successful response.

A case with its content (transcript, expectations, tools). Reading it is audit-logged.

id
string
required
revision
integer
required
type
enum<string>
required
Available options:
turn,
conversation,
audio
title
string
required
checkGroupId
string | null
required
source
enum<string>
required
Available options:
production,
trace,
manual,
red_team,
api,
mcp,
upload
sourceConversationId
string | null
required
sourceAgent
object | null
required

An agent the benchmark is assigned to.

tags
string[]
required
language
string | null
required
retired
boolean
required
draft
boolean
required
preview
string
required
sourceAgentVersionLabel
string

The agent prompt version the case was written against, e.g. "v7".

referenceUnverified
boolean

audio: the reference transcript came from the call and nobody has checked it yet. The case still runs.

unpublished
boolean
skippedJudgeIds
string[]
judgeParamOverrides
object
addedInVersion
integer | null
retiredInVersion
integer | null
toolExpectation
object

Which tool call(s) a turn case expects.

replyExpectation
object

How the spoken reply of a turn case is checked.

traceSource
object
status
enum<string>
Available options:
ready,
draft,
preparing,
failed
contentPurged
boolean
contentDeleted
boolean

"Delete all call content" blanked this case: content and Judge reasoning are gone, the title is a neutral "Case N · content deleted", scores stay.

createdAt
string

ISO 8601 timestamp.

updatedAt
string

ISO 8601 timestamp.

context
object
persona
object
tools
object[]
toolMocks
object[]
keyTerms
string[]
referenceTranscript
string | null
variables
object
promptAgentVersionId
string | null