API

Export one owned saved conversation

Generated from the checked-in source. Do not edit this reference by hand.

GET /api/v1/workspaces/{workspace}/chats/{id}/export

Requires workspace read access and the authenticated conversation owner. Reads durable content directly, including sessions outside the latest-100 list. Excludes internal identifiers, settings, diagnostic errors and accounting. Conversation and attachment content is deliberately included and may contain user-supplied sensitive text. Legacy single-turn sessions become one turn. Does not export request Logs or billing evidence. The server resolves the organization from the authorized workspace. Foreign or missing workspaces return 404. The compatibility route remains supported with identical payload, owner, revision and replay semantics.

Operation: exportChatSessionByWorkspace.

Authentication

Use the credential and permission scope described above. Each object below is an alternative; schemes within one object are required together.

[
  {
    "bearerAuth": []
  }
]

HTTP request

Set NIU_ORIGIN to your installation origin (without /v1). Replace path, query and header placeholders with the required values. Query examples use curl 7.87 or newer to encode values with --url-query. Use the credential scope described above; a bearer token must have the authority required by this operation.

curl --fail-with-body -X GET "$NIU_ORIGIN/api/v1/workspaces/{workspace}/chats/{id}/export" \
  -H "Authorization: Bearer $NIU_BEARER_TOKEN"

Parameters

workspace

Location: path. Required.

{
  "type": "string",
  "format": "uuid"
}

id

Location: path. Required.

{
  "type": "string",
  "format": "uuid"
}

Request body

No request body is declared.

Responses

HTTP 200

Portable conversation JSON

Content type: application/json.

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "format",
    "version",
    "turns"
  ],
  "properties": {
    "format": {
      "const": "niu-chat"
    },
    "version": {
      "const": 1
    },
    "title": {
      "type": "string"
    },
    "createdAt": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "turns": {
      "type": "array",
      "maxItems": 100,
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "prompt",
          "results"
        ],
        "properties": {
          "prompt": {
            "type": "string"
          },
          "results": {
            "type": "array",
            "maxItems": 4,
            "items": {
              "type": "object",
              "additionalProperties": false,
              "required": [
                "model",
                "content",
                "phase"
              ],
              "properties": {
                "model": {
                  "type": "string"
                },
                "content": {
                  "type": "string"
                },
                "finishReason": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "maxLength": 128,
                  "description": "Model completion reason, when supplied. Transport completion alone does not establish a complete answer."
                },
                "phase": {
                  "type": "string",
                  "enum": [
                    "connecting",
                    "streaming",
                    "complete",
                    "failed",
                    "cancelled"
                  ]
                }
              }
            }
          },
          "attachments": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "required": [
                "name",
                "type",
                "content"
              ],
              "properties": {
                "name": {
                  "type": "string"
                },
                "type": {
                  "type": "string"
                },
                "content": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}

HTTP 401

Authentication required

HTTP 403

Workspace read access required

HTTP 404

No saved conversation for this workspace and owner

HTTP 503

Durable storage unavailable

Behavior and supported scope

Supported scope: implemented