For the complete documentation index, see llms.txt. This page is also available as Markdown.

Exports

List Exports

get

List all exports for a project with optional filters.

Authorizations
AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Path parameters
project_idintegerRequired
Query parameters
usernamestring · nullableOptional
export_formatstring · nullableOptional
statusstring · nullableOptional
conversation_idinteger · nullableOptional
Responses
200

Successful Response

application/json
export_idintegerRequired
project_idinteger · nullableOptional
conversation_idinteger · nullableOptional
message_idinteger · nullableOptional
requested_bystringRequired
filenamestringRequired
storage_pathstringRequired
file_typestring · nullableOptional
file_size_bytesinteger · nullableOptional
export_formatstringRequired
source_descriptionstring · nullableOptional
statusstringRequired
error_messagestring · nullableOptional
created_atstring · date-timeRequired
completed_atstring · date-time · nullableOptional
expires_atstring · date-time · nullableOptional
download_countintegerRequired
get/api/v1/projects/{project_id}/exports
GET /api/v1/projects/{project_id}/exports HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
  {
    "export_id": 1,
    "project_id": 1,
    "conversation_id": 1,
    "message_id": 1,
    "requested_by": "text",
    "filename": "text",
    "storage_path": "text",
    "file_type": "text",
    "file_size_bytes": 1,
    "export_format": "text",
    "source_description": "text",
    "status": "text",
    "error_message": "text",
    "created_at": "2026-01-01T00:00:00.000Z",
    "completed_at": "2026-01-01T00:00:00.000Z",
    "expires_at": "2026-01-01T00:00:00.000Z",
    "download_count": 1
  }
]

Get Export Metadata

get

Get metadata for a specific export.

Authorizations
AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Path parameters
project_idintegerRequired
export_idintegerRequired
Responses
200

Successful Response

application/json
export_idintegerRequired
project_idinteger · nullableOptional
conversation_idinteger · nullableOptional
message_idinteger · nullableOptional
requested_bystringRequired
filenamestringRequired
storage_pathstringRequired
file_typestring · nullableOptional
file_size_bytesinteger · nullableOptional
export_formatstringRequired
source_descriptionstring · nullableOptional
statusstringRequired
error_messagestring · nullableOptional
created_atstring · date-timeRequired
completed_atstring · date-time · nullableOptional
expires_atstring · date-time · nullableOptional
download_countintegerRequired
get/api/v1/projects/{project_id}/exports/{export_id}
GET /api/v1/projects/{project_id}/exports/{export_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "export_id": 1,
  "project_id": 1,
  "conversation_id": 1,
  "message_id": 1,
  "requested_by": "text",
  "filename": "text",
  "storage_path": "text",
  "file_type": "text",
  "file_size_bytes": 1,
  "export_format": "text",
  "source_description": "text",
  "status": "text",
  "error_message": "text",
  "created_at": "2026-01-01T00:00:00.000Z",
  "completed_at": "2026-01-01T00:00:00.000Z",
  "expires_at": "2026-01-01T00:00:00.000Z",
  "download_count": 1
}

Delete Export

delete

Delete an exported file (file + DB record).

Authorizations
AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Path parameters
project_idintegerRequired
export_idintegerRequired
Responses
200

Successful Response

application/json
anyOptional
delete/api/v1/projects/{project_id}/exports/{export_id}
DELETE /api/v1/projects/{project_id}/exports/{export_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Download Export

get

Download an exported file.

Authorizations
AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Path parameters
project_idintegerRequired
export_idintegerRequired
Responses
200

Successful Response

No content

get/api/v1/projects/{project_id}/exports/{export_id}/download
GET /api/v1/projects/{project_id}/exports/{export_id}/download HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Preview Export

get

Get a preview of the first few rows of an exported file.

Authorizations
AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Path parameters
project_idintegerRequired
export_idintegerRequired
Responses
200

Successful Response

application/json
filenamestringRequired
export_formatstringRequired
thumbnail_base64string · nullableOptional
columnsstring[] · nullableOptional
total_rowsinteger · nullableOptional
total_columnsinteger · nullableOptional
truncated_columnsboolean · nullableOptional
get/api/v1/projects/{project_id}/exports/{export_id}/preview
GET /api/v1/projects/{project_id}/exports/{export_id}/preview HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "filename": "text",
  "export_format": "text",
  "thumbnail_base64": "text",
  "columns": [
    "text"
  ],
  "rows": [
    []
  ],
  "total_rows": 1,
  "total_columns": 1,
  "truncated_columns": true
}

