The destinations API from Unstructured — 3 operation(s) for destinations.
openapi: 3.1.0
info:
title: Unstructured Partition channels destinations API
version: 1.5.58
servers:
- url: https://api.unstructuredapp.io
description: Serverless SaaS API
x-speakeasy-server-id: saas-api
- url: http://localhost:8000
description: Development server
x-speakeasy-server-id: development
security:
- ApiKeyAuth: []
- {}
tags:
- name: destinations
paths:
/api/v1/destinations/:
get:
tags:
- destinations
summary: List destination connectors
description: Retrieve a list of available destination connectors.
operationId: list_destinations
parameters:
- name: destination_type
in: query
required: false
schema:
anyOf:
- $ref: '#/components/schemas/DestinationConnectorType'
- type: 'null'
title: Destination Type
- name: unstructured-api-key
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Unstructured-Api-Key
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/DestinationConnectorInformation'
title: Response List Destinations
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
post:
tags:
- destinations
summary: Create destination connector
description: Create a new destination connector using the provided configuration and name.
operationId: create_destination
parameters:
- name: unstructured-api-key
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Unstructured-Api-Key
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateDestinationConnector'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DestinationConnectorInformation'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/destinations/{destination_id}:
get:
tags:
- destinations
summary: Get destination connector
description: Retrieve detailed information for a specific destination connector by its ID.
operationId: get_destination
parameters:
- name: destination_id
in: path
required: true
schema:
anyOf:
- type: string
format: uuid
- type: string
title: Destination Id
- name: unstructured-api-key
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Unstructured-Api-Key
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DestinationConnectorInformation'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
put:
tags:
- destinations
summary: Update destination connector
description: Update the configuration of an existing destination connector.
operationId: update_destination
parameters:
- name: destination_id
in: path
required: true
schema:
anyOf:
- type: string
format: uuid
- type: string
title: Destination Id
- name: unstructured-api-key
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Unstructured-Api-Key
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateDestinationConnector'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DestinationConnectorInformation'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- destinations
summary: Delete destination connector
description: Delete a specific destination connector by its ID.
operationId: delete_destination
parameters:
- name: destination_id
in: path
required: true
schema:
anyOf:
- type: string
format: uuid
- type: string
title: Destination Id
- name: unstructured-api-key
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Unstructured-Api-Key
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/destinations/{destination_id}/connection-check:
post:
tags:
- destinations
summary: Create destination connection check
description: Initiate a connection check for the destination connector
operationId: create_connection_check_destinations
parameters:
- name: destination_id
in: path
required: true
schema:
anyOf:
- type: string
format: uuid
- type: string
title: Destination Id
- name: unstructured-api-key
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Unstructured-Api-Key
responses:
'202':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DagNodeConnectionCheck'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
x-speakeasy-name-override: create_connection_check_destinations
get:
tags:
- destinations
summary: Get the latest destination connector connection check
description: Retrieves the most recent connection check for the specified destination connector.
operationId: get_connection_check_destinations
parameters:
- name: destination_id
in: path
required: true
schema:
anyOf:
- type: string
format: uuid
- type: string
title: Destination Id
- name: unstructured-api-key
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Unstructured-Api-Key
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DagNodeConnectionCheck'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
x-speakeasy-name-override: get_connection_check_destinations
components:
schemas:
ConnectionCheckStatus:
type: string
enum:
- SCHEDULED
- SUCCESS
- FAILURE
title: ConnectionCheckStatus
RedisDestinationConnectorConfigInput:
properties:
host:
type: string
title: Host
port:
type: integer
minimum: 1.0
title: Port
default: 6379
username:
anyOf:
- type: string
- type: 'null'
title: Username
password:
anyOf:
- type: string
- type: 'null'
title: Password
uri:
anyOf:
- type: string
- type: 'null'
title: Uri
database:
type: integer
minimum: 0.0
title: Database
default: 0
ssl:
type: boolean
title: Ssl
default: true
batch_size:
type: integer
minimum: 1.0
title: Batch Size
default: 100
additionalProperties: true
type: object
required:
- host
title: RedisDestinationConnectorConfigInput
CouchbaseDestinationConnectorConfig:
properties:
bucket:
type: string
title: Bucket
connection_string:
type: string
title: Connection String
scope:
anyOf:
- type: string
- type: 'null'
title: Scope
collection:
anyOf:
- type: string
- type: 'null'
title: Collection
batch_size:
type: integer
title: Batch Size
username:
type: string
title: Username
password:
type: string
title: Password
additionalProperties: true
type: object
required:
- bucket
- connection_string
- batch_size
- username
- password
title: CouchbaseDestinationConnectorConfig
QdrantCloudDestinationConnectorConfig:
properties:
url:
type: string
title: Url
api_key:
type: string
title: Api Key
collection_name:
type: string
title: Collection Name
batch_size:
type: integer
title: Batch Size
additionalProperties: true
type: object
required:
- url
- api_key
- collection_name
- batch_size
title: QdrantCloudDestinationConnectorConfig
DeltaTableConnectorConfig:
properties:
aws_access_key_id:
type: string
title: Aws Access Key Id
aws_secret_access_key:
type: string
title: Aws Secret Access Key
aws_region:
type: string
title: Aws Region
table_uri:
type: string
title: Table Uri
additionalProperties: true
type: object
required:
- aws_access_key_id
- aws_secret_access_key
- aws_region
- table_uri
title: DeltaTableConnectorConfig
UpdateDestinationConnector:
properties:
config:
anyOf:
- $ref: '#/components/schemas/AstraDBConnectorConfigInput'
- $ref: '#/components/schemas/CouchbaseDestinationConnectorConfigInput'
- $ref: '#/components/schemas/DatabricksVolumesConnectorConfigInput'
- $ref: '#/components/schemas/DatabricksVDTDestinationConnectorConfigInput'
- $ref: '#/components/schemas/DeltaTableConnectorConfigInput'
- $ref: '#/components/schemas/ElasticsearchConnectorConfigInput'
- $ref: '#/components/schemas/GCSDestinationConnectorConfigInput'
- $ref: '#/components/schemas/KafkaCloudDestinationConnectorConfigInput'
- $ref: '#/components/schemas/MilvusDestinationConnectorConfigInput'
- $ref: '#/components/schemas/MongoDBConnectorConfigInput'
- $ref: '#/components/schemas/Neo4jDestinationConnectorConfigInput'
- $ref: '#/components/schemas/OneDriveDestinationConnectorConfigInput'
- $ref: '#/components/schemas/PineconeDestinationConnectorConfigInput'
- $ref: '#/components/schemas/PostgresDestinationConnectorConfigInput'
- $ref: '#/components/schemas/RedisDestinationConnectorConfigInput'
- $ref: '#/components/schemas/QdrantCloudDestinationConnectorConfigInput'
- $ref: '#/components/schemas/SnowflakeDestinationConnectorConfigInput'
- $ref: '#/components/schemas/TeradataDestinationConnectorConfigInput'
- $ref: '#/components/schemas/WeaviateDestinationConnectorConfigInput'
- $ref: '#/components/schemas/IBMWatsonxS3DestinationConnectorConfigInput'
- $ref: '#/components/schemas/S3DestinationConnectorConfigInput'
- $ref: '#/components/schemas/AzureDestinationConnectorConfigInput'
- additionalProperties: true
type: object
title: Config
type: object
required:
- config
title: UpdateDestinationConnector
DeltaTableConnectorConfigInput:
properties:
aws_access_key_id:
type: string
title: Aws Access Key Id
aws_secret_access_key:
type: string
title: Aws Secret Access Key
aws_region:
type: string
title: Aws Region
table_uri:
type: string
pattern: ^s3:\/\/
title: Table Uri
additionalProperties: true
type: object
required:
- aws_access_key_id
- aws_secret_access_key
- aws_region
- table_uri
title: DeltaTableConnectorConfigInput
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError
PostgresDestinationConnectorConfigInput:
properties:
host:
type: string
title: Host
database:
type: string
title: Database
port:
type: integer
title: Port
username:
type: string
title: Username
password:
type: string
title: Password
table_name:
type: string
title: Table Name
batch_size:
type: integer
title: Batch Size
additionalProperties: true
type: object
required:
- host
- database
- port
- username
- password
- table_name
- batch_size
title: PostgresDestinationConnectorConfigInput
PineconeDestinationConnectorConfigInput:
properties:
index_name:
type: string
title: Index Name
api_key:
type: string
title: Api Key
namespace:
type: string
title: Namespace
batch_size:
type: integer
minimum: 1.0
title: Batch Size
default: 50
additionalProperties: true
type: object
required:
- index_name
- api_key
- namespace
title: PineconeDestinationConnectorConfigInput
ElasticsearchConnectorConfigInput:
properties:
hosts:
items:
type: string
type: array
title: Hosts
index_name:
type: string
title: Index Name
es_api_key:
type: string
title: Es Api Key
additionalProperties: true
type: object
required:
- hosts
- index_name
- es_api_key
title: ElasticsearchConnectorConfigInput
TeradataDestinationConnectorConfig:
properties:
host:
type: string
title: Host
user:
type: string
title: User
password:
type: string
title: Password
database:
anyOf:
- type: string
- type: 'null'
title: Database
dbs_port:
type: integer
minimum: 1.0
title: Dbs Port
default: 1025
table_name:
type: string
title: Table Name
default: elements
batch_size:
type: integer
minimum: 1.0
title: Batch Size
default: 50
record_id_key:
anyOf:
- type: string
- type: 'null'
title: Record Id Key
default: record_id
additionalProperties: true
type: object
required:
- host
- user
- password
title: TeradataDestinationConnectorConfig
IBMWatsonxS3DestinationConnectorConfigInput:
properties:
iam_api_key:
type: string
title: Iam Api Key
access_key_id:
type: string
title: Access Key Id
secret_access_key:
type: string
title: Secret Access Key
iceberg_endpoint:
type: string
title: Iceberg Endpoint
object_storage_endpoint:
type: string
title: Object Storage Endpoint
object_storage_region:
type: string
title: Object Storage Region
catalog:
type: string
title: Catalog
max_retries_connection:
type: integer
maximum: 100.0
minimum: 2.0
title: Max Retries Connection
description: Maximum number of retries in case of a connection error
default: 10
namespace:
type: string
title: Namespace
table:
type: string
title: Table
max_retries:
type: integer
maximum: 500.0
minimum: 2.0
title: Max Retries
description: Maximum number of retries to upload data
default: 50
record_id_key:
type: string
title: Record Id Key
description: Searchable key to find entries for the same record on previous runs
default: record_id
additionalProperties: true
type: object
required:
- iam_api_key
- access_key_id
- secret_access_key
- iceberg_endpoint
- object_storage_endpoint
- object_storage_region
- catalog
- namespace
- table
title: IBMWatsonxS3DestinationConnectorConfigInput
TeradataDestinationConnectorConfigInput:
properties:
host:
type: string
title: Host
user:
type: string
title: User
password:
type: string
title: Password
database:
anyOf:
- type: string
- type: 'null'
title: Database
dbs_port:
type: integer
minimum: 1.0
title: Dbs Port
default: 1025
table_name:
type: string
title: Table Name
default: elements
batch_size:
type: integer
minimum: 1.0
title: Batch Size
default: 50
record_id_key:
anyOf:
- type: string
- type: 'null'
title: Record Id Key
default: record_id
additionalProperties: true
type: object
required:
- host
- user
- password
title: TeradataDestinationConnectorConfigInput
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
SnowflakeDestinationConnectorConfig:
properties:
account:
type: string
title: Account
role:
type: string
title: Role
user:
type: string
title: User
password:
type: string
title: Password
host:
type: string
title: Host
port:
type: integer
minimum: 1.0
title: Port
default: 443
database:
type: string
title: Database
schema:
type: string
title: Schema
table_name:
type: string
title: Table Name
default: elements
batch_size:
type: integer
minimum: 1.0
title: Batch Size
default: 50
record_id_key:
anyOf:
- type: string
- type: 'null'
title: Record Id Key
default: record_id
additionalProperties: true
type: object
required:
- account
- role
- user
- password
- host
- database
- schema
title: SnowflakeDestinationConnectorConfig
MilvusDestinationConnectorConfig:
properties:
uri:
type: string
title: Uri
user:
anyOf:
- type: string
- type: 'null'
title: User
token:
anyOf:
- type: string
- type: 'null'
title: Token
password:
anyOf:
- type: string
- type: 'null'
title: Password
db_name:
anyOf:
- type: string
- type: 'null'
title: Db Name
collection_name:
type: string
title: Collection Name
record_id_key:
type: string
title: Record Id Key
additionalProperties: true
type: object
required:
- uri
- collection_name
- record_id_key
title: MilvusDestinationConnectorConfig
S3DestinationConnectorConfig:
properties:
remote_url:
type: string
title: Remote Url
anonymous:
type: boolean
title: Anonymous
ambient_credentials:
anyOf:
- type: boolean
- type: 'null'
title: Ambient Credentials
key:
anyOf:
- type: string
- type: 'null'
title: Key
secret:
anyOf:
- type: string
- type: 'null'
title: Secret
token:
anyOf:
- type: string
- type: 'null'
title: Token
endpoint_url:
anyOf:
- type: string
- type: 'null'
title: Endpoint Url
role_arn:
anyOf:
- type: string
- type: 'null'
title: Role Arn
external_id:
anyOf:
- type: string
- type: 'null'
title: External Id
additionalProperties: true
type: object
required:
- remote_url
- anonymous
title: S3DestinationConnectorConfig
AzureDestinationConnectorConfig:
properties:
remote_url:
type: string
title: Remote Url
account_name:
anyOf:
- type: string
- type: 'null'
title: Account Name
account_key:
anyOf:
- type: string
- type: 'null'
title: Account Key
connection_string:
anyOf:
- type: string
- type: 'null'
title: Connection String
sas_token:
anyOf:
- type: string
- type: 'null'
title: Sas Token
additionalProperties: true
type: object
required:
- remote_url
title: AzureDestinationConnectorConfig
AzureDestinationConnectorConfigInput:
properties:
remote_url:
type: string
pattern: ^(az:\/\/|abfs:\/\/)
title: Remote Url
account_name:
anyOf:
- type: string
- type: 'null'
title: Account Name
account_key:
anyOf:
- type: string
- type: 'null'
title: Account Key
connection_string:
anyOf:
- type: string
- type: 'null'
title: Connection String
sas_token:
anyOf:
- type: string
- type: 'null'
title: Sas Token
additionalProperties: true
type: object
required:
- remote_url
title: AzureDestinationConnectorConfigInput
Neo4jDestinationConnectorConfigInput:
properties:
uri:
type: string
title: Uri
database:
type: string
title: Database
username:
type: string
title: Username
password:
type: string
title: Password
batch_size:
type: integer
minimum: 1.0
title: Batch Size
default: 100
additionalProperties: true
type: object
required:
- uri
- database
- username
- password
title: Neo4jDestinationConnectorConfigInput
DestinationConnectorType:
type: string
enum:
- astradb
- couchbase
- databricks_volumes
- databricks_volume_delta_tables
- delta_table
- elasticsearch
- gcs
- kafka-cloud
- milvus
- mongodb
- motherduck
- neo4j
- onedrive
- pinecone
- postgres
- redis
- qdrant-cloud
- snowflake
- teradata
- weaviate-cloud
- ibm_watsonx_s3
- s3
- azure
title: DestinationConnectorType
KafkaCloudDestinationConnectorConfigInput:
properties:
bootstrap_servers:
type: string
title: Bootstrap Servers
port:
type: integer
minimum: 1.0
title: Port
default: 9092
group_id:
anyOf:
- type: string
- type: 'null'
title: Group Id
topic:
type: string
title: Topic
kafka_api_key:
type: string
title: Kafka Api Key
secret:
type: string
title: Secret
batch_size:
type: integer
minimum: 1.0
title: Batch Size
default: 100
additionalProperties: true
type: object
required:
- bootstrap_servers
- topic
- kafka_api_key
- secret
title: KafkaCloudDestinationConnectorConfigInput
GCSDestinationConnectorConfigInput:
properties:
remote_url:
type: string
pattern: ^(gs|gcs):\/\/
title: Remote Url
service_account_key:
type: string
title: Service Account Key
additionalProperties: true
type: object
required:
- remote_url
- service_account_key
title: GCSDestinationConnectorConfigInput
S3DestinationConnectorConfigInput:
properties:
remote_url:
type: string
pattern: ^s3:\/\/
title: Remote Url
anonymous:
type: boolean
title: Anonymous
default: false
ambient_credentials:
type: boolean
title: Ambient Credentials
default: false
key:
anyOf:
- type: string
- type: 'null'
title: Key
secret:
anyOf:
- type: string
- type: 'null'
title: Secret
token:
anyOf:
- type: string
- type: 'null'
title: Token
endpoint_url:
anyOf:
- type: string
- type: 'null'
title: Endpoint Url
role_arn:
anyOf:
- type: string
- type: 'null'
title: Role Arn
external_id:
anyOf:
- type: string
- type: 'null'
title: External Id
additionalProperties: true
type: object
required:
- remote_url
title: S3DestinationConnectorConfigInput
DatabricksVDTDestinationConnectorConfigInput:
properties:
server_hostname:
type: string
title: Server Hostname
http_path:
type: string
title: Http Path
token:
anyOf:
- type: string
- type: 'null'
title: Token
client_id:
anyOf:
- type: string
- type: 'null'
title: Client Id
client_secret:
anyOf:
- type: string
- type: 'null'
title: Client Secret
catalog:
type: string
title: Catalog
database:
type: string
title: Database
default: default
table_name:
anyOf:
- type: string
- type: 'null'
title: Table Name
schema:
type: string
title: Schema
default: default
volume:
type: string
title: Volume
volume_path:
anyOf:
- type: string
- type: 'null'
title: Volume Path
additionalProperties: true
type: object
required:
- server_hostname
- http_path
- catalog
- volume
title: DatabricksVDTDestinationConnectorConfigInput
DestinationConnectorInformation:
properties:
id:
type: string
format: uuid
title: Id
name:
type: string
title: Name
type:
anyOf:
- $ref: '#/components/schemas/DestinationConnectorType'
- type: string
title: Type
config:
anyOf:
- $ref: '#/components/schemas/AstraDBConnectorConfig'
- $ref: '#/components/schemas/CouchbaseDestinationConnectorConfig'
- $ref: '#/components/schemas/DatabricksVolumesConnectorConfig'
- $ref: '#/components/schemas/DatabricksVDTDestinationConnectorConfig'
- $ref: '#/components/schemas/DeltaTableConnectorConfig'
- $ref: '#/components/schemas/ElasticsearchConnectorConfig'
- $ref: '#/components/schemas/GCSDestinationConnectorConfig'
- $ref: '#/components/schemas/KafkaCloudDestinationConnectorConfig'
- $ref: '#/components/schemas/MilvusDestinationConnectorConfig'
- $ref: '#/components/schemas/MongoDBConnectorConfig'
- $ref: '#/components/schemas/Neo4jDestinationConnectorConfig'
- $ref: '#/components/schemas/OneDriveDestinationConnectorConfig'
- $ref: '#/components/schemas/PineconeDestinationConnectorConfig'
- $ref: '#/components/schemas/PostgresDestinationConnectorConfig'
- $ref: '#/components/schemas/RedisDestinationConnectorConfig'
- $ref: '#/components/schemas/QdrantCloudDestinationConnectorConfig'
- $ref: '#/components/schemas/SnowflakeDestinationConnectorConfig'
- $ref: '#/components/schemas/TeradataDestinationConnectorConfig'
- $ref: '#/components/schemas/WeaviateDestinationConnectorConfig'
- $ref: '#/components/schemas/IBMWatsonxS3DestinationConnectorConfig'
- $ref: '#/components/schemas/S3DestinationConnectorConfig'
- $ref: '#/components/schemas/AzureDestinationConnectorConfig'
- additionalProperties: true
type: object
title: Config
created_at:
type: string
format: date-time
title: Created At
updated_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Updated At
key:
anyOf:
- type: string
- type: 'null'
title: Key
type: object
required:
- id
- name
- type
- config
- created_at
title: DestinationConnectorInformation
SnowflakeDestinationConnectorConfigInput:
properties:
account:
type: string
title: Account
role:
type: string
title: Role
user:
type: string
title: User
password:
type: string
title: Password
host:
type: string
# --- truncated at 32 KB (53 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/unstructured/refs/heads/main/openapi/unstructured-destinations-api-openapi.yml