Skip to main content
POST
/
api
/
v1
/
sources
curl --request POST \
  --url "${UNSTRUCTURED_API_URL}/api/v1/sources/" \
  --header "unstructured-api-key: ${UNSTRUCTURED_API_KEY}" \
  --header "Content-Type: application/json" \
  --data '{
    "name": "My S3 Source",
    "type": "s3",
    "config": {
      "remote_url": "s3://my-bucket/input/",
      "access_key_id": "AKIAIOSFODNN7EXAMPLE",
      "secret_access_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
      "recursive": true
    }
  }'

{
  "id": "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
  "name": "My S3 Source",
  "type": "s3",
  "config": {
    "remote_url": "s3://my-bucket/input/",
    "access_key_id": "AKIAIOSFODNN7EXAMPLE",
    "secret_access_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
    "recursive": true
  },
  "created_at": "2026-01-01T00:00:00Z",
  "updated_at": null
}

Documentation Index

Fetch the complete documentation index at: https://docs.unstructured.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Body

​
name
string
required
Source connector name.
​
type
string
required
Connector type. One of: azure, box, confluence, couchbase, databricks_volumes, dropbox, elasticsearch, gcs, google_drive, kafka-cloud, mongodb, onedrive, opensearch, outlook, postgres, s3, salesforce, sharepoint, snowflake, teradata, jira, zendesk.
​
config
object
required
Connector configuration. Required fields vary by connector type.For the specific settings to include for a connector, see the entry for that connector in Sources.

​
Response

​
id
string
required
Unique identifier for the source connector.
​
name
string
required
Source connector name.
​
type
string
required
Connector type.
​
config
object
required
Connector configuration. Fields vary by connector type.For the specific settings to include for a specific connector, see the entry for that connector in Sources.
​
created_at
string
required
ISO 8601 timestamp when the connector was created.
​
updated_at
string
ISO 8601 timestamp when the connector was last updated.
curl --request POST \
  --url "${UNSTRUCTURED_API_URL}/api/v1/sources/" \
  --header "unstructured-api-key: ${UNSTRUCTURED_API_KEY}" \
  --header "Content-Type: application/json" \
  --data '{
    "name": "My S3 Source",
    "type": "s3",
    "config": {
      "remote_url": "s3://my-bucket/input/",
      "access_key_id": "AKIAIOSFODNN7EXAMPLE",
      "secret_access_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
      "recursive": true
    }
  }'

{
  "id": "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
  "name": "My S3 Source",
  "type": "s3",
  "config": {
    "remote_url": "s3://my-bucket/input/",
    "access_key_id": "AKIAIOSFODNN7EXAMPLE",
    "secret_access_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
    "recursive": true
  },
  "created_at": "2026-01-01T00:00:00Z",
  "updated_at": null
}