Workflows

To use the Unstructured Workflow Endpoint to manage workflows, do the following:

To get a list of available workflows, use the UnstructuredClient object’s workflows.list_workflows function (for the Python SDK) or the GET method to call the /workflows endpoint (for curl or Postman). Learn more.
To get information about a workflow, use the UnstructuredClient object’s workflows.get_workflow function (for the Python SDK) or the GET method to call the /workflows/<workflow-id> endpoint (for curl or Postman)use the GET method to call the /workflows/<workflow-id> endpoint. Learn more.
To create a workflow, use the UnstructuredClient object’s workflows.create_workflow function (for the Python SDK) or the POST method to call the /workflows endpoint (for curl or Postman). Learn more.
To run a workflow manually, use the UnstructuredClient object’s workflows.run_workflow function (for the Python SDK) or the POST method to call the /workflows/<workflow-id>/run endpoint (for curl or Postman). Learn more.
To update a workflow, use the UnstructuredClient object’s workflows.update_workflow function (for the Python SDK) or the PUT method to call the /workflows/<workflow-id> endpoint (for curl or Postman). Learn more.
To delete a workflow, use the UnstructuredClient object’s workflows.delete_workflow function (for the Python SDK) or the DELETE method to call the /workflows/<workflow-id> endpoint (for curl or Postman). Learn more.

The following examples assume that you have already met the requirements and understand the basics of working with the Unstructured Workflow Endpoint.

Create a workflow

To create a workflow, use the UnstructuredClient object’s workflows.create_workflow function (for the Python SDK) or the POST method to call the /workflows endpoint (for curl or Postman). In the CreateWorkflow object (for the Python SDK) or the request body (for curl or Postman), specify the settings for the workflow, as follows:

Python SDK (remote source and remote destination)

import os

from unstructured_client import UnstructuredClient
from unstructured_client.models.shared import (
    WorkflowNode,
    CreateWorkflow,
    WorkflowType,
    Schedule
)
from unstructured_client.models.operations import CreateWorkflowRequest


client = UnstructuredClient(
    api_key_auth=os.getenv("UNSTRUCTURED_API_KEY")
)

workflow_node = WorkflowNode(
    name="<node-name>",
    type="<node-type>",
    subtype="<node-subtype>",
    settings={
        "...": "..."
    }
)

another_workflow_node = WorkflowNode(
    name="<node-name>",
    type="<node-type>",
    subtype="<node-subtype>",
    settings={
        "...": "..."
    }
)

# And so on for any additional nodes.

workflow = CreateWorkflow(
    name="<name>",
    source_id="<source-connector-id>",
    destination_id="<destination-connector-id>",
    workflow_type=WorkflowType.<TYPE>,
    workflow_nodes=[
        workflow_node,
        another_workflow_node
        # And so on for any additional nodes.
    ],
    schedule=Schedule("<schedule-timeframe>")
)

response = client.workflows.create_workflow(
    request=CreateWorkflowRequest(
        create_workflow=workflow
    )
)

info = response.workflow_information

print(f"name:           {info.name}")
print(f"id:             {info.id}")
print(f"status:         {info.status}")
print(f"type:           {info.workflow_type}")
print("source(s):")

for source in info.sources:
    print(f"            {source}")

print("destination(s):")

for destination in info.destinations:
    print(f"            {destination}")

print("schedule(s):")

for crontab_entry in info.schedule.crontab_entries:
    print(f"            {crontab_entry.cron_expression}")

Python SDK (local source and local destination)

To use a local source and a local destination, do not specify a source_id or destination_id value. Also, the workflow_type must be set to CUSTOM.

A workflow with a local source has the following limitations:

The workflow cannot be set to run on a repeating schedule.
The workflow cannot be run with the Unstructured Python SDK or from the Unstructured user interface (UI), even though the workflows is visible in the UI. However, you can run the workflow with REST API clients such as curl or Postman. Learn how.

import os

from unstructured_client import UnstructuredClient
from unstructured_client.models.shared import (
    WorkflowNode,
    CreateWorkflow,
    WorkflowType
)
from unstructured_client.models.operations import CreateWorkflowRequest

workflow_node = WorkflowNode(
    name="<node-name>",
    type="<node-type>",
    subtype="<node-subtype>",
    settings={
        "...": "..."
    }
)

another_workflow_node = WorkflowNode(
    name="<node-name>",
    type="<node-type>",
    subtype="<node-subtype>",
    settings={
        "...": "..."
    }
)

# And so on for any additional nodes.

workflow=CreateWorkflow(
    name="<name>",
    workflow_type=WorkflowType.CUSTOM,
    workflow_nodes=[
        workflow_node,
        another_workflow_node
        # And so on for any additional nodes.
    ]
)

with UnstructuredClient(api_key_auth=os.getenv("UNSTRUCTURED_API_KEY")) as client:
    response = client.workflows.create_workflow(
        request=CreateWorkflowRequest(
            create_workflow=workflow
        )
    )

    info = response.workflow_information

    print(f"name: {info.name}")
    print(f"id: {info.id}")
    print(f"status: {info.status}")
    print(f"type: {info.workflow_type}")
    print("source(s):")

    for source in info.sources:
        print(f"    {source}")

    print("destination(s):")

    for destination in info.destinations:
        print(f"    {destination}")

    print("schedule(s):")

    for crontab_entry in info.schedule.crontab_entries:
        print(f"    {crontab_entry.cron_expression}")

Python SDK (local source and remote destination)

To use a local source and a remote destination, specify a destination_id value, and do not specify a source_id value. Also, the workflow_type must be set to CUSTOM.

A workflow with a local source has the following limitations:

The workflow cannot be set to run on a repeating schedule.
The workflow cannot be run with the Unstructured Python SDK or from the Unstructured user interface (UI), even though the workflows is visible in the UI. However, you can run the workflow with REST API clients such as curl or Postman. Learn how.

import os

from unstructured_client import UnstructuredClient
from unstructured_client.models.shared import (
    WorkflowNode,
    CreateWorkflow,
    WorkflowType
)
from unstructured_client.models.operations import CreateWorkflowRequest

workflow_node = WorkflowNode(
    name="<node-name>",
    type="<node-type>",
    subtype="<node-subtype>",
    settings={
        "...": "..."
    }
)

another_workflow_node = WorkflowNode(
    name="<node-name>",
    type="<node-type>",
    subtype="<node-subtype>",
    settings={
        "...": "..."
    }
)

# And so on for any additional nodes.

workflow=CreateWorkflow(
    name="<name>",
    destination_id="<destination-connector-id>",
    workflow_type=WorkflowType.CUSTOM,
    workflow_nodes=[
        workflow_node,
        another_workflow_node
        # And so on for any additional nodes.
    ]
)

