The Unstructured connector lets your AI agent act in each user's Unstructured account. Each user connects their own Unstructured API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 30 tools.
- Tools
- 30
- What they doRead · write · destructive
- 17 · 10 · 317 read10 write3 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Unstructured connection
In AgentKit > Connections, create an Unstructured connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'unstructured'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Unstructured:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'unstructured_account_get',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "unstructured"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Unstructured:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="unstructured_account_get",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their Unstructured credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolunstructured_account_getGet the account and workspace the API key belongs to.Read-onlyGet Account
Get the account and workspace the API key belongs to. Returns account_id and workspace_id. Use this to confirm which workspace the connection works in.
Inputs
This tool takes no inputs.
unstructured_destination_connection_check_getGet the latest connection check for a destination connector.Read-onlyGet Destination Connection Check
Get the latest connection check for a destination connector. Returns id, status (SCHEDULED, SUCCESS or FAILURE), reason when it failed, and timestamps. Use this after unstructured_destination_connection_check_create.
Inputs
destination_idstringrequired- Destination connector ID (UUID) or key. Get it from unstructured_destinations_list. Example: 7c9e1a3b-5d7f-4b2c-8e4a-6f8b0d2c4e6a
unstructured_destination_getGet one destination connector by ID or key.Read-onlyGet Destination Connector
Get one destination connector by ID or key. Returns id, key, name, type, config (secrets masked), created_at and updated_at. Use unstructured_destinations_list to find the ID.
Inputs
destination_idstringrequired- Destination connector ID (UUID) or key. Get it from unstructured_destinations_list. Example: 7c9e1a3b-5d7f-4b2c-8e4a-6f8b0d2c4e6a
unstructured_destinations_listList the workspace's destination connectors, optionally filtered by type.Read-onlyList Destination Connectors
List the workspace's destination connectors, optionally filtered by type. Returns an array of connectors with id, key, name, type, config (secrets masked) and created_at. Use this to find a destination ID for a workflow. Use unstructured_destination_get for one connector.
Inputs
destination_typestring- Only destination connectors of this type, for example astradb, couchbase, databricks_volumes, databricks_volume_delta_tables, delta_table, elasticsearch. Example: s3one of
astradbcouchbasedatabricks_volumesdatabricks_volume_delta_tablesdelta_tableelasticsearchkafka-cloudmilvusmongodbmotherduckneo4jonedrivepineconepostgresredisqdrant-cloudsnowflaketeradataweaviate-cloudibm_watsonx_s3s3azuregcs
unstructured_job_details_getGet a job's processing details per node.Read-onlyGet Job Details
Get a job's processing details per node. Returns processing_status, progress, node_stats (per-node document counts), summary and warning_nodes. Use this to see where documents are in the pipeline or which step failed.
Inputs
job_idstringrequired- Job ID (UUID) from unstructured_workflow_run or unstructured_jobs_list. Example: 3e5a7c9b-1d2f-4a6c-8e0b-2d4f6a8c0e1d
unstructured_job_failed_files_listList the documents that failed in a job, with their error messages.Read-onlyList Job Failed Files
List the documents that failed in a job, with their error messages. Returns failed_files (each document with its error), total and next_offset. Use this to debug a run that reported failures.
Inputs
job_idstringrequired- Job ID (UUID) from unstructured_workflow_run or unstructured_jobs_list. Example: 3e5a7c9b-1d2f-4a6c-8e0b-2d4f6a8c0e1d
limitinteger- Files per page, 1 to 1000. Example: 100
offsetinteger- Files to skip, for paging. Example: 0
unstructured_job_file_status_getGet the processing status of each file in a job, with any warnings.Read-onlyGet Job File Status
Get the processing status of each file in a job, with any warnings. Returns files (each with its id, name, status and notices) and truncated. Use this to get file IDs for unstructured_job_output_download or to review warnings.
Inputs
job_idstringrequired- Job ID (UUID) from unstructured_workflow_run or unstructured_jobs_list. Example: 3e5a7c9b-1d2f-4a6c-8e0b-2d4f6a8c0e1d
has_warningsboolean- true returns only files with notices, false only files without. Leave empty for every file. Example: true
unstructured_job_getGet a job's status.Read-onlyGet Job
Get a job's status. Returns id, workflow_id, status, runtime, created_at, failed_file_count, input_file_ids and output_node_files. Use this to poll a run. Use unstructured_job_details_get for per-node counts and unstructured_job_failed_files_list for errors.
Inputs
job_idstringrequired- Job ID (UUID) from unstructured_workflow_run or unstructured_jobs_list. Example: 3e5a7c9b-1d2f-4a6c-8e0b-2d4f6a8c0e1d
unstructured_job_output_downloadGet the processed output of one file from a job, as Unstructured document elements.Read-onlyDownload Job Output
Get the processed output of one file from a job, as Unstructured document elements. Returns a JSON array of elements with type, text, element_id and metadata (and embeddings when the workflow embeds). Use this to read results without opening the destination. Get file IDs from unstructured_job_file_status_get.
Inputs
file_idstringrequired- ID of the processed file, from unstructured_job_get (input_file_ids) or unstructured_job_file_status_get. Example: 9a1b3c5d7e
job_idstringrequired- Job ID (UUID) from unstructured_workflow_run or unstructured_jobs_list. Example: 3e5a7c9b-1d2f-4a6c-8e0b-2d4f6a8c0e1d
node_idstring- Node whose output to return. Defaults to the last processing node. Example: 5d7f9b1c-3e5a-4c7e-9a1b-3c5d7e9f1a2b
unstructured_jobs_listList jobs (workflow runs) in the workspace, optionally for one workflow or status.Read-onlyList Jobs
List jobs (workflow runs) in the workspace, optionally for one workflow or status. Returns an array of jobs with id, workflow_id, workflow_name, status, runtime and created_at. Use this to find recent runs. Use unstructured_job_get for one job.
Inputs
statusstring- Only jobs in this status, for example SCHEDULED, IN_PROGRESS, COMPLETED, STOPPED or FAILED. Example: COMPLETED
workflow_idstring- Only jobs of this workflow. Example: f0a1b2c3-4d5e-4f7a-8b9c-0d1e2f3a4b5c
unstructured_source_connection_check_getGet the latest connection check for a source connector.Read-onlyGet Source Connection Check
Get the latest connection check for a source connector. Returns id, status (SCHEDULED, SUCCESS or FAILURE), reason when it failed, and timestamps. Use this after unstructured_source_connection_check_create.
Inputs
source_idstringrequired- Source connector ID (UUID) or key. Get it from unstructured_sources_list. Example: 2b4f6d8e-1a3c-4e5f-9a7b-0c2d4e6f8a1b
unstructured_source_getGet one source connector by ID or key.Read-onlyGet Source Connector
Get one source connector by ID or key. Returns id, key, name, type, config (secrets masked), created_at and updated_at. Use unstructured_sources_list to find the ID.
Inputs
source_idstringrequired- Source connector ID (UUID) or key. Get it from unstructured_sources_list. Example: 2b4f6d8e-1a3c-4e5f-9a7b-0c2d4e6f8a1b
unstructured_sources_listList the workspace's source connectors, optionally filtered by type.Read-onlyList Source Connectors
List the workspace's source connectors, optionally filtered by type. Returns an array of connectors with id, key, name, type, config (secrets masked) and created_at. Use this to find a source ID for a workflow. Use unstructured_source_get for one connector.
Inputs
source_typestring- Only source connectors of this type, for example confluence, couchbase, databricks_volumes, dropbox, elasticsearch, google_drive. Example: s3one of
confluencecouchbasedatabricks_volumesdropboxelasticsearchgoogle_drivekafka-cloudmongodbonedriveoutlookpostgressalesforcesharepointslacksnowflaketeradatajirazendesks3azuregcs
unstructured_template_getGet a workflow template with its nodes.Read-onlyGet Workflow Template
Get a workflow template with its nodes. Returns id, name, version, description and nodes (each with name, type, subtype and settings). Use this to copy node settings into a custom workflow.
Inputs
template_idstringrequired- Template ID from unstructured_templates_list. Example: hi-res-and-enrich
unstructured_templates_listList the workflow templates Unstructured provides.Read-onlyList Workflow Templates
List the workflow templates Unstructured provides. Returns templates with id, name, version, description and last_updated. Use this to pick a template_id for unstructured_workflow_create.
Inputs
This tool takes no inputs.
unstructured_workflow_getGet one workflow by ID or key, including its processing nodes.Read-onlyGet Workflow
Get one workflow by ID or key, including its processing nodes. Returns id, key, name, sources, destinations, workflow_type, workflow_nodes, schedule, status and timestamps. Use this to inspect or copy a workflow's node settings. Use unstructured_workflows_list to find the ID.
Inputs
workflow_idstringrequired- Workflow ID (UUID) or key. Get it from unstructured_workflows_list. Example: f0a1b2c3-4d5e-4f7a-8b9c-0d1e2f3a4b5c
unstructured_workflows_listList the workspace's workflows, optionally filtered by connector, state, name or creation time.Read-onlyList Workflows
List the workspace's workflows, optionally filtered by connector, state, name or creation time. Returns an array of workflows with id, key, name, sources, destinations, workflow_type, schedule, status and created_at. Use this to find a workflow to run. Use unstructured_workflow_get for its nodes.
Inputs
created_beforestring- Only workflows created before this time (ISO 8601). Example: 2026-11-15T00:00:00Z
created_sincestring- Only workflows created at or after this time (ISO 8601). Example: 2026-10-01T00:00:00Z
destination_idstring- Only workflows that write to this destination connector. Example: 7c9e1a3b-5d7f-4b2c-8e4a-6f8b0d2c4e6a
namestring- Only workflows with this name. Example: Invoice pipeline
pageinteger- Page number, starting at 1. Example: 1
page_sizeinteger- Workflows per page. Example: 20
sort_bystring- Field to sort by. Default: id. Example: created_at
sort_directionstring- Sort direction: asc or desc. Example: descone of
ascdesc source_idstring- Only workflows that read from this source connector. Example: 2b4f6d8e-1a3c-4e5f-9a7b-0c2d4e6f8a1b
statusstring- Workflow state: active or inactive. Example: activeone of
activeinactive
unstructured_destination_connection_check_createStart a check that the destination connector can reach its service with its credentials.WriteCheck Destination Connection
Start a check that the destination connector can reach its service with its credentials. Returns the check with id, status (SCHEDULED, SUCCESS or FAILURE) and created_at. Use this after creating or updating a connector, then read the outcome with unstructured_destination_connection_check_get.
Inputs
destination_idstringrequired- Destination connector ID (UUID) or key. Get it from unstructured_destinations_list. Example: 7c9e1a3b-5d7f-4b2c-8e4a-6f8b0d2c4e6a
unstructured_destination_createCreate a destination connector that lets workflows write processed output to a storage service, database or vector store, using the type's connection settings.WriteCreate Destination Connector
Create a destination connector that lets workflows write processed output to a storage service, database or vector store, using the type's connection settings. Returns the connector with id, key, name, type and config. Use this before unstructured_workflow_create. Run unstructured_destination_connection_check_create afterwards to test the credentials.
Inputs
configobjectrequired- Connection settings for the chosen type. For s3: remote_url (s3://bucket/path/) plus key and secret; vector stores and databases take their own fields (for example api_endpoint, token and collection_name for astradb). See https://docs.unstructured.io/api-reference/workflow/destinations/overview for each type's fields. Example: {"remote_url": "s3://acme-docs/processed/", "key": "AKIAIOSFODNN7EXAMPLE", "secret": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"}
namestringrequired- Display name for the connector. Example: Processed output bucket
typestringrequired- Connector type, such as astradb, couchbase, databricks_volumes, databricks_volume_delta_tables, delta_table, elasticsearch, kafka-cloud, milvus, mongodb, motherduck, neo4j, onedrive, pinecone, postgres, redis, qdrant-cloud, snowflake, teradata, weaviate-cloud, ibm_watsonx_s3, s3, azure, gcs. The type decides which config fields are needed. Example: s3one of
astradbcouchbasedatabricks_volumesdatabricks_volume_delta_tablesdelta_tableelasticsearchkafka-cloudmilvusmongodbmotherduckneo4jonedrivepineconepostgresredisqdrant-cloudsnowflaketeradataweaviate-cloudibm_watsonx_s3s3azuregcs keystring- Stable identifier for the destination, unique in the workspace: 1-63 lowercase letters, digits and hyphens. Derived from name if empty. Example: s3-invoices
unstructured_destination_updateReplace a destination connector's connection settings, and optionally rename it.WriteUpdate Destination Connector
Replace a destination connector's connection settings, and optionally rename it. Returns the updated connector. Use this to rotate credentials or change the path. Use unstructured_destination_connection_check_create to test it afterwards.
- Idempotent
Inputs
configobjectrequired- Full connection settings for the connector's type; they replace the current config. Example: {"remote_url": "s3://acme-docs/processed/", "key": "AKIAIOSFODNN7EXAMPLE", "secret": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"}
destination_idstringrequired- Destination connector ID (UUID) or key. Get it from unstructured_destinations_list. Example: 7c9e1a3b-5d7f-4b2c-8e4a-6f8b0d2c4e6a
keystring- New key, unique in the workspace. Requests using the old key then return 404. Example: s3-invoices-eu
namestring- New display name. Leave empty to keep it. Example: Invoices bucket (EU)
unstructured_job_cancelRequest that a scheduled or running job stop.WriteCancel Job
Request that a scheduled or running job stop. Returns the job with stop_requested set. Use this to stop a run. Poll unstructured_job_get until the status is final.
- Idempotent
Inputs
job_idstringrequired- Job ID (UUID) from unstructured_workflow_run or unstructured_jobs_list. Example: 3e5a7c9b-1d2f-4a6c-8e0b-2d4f6a8c0e1d
unstructured_source_connection_check_createStart a check that the source connector can reach its service with its credentials.WriteCheck Source Connection
Start a check that the source connector can reach its service with its credentials. Returns the check with id, status (SCHEDULED, SUCCESS or FAILURE) and created_at. Use this after creating or updating a connector, then read the outcome with unstructured_source_connection_check_get.
Inputs
source_idstringrequired- Source connector ID (UUID) or key. Get it from unstructured_sources_list. Example: 2b4f6d8e-1a3c-4e5f-9a7b-0c2d4e6f8a1b
unstructured_source_createCreate a source connector that lets workflows read documents from a storage service, drive or app, using the type's connection settings.WriteCreate Source Connector
Create a source connector that lets workflows read documents from a storage service, drive or app, using the type's connection settings. Returns the connector with id, key, name, type and config. Use this before unstructured_workflow_create. Run unstructured_source_connection_check_create afterwards to test the credentials.
Inputs
configobjectrequired- Connection settings for the chosen type. For s3: remote_url (s3://bucket/path/) plus key and secret, or anonymous true for a public bucket; gcs and azure use a remote_url too; other types take their own fields (for example a site URL and client credentials for sharepoint). See https://docs.unstructured.io/api-reference/workflow/sources/overview for each type's fields. Example: {"remote_url": "s3://acme-docs/invoices/", "key": "AKIAIOSFODNN7EXAMPLE", "secret": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", "recursive": true}
namestringrequired- Display name for the connector. Example: Invoices bucket
typestringrequired- Connector type, such as confluence, couchbase, databricks_volumes, dropbox, elasticsearch, google_drive, kafka-cloud, mongodb, onedrive, outlook, postgres, salesforce, sharepoint, slack, snowflake, teradata, jira, zendesk, s3, azure, gcs. The type decides which config fields are needed. Example: s3one of
confluencecouchbasedatabricks_volumesdropboxelasticsearchgoogle_drivekafka-cloudmongodbonedriveoutlookpostgressalesforcesharepointslacksnowflaketeradatajirazendesks3azuregcs keystring- Stable identifier for the source, unique in the workspace: 1-63 lowercase letters, digits and hyphens. Derived from name if empty. Example: s3-invoices
unstructured_source_updateReplace a source connector's connection settings, and optionally rename it.WriteUpdate Source Connector
Replace a source connector's connection settings, and optionally rename it. Returns the updated connector. Use this to rotate credentials or change the path. Use unstructured_source_connection_check_create to test it afterwards.
- Idempotent
Inputs
configobjectrequired- Full connection settings for the connector's type; they replace the current config. Example: {"remote_url": "s3://acme-docs/invoices/", "key": "AKIAIOSFODNN7EXAMPLE", "secret": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", "recursive": true}
source_idstringrequired- Source connector ID (UUID) or key. Get it from unstructured_sources_list. Example: 2b4f6d8e-1a3c-4e5f-9a7b-0c2d4e6f8a1b
keystring- New key, unique in the workspace. Requests using the old key then return 404. Example: s3-invoices-eu
namestring- New display name. Leave empty to keep it. Example: Invoices bucket (EU)
unstructured_workflow_createCreate a workflow that reads documents from a source connector, partitions and optionally enriches, chunks and embeds them, and writes the output to a destination connector.WriteCreate Workflow
Create a workflow that reads documents from a source connector, partitions and optionally enriches, chunks and embeds them, and writes the output to a destination connector. Returns the workflow with id, key, name, workflow_type, nodes and schedule. Use this after creating connectors. Start it with unstructured_workflow_run or give it a schedule.
Inputs
namestringrequired- Workflow name. Example: Invoice pipeline
workflow_typestringrequired- basic, advanced or platinum use Unstructured's preset processing; custom uses workflow_nodes or template_id. Example: customone of
basicadvancedplatinumcustom destination_idstring- Destination connector to write to. Example: 7c9e1a3b-5d7f-4b2c-8e4a-6f8b0d2c4e6a
keystring- Stable identifier for the workflow, unique in the workspace: 1-63 lowercase letters, digits and hyphens. Derived from name if empty. Example: invoice-pipeline
reprocess_allboolean- If true, the next runs reprocess every document, not only new or changed ones. Example: false
schedulestring- How often to run automatically, for example every hour, daily or weekly. Leave empty to run only on demand. Example: dailyone of
every 15 minutesevery hourevery 2 hoursevery 4 hoursevery 6 hoursevery 8 hoursevery 10 hoursevery 12 hoursdailyweeklymonthly source_idstring- Source connector to read from. Example: 2b4f6d8e-1a3c-4e5f-9a7b-0c2d4e6f8a1b
template_idstring- Template to build a custom workflow from instead of workflow_nodes. Get IDs from unstructured_templates_list. Example: hi-res-and-enrich
workflow_nodesarray- For custom workflows: processing nodes in order (partition, then optional enrichment, chunk, embed or extract), each with name, type, subtype and settings. Copy node shapes from unstructured_template_get or an existing workflow. Example: [{"name": "Partitioner", "type": "partition", "subtype": "unstructured_api", "settings": {"strategy": "fast"}}]
unstructured_workflow_runStart a job that runs a workflow now, reading all new or changed documents from its source connector, spending processing credits.WriteRun Workflow
Start a job that runs a workflow now, reading all new or changed documents from its source connector, spending processing credits. Returns the job with id, workflow_id, status and created_at. A new job starts only if none is already active for the workflow. Use this for on-demand runs of workflows that have a source connector. Follow the job with unstructured_job_get.
Inputs
workflow_idstringrequired- Workflow ID (UUID) or key. Get it from unstructured_workflows_list. Example: f0a1b2c3-4d5e-4f7a-8b9c-0d1e2f3a4b5c
unstructured_workflow_updateChange a workflow's name, connectors, type, nodes or schedule, or pause and resume it.WriteUpdate Workflow
Change a workflow's name, connectors, type, nodes or schedule, or pause and resume it. Returns the updated workflow. Use this to adjust processing. Changing settings does not reprocess existing documents unless reprocess_all is true.
- Idempotent
Inputs
workflow_idstringrequired- Workflow ID (UUID) or key. Get it from unstructured_workflows_list. Example: f0a1b2c3-4d5e-4f7a-8b9c-0d1e2f3a4b5c
destination_idstring- New destination connector. Example: 7c9e1a3b-5d7f-4b2c-8e4a-6f8b0d2c4e6a
namestring- New name. Example: Invoice pipeline v2
reprocess_allboolean- If true, the next runs reprocess every document. Example: true
schedulestring- New run schedule. Example: weeklyone of
every 15 minutesevery hourevery 2 hoursevery 4 hoursevery 6 hoursevery 8 hoursevery 10 hoursevery 12 hoursdailyweeklymonthly source_idstring- New source connector. Example: 2b4f6d8e-1a3c-4e5f-9a7b-0c2d4e6f8a1b
statestring- active to enable scheduled runs, inactive to pause them. Example: inactiveone of
activeinactive workflow_nodesarray- Replacement processing nodes for a custom workflow. Example: [{"name": "Partitioner", "type": "partition", "subtype": "unstructured_api", "settings": {"strategy": "fast"}}]
workflow_typestring- New workflow type: basic, advanced, platinum or custom. Example: customone of
basicadvancedplatinumcustom
unstructured_destination_deleteDelete a destination connector.DestructiveDelete Destination Connector
Delete a destination connector. Returns a confirmation. Remove it from workflows first; workflows that still use it cannot run.
- Idempotent
Inputs
destination_idstringrequired- Destination connector ID (UUID) or key. Get it from unstructured_destinations_list. Example: 7c9e1a3b-5d7f-4b2c-8e4a-6f8b0d2c4e6a
unstructured_source_deleteDelete a source connector.DestructiveDelete Source Connector
Delete a source connector. Returns a confirmation. Remove it from workflows first; workflows that still use it cannot run.
- Idempotent
Inputs
source_idstringrequired- Source connector ID (UUID) or key. Get it from unstructured_sources_list. Example: 2b4f6d8e-1a3c-4e5f-9a7b-0c2d4e6f8a1b
unstructured_workflow_deleteDelete a workflow.DestructiveDelete Workflow
Delete a workflow. Its connectors stay. Returns a confirmation. Use unstructured_workflow_update with state inactive to pause it instead.
- Idempotent
Inputs
workflow_idstringrequired- Workflow ID (UUID) or key. Get it from unstructured_workflows_list. Example: f0a1b2c3-4d5e-4f7a-8b9c-0d1e2f3a4b5c
No tools match.