Destinations

Export

Export dataslice metadata and/or nodes to a configured destination.

This endpoint supports exporting data from a dataslice or data connector to a destination system. For small datasets (fewer than 100 files), the export runs synchronously. For larger datasets, the export is processed in the background and returns a tracker ID for monitoring progress.

Request Body

Field	Type	Required	Description
`dataslice_id`	`str`	No	The ID of the dataslice to export. Required if `data_connector_name` is not provided.
`data_connector_name`	`str`	No	The name of the data connector to export from. Required if `dataslice_id` is not provided.
`destination_name`	`str`	No	The name of the configured destination to export to.
`export_tags`	`List[str]`	No	List of specific tags to export. If empty, all tags are exported.
`export_level`	`ExportLevel`	No	Level of export: `"file"`, `"chunk"`, or `"both"` (default: `"both"`).
`export_nodes`	`bool`	No	Whether to export node data (default: `true`).
`export_metadata`	`bool`	No	Whether to export metadata (default: `true`).
`metadata_format`	`MetadataStorageFormat`	No	Format for metadata storage: `"column_store"` or `"json_store"`.

Response

200: Export completed or initiated successfully
- Returns: ExportDatasliceDestinationResponse with:
  - message: Status message
  - success: Number of successfully exported items
  - failed: Number of failed exports
  - failed_items: List of items that failed to export
  - failed_tags: List of tags that failed to export (if applicable)
  - tracker_id: Progress tracker ID for background exports (only for large datasets)
400: Bad Request (e.g., missing required parameters)
500: Internal Server Error

Example Request

{
  "dataslice_id": "550e8400-e29b-41d4-a716-446655440000",
  "destination_name": "my-destination",
  "export_tags": ["contracts", "invoices"],
  "export_level": "both",
  "export_nodes": true,
  "export_metadata": true,
  "metadata_format": "column_store"
}

Example Response (Synchronous)

{
  "message": "Export completed successfully",
  "success": 45,
  "failed": 0,
  "failed_items": [],
  "failed_tags": null,
  "tracker_id": null
}

Example Response (Background Processing)

{
  "message": "Export started in background. Use tracker_id to monitor progress.",
  "success": 0,
  "failed": 0,
  "failed_items": [],
  "failed_tags": null,
  "tracker_id": "export-12345678-90ab-cdef-1234-567890abcdef"
}

POST

dataslice

export

metadata

destination

Python

import os
from unstructured import UnstructuredClient

client = UnstructuredClient(
    username=os.environ.get("UNSTRUCTURED_USERNAME"),  # This is the default and can be omitted
    password=os.environ.get("UNSTRUCTURED_PASSWORD"),  # This is the default and can be omitted
)
response = client.destination.export()
print(response.tracker_id)

import UnstructuredClient from 'unstructured-sdk';

const client = new UnstructuredClient({
  authMethod: 'My Auth Method',
  username: process.env['UNSTRUCTURED_USERNAME'], // This is the default and can be omitted
  password: process.env['UNSTRUCTURED_PASSWORD'], // This is the default and can be omitted
});

const response = await client.destination.export();

console.log(response.tracker_id);

{
  "message": "<string>",
  "success": 123,
  "failed": 123,
  "failed_items": [
    "<string>"
  ],
  "failed_tags": [
    "<string>"
  ],
  "tracker_id": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

dataslice_id

string | null

data_connector_name

string | null

destination_name

string | null

export_tags

any[]

export_level

enum<string>

default:both

Available options:

file,

chunk,

both

export_nodes

boolean

default:true

export_metadata

boolean

default:true

metadata_format

enum<string> | null

Available options:

column_store,

json_store

Response

Successful Response

message

string

required

success

integer

required

failed

integer

required

failed_items

string[]

required

failed_tags

string[] | null

tracker_id

string | null

⌘I

Python

import os
from unstructured import UnstructuredClient

client = UnstructuredClient(
    username=os.environ.get("UNSTRUCTURED_USERNAME"),  # This is the default and can be omitted
    password=os.environ.get("UNSTRUCTURED_PASSWORD"),  # This is the default and can be omitted
)
response = client.destination.export()
print(response.tracker_id)

import UnstructuredClient from 'unstructured-sdk';

const client = new UnstructuredClient({
  authMethod: 'My Auth Method',
  username: process.env['UNSTRUCTURED_USERNAME'], // This is the default and can be omitted
  password: process.env['UNSTRUCTURED_PASSWORD'], // This is the default and can be omitted
});

const response = await client.destination.export();

console.log(response.tracker_id);

{
  "message": "<string>",
  "success": 123,
  "failed": 123,
  "failed_items": [
    "<string>"
  ],
  "failed_tags": [
    "<string>"
  ],
  "tracker_id": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

Overview

Data Connectors

Tags

Taxonomies

Metadata

Data Slices

Destinations

Projects

Workflows

Task Tracking

Export

Request Body

Response

Example Request

Example Response (Synchronous)

Example Response (Background Processing)

Authorizations

Body

Response