Export

Export

Export metadata for a specific data slice or the entire data connector, in JSON or CSV format.

Request Body

Field	Type	Description
`data_connector_name`	`str`	Name of the data connector to export metadata from.
`dataslice_id`	`Optional[str]`	ID of the dataslice to export metadata from. If omitted, all data is included.
`export_file_level`	`bool`	`True` for file-level export, `False` for chunk-level export.
`export_format`	`Optional[ExportFormat]`	Desired export format: `json` or `csv` (e.g., `"json"`, `"csv"`).
`selected_metadata_fields`	`Optional[List[str]]`	List of metadata fields to include in the export.

Response

200: Metadata exported successfully
- Returns: A streaming file response containing the exported metadata in the requested format.
500: Internal Server Error

Example

{
  "data_connector_name": "example-connector",
  "dataslice_id": "abc123",
  "export_file_level": true,
  "export_format": "json",
  "selected_metadata_fields": ["field1", "field2"]
}

POST

dataslice

export

metadata

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.data_slice.export(
    data_connector_name="data_connector_name",
)
print(response)

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.dataSlice.export({ data_connector_name: 'data_connector_name' });

console.log(response);

{
  "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

data_connector_name

string

required

dataslice_id

string | null

export_file_level

boolean

default:false

export_format

enum<string> | null

Available options:

json,

csv

selected_metadata_fields

string[] | null

Response

Successful Response

⌘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.data_slice.export(
    data_connector_name="data_connector_name",
)
print(response)

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.dataSlice.export({ data_connector_name: 'data_connector_name' });

console.log(response);

{
  "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

Request Body

Response

Example

Authorizations

Body

Response