Skip to main content
PATCH
Update version

Authorizations

​
Authorization
string
header
required

API key authorization. Pass your API key in the Authorization header as a Bearer token. Both new (gsk_*) and legacy (gsk-) API keys are accepted, e.g. Authorization: Bearer gsk_... or Authorization: Bearer gsk-....

Path Parameters

​
id
string
required

Version ID

Body

application/json
​
id
string
Example:

"ver_123"

​
productId
string
Example:

"prod_123"

​
userId
string | null
Example:

"user_123"

​
name
string

Optional human label. Omit it and the version is stored under its canonical label. A name of "v" followed by digits is rejected, because it reads as the number of another version. The one exception is the number this version is given, which produces the same result as omitting the name. "v1.0" is accepted.

Example:

"support release"

​
description
string | null
Example:

"Version description"

​
modelId
string | null
Example:

"model_123"

​
systemPrompt
string | null
Example:

"You are a helpful assistant"

​
datasetUri
string | null
Example:

"https://example.com/dataset.csv"

​
datasetDescription
string | null
Example:

"Training dataset"

​
guardrails
string | null
Example:

"Safety guidelines"

​
facts
object | null

The agent state this version represents, as a flat map of text to text. Every key and every value is trimmed, an entry whose key or value is then empty is dropped, and the rest is kept exactly, so "0.7" and "0.70" are two different facts. At most 32 keys, and at most 2000 bytes once the map is encoded as JSON, which counts its punctuation too. No key and no value may hold the NUL character or half of a surrogate pair. Two keys that become equal after the spaces around them are removed are refused, unless both become empty, which drops them instead because a blank key names no fact; a key repeated with the exact same spelling never reaches that rule, because JSON parsing keeps only its last value. Two live versions of one product may not hold the same facts; the key order you send does not change that comparison. A map that leaves no entry is stored as null.

Example:
​
otelInputSourceRule
object | null

Recover a turn's user-visible input for products whose user message lives on a non-LLM span. Set per product or version (version wins). Per span it applies only when no LLM input is present. Per turn the value it extracts IS the turn input, ahead of every fallback, and the turn input is EMPTY when the rule extracts nothing from any span of the turn. The two directions resolve independently.

Example:
​
otelOutputSourceRule
object | null

Recover a turn's user-visible output for templated or non-LLM replies whose final answer lives on a non-LLM span. Set per product or version (version wins). Per span it applies only when no LLM output is present. Per turn the value it extracts IS the turn output, ahead of every fallback, and the turn output is EMPTY when the rule extracts nothing from any span of the turn. The two directions resolve independently.

Example:
​
initializationEndpointConnectionId
string | null
Example:

"ec_123"

​
conversationEndpointConnectionId
string | null
Example:

"ec_123"

​
finalizationEndpointConnectionId
string | null
Example:

"ec_123"

​
phoneConnectionId
string | null

The version's phone connection (telephony conversation target). At most one conversation target may be set across conversationEndpointConnectionId, phoneConnectionId, and webRtcConnectionId.

Example:

"phoneConnection_123"

​
webRtcConnectionId
string | null

The version's WebRTC connection (live two-way audio conversation target). At most one conversation target may be set across conversationEndpointConnectionId, phoneConnectionId, and webRtcConnectionId.

Example:

"webRtcConnection_123"

​
parentVersionId
string | null

Id of the version this one was revised from (its direct parent in the revision lineage). On create, providing this value records the parent edge; the parent must belong to the same product. Omit or null to create a root version with no parent. On responses, this is the recorded parent edge (null for roots).

Example:

"ver_122"

​
createdAt
string<date-time>
​
deletedAt
string<date-time> | null

Response

Version updated successfully

​
id
string
Example:

"ver_123"

​
productId
string
Example:

"prod_123"

​
userId
string | null
Example:

"user_123"

​
number
integer
read-only

The version's sequence number inside its product. It starts at 1, is assigned when the version is created, never changes, and is never reused after a version is deleted. The canonical label is "v" followed by this number.

Required range: x >= 1
Example:

7

​
name
string

Optional human label. Omit it and the version is stored under its canonical label. A name of "v" followed by digits is rejected, because it reads as the number of another version. The one exception is the number this version is given, which produces the same result as omitting the name. "v1.0" is accepted.

Example:

"support release"

​
description
string | null
Example:

"Version description"

​
modelId
string | null
Example:

"model_123"

​
systemPrompt
string | null
Example:

"You are a helpful assistant"

​
datasetUri
string | null
Example:

"https://example.com/dataset.csv"

​
datasetDescription
string | null
Example:

"Training dataset"

​
guardrails
string | null
Example:

"Safety guidelines"

​
facts
object | null

The agent state this version represents, as a flat map of text to text. Every key and every value is trimmed, an entry whose key or value is then empty is dropped, and the rest is kept exactly, so "0.7" and "0.70" are two different facts. At most 32 keys, and at most 2000 bytes once the map is encoded as JSON, which counts its punctuation too. No key and no value may hold the NUL character or half of a surrogate pair. Two keys that become equal after the spaces around them are removed are refused, unless both become empty, which drops them instead because a blank key names no fact; a key repeated with the exact same spelling never reaches that rule, because JSON parsing keeps only its last value. Two live versions of one product may not hold the same facts; the key order you send does not change that comparison. A map that leaves no entry is stored as null.

Example:
​
otelInputSourceRule
object | null

Recover a turn's user-visible input for products whose user message lives on a non-LLM span. Set per product or version (version wins). Per span it applies only when no LLM input is present. Per turn the value it extracts IS the turn input, ahead of every fallback, and the turn input is EMPTY when the rule extracts nothing from any span of the turn. The two directions resolve independently.

Example:
​
otelOutputSourceRule
object | null

Recover a turn's user-visible output for templated or non-LLM replies whose final answer lives on a non-LLM span. Set per product or version (version wins). Per span it applies only when no LLM output is present. Per turn the value it extracts IS the turn output, ahead of every fallback, and the turn output is EMPTY when the rule extracts nothing from any span of the turn. The two directions resolve independently.

Example:
​
initializationEndpointConnectionId
string | null
Example:

"ec_123"

​
conversationEndpointConnectionId
string | null
Example:

"ec_123"

​
finalizationEndpointConnectionId
string | null
Example:

"ec_123"

​
phoneConnectionId
string | null

The version's phone connection (telephony conversation target). At most one conversation target may be set across conversationEndpointConnectionId, phoneConnectionId, and webRtcConnectionId.

Example:

"phoneConnection_123"

​
webRtcConnectionId
string | null

The version's WebRTC connection (live two-way audio conversation target). At most one conversation target may be set across conversationEndpointConnectionId, phoneConnectionId, and webRtcConnectionId.

Example:

"webRtcConnection_123"

​
parentVersionId
string | null

Id of the version this one was revised from (its direct parent in the revision lineage). On create, providing this value records the parent edge; the parent must belong to the same product. Omit or null to create a root version with no parent. On responses, this is the recorded parent edge (null for roots).

Example:

"ver_122"

​
createdAt
string<date-time>
​
deletedAt
string<date-time> | null