Read

List

Get filtered metadata based on conditions. Supports shared connections.

Request Body

Field	Type	Description
`data_connector_name`	`str`	Name of the data connector (vector database profile).
`dataslice_id`	`Optional[str]`	ID of the dataslice to get files from.
`tag_names`	`Optional[List[str]]`	List of tag names to include in the metadata.
`include_chunk_level`	`Optional[bool]`	Whether to include chunk-level metadata. Default: `true`
`file_names`	`Optional[List[str]]`	List of specific file names to include in the metadata.
`chunk_ids`	`Optional[List[str]]`	List of specific chunk IDs to include in the metadata.
`include_last_updated`	`Optional[bool]`	Whether to include the last updated timestamp. Default: `false`

Response

200: Metadata retrieved successfully
- Without chunk_ids: Returns metadata grouped by filename, tag, and level
  {filename: {tag_id: {chunk_level: {chunk_id: metadata}, file_level: metadata}}}
- With chunk_ids: Returns metadata by chunk ID
  {chunk_id: {metadata}}
500: Internal Server Error

Example

{
  "data_connector_name": "my-connector",
  "dataslice_id": "abc123",
  "tag_names": ["category", "date"],
  "include_chunk_level": true,
  "file_names": ["document1.pdf", "document2.pdf"]
}

POST

metadata

list

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
)
metadata = client.metadata.list(
    data_connector_name="data_connector_name",
)
print(metadata.metadata)

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 metadata = await client.metadata.list({ data_connector_name: 'data_connector_name' });

console.log(metadata.metadata);

{
  "metadata": {}
}

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

tag_names

string[] | null

include_chunk_level

boolean | null

default:true

file_names

string[] | null

chunk_ids

string[] | null

include_last_updated

boolean | null

default:false

Response

Successful Response

metadata

MetadataByTagAndChunk · object

required

MetadataByTagAndChunk
MetadataByChunk

Show child attributes

⌘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
)
metadata = client.metadata.list(
    data_connector_name="data_connector_name",
)
print(metadata.metadata)

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 metadata = await client.metadata.list({ data_connector_name: 'data_connector_name' });

console.log(metadata.metadata);

{
  "metadata": {}
}

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

List

Request Body

Response

Example

Authorizations

Body

Response