Python

from unstructured import UnstructuredClient

client = UnstructuredClient(
    username="My Username",
    password="My Password",
)
response = client.data_source.list_ingested_data(
    data_connector_name="data_connector_name",
)
print(response.metadata)

{
  "metadata": {}
}

Data Connectors

List Ingested Data

Retrieve metadata from documents ingested into Unstructured.

Request Body

Field	Type	Description
`data_connector_name`	`str`	Name of the data connector to query.
`group_by`	`str`	Group results by `file` or `node`. Default: `file`.
`metadata_keys`	`List[str]`	Specific metadata keys to retrieve.
`file_names`	`List[str]`	Filter by specific file names.
`point_ids`	`List[str]`	Filter by specific node/point IDs.
`metadata_key_filters`	`List[str]`	Filter by presence of metadata keys.
`metadata_value_filters`	`Dict[str, List]`	Filter by specific metadata values.
`full_text_filters`	`List[str]`	Full-text search filters.
`limit`	`int`	Maximum number of results to return.
`with_vectors`	`bool`	Include vector embeddings. Default: `false`.

Response

200: Successfully retrieved metadata
- Returns: { "metadata": Dict }
500: Internal Server Error (e.g., error fetching metadata)

Example

{
  "data_connector_name": "my-documents",
  "group_by": "file",
  "metadata_keys": ["title", "author", "date"],
  "file_names": ["document1.pdf", "document2.pdf"],
  "limit": 100
}

POST

data

metadata

list

Python

from unstructured import UnstructuredClient

client = UnstructuredClient(
    username="My Username",
    password="My Password",
)
response = client.data_source.list_ingested_data(
    data_connector_name="data_connector_name",
)
print(response.metadata)

{
  "metadata": {}
}

Body

application/json

data_connector_name

string

required

group_by

string | null

default:file

metadata_keys

string[] | null

file_names

string[] | null

point_ids

string[] | null

metadata_key_filters

string[] | null

metadata_value_filters

Metadata Value Filters · object

Show child attributes

metadata_value_filters.{key}

string[]

full_text_filters

string[] | null

limit

integer | null

with_vectors

boolean | null

default:false

Response

Successful Response

metadata

Metadata · object

required

Show child attributes

metadata.{key}

object

Ingest Upsert

⌘I

Data Connectors

Tags

Taxonomies

Metadata

Task Tracking

Data Slices

Destinations

List Ingested Data

Request Body

Response

Example

Body

Response