with UnstructuredClient(api_key_auth=os.getenv("UNSTRUCTURED_API_KEY")) as client:
    response = client.workflows.create_workflow(
        request=CreateWorkflowRequest(
            create_workflow=workflow
        )
    )

    info = response.workflow_information

    print(f"name: {info.name}")
    print(f"id: {info.id}")
    print(f"status: {info.status}")
    print(f"type: {info.workflow_type}")
    print("source(s):")

    for source in info.sources:
        print(f"    {source}")

    print("destination(s):")

    for destination in info.destinations:
        print(f"    {destination}")

    print("schedule(s):")

    for crontab_entry in info.schedule.crontab_entries:
        print(f"    {crontab_entry.cron_expression}")

Python SDK (async) (remote source and remote destination)

import os
import asyncio

from unstructured_client import UnstructuredClient
from unstructured_client.models.shared import (
    WorkflowNode,
    CreateWorkflow,
    WorkflowType,
    Schedule
)
from unstructured_client.models.operations import CreateWorkflowRequest

async def create_workflow():
    client = UnstructuredClient(
        api_key_auth=os.getenv("UNSTRUCTURED_API_KEY")
    )

    workflow_node = WorkflowNode(
        name="<node-name>",
        type="<node-type>",
        subtype="<node-subtype>",
        settings={
            "...": "..."
        }
    )

    another_workflow_node = WorkflowNode(
        name="<node-name>",
        type="<node-type>",
        subtype="<node-subtype>",
        settings={
            "...": "..."
        }
    )

    # And so on for any additional nodes.

    workflow = CreateWorkflow(
        name="<name>",
        source_id="<source-connector-id>",
        destination_id="<destination-connector-id>",
        workflow_type=WorkflowType.<TYPE>,
        workflow_nodes=[
            workflow_node,
            another_workflow_node
            # And so on for any additional nodes.
        ],
        schedule=Schedule("<schedule-timeframe>")
    )

    response = await client.workflows.create_workflow_async(
        request=CreateWorkflowRequest(
            create_workflow=workflow
        )
    )

    info = response.workflow_information

    print(f"name:           {info.name}")
    print(f"id:             {info.id}")
    print(f"status:         {info.status}")
    print(f"type:           {info.workflow_type}")
    print("source(s):")

    for source in info.sources:
        print(f"            {source}")

    print("destination(s):")

    for destination in info.destinations:
        print(f"            {destination}")

    print("schedule(s):")

    for crontab_entry in info.schedule.crontab_entries:
        print(f"            {crontab_entry.cron_expression}")

asyncio.run(create_workflow())

Python SDK (async) (local source and local destination)

To use a local source and a local destination, do not specify a source_id or destination_id value. Also, the workflow_type must be set to CUSTOM.

A workflow with a local source has the following limitations:

The workflow cannot be set to run on a repeating schedule.
The workflow cannot be run with the Unstructured Python SDK or from the Unstructured user interface (UI), even though the workflows is visible in the UI. However, you can run the workflow with REST API clients such as curl or Postman. Learn how.

import os
import asyncio

from unstructured_client import UnstructuredClient
from unstructured_client.models.shared import (
    WorkflowNode,
    CreateWorkflow,
    WorkflowType
)
from unstructured_client.models.operations import CreateWorkflowRequest

async def create_workflow():
    workflow_node = WorkflowNode(
        name="<node-name>",
        type="<node-type>",
        subtype="<node-subtype>",
        settings={
            "...": "..."
        }
    )

    another_workflow_node = WorkflowNode(
        name="<node-name>",
        type="<node-type>",
        subtype="<node-subtype>",
        settings={
            "...": "..."
        }
    )

    # And so on for any additional nodes.

    workflow = CreateWorkflow(
        name="<name>",
        workflow_type=WorkflowType.CUSTOM,
        workflow_nodes=[
            workflow_node,
            another_workflow_node
            # And so on for any additional nodes.
        ]
    )

    with UnstructuredClient(api_key_auth=os.getenv("UNSTRUCTURED_API_KEY")) as client:
        response = await client.workflows.create_workflow_async(
            request=CreateWorkflowRequest(
                create_workflow=workflow
            )
        )

        info = response.workflow_information

        print(f"name: {info.name}")
        print(f"id: {info.id}")
        print(f"status: {info.status}")
        print(f"type: {info.workflow_type}")
        print("source(s):")

        for source in info.sources:
            print(f"    {source}")

        print("destination(s):")

        for destination in info.destinations:
            print(f"    {destination}")

        print("schedule(s):")

        for crontab_entry in info.schedule.crontab_entries:
            print(f"    {crontab_entry.cron_expression}")

asyncio.run(create_workflow())

Python SDK (async) (local source and remote destination)

To use a local source and a remote destination, specify a destination_id value, and do not specify a source_id value. Also, the workflow_type must be set to CUSTOM.

A workflow with a local source has the following limitations:

The workflow cannot be set to run on a repeating schedule.
The workflow cannot be run with the Unstructured Python SDK or from the Unstructured user interface (UI), even though the workflows is visible in the UI. However, you can run the workflow with REST API clients such as curl or Postman. Learn how.

import os
import asyncio

from unstructured_client import UnstructuredClient
from unstructured_client.models.shared import (
    WorkflowNode,
    CreateWorkflow,
    WorkflowType
)
from unstructured_client.models.operations import CreateWorkflowRequest

async def create_workflow():
    workflow_node = WorkflowNode(
        name="<node-name>",
        type="<node-type>",
        subtype="<node-subtype>",
        settings={
            "...": "..."
        }
    )

    another_workflow_node = WorkflowNode(
        name="<node-name>",
        type="<node-type>",
        subtype="<node-subtype>",
        settings={
            "...": "..."
        }
    )

    # And so on for any additional nodes.

    workflow = CreateWorkflow(
        name="<name>",
        destination_id="<destination-connector-id>",
        workflow_type=WorkflowType.CUSTOM,
        workflow_nodes=[
            workflow_node,
            another_workflow_node
            # And so on for any additional nodes.
        ]
    )

    with UnstructuredClient(api_key_auth=os.getenv("UNSTRUCTURED_API_KEY")) as client:
        response = await client.workflows.create_workflow_async(
            request=CreateWorkflowRequest(
                create_workflow=workflow
            )
        )

        info = response.workflow_information

        print(f"name: {info.name}")
        print(f"id: {info.id}")
        print(f"status: {info.status}")
        print(f"type: {info.workflow_type}")
        print("source(s):")

        for source in info.sources:
            print(f"    {source}")

        print("destination(s):")

        for destination in info.destinations:
            print(f"    {destination}")

        print("schedule(s):")

        for crontab_entry in info.schedule.crontab_entries:
            print(f"    {crontab_entry.cron_expression}")

asyncio.run(create_workflow())

curl (remote source and remote destination)

curl --request 'POST' --location \
"$UNSTRUCTURED_API_URL/workflows" \
--header "unstructured-api-key: $UNSTRUCTURED_API_KEY" \
--header 'accept: application/json' \
--data \
'{
    "name": "<name>",
    "source_id": "<source-connector-id>",
    "destination_id": "<destination-connector-id>",
    "workflow_type": "<type>",
    "workflow_nodes": [
        {
            "name": "<node-name>",
            "type": "<node-type>",
            "subtype": "<node-subtype>",
            "settings": {
                "...": "..."
            }
        },
        {
            "...": "..." 
        } 
    ],
    "schedule": "<schedule-timeframe>"
}'

