Create destination connector

Create a new destination connector using the provided configuration.

POST /api/v1/destinations/

cURL

curl --request POST \
  --url "${UNSTRUCTURED_API_URL}/api/v1/destinations/" \
  --header "unstructured-api-key: ${UNSTRUCTURED_API_KEY}" \
  --header "Content-Type: application/json" \
  --data '{
    "name": "My S3 Destination",
    "type": "s3",
    "config": {
      "remote_url": "s3://my-bucket/output/",
      "aws_access_key_id": "AKIAIOSFODNN7EXAMPLE",
      "aws_secret_access_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
    }
  }'

import os
from unstructured_client import UnstructuredClient
from unstructured_client.models.operations import CreateDestinationRequest
from unstructured_client.models.shared import CreateDestinationConnector

client = UnstructuredClient(
    api_key_auth=os.getenv("UNSTRUCTURED_API_KEY"),
    server_url=os.getenv("UNSTRUCTURED_API_URL"),
)

response = client.destinations.create_destination(
    request=CreateDestinationRequest(
        create_destination_connector=CreateDestinationConnector(
            name="My S3 Destination",
            type="s3",
            config={
                "remote_url": "s3://my-bucket/output/",
                "aws_access_key_id": "AKIAIOSFODNN7EXAMPLE",
                "aws_secret_access_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
            },
        )
    )
)
print(response)

import asyncio
import os
from unstructured_client import UnstructuredClient
from unstructured_client.models.operations import CreateDestinationRequest
from unstructured_client.models.shared import CreateDestinationConnector

async def create_destination():
    client = UnstructuredClient(
        api_key_auth=os.getenv("UNSTRUCTURED_API_KEY"),
        server_url=os.getenv("UNSTRUCTURED_API_URL"),
    )
    response = await client.destinations.create_destination_async(
        request=CreateDestinationRequest(
            create_destination_connector=CreateDestinationConnector(
                name="My S3 Destination",
                type="s3",
                config={
                    "remote_url": "s3://my-bucket/output/",
                    "aws_access_key_id": "AKIAIOSFODNN7EXAMPLE",
                    "aws_secret_access_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
                },
            )
        )
    )
    print(response)

asyncio.run(create_destination())

Response

{
  "id": "d1a2b3c4-5d6e-7f8a-9b0c-1d2e3f4a5b6c",
  "name": "My S3 Destination",
  "type": "s3",
  "config": {
    "remote_url": "s3://my-bucket/output/",
    "aws_access_key_id": "AKIAIOSFODNN7EXAMPLE",
    "aws_secret_access_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
  },
  "created_at": "2026-01-01T00:00:00Z",
  "updated_at": null
}

Body

name · string · required

Destination connector name.

type · string · required

Connector type. One of: azure, astradb, azure_ai_search, couchbase, databricks_volumes, databricks_volume_delta_tables, delta_table, elasticsearch, gcs, kafka-cloud, milvus, mongodb, motherduck, neo4j, onedrive, opensearch, pinecone, postgres, redis, qdrant-cloud, s3, snowflake, teradata, weaviate-cloud, ibm_watsonx_s3.

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 Destinations.

Response

id · string · required

Unique identifier for the destination connector.

name · string · required

Destination 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 Destinations.

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

curl --request POST \
  --url "${UNSTRUCTURED_API_URL}/api/v1/destinations/" \
  --header "unstructured-api-key: ${UNSTRUCTURED_API_KEY}" \
  --header "Content-Type: application/json" \
  --data '{
    "name": "My S3 Destination",
    "type": "s3",
    "config": {
      "remote_url": "s3://my-bucket/output/",
      "aws_access_key_id": "AKIAIOSFODNN7EXAMPLE",
      "aws_secret_access_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
    }
  }'

import os
from unstructured_client import UnstructuredClient
from unstructured_client.models.operations import CreateDestinationRequest
from unstructured_client.models.shared import CreateDestinationConnector

client = UnstructuredClient(
    api_key_auth=os.getenv("UNSTRUCTURED_API_KEY"),
    server_url=os.getenv("UNSTRUCTURED_API_URL"),
)

response = client.destinations.create_destination(
    request=CreateDestinationRequest(
        create_destination_connector=CreateDestinationConnector(
            name="My S3 Destination",
            type="s3",
            config={
                "remote_url": "s3://my-bucket/output/",
                "aws_access_key_id": "AKIAIOSFODNN7EXAMPLE",
                "aws_secret_access_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
            },
        )
    )
)
print(response)

import asyncio
import os
from unstructured_client import UnstructuredClient
from unstructured_client.models.operations import CreateDestinationRequest
from unstructured_client.models.shared import CreateDestinationConnector

async def create_destination():
    client = UnstructuredClient(
        api_key_auth=os.getenv("UNSTRUCTURED_API_KEY"),
        server_url=os.getenv("UNSTRUCTURED_API_URL"),
    )
    response = await client.destinations.create_destination_async(
        request=CreateDestinationRequest(
            create_destination_connector=CreateDestinationConnector(
                name="My S3 Destination",
                type="s3",
                config={
                    "remote_url": "s3://my-bucket/output/",
                    "aws_access_key_id": "AKIAIOSFODNN7EXAMPLE",
                    "aws_secret_access_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
                },
            )
        )
    )
    print(response)

asyncio.run(create_destination())

Response

{
  "id": "d1a2b3c4-5d6e-7f8a-9b0c-1d2e3f4a5b6c",
  "name": "My S3 Destination",
  "type": "s3",
  "config": {
    "remote_url": "s3://my-bucket/output/",
    "aws_access_key_id": "AKIAIOSFODNN7EXAMPLE",
    "aws_secret_access_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
  },
  "created_at": "2026-01-01T00:00:00Z",
  "updated_at": null
}