curl --request POST \
--url https://api.usenexio.com/api/v1/conversation-instances/{instance_slug}/versions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"changelog": "<string>",
"waived_by": "<string>",
"waive_reason": "<string>"
}
'import requests
url = "https://api.usenexio.com/api/v1/conversation-instances/{instance_slug}/versions"
payload = {
"changelog": "<string>",
"waived_by": "<string>",
"waive_reason": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({changelog: '<string>', waived_by: '<string>', waive_reason: '<string>'})
};
fetch('https://api.usenexio.com/api/v1/conversation-instances/{instance_slug}/versions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"version": 123,
"config_hash": "<string>",
"released_at": "2023-11-07T05:31:56Z",
"changelog": "<string>",
"already_released": true,
"published_by": "<string>"
}{
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}{
"code": "unauthorized",
"message": "Missing or invalid API key"
}{
"code": "insufficient_capability",
"message": "API key does not have permission for this action"
}{
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}{
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}{
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}{
"code": "rate_limited",
"message": "Rate limit exceeded"
}{
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}{
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}{
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}Publish a version
Release the draft config as the next version, through the eval gate. Organization API keys only.
curl --request POST \
--url https://api.usenexio.com/api/v1/conversation-instances/{instance_slug}/versions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"changelog": "<string>",
"waived_by": "<string>",
"waive_reason": "<string>"
}
'import requests
url = "https://api.usenexio.com/api/v1/conversation-instances/{instance_slug}/versions"
payload = {
"changelog": "<string>",
"waived_by": "<string>",
"waive_reason": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({changelog: '<string>', waived_by: '<string>', waive_reason: '<string>'})
};
fetch('https://api.usenexio.com/api/v1/conversation-instances/{instance_slug}/versions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"version": 123,
"config_hash": "<string>",
"released_at": "2023-11-07T05:31:56Z",
"changelog": "<string>",
"already_released": true,
"published_by": "<string>"
}{
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}{
"code": "unauthorized",
"message": "Missing or invalid API key"
}{
"code": "insufficient_capability",
"message": "API key does not have permission for this action"
}{
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}{
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}{
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}{
"code": "rate_limited",
"message": "Rate limit exceeded"
}{
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}{
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}{
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}Behavior
This request runs the instance’sgate eval scenarios with real model calls before it releases anything, and can take up to 50 minutes. It is exempt from the 30-second request timeout; keep the connection open. The gate rules, every outcome, and the waiver are on Versions and publish.Authorizations
Send the key as Authorization: Bearer <key>. Two kinds of key exist.
Organization keys are issued in the portal (Settings, then API keys),
each bound to one environment, shaped nx_<environment slug>_<64 hex>. They carry
no capabilities and pass every capability check, with one exception:
routes under /api/v1/records, /api/v1/engines/{id}/opportunities,
/api/v1/graph and /api/v1/catalog/documents accept an
organization key only when its environment is live, and refuse any
other with 403 scoped_key_required. Revocation takes effect within 60
seconds.
Scoped keys are issued by Nexio on request, shaped
nxsk_v1_<24 hex key id>_<43 character secret>. Each is bound to one
org, one environment, a set of engines and a set of capabilities. A
malformed, unknown or revoked nxsk_ key fails with 401 and is never
retried as an organization key. Revocation takes effect on the next
request. A scoped key without a route's capability gets 403
insufficient_capability; a scoped key not bound to the engine gets 403
engine_binding_forbidden.
Key-grantable capabilities: engines:read, runs:write, runs:read,
runs:defensibility:read, runs:test, catalog:read,
catalog:documents:read, webhooks:manage, conversations:use,
conversations:export, records:read, records:opportunities:run,
actions:write, actions:read, graph:read, records:analyze.
Routes that accept organization keys only (every scoped key gets 403
insufficient_capability): environment management, engine create,
update, configuration and publish, and conversation instance
authoring. Each operation description names the capability a scoped
key needs.
Path Parameters
Conversation instance identifier slug (e.g. platform-assistant).
Response
The released version (or the idempotent no-op). released_at has whole-second precision. On a new release it is the time the response was built and can differ slightly from the version list. When already_released is true, changelog and published_by are the latest version's, not this request's.