List Conversation Exports

get

List all exports generated within a specific conversation.

Authorizations
AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Path parameters
conversation_idintegerRequired
Responses
200

Successful Response

application/json
export_idintegerRequired
project_idinteger · nullableOptional
conversation_idinteger · nullableOptional
message_idinteger · nullableOptional
requested_bystringRequired
filenamestringRequired
storage_pathstringRequired
file_typestring · nullableOptional
file_size_bytesinteger · nullableOptional
export_formatstringRequired
source_descriptionstring · nullableOptional
statusstringRequired
error_messagestring · nullableOptional
created_atstring · date-timeRequired
completed_atstring · date-time · nullableOptional
expires_atstring · date-time · nullableOptional
download_countintegerRequired
get/api/v1/conversations/{conversation_id}/exports
GET /api/v1/conversations/{conversation_id}/exports HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
  {
    "export_id": 1,
    "project_id": 1,
    "conversation_id": 1,
    "message_id": 1,
    "requested_by": "text",
    "filename": "text",
    "storage_path": "text",
    "file_type": "text",
    "file_size_bytes": 1,
    "export_format": "text",
    "source_description": "text",
    "status": "text",
    "error_message": "text",
    "created_at": "2026-01-01T00:00:00.000Z",
    "completed_at": "2026-01-01T00:00:00.000Z",
    "expires_at": "2026-01-01T00:00:00.000Z",
    "download_count": 1
  }
]

Get User Export Metadata

get

Get metadata for a specific export (no project scope).

Authorizations
AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Path parameters
export_idintegerRequired
Responses
200

Successful Response

application/json
export_idintegerRequired
project_idinteger · nullableOptional
conversation_idinteger · nullableOptional
message_idinteger · nullableOptional
requested_bystringRequired
filenamestringRequired
storage_pathstringRequired
file_typestring · nullableOptional
file_size_bytesinteger · nullableOptional
export_formatstringRequired
source_descriptionstring · nullableOptional
statusstringRequired
error_messagestring · nullableOptional
created_atstring · date-timeRequired
completed_atstring · date-time · nullableOptional
expires_atstring · date-time · nullableOptional
download_countintegerRequired
get/api/v1/exports/{export_id}
GET /api/v1/exports/{export_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "export_id": 1,
  "project_id": 1,
  "conversation_id": 1,
  "message_id": 1,
  "requested_by": "text",
  "filename": "text",
  "storage_path": "text",
  "file_type": "text",
  "file_size_bytes": 1,
  "export_format": "text",
  "source_description": "text",
  "status": "text",
  "error_message": "text",
  "created_at": "2026-01-01T00:00:00.000Z",
  "completed_at": "2026-01-01T00:00:00.000Z",
  "expires_at": "2026-01-01T00:00:00.000Z",
  "download_count": 1
}

Download User Export

get

Download an exported file by export_id (for exports without a project scope).

Authorizations
AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Path parameters
export_idintegerRequired
Responses
200

Successful Response

No content

get/api/v1/exports/{export_id}/download
GET /api/v1/exports/{export_id}/download HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Preview User Export

get

Get a preview of the first few rows of an exported file (no project scope).

Authorizations
AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Path parameters
export_idintegerRequired
Responses
200

Successful Response

application/json
filenamestringRequired
export_formatstringRequired
thumbnail_base64string · nullableOptional
columnsstring[] · nullableOptional
total_rowsinteger · nullableOptional
total_columnsinteger · nullableOptional
truncated_columnsboolean · nullableOptional
get/api/v1/exports/{export_id}/preview
GET /api/v1/exports/{export_id}/preview HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "filename": "text",
  "export_format": "text",
  "thumbnail_base64": "text",
  "columns": [
    "text"
  ],
  "rows": [
    []
  ],
  "total_rows": 1,
  "total_columns": 1,
  "truncated_columns": true
}

Last updated