curl (local source and local destination)

To use a local source and a local destination, do not specify a source_id or destination_id value. Also, the workflow_type must be set to custom.

A workflow with a local source has the following limitations:

The workflow cannot be set to run on a repeating schedule.
The workflow cannot be run with the Unstructured Python SDK or from the Unstructured user interface (UI), even though the workflows is visible in the UI. However, you can run the workflow with REST API clients such as curl (or Postman). Learn how.

curl --request 'POST' --location \
"$UNSTRUCTURED_API_URL/workflows" \
--header "unstructured-api-key: $UNSTRUCTURED_API_KEY" \
--header 'accept: application/json' \
--data \
'{
    "name": "<name>",
    "workflow_type": "custom",
    "workflow_nodes": [
        {
            "name": "<node-name>",
            "type": "<node-type>",
            "subtype": "<node-subtype>",
            "settings": {
                "...": "..."
            }
        },
        {
            "...": "..." 
        } 
    ]
}'

curl (local source and remote destination)

To use a local source and a remote destination, specify a destination_id value, and do not specify a source_id value. Also, the workflow_type must be set to custom.

A workflow with a local source has the following limitations:

The workflow cannot be set to run on a repeating schedule.
The workflow cannot be run with the Unstructured Python SDK or from the Unstructured user interface (UI), even though the workflows is visible in the UI. However, you can run the workflow with REST API clients such as curl (or Postman). Learn how.

curl --request 'POST' --location \
"$UNSTRUCTURED_API_URL/workflows" \
--header "unstructured-api-key: $UNSTRUCTURED_API_KEY" \
--header 'accept: application/json' \
--data \
'{
    "name": "<name>",
    "destination_id": "<destination-connector-id>",
    "workflow_type": "custom",
    "workflow_nodes": [
        {
            "name": "<node-name>",
            "type": "<node-type>",
            "subtype": "<node-subtype>",
            "settings": {
                "...": "..."
            }
        },
        {
            "...": "..." 
        } 
    ]
}'

Postman (remote source and remote destination)

In the method drop-down list, select POST.
In the address box, enter the following URL:
```
{{UNSTRUCTURED_API_URL}}/workflows
```
On the Headers tab, enter the following headers:
- Key: unstructured-api-key, Value: {{UNSTRUCTURED_API_KEY}}
- Key: accept, Value: application/json

On the Body tab, select raw and JSON, and specify the settings for the workflow:

{
    "name": "<name>",
    "source_id": "<source-connector-id>",
    "destination_id": "<destination-connector-id>",
    "workflow_type": "<type>",
    "workflow_nodes": [
        {
            "name": "<node-name>",
            "type": "<node-type>",
            "subtype": "<node-subtype>",
            "settings": {
                "...": "..."
            }
        },
        {
            "...": "..." 
        } 
    ],
    "schedule": "<schedule-timeframe>"
}

Click Send.

Postman (local source and local destination)

To use a local source and a local destination do not specify a source_id or destination_id value. Also, the workflow_type must be set to custom.

A workflow with a local source has the following limitations:

The workflow cannot be set to run on a repeating schedule.
The workflow cannot be run with the Unstructured Python SDK or from the Unstructured user interface (UI), even though the workflows is visible in the UI. However, you can run the workflow with REST API clients such as Postman (or curl). Learn how.

In the method drop-down list, select POST.
In the address box, enter the following URL:
```
{{UNSTRUCTURED_API_URL}}/workflows
```
On the Headers tab, enter the following headers:
- Key: unstructured-api-key, Value: {{UNSTRUCTURED_API_KEY}}
- Key: accept, Value: application/json

On the Body tab, select raw and JSON, and specify the settings for the workflow:

{
    "name": "<name>",
    "workflow_type": "custom",
    "workflow_nodes": [
        {
            "name": "<node-name>",
            "type": "<node-type>",
            "subtype": "<node-subtype>",
            "settings": {
                "...": "..."
            }
        },
        {
            "...": "..." 
        } 
    ]
}

Click Send.

Postman (local source and remote destination)

To use a local source and a remote destination, specify a destination_id value, and do not specify a source_id value. Also, the workflow_type must be set to custom.

A workflow with a local source has the following limitations:

The workflow cannot be set to run on a repeating schedule.
The workflow cannot be run with the Unstructured Python SDK or from the Unstructured user interface (UI), even though the workflows is visible in the UI. However, you can run the workflow with REST API clients such as Postman (or curl). Learn how.

In the method drop-down list, select POST.
In the address box, enter the following URL:
```
{{UNSTRUCTURED_API_URL}}/workflows
```
On the Headers tab, enter the following headers:
- Key: unstructured-api-key, Value: {{UNSTRUCTURED_API_KEY}}
- Key: accept, Value: application/json

On the Body tab, select raw and JSON, and specify the settings for the workflow:

{
    "name": "<name>",
    "workflow_type": "custom",
    "workflow_nodes": [
        {
            "name": "<node-name>",
            "destination_id": "<destination-connector-id>",
            "type": "<node-type>",
            "subtype": "<node-subtype>",
            "settings": {
                "...": "..."
            }
        },
        {
            "...": "..." 
        } 
    ]
}

Click Send.

Replace the preceding placeholders as follows:

<name> (required) - A unique name for this workflow.
<source-connector-id> (required) - The ID of the target source connector. To get the ID, use the UnstructuredClient object’s sources.list_sources function (for the Python SDK) or the GET method to call the /sources endpoint (for curl or Postman). Learn more.
<destination-connector-id> (required) - The ID of the target destination connector. To get the ID, use the UnstructuredClient object’s destinations.list_destinations function (for the Python SDK) or the GET method to call the /destinations endpoint (for curl or Postman). Learn more.
<TYPE> (for the Python SDK) or <type> (for curl or Postman) (required) - The workflow type. Available values include CUSTOM (for the Python SDK) and custom (for curl or Postman). If <TYPE> is set to CUSTOM (for the Python SDK), or if <type> is set to custom (for curl or Postman), you must add a workflow_nodes array. For instructions, see Custom workflow DAG nodes.
The previously-available workflow optimization types ADVANCED, BASIC, and PLATINUM (for the Python SDK) and advanced, basic, and platinum (for curl or Postman) are non-operational and planned to be fully removed in a future release.The ability to create an automatic workflow type is currently not available but is planned to be added in a future release.
<schedule-timeframe> - The repeating automatic run schedule, specified as a predefined phrase. The available predefined phrases are:
- every 15 minutes (for curl or Postman): Every 15 minutes (cron expression: */15 * * * *).
- every hour: At the first minute of every hour (cron expression: 0 * * * *).
- every 2 hours: At the first minute of every second hour (cron expression: 0 */2 * * *).
- every 4 hours: At the first minute of every fourth hour (cron expression: 0 */4 * * *).
- every 6 hours: At the first minute of every sixth hour (cron expression: 0 */6 * * *).
- every 8 hours: At the first minute of every eighth hour (cron expression: 0 */8 * * *).
- every 10 hours: At the first minute of every tenth hour (cron expression: 0 */10 * * *).
- every 12 hours: At the first minute of every twelfth hour (cron expression: 0 */12 * * *).
- daily: At the first minute of every day (cron expression: 0 0 * * *).
- weekly: At the first minute of every Sunday (cron expression: 0 0 * * 0).
- monthly: At the first minute of the first day of every month (cron expression: 0 0 1 * *).
If schedule is not specified, the workflow does not automatically run on a repeating schedule. Workflows with a local source cannot be set to run on a repeating schedule.

Update a workflow

To update information about a workflow, use the UnstructuredClient object’s workflows.update_workflow function (for the Python SDK) or the PUT method to call the /workflows/<workflow-id> endpoint (for curl or Postman), replacing <workflow-id> with the workflow’s unique ID. To get this ID, see List workflows. In the request body, specify the settings for the workflow. For the specific settings to include, see Create a workflow.

Python SDK

import os

from unstructured_client import UnstructuredClient
from unstructured_client.models.shared import (
    WorkflowNode,
    UpdateWorkflow,
    WorkflowType,
    Schedule,
),
from unstructured_client.models.operations import UpdateWorkflowRequest


client = UnstructuredClient(
    api_key_auth=os.getenv("UNSTRUCTURED_API_KEY")
)

workflow_node = WorkflowNode(
    # Specify the settings for a workflow node here.
)

another_workflow_node = WorkflowNode(
    # Specify the settings for another workflow node here.
)

# And so on for any additional nodes.

workflow = UpdateWorkflow(
    # Specify the settings for the workflow here.
)

response = client.workflows.update_workflow(
    request=UpdateWorkflowRequest(
        workflow_id="<workflow-id>",
        update_workflow=workflow
    )
)

info = response.workflow_information

print(f"name:           {info.name}")
print(f"id:             {info.id}")
print(f"status:         {info.status}")
print(f"type:           {info.workflow_type}")
print("source(s):")

for source in info.sources:
    print(f"            {source}")

print("destination(s):")

for destination in info.destinations:
    print(f"            {destination}")

print("schedule(s):")

for crontab_entry in info.schedule.crontab_entries:
    print(f"            {crontab_entry.cron_expression}")

Python SDK (async)

import os
import asyncio

from unstructured_client import UnstructuredClient
from unstructured_client.models.shared import (
    WorkflowNode,
    UpdateWorkflow,
    WorkflowType,
    Schedule,
),
from unstructured_client.models.operations import UpdateWorkflowRequest

async def update_workflow():
    client = UnstructuredClient(
        api_key_auth=os.getenv("UNSTRUCTURED_API_KEY")
    )

    workflow_node = WorkflowNode(
        # Specify the settings for a workflow node here.
    )

    another_workflow_node = WorkflowNode(
        # Specify the settings for another workflow node here.
    )

    # And so on for any additional nodes.

    workflow = UpdateWorkflow(
        # Specify the settings for the workflow here.
    )

    response = await client.workflows.update_workflow_async(
        request=UpdateWorkflowRequest(
            workflow_id="<workflow-id>",
            update_workflow=workflow
        )
    )

    info = response.workflow_information

    print(f"name:           {info.name}")
    print(f"id:             {info.id}")
    print(f"status:         {info.status}")
    print(f"type:           {info.workflow_type}")
    print("source(s):")

    for source in info.sources:
        print(f"            {source}")

    print("destination(s):")

    for destination in info.destinations:
        print(f"            {destination}")

    print("schedule(s):")

    for crontab_entry in info.schedule.crontab_entries:
        print(f"            {crontab_entry.cron_expression}")

asyncio.run(update_workflow())

curl

curl --request 'PUT' --location \
"$UNSTRUCTURED_API_URL/workflows/<workflow-id>" \
--header "unstructured-api-key: $UNSTRUCTURED_API_KEY" \
--header 'accept: application/json' \
--data \
'{
    # Specify the settings for the workflow here.
}'

Postman

In the method drop-down list, select PUT.
In the address box, enter the following URL:
```
{{UNSTRUCTURED_API_URL}}/workflows/<workflow-id>
```
On the Headers tab, enter the following headers:
- Key: unstructured-api-key, Value: {{UNSTRUCTURED_API_KEY}}
- Key: accept, Value: application/json
On the Body tab, select raw and JSON, and specify the settings for the workflow.
Click Send.

Custom workflow DAG nodes

If WorkflowType is set to CUSTOM (for the Python SDK), or if workflow_type is set to custom (for curl or Postman), you must also specify the settings for the workflow’s directed acyclic graph (DAG) nodes. These nodes’ settings are specified in the workflow_nodes array.

A Source node is automatically created when you specify the source_id value outside of the
workflow_nodes array.
A Destination node is automatically created when you specify the destination_id value outside of the workflow_nodes array.
You can specify Partitioner, Chunker, Enrichment, and Embedder nodes.
Image summary descriptions, table summary descriptions, and table-to-HTML output is generated only when the Partitioner node in a workflow is set to use the High Res partitioning strategy and the workflow also contains an image description, table description, or table-to-HTML enrichment node.Setting the Partitioner node to use Auto, VLM, or Fast in a workflow that also contains an image description, table description, or table-to-HTML enrichment node will not generate any image summary descriptions, table summary descriptions, or table-to-HTML output, and it could also cause the workflow to stop running or produce unexpected results.
The order of the nodes in the workflow_nodes array will be the same order that these nodes appear in the DAG, with the first node in the array added directly after the Source node. The Destination node follows the last node in the array.
Be sure to specify nodes in the allowed order. The following DAG placements are all allowed:

Partitioner node

A Partitioner node has a type of partition. Learn about the available partitioning strategies.

Auto strategy

Python SDK

auto_partitioner_workflow_node = WorkflowNode(
    name="Partitioner",
    subtype="vlm",
    type="partition",
    settings={
        "provider": "<provider>",
        "provider_api_key": None,
        "model": "<model>",
        "output_format": "<output-format>",
        "prompt": {
            "text": "<alternative-prompt>"
        },
        "format_html": <True|False>,
        "unique_element_ids": <True|False>,
        "is_dynamic": True,
        "allow_fast": True
   }
)

curl, Postman

{
    "name": "Partitioner",
    "type": "vlm",
    "subtype": "partition",
    "settings": {
        "provider": "<provider>",
        "provider_api_key": null,
        "model": "<model>",
        "output_format": "<output-format>",
        "prompt": {
            "text": "<alternative-prompt>"
        },
        "format_html": <true|false>,
        "unique_element_ids": <true|false>,
        "is_dynamic": true,
        "allow_fast": true
    }
}

Fields for settings include:

strategy: Required. The partitioning strategy to use. This field must be set to auto.
provider: Optional. If the Auto partitioning strategy needs to use the VLM partitioning strategy, then use the specified VLM provider. Allowed values include auto, openai, anthropic, and bedrock. The default value is anthropic.
provider_api_key: Optional. If specified, use a non-default API key for calls to the specified VLM provider as needed. The default is none, which means to rely on using Unstructured’s internal default API key for the VLM provider.
model: Optional. If the Auto partitioning strategy needs to use the VLM partitioning strategy, then use the specified VLM. The default value is claude-3-5-sonnet-20241022.
- For openai, available values for model are gpt-4o and gpt-4o-mini.
- For anthropic, available values for model are claude-3-5-sonnet-20241022 and claude-3-7-sonnet-20250219.
- For bedrock, available values for model are:
  - us.amazon.nova-lite-v1:0
  - us.amazon.nova-pro-v1:0
  - us.anthropic.claude-3-opus-20240229-v1:0
  - us.anthropic.claude-3-haiku-20240307-v1:0
  - us.anthropic.claude-3-sonnet-20240229-v1:0
  - us.anthropic.claude-3-5-sonnet-20241022-v2:0
  - us.meta.llama3-2-11b-instruct-v1:0
  - us.meta.llama3-2-90b-instruct-v1:0
output_format: Output. The format of the response. Allowed values include text/html and application/json. The default is text/html.
prompt.text: Optional. If the Auto partitioning strategy needs to use the VLM partitioning strategy, then use the specified prompt when calling the specified VLM. The default value is none, which means to rely on using Unstructured’s internal default prompt when calling the VLM.
format_html: Optional. If the Auto partitioning strategy needs to use the VLM partitioning strategy, true (the default) to apply Beautiful Soup’s prettify method to the HTML that is generated by the VLM partitioner, which for example adds indentation for better readability.
unique_element_ids: Optional. True (the default) to assign UUIDs to element IDs, which guarantees their uniqueness. This is useful for example when using them as primary keys in a database. False to assign a SHA-256 of the element’s text as its element ID.
is_dynamic: Required. True to enable dynamic routing of pages to Fast, High Res, or VLM as needed for better overall performance and cost savings.
allow_fast: Required. True to allow routing of pages to Fast as needed for better overall performance and cost savings.

VLM strategy

Python SDK

vlm_partitioner_workflow_node = WorkflowNode(
    name="Partitioner",
    subtype="vlm",
    type="partition",
    settings={
        "provider": "<provider>",
        "provider_api_key": None,
        "model": "<model>",
        "output_format": "<output-format>",
         "prompt": {
            "text": "<alternative-prompt>"
        },
        "format_html": <True|False>,
        "unique_element_ids": <True|False>,
        "is_dynamic": False,
        "allow_fast": True|False
    }
)

curl, Postman

{
    "name": "Partitioner",
    "type": "partition",
    "subtype": "vlm",
    "settings": {
        "provider": "<provider>",
        "provider_api_key": null,
        "model": "<model>",
        "output_format": "<output-format>",
        "prompt": {
            "text": "<alternative-prompt>"
        },
        "format_html": <true|false>,
        "unique_element_ids": <true|false>,
        "is_dynamic": false,
        "allow_fast": <true|false>
    }
}

Fields for settings include:

provider: Optional. Use the specified VLM provider. Allowed values include auto, openai, anthropic, and bedrock. The default value is anthropic.
provider_api_key: Optional. If specified, use a non-default API key for calls to the specified VLM provider as needed. The default is none, which means to rely on using Unstructured’s internal default API key for the VLM provider.
model: Optional. If the Auto partitioning strategy needs to use the VLM partitioning strategy, then use the specified VLM. The default value is claude-3-5-sonnet-20241022.
- For openai, available values for model are gpt-4o and gpt-4o-mini.
- For anthropic, available values for model are claude-3-5-sonnet-20241022 and claude-3-7-sonnet-20250219.
- For bedrock, available values for model are:
  - us.amazon.nova-lite-v1:0
  - us.amazon.nova-pro-v1:0
  - us.anthropic.claude-3-opus-20240229-v1:0
  - us.anthropic.claude-3-haiku-20240307-v1:0
  - us.anthropic.claude-3-sonnet-20240229-v1:0
  - us.anthropic.claude-3-5-sonnet-20241022-v2:0
  - us.meta.llama3-2-11b-instruct-v1:0
  - us.meta.llama3-2-90b-instruct-v1:0
output_format: Output. The format of the response. Allowed values include text/html and application/json. The default is text/html.
prompt.text: Optional. Use the specified prompt when calling the specified VLM. The default value is none, which means to rely on using Unstructured’s internal default prompt when calling the VLM.
format_html: Optional. True (the default) to apply Beautiful Soup’s prettify method to the HTML that is generated by the VLM partitioner, which for example adds indentation for better readability.
unique_element_ids: Optional. True (the default) to assign UUIDs to element IDs, which guarantees their uniqueness. This is useful for example when using them as primary keys in a database. False to assign a SHA-256 of the element’s text as its element ID.
is_dynamic: Required. False to use the VLM strategy.
allow_fast: Optional. True (the default) to allow routing of pages to Fast as needed for better overall performance and cost savings.

High Res strategy

Python SDK

high_res_paritioner_workflow_node = WorkflowNode(
    name="Partitioner",
    subtype="unstructured_api",
    type="partition",
    settings={
        "strategy": "hi_res",
        "include_page_breaks": <True|False>,
        "pdf_infer_table_structure": <True|False>,
        "exclude_elements": [
            "<element-name>",
            "<element-name>"
        ],
        "xml_keep_tags": <True|False>,
        "encoding": "<encoding>",
        "ocr_languages": [
            "<language>",
            "<language>"
        ],
        "extract_image_block_types": [
            "image",
            "table"
        ],
        "infer_table_structure": <True|False>,
    }
)

curl, Postman

{
    "name": "Partitioner",
    "type": "partition",
    "subtype": "unstructured_api",
    "settings": {
        "strategy": "hi_res",
        "include_page_breaks": <true|false>,
        "pdf_infer_table_structure": <true|false>,
        "exclude_elements": [
            "<element-name>",
            "<element-name>"
        ],
        "xml_keep_tags": <true|false>,
        "encoding": "<encoding>",
        "ocr_languages": [
            "<language>",
            "<language>"
        ],
        "extract_image_block_types": [
            "image",
            "table"
        ],
        "infer_table_structure": <true|false>,
    }
}

strategy: Required. The partitioning strategy to use. This field must be set to hi_res.
include_page_breaks: Optional. True to include page breaks in the output if supported by the file type. The default is false.
pdf_infer_table_structure: Optional. True for any Table elements extracted from a PDF to include an additional metadata field, text_as_html, where the value (string) is a just a transformation of the data into an HTML table. The default is false.
exclude_elements: Optional. A list of any Unstructured element types to exclude from the output. The default is none. Available values include:
- FigureCaption
- NarrativeText
- ListItem
- Title
- Address
- Table
- PageBreak
- Header
- Footer
- UncategorizedText
- Image
- Formula
- EmailAddress
xml_keep_tags: Optional. True to retain any XML tags in the output. False (the default) to just extract the text from any XML tags instead.
encoding: Optional. The encoding method used to decode the text input. The default is utf-8.
ocr_languages: Optional. A list of languages present in the input, for use in partitioning, OCR, or both. Multiple languages indicate that the text could be in any of the specified languages. The default is [ 'eng' ]. See the language codes list.
extract_image_block_types: Optional. A list of the Unstructured element types for use in extracting image blocks as Base64 encoded data stored in metadata fields. Available values include Image and Table. The default is [ 'Image', 'Table' ].
infer_table_structure: Optional. True to have any table elements extracted from a PDF to include an additional metadata field named text_as_html, containing an HTML <table> transformation. The default is false.

Fast strategy

Python SDK

fast_partitioner_workflow_node = WorkflowNode(
    name="Partitioner",
    subtype="unstructured_api",
    type="partition",
    settings={
        "strategy": "fast",
        "include_page_breaks": <True|False>,
        "pdf_infer_table_structure": <True|False>,
        "exclude_elements": [
            "<element-name>",
            "<element-name>"
        ],
        "xml_keep_tags": <True|False>,
        "encoding": "<encoding>",
        "ocr_languages": [
            "<language>",
            "<language>"
        ],
        "extract_image_block_types": [
            "image",
            "table"
        ],
        "infer_table_structure": <True|False>
    }
)

curl, Postman

{
    "name": "Partitioner",
    "type": "partition",
    "subtype": "unstructured_api",
    "settings": {
        "strategy": "fast",
        "include_page_breaks": <true|false>,
        "pdf_infer_table_structure": <true|false>,
        "exclude_elements": [
            "<element-name>",
            "<element-name>"
        ],
        "xml_keep_tags": <true|false>,
        "encoding": "<encoding>",
        "ocr_languages": [
            "<language-code>",
            "<language-code>"
        ],
        "extract_image_block_types": [
            "image",
            "table"
        ],
        "infer_table_structure": <true|false>
    }
}

Fields for settings include:

strategy: Required. The partitioning strategy to use. This field must be set to fast.
`include_page_breaks: Optional. True to include page breaks in the output if supported by the file type. The default is false.
pdf_infer_table_structure: Optional. Although this field is listed, it applies only to the hi_res strategy and will not work if set to true. The default is false.
exclude_elements: Optional. A list of any Unstructured element types to exclude from the output. The default is none. Available values include:
- FigureCaption
- NarrativeText
- ListItem
- Title
- Address
- Table
- PageBreak
- Header
- Footer
- UncategorizedText
- Image
- Formula
- EmailAddress
xml_keep_tags: Optional. True to retain any XML tags in the output. False (the default) to just extract the text from any XML tags instead.
encoding: Optional. The encoding method used to decode the text input. The default is utf-8.
ocr_languages: Optional. A list of languages present in the input, for use in partitioning, OCR, or both. Multiple languages indicate that the text could be in any of the specified languages. The default is [ 'eng' ]. See the language codes list.
extract_image_block_types: Optional. A list of the Unstructured element types for use in extracting image blocks as Base64 encoded data stored in metadata fields. Available values include Image and Table. The default is [ 'Image', 'Table' ].
infer_table_structure: Optional. True to have any table elements extracted from a PDF to include an additional metadata field named text_as_html, containing an HTML <table> transformation. The default is false.

Chunker node

A Chunker node has a type of chunk. Learn about the available chunking strategies.

Chunk by Character strategy

Python SDK

chunk_by_character_chunker_workflow_node = WorkflowNode(
    name="Chunker",
    subtype="chunk_by_character",
    type="chunk",
    settings={
        "unstructured_api_url": None,
        "unstructured_api_key": None,
        "include_orig_elements": <True|False>,
        "new_after_n_chars": <new-after-n-chars>,
        "max_characters": <max-characters>,
        "overlap": <overlap>,
        "overlap_all": <True|False>,
        "contextual_chunking_strategy": "<contextual-chunking-strategy>"
    }
)

curl, Postman

{
    "name": "Chunker",
    "type": "chunk",
    "subtype": "chunk_by_character",
    "settings": {
        "unstructured_api_url": null,
        "unstructured_api_key": null,
        "include_orig_elements": <true|false>,
        "new_after_n_chars": <new-after-n-chars>,
        "max_characters": <max-characters>,
        "overlap": <overlap>,
        "overlap_all": <true|false>,
        "contextual_chunking_strategy": "<contextual-chunking-strategy>"
    }
}

Fields for settings include:

unstructured_api_url: Optional. If specified, use a non-default API URL for calls to the specified chunker as needed. The default is none, which means to rely on using Unstructured’s internal default API URL for the chunker.
unstructured_api_key: Optional. If specified, use a non-default API key for calls to the specified chunker as needed. The default is none, which means to rely on using Unstructured’s internal default API key for the chunker.
include_orig_elements: Optional. True to have the elements that are used to form a chunk appear in .metadata.orig_elements for that chunk. The default is false.
new_after_n_chars: Optional. Closes new sections after reaching a length of this many characters. This is an approximate limit. The default is none.
max_characters: Optional. The absolute maximum number of characters in a chunk. The default is none.
overlap: Optional. Applies a prefix of this many trailing characters from the prior text-split chunk to second and later chunks formed from oversized elements by text-splitting. The default is none.
overlap_all: Optional. True to apply overlap to “normal” chunks formed by combining whole elements. Use with caution as this can introduce noise into otherwise clean semantic units. The default is false.
contextual_chunking_strategy: Optional. If specified, prepends chunk-specific explanatory context to each chunk. Allowed values include v1. The default is none.

Chunk by Title strategy

Python SDK

chunk_by_title_chunker_workflow_node = WorkflowNode(
    name="Chunker",
    subtype="chunk_by_title",
    type="chunk",
    settings={
        "unstructured_api_url": None,
        "unstructured_api_key": None,
        "multipage_sections": <True|False>,
        "combine_text_under_n_chars": <combine-text-under-n-chars>,
        "include_orig_elements": <True|False>,
        "new_after_n_chars": <new-after-n-chars>,
        "max_characters": <max-characters>,
        "overlap": <overlap>,
        "overlap_all": <True|False>,
        "contextual_chunking_strategy": "<contextual-chunking-strategy>"
    }
)

curl, Postman

{
    "name": "Chunker",
    "type": "chunk",
    "subtype": "chunk_by_title",
    "settings": {
        "unstructured_api_url": null,
        "unstructured_api_key": null,
        "multipage_sections": <true|false>,
        "combine_text_under_n_chars": <combine-text-under-n-chars>,
        "include_orig_elements": <true|false>,
        "new_after_n_chars": <new-after-n-chars>,
        "max_characters": <max-characters>,
        "overlap": <overlap>,
        "overlap_all": <true|false>,
        "contextual_chunking_strategy": "<contextual-chunking-strategy>"
    }
}

Fields for settings include:

unstructured_api_url: Optional. If specified, use a non-default API URL for calls to the specified chunker as needed. The default is none, which means to rely on using Unstructured’s internal default API URL for the chunker.
unstructured_api_key: Optional. If specified, use a non-default API key for calls to the specified chunker as needed. The default is none, which means to rely on using Unstructured’s internal default API key for the chunker.- multipage_sections: Optional. … The default is false.
combine_text_under_n_chars: Optional. Combines elements from a section into a chunk until a section reaches a length of this many characters. The default is none.
include_orig_elements: Optional. True to have the elements that are used to form a chunk appear in .metadata.orig_elements for that chunk. The default is false.
new_after_n_chars: Optional. Closes new sections after reaching a length of this many characters. This is an approximate limit. The default is none.
max_characters: Optional. The absolute maximum number of characters in a chunk. The default is none.
overlap: Optional. Applies a prefix of this many trailing characters from the prior text-split chunk to second and later chunks formed from oversized elements by text-splitting. The default is none.
overlap_all: Optional. True to apply overlap to “normal” chunks formed by combining whole elements. Use with caution as this can introduce noise into otherwise clean semantic units. The default is false.
contextual_chunking_strategy: Optional. If specified, prepends chunk-specific explanatory context to each chunk. Allowed values include v1. The default is none.

Chunk by Page strategy

Python SDK

chunk_by_page_chunker_workflow_node = WorkflowNode(
    name="Chunker",
    subtype="chunk_by_page",
    type="chunk",
    settings={
        "unstructured_api_url": None,
        "unstructured_api_key": None,
        "include_orig_elements": <True|False>,
        "new_after_n_chars": <new-after-n-chars>,
        "max_characters": <max-characters>,
        "overlap": <overlap>,
        "overlap_all": <True|False>,
        "contextual_chunking_strategy": "<contextual-chunking-strategy>"
    }
)

curl, Postman

{
    "name": "Chunker",
    "type": "chunk",
    "subtype": "chunk_by_page",
    "settings": {
        "unstructured_api_url": null,
        "unstructured_api_key": null,
        "include_orig_elements": <true|false>,
        "new_after_n_chars": <new-after-n-chars>,
        "max_characters": <max-characters>,
        "overlap": <overlap>,
        "overlap_all": <true|false>,
        "contextual_chunking_strategy": "<contextual-chunking-strategy>"
    }
}

Fields for settings include:

unstructured_api_url: Optional. If specified, use a non-default API URL for calls to the specified chunker as needed. The default is none, which means to rely on using Unstructured’s internal default API URL for the chunker.
unstructured_api_key: Optional. If specified, use a non-default API key for calls to the specified chunker as needed. The default is none, which means to rely on using Unstructured’s internal default API key for the chunker.- include_orig_elements: Optional. … The default is false.
include_orig_elements: Optional. True to have the elements that are used to form a chunk appear in .metadata.orig_elements for that chunk. The default is false.
new_after_n_chars: Optional. Closes new sections after reaching a length of this many characters. This is an approximate limit. The default is none.
max_characters: Optional. The absolute maximum number of characters in a chunk. The default is none.
overlap: Optional. Applies a prefix of this many trailing characters from the prior text-split chunk to second and later chunks formed from oversized elements by text-splitting. The default is none.
overlap_all: Optional. True to apply overlap to “normal” chunks formed by combining whole elements. Use with caution as this can introduce noise into otherwise clean semantic units. The default is false.
contextual_chunking_strategy: Optional. If specified, prepends chunk-specific explanatory context to each chunk. Allowed values include v1. The default is none.

Chunk by Similarity strategy

Python SDK

chunk_by_similarity_chunker_workflow_node = WorkflowNode(
    name="Chunker",
    subtype="chunk_by_similarity",
    type="chunk",
    settings={
        "unstructured_api_url": None,
        "unstructured_api_key": None,
        "include_orig_elements": <True|False>,
        "new_after_n_chars": <True|False>,
        "max_characters": <max-characters>,
        "overlap": <overlap>,
        "overlap_all": <True|False>,
        "contextual_chunking_strategy": "<contextual-chunking-strategy>",
        "similarity_threshold": <similarity-threshold>
    }
)

curl, Postman

{
    "name": "Chunker",
    "type": "chunk",
    "subtype": "chunk_by_similarity",
    "settings": {
        "unstructured_api_url": null,
        "unstructured_api_key": null,
        "include_orig_elements": <true|false>,
        "new_after_n_chars": <true|false>,
        "max_characters": <max-characters>,
        "overlap": <overlap>,
        "overlap_all": <true|false>,
        "contextual_chunking_strategy": "<contextual-chunking-strategy>",
        "similarity_threshold": <similarity-threshold>
    }
}

Fields for settings include:

unstructured_api_url: Optional. If specified, use a non-default API URL for calls to the specified chunker as needed. The default is none, which means to rely on using Unstructured’s internal default API URL for the chunker.
unstructured_api_key: Optional. If specified, use a non-default API key for calls to the specified chunker as needed. The default is none, which means to rely on using Unstructured’s internal default API key for the chunker.
include_orig_elements: Optional. True to have the elements that are used to form a chunk appear in .metadata.orig_elements for that chunk. The default is false.
new_after_n_chars: Optional. Closes new sections after reaching a length of this many characters. This is an approximate limit. The default is none.
max_characters: Optional. The absolute maximum number of characters in a chunk. The default is none.
overlap: Optional. Applies a prefix of this many trailing characters from the prior text-split chunk to second and later chunks formed from oversized elements by text-splitting. The default is none.
overlap_all: Optional. True to apply overlap to “normal” chunks formed by combining whole elements. Use with caution as this can introduce noise into otherwise clean semantic units. The default is false.
contextual_chunking_strategy: Optional. If specified, prepends chunk-specific explanatory context to each chunk. Allowed values include v1. The default is none.
similarity_threshold: Optional. The minimum similarity that text in consecutive elements must have to be included in the same chunk. This must be a value between 0.0 and 1.0, exclusive (0.01 to 0.99). The default is none.

Enrichment node

An Enrichment node has a type of prompter. Learn about the available enrichments.

Image summary descriptions, table summary descriptions, and table-to-HTML output is generated only when the Partitioner node in a workflow is set to use the High Res partitioning strategy and the workflow also contains an image description, table description, or table-to-HTML enrichment node.Setting the Partitioner node to use Auto, VLM, or Fast in a workflow that also contains an image description, table description, or table-to-HTML enrichment node will not generate any image summary descriptions, table summary descriptions, or table-to-HTML output, and it could also cause the workflow to stop running or produce unexpected results.

Image Description task

Image summary descriptions are generated only when the Partitioner node in a workflow is set to use the High Res partitioning strategy and the workflow also contains an image description enrichment node.Setting the Partitioner node to use Auto, VLM, or Fast in a workflow that also contains an image description enrichment node will not produce any image summary descriptions, and it could also cause the workflow to stop running or produce unexpected results.

Python SDK

curl, Postman

Allowed values for <subtype> include:

openai_image_description
anthropic_image_description
bedrock_image_description

Table Description task

Table summary descriptions are generated only when the Partitioner node in a workflow is set to use the High Res partitioning strategy and the workflow also contains a table description enrichment node.Setting the Partitioner node to use Auto, VLM, or Fast in a workflow that also contains a table description enrichment node will not produce any table summary descriptions, and it could also cause the workflow to stop running or produce unexpected results.

Python SDK

curl, Postman

Allowed values for <subtype> include:

openai_table_description
anthropic_table_description
bedrock_table_description

Table to HTML task

Table-to-HTML generation happens only when the Partitioner node in a workflow is set to use the High Res partitioning strategy and the workflow also contains a table-to-HTML enrichment node.Setting the Partitioner node to use Auto, VLM, or Fast in a workflow that also contains a table-to-HTML enrichment node will not generate any table-to-HTML output, and it could also cause the workflow to stop running or produce unexpected results.

Python SDK

curl, Postman

Named Entity Recognition (NER) task

Python SDK

ner_enrichment_workflow_node = WorkflowNode(
    name="Enrichment",
    subtype="<subtype>",
    type="prompter",
    settings={
        "prompt_interface_overrides": {
            "prompt": {
                "user": "<user-prompt-override>"
            } 
        }             
    }
)

curl, Postman

{
    "name": "Enrichment",
    "type": "prompter",
    "subtype": "<subtype>",
    "settings": {
        "prompt_interface_overrides": {
            "prompt": {
                "user": "<user-prompt-override>"
            } 
        }
    }
}

Fields for settings include:

prompt_interface_overrides.prompt.user: Optional. Any alternative prompt to use with the underlying NER model. The default is none, which means to rely on using Unstructured’s internal default prompt when calling the NER model. The internal default prompt is as follows, which you can override by providing an alternative prompt:

Extract named entities and their relationships from the following text.

Provide the entities, their corresponding types and relationships as a structured JSON response.

Entity types:
- PERSON
- ORGANIZATION
- LOCATION
- DATE
- TIME
- EVENT
- MONEY
- PERCENT
- FACILITY
- PRODUCT
- ROLE
- DOCUMENT
- DATASET

Relationship types:
- PERSON - ORGANIZATION: works_for, affiliated_with, founded
- PERSON - LOCATION: born_in, lives_in, traveled_to
- ORGANIZATION - LOCATION: based_in, has_office_in
- Entity - DATE: occurred_on, founded_on, died_on, published_in
- PERSON - PERSON: married_to, parent_of, colleague_of
- PRODUCT - ORGANIZATION: developed_by, owned_by
- EVENT - LOCATION: held_in, occurred_in
- Entity - ROLE: has_title, acts_as, has_role
- DATASET - PERSON: mentions
- DATASET - DOCUMENT: located_in
- PERSON - DATASET: published
- DOCUMENT - DOCUMENT: referenced_in, contains
- DOCUMENT - DATE: dated
- PERSON - DOCUMENT: published

[START OF TEXT]
{{text}}
[END OF TEXT]


Response format json schema: {
    "items": [
        { "entity": "Entity name", "type": "Entity type" },
        { "entity": "Entity name", "type": "Entity type" }
    ],
    "relationships": [
        {"from": "Entity name", "relationship": "Relationship type", "to": "Entity name"},
        {"from": "Entity name", "relationship": "Relationship type", "to": "Entity name"}
    ]
}

If you provide an alternative prompt, you must provide the entire alternative prompt in the preceding format. For best results, Unstructured strongly recommends that you limit your changes only to certain portions of the internal default prompt, specifically:

Adding, renaming, or deleting items in the list of predefined types (such as PERSON, ORGANIZATION, LOCATION, and so on).
Adding, renaming, or deleting items in the list of predefined relationships (such as works_for, based_in, has_role, and so on).

As needed, adding any clarifying instructions only between these two lines:

...
Provide the entities and their corresponding types as a structured JSON response.

(Add any clarifying instructions here only.)

[START OF TEXT]
...

Changing any other portions of the internal default prompt could produce unexpected results.

Allowed values for <subtype> include:

openai_ner
anthropic_ner

Embedder node

An Embedder node has a type of embed. Learn about the available embedding providers and models.

Python SDK

curl, Postman

Allowed values for subtype and model_name include:

"subtype": "azure_openai"
- "model_name": "text-embedding-3-small"
- "model_name": "text-embedding-3-large"
- "model_name": "text-embedding-ada-002"
"subtype": "bedrock"
- "model_name": "amazon.titan-embed-text-v2:0"
- "model_name": "amazon.titan-embed-text-v1"
- "model_name": "amazon.titan-embed-image-v1"
- "model_name": "cohere.embed-english-v3"
- "model_name": "cohere.embed-multilingual-v3"
"subtype": "togetherai"
- "model_name": "togethercomputer/m2-bert-80M-32k-retrieval"
"subtype": "voyageai"
- "model_name": "voyage-3"
- "model_name": "voyage-3-large"
- "model_name": "voyage-3-lite"
- "model_name": "voyage-code-3"
- "model_name": "voyage-finance-2"
- "model_name": "voyage-law-2"
- "model_name": "voyage-code-2"
- "model_name": "voyage-multimodal-3"

Unstructured API

Workflow Endpoint

Partition Endpoint

Legacy APIs

Troubleshooting

Create a workflow

Update a workflow

Custom workflow DAG nodes

Partitioner node

Auto strategy

VLM strategy

High Res strategy

Fast strategy

Chunker node

Chunk by Character strategy

Chunk by Title strategy

Chunk by Page strategy

Chunk by Similarity strategy

Enrichment node

Image Description task

Table Description task

Table to HTML task

Named Entity Recognition (NER) task

Embedder node

Unstructured API

Workflow Endpoint

Partition Endpoint

Legacy APIs

Troubleshooting

​Create a workflow

​Update a workflow

​Custom workflow DAG nodes

​Partitioner node

​Auto strategy

​VLM strategy

​High Res strategy

​Fast strategy

​Chunker node

​Chunk by Character strategy

​Chunk by Title strategy

​Chunk by Page strategy

​Chunk by Similarity strategy

​Enrichment node

​Image Description task

​Table Description task

​Table to HTML task

​Named Entity Recognition (NER) task

​Embedder node

Create a workflow

Update a workflow

Custom workflow DAG nodes

Partitioner node

Auto strategy

VLM strategy

High Res strategy

Fast strategy

Chunker node

Chunk by Character strategy

Chunk by Title strategy

Chunk by Page strategy

Chunk by Similarity strategy

Enrichment node

Image Description task

Table Description task

Table to HTML task

Named Entity Recognition (NER) task

Embedder node