> ## Documentation Index
> Fetch the complete documentation index at: https://docs.argalabs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Unstructured

> Unstructured Scenario seeding parameters, nested fields, and examples

Use `unstructured` in `twins` and put this configuration under `seed_config.unstructured`.

Unstructured.io document-processing platform with sources, destinations, workflows, and ingestion jobs.

## Example seed

This is the complete Scenario request body for [creating a Scenario](https://docs.argalabs.com/api-reference/post-create-a-scenario.md). You can also import it with `arga test-runner scenarios import --file scenario.json`.

```json theme={null}
{
  "name": "Unstructured eval fixture",
  "twins": [
    "unstructured"
  ],
  "seed_config": {
    "unstructured": {
      "sources": [
        {
          "name": "S3 Docs",
          "type": "s3",
          "config": {
            "bucket": "docs"
          }
        }
      ],
      "destinations": [
        {
          "name": "Pinecone",
          "type": "pinecone",
          "config": {}
        }
      ],
      "workflows": [
        {
          "name": "Ingest",
          "source_name": "S3 Docs",
          "destination_name": "Pinecone"
        }
      ],
      "jobs": [
        {
          "workflow_name": "Ingest",
          "files": [
            {
              "name": "a.txt",
              "content": "hello"
            }
          ]
        }
      ]
    }
  }
}
```

## Parameters

The following fields belong directly inside `seed_config.unstructured`. Required nested fields are marked in their tables. Provider-native objects can contain service-specific fields beyond the representative record shapes below.

| Parameter | Type | Description |
| - | - | - |
| `sources` | `object[]` | Sources fixtures in provider-native format. |
| `destinations` | `object[]` | Destinations fixtures in provider-native format. |
| `workflows` | `object[]` | Workflows fixtures in provider-native format. |
| `jobs` | `object[]` | Jobs fixtures in provider-native format. |

## Resource fields

These tables describe the record shapes used by the example. Keep native field names and casing. Map keys such as property names, IDs, and metadata keys are supplied by your fixture.

### `sources[]`

| Parameter | Type | Description |
| - | - | - |
| `name` | `string` | Human-readable name. |
| `type` | `string` | Type. |
| `config` | `object` | Runtime settings accepted by this Scenario adapter. |

### `destinations[]`

| Parameter | Type | Description |
| - | - | - |
| `name` | `string` | Human-readable name. |
| `type` | `string` | Type. |
| `config` | `object` | Runtime settings accepted by this Scenario adapter. |

### `workflows[]`

| Parameter | Type | Description |
| - | - | - |
| `name` | `string` | Human-readable name. |
| `source_name` | `string` | Source name. |
| `destination_name` | `string` | Destination name. |
| `source_id` | `string` | Source id. |
| `destination_id` | `string` | Destination id. |
| `template_id` | `string` | Template id. |

### `jobs[]`

| Parameter | Type | Description |
| - | - | - |
| `workflow_name` | `string` | Workflow name. |
| `files` | `object[]` | Files fixtures in provider-native format. |
| `workflow_id` | `string` | Workflow id. |

### `jobs[].files[]`

| Parameter | Type | Description |
| - | - | - |
| `name` | `string` | Human-readable name. |
| `content` | `string` | Text content. |

## API coverage and limitations

**Twin name:** `unstructured`

**Supports**

* Legacy partition endpoint at `POST /general/v0/general`.
* Workflow API routes for sources, destinations, connection checks, workflows, jobs, job cancellation, job details, failed files, job downloads, templates, and deterministic async job lifecycles.
* API-key authentication, scope families, document validation, event producers, webhook subscriptions, signed delivery attempts, retries, replay, failure injection, and admin inspection.

**Known limitations**

* Unsupported file extensions, encrypted files, invalid PDFs, retired VLM models, unsupported VLM provider/model pairs, and invalid auth scopes return structured errors.
* On-demand jobs enforce modeled constraints such as file count, file size, launch spacing, and concurrent active job limits.
* Some output-format behavior is approximated; unsupported output formats fall back to JSON unless callers request CSV explicitly.

**MCP tools:** `get_twin_catalog`, `provision_twins`, `start_url_validation`, `get_validation_results`.

See [Scenario seeding](https://docs.argalabs.com/twins/seeding.md) for saving, provisioning, and resetting fixtures.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.