Export a conversation

Export a conversation (compliance)

curl --request GET \
  --url https://api.usenexio.com/api/v1/conversation-instances/{instance_slug}/conversations/{conversation_id}/export \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.usenexio.com/api/v1/conversation-instances/{instance_slug}/conversations/{conversation_id}/export"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.usenexio.com/api/v1/conversation-instances/{instance_slug}/conversations/{conversation_id}/export', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "export_version": "<string>",
  "generated_at": "2023-11-07T05:31:56Z",
  "conversation": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "org_id": "<string>",
    "environment": "<string>",
    "instance_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "end_user": "<string>",
    "title": "<string>",
    "status": "active",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "messages": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "role": "user",
      "turn_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "config_version_hash": "<string>",
      "parent_message_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "content": [
        {}
      ],
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "config_versions": [
    {
      "hash": "<string>",
      "released_version": "<string>"
    }
  ],
  "tool_events": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "turn_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "tool_name": "<string>",
      "execution": "<string>",
      "outcome": "<string>",
      "duration_ms": 123,
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "guardrail_events": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "turn_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "config_version_hash": "<string>",
      "rule_id": "<string>",
      "decision": "<string>",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "annotations": [
    {
      "triage": {
        "status": "<string>",
        "owner": "<string>",
        "reply": "<string>",
        "revision": 123
      },
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "instance_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "turn_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "rating": "good",
      "source": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "end_user": "<string>",
      "target": {},
      "comment": "<string>",
      "reason": "<string>",
      "submitter_user_id": "<string>",
      "submitter_id": "<string>",
      "feedback_key": "<string>"
    }
  ]
}

{
  "code": "<string>",
  "message": "<string>",
  "details": "<unknown>"
}

{
  "code": "unauthorized",
  "message": "Missing or invalid API key"
}

{
  "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": "auth_unavailable",
  "message": "API key authentication is temporarily unavailable"
}

{
  "code": "request_timeout",
  "message": "Request timed out"
}

GET

api

conversation-instances

{instance_slug}

conversations

{conversation_id}

export

Export a conversation (compliance)

curl --request GET \
  --url https://api.usenexio.com/api/v1/conversation-instances/{instance_slug}/conversations/{conversation_id}/export \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.usenexio.com/api/v1/conversation-instances/{instance_slug}/conversations/{conversation_id}/export"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.usenexio.com/api/v1/conversation-instances/{instance_slug}/conversations/{conversation_id}/export', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "export_version": "<string>",
  "generated_at": "2023-11-07T05:31:56Z",
  "conversation": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "org_id": "<string>",
    "environment": "<string>",
    "instance_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "end_user": "<string>",
    "title": "<string>",
    "status": "active",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "messages": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "role": "user",
      "turn_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "config_version_hash": "<string>",
      "parent_message_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "content": [
        {}
      ],
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "config_versions": [
    {
      "hash": "<string>",
      "released_version": "<string>"
    }
  ],
  "tool_events": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "turn_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "tool_name": "<string>",
      "execution": "<string>",
      "outcome": "<string>",
      "duration_ms": 123,
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "guardrail_events": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "turn_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "config_version_hash": "<string>",
      "rule_id": "<string>",
      "decision": "<string>",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "annotations": [
    {
      "triage": {
        "status": "<string>",
        "owner": "<string>",
        "reply": "<string>",
        "revision": 123
      },
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "instance_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "turn_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "rating": "good",
      "source": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "end_user": "<string>",
      "target": {},
      "comment": "<string>",
      "reason": "<string>",
      "submitter_user_id": "<string>",
      "submitter_id": "<string>",
      "feedback_key": "<string>"
    }
  ]
}

{
  "code": "<string>",
  "message": "<string>",
  "details": "<unknown>"
}

{
  "code": "unauthorized",
  "message": "Missing or invalid API key"
}

{
  "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": "auth_unavailable",
  "message": "API key authentication is temporarily unavailable"
}

{
  "code": "request_timeout",
  "message": "Request timed out"
}

Authorizations

Authorization

string

header

required

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

instance_slug

string

required

Conversation instance identifier slug (e.g. platform-assistant).

conversation_id

string<uuid>

required

Query Parameters

end_user

string

required

The asserted end-user identity the conversation must belong to.

Response

The complete export document.

export_version

string

required

Export document contract version. Currently "1".

generated_at

string<date-time>

required

conversation

object

required

Hide child attributes

conversation.id

string<uuid>

required

conversation.org_id

string

required

conversation.environment

string

required

conversation.instance_id

string<uuid>

required

conversation.end_user

string

required

conversation.title

string | null

required

conversation.status

enum<string>

required

Available options:

active,

archived

conversation.created_at

string<date-time>

required

conversation.updated_at

string<date-time>

required

messages

object[]

required

The complete transcript in insertion order. An export is an audit artifact, so it keeps EVERY version of a revised message, not only the branch the conversation serves; parent_message_id records how the versions relate.

Hide child attributes

messages.id

string<uuid>

required

messages.role

enum<string>

required

Available options:

user,

assistant

messages.turn_id

string<uuid>

required

messages.config_version_hash

string

required

messages.parent_message_id

string<uuid> | null

required

The message this one follows on its branch; null when it starts the conversation.

messages.content

object[]

required

messages.created_at

string<date-time>

required

config_versions

object[]

required

Every distinct config version that served a message.

Hide child attributes

config_versions.hash

string

required

config_versions.released_version

string

The newest released instance version carrying this hash, as an integer string (for example "4"); omitted when the hash was never released.

tool_events

object[]

required

In the order they were recorded, oldest first.

Hide child attributes

tool_events.id

string<uuid>

required

tool_events.turn_id

string<uuid>

required

tool_events.tool_name

string

required

tool_events.execution

string

required

tool_events.outcome

string

required

tool_events.duration_ms

integer

required

tool_events.created_at

string<date-time>

required

guardrail_events

object[]

required

In the order they were recorded, oldest first.

Hide child attributes

guardrail_events.id

string<uuid>

required

guardrail_events.turn_id

string<uuid>

required

guardrail_events.config_version_hash

string

required

guardrail_events.rule_id

string

required

guardrail_events.decision

string

required

guardrail_events.created_at

string<date-time>

required

annotations

object[]

required

Every non-retracted annotation on the conversation, API and portal submitted, newest first.

Hide child attributes

annotations.triage

object

required

How the platform team is handling this feedback: status, owner, reply and revision. Read-only and always present. A new annotation reads {"status": "new", "owner": "", "reply": "", "revision": 0}.

Hide child attributes

annotations.triage.status

string

annotations.triage.owner

string

annotations.triage.reply

string

annotations.triage.revision

integer

annotations.id

string<uuid>

required

annotations.conversation_id

string<uuid>

required

annotations.instance_id

string<uuid>

required

annotations.turn_id

string<uuid>

required

annotations.rating

enum<string>

required

Available options:

good,

bad,

neutral

annotations.source

string

required

Capture surface, e.g. api or portal.

annotations.created_at

string<date-time>

required

annotations.updated_at

string<date-time>

required

annotations.end_user

string

The conversation's end user; omitted when unset.

annotations.target

object

Optional JSON sub-target inside the turn; omitted when unset.

annotations.comment

string

Optional free-text comment; omitted when unset.

annotations.reason

string

Optional structured reason token; omitted when unset.

annotations.submitter_user_id

string

Portal (WorkOS) submitter; omitted for API submissions.

annotations.submitter_id

string

Consumer-side submitter identifier; omitted when unset.

annotations.feedback_key

string

Replay-safe logical signal key; omitted when unset.

Last modified on September 25, 2026

Overview

Engines

Environments

Conversations

Webhooks

Events

Records

Graph

Platform

Export a conversation

Authorizations

Path Parameters

Query Parameters

Response