The sources API from Unstructured — 3 operation(s) for sources.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/unstructured-sources-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Platform Sources API
version: 3.1.0
servers:
- url: https://platform.unstructuredapp.io/
description: Unstructured Platform API
x-speakeasy-server-id: platform-api
tags:
- name: sources
paths:
/api/v1/sources/:
get:
tags:
- sources
summary: List available source connectors
description: Retrieve a list of available source connectors.
operationId: list_sources
parameters:
- name: source_type
in: query
required: false
schema:
anyOf:
- $ref: '#/components/schemas/SourceConnectorType'
- type: 'null'
title: Source 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/SourceConnectorInformation'
title: Response List Sources
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
post:
tags:
- sources
summary: Create source connector
description: Create a new source connector using the provided configuration and name.
operationId: create_source
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/CreateSourceConnector'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/SourceConnectorInformation'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/sources/{source_id}:
get:
tags:
- sources
summary: Get source connector
description: Retrieve detailed information for a specific source connector by its ID.
operationId: get_source
parameters:
- name: source_id
in: path
required: true
schema:
anyOf:
- type: string
format: uuid
- type: string
title: Source 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/SourceConnectorInformation'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- sources
summary: Delete source connector
description: Delete a specific source connector identified by its ID.
operationId: delete_source
parameters:
- name: source_id
in: path
required: true
schema:
anyOf:
- type: string
format: uuid
- type: string
title: Source 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'
put:
tags:
- sources
summary: Update source connector
description: Update the configuration of an existing source connector.
operationId: update_source
parameters:
- name: source_id
in: path
required: true
schema:
anyOf:
- type: string
format: uuid
- type: string
title: Source 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/UpdateSourceConnector'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/SourceConnectorInformation'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/sources/{source_id}/connection-check:
post:
tags:
- sources
summary: Create source connection check
description: Initiates a connection check for the specified source connector.
operationId: create_connection_check_sources
parameters:
- name: source_id
in: path
required: true
schema:
anyOf:
- type: string
format: uuid
- type: string
title: Source 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_sources
get:
tags:
- sources
summary: Get the latest source connector connection check
description: Retrieves the most recent connection check for the specified source connector.
operationId: get_connection_check_sources
parameters:
- name: source_id
in: path
required: true
schema:
anyOf:
- type: string
format: uuid
- type: string
title: Source 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_sources
components:
schemas:
JiraSourceConnectorConfig:
properties:
url:
type: string
title: Url
username:
anyOf:
- type: string
- type: 'null'
title: Username
cloud_id:
anyOf:
- type: string
- type: 'null'
title: Cloud Id
password:
anyOf:
- type: string
- type: 'null'
title: Password
token:
anyOf:
- type: string
- type: 'null'
title: Token
oauth_token:
anyOf:
- type: string
- type: 'null'
title: Oauth Token
refresh_token:
anyOf:
- type: string
- type: 'null'
title: Refresh Token
cloud:
anyOf:
- type: boolean
- type: 'null'
title: Cloud
default: false
projects:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Projects
boards:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Boards
issues:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Issues
status_filters:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Status Filters
download_attachments:
anyOf:
- type: boolean
- type: 'null'
title: Download Attachments
default: false
additionalProperties: true
type: object
required:
- url
title: JiraSourceConnectorConfig
SnowflakeSourceConnectorConfig:
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
batch_size:
type: integer
minimum: 1.0
title: Batch Size
default: 100
id_column:
type: string
title: Id Column
fields:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Fields
additionalProperties: true
type: object
required:
- account
- role
- user
- password
- host
- database
- schema
- table_name
- id_column
title: SnowflakeSourceConnectorConfig
CouchbaseSourceConnectorConfig:
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
collection_id:
type: string
title: Collection Id
additionalProperties: true
type: object
required:
- bucket
- connection_string
- batch_size
- username
- password
- collection_id
title: CouchbaseSourceConnectorConfig
OneDriveSourceConnectorConfigInput:
properties:
client_id:
anyOf:
- type: string
- type: 'null'
title: Client Id
user_pname:
type: string
title: User Pname
tenant:
type: string
title: Tenant
authority_url:
type: string
title: Authority Url
default: https://login.microsoftonline.com
client_cred:
anyOf:
- type: string
- type: 'null'
title: Client Cred
oauth_token:
anyOf:
- type: string
- type: 'null'
title: Oauth Token
refresh_token:
anyOf:
- type: string
- type: 'null'
title: Refresh Token
recursive:
type: boolean
title: Recursive
default: false
path:
type: string
title: Path
additionalProperties: true
type: object
required:
- user_pname
- tenant
- path
title: OneDriveSourceConnectorConfigInput
ConfluenceSourceConnectorConfigInput:
properties:
url:
type: string
title: Url
username:
anyOf:
- type: string
- type: 'null'
title: Username
cloud_id:
anyOf:
- type: string
- type: 'null'
title: Cloud Id
password:
anyOf:
- type: string
- type: 'null'
title: Password
api_token:
anyOf:
- type: string
- type: 'null'
title: Api Token
token:
anyOf:
- type: string
- type: 'null'
title: Token
oauth_token:
anyOf:
- type: string
- type: 'null'
title: Oauth Token
refresh_token:
anyOf:
- type: string
- type: 'null'
title: Refresh Token
cloud:
type: boolean
title: Cloud
default: false
extract_images:
type: boolean
title: Extract Images
default: false
extract_files:
type: boolean
title: Extract Files
default: false
max_num_of_spaces:
type: integer
minimum: 1.0
title: Max Num Of Spaces
default: 500
max_num_of_docs_from_each_space:
type: integer
minimum: 1.0
title: Max Num Of Docs From Each Space
default: 150
spaces:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Spaces
additionalProperties: true
type: object
required:
- url
title: ConfluenceSourceConnectorConfigInput
KafkaCloudSourceConnectorConfig:
properties:
bootstrap_servers:
type: string
title: Bootstrap Servers
port:
type: integer
title: Port
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
num_messages_to_consume:
type: integer
title: Num Messages To Consume
additionalProperties: true
type: object
required:
- bootstrap_servers
- port
- topic
- kafka_api_key
- secret
- num_messages_to_consume
title: KafkaCloudSourceConnectorConfig
DropboxSourceConnectorConfigInput:
properties:
token:
type: string
title: Token
refresh_token:
anyOf:
- type: string
- type: 'null'
title: Refresh Token
remote_url:
type: string
pattern: ^dropbox:\/\/
title: Remote Url
recursive:
type: boolean
title: Recursive
default: true
additionalProperties: true
type: object
required:
- token
- remote_url
title: DropboxSourceConnectorConfigInput
AzureSourceConnectorConfig:
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
recursive:
type: boolean
title: Recursive
additionalProperties: true
type: object
required:
- remote_url
- recursive
title: AzureSourceConnectorConfig
AzureSourceConnectorConfigInput:
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
recursive:
type: boolean
title: Recursive
default: true
additionalProperties: true
type: object
required:
- remote_url
title: AzureSourceConnectorConfigInput
BoxSourceConnectorConfigInput:
properties:
box_app_config:
anyOf:
- type: string
- type: 'null'
title: Box App Config
access_token:
anyOf:
- type: string
- type: 'null'
title: Access Token
refresh_token:
anyOf:
- type: string
- type: 'null'
title: Refresh Token
remote_url:
type: string
pattern: ^box:\/\/
title: Remote Url
recursive:
type: boolean
title: Recursive
default: true
additionalProperties: true
type: object
required:
- remote_url
title: BoxSourceConnectorConfigInput
SlackSourceConnectorConfig:
properties:
token:
type: string
title: Token
refresh_token:
anyOf:
- type: string
- type: 'null'
title: Refresh Token
channels:
items:
type: string
type: array
minItems: 1
title: Channels
start_date:
anyOf:
- type: string
- type: 'null'
title: Start Date
end_date:
anyOf:
- type: string
- type: 'null'
title: End Date
additionalProperties: true
type: object
required:
- token
- channels
title: SlackSourceConnectorConfig
OutlookSourceConnectorConfigInput:
properties:
authority_url:
type: string
title: Authority Url
default: https://login.microsoftonline.com
tenant:
anyOf:
- type: string
- type: 'null'
title: Tenant
client_id:
anyOf:
- type: string
- type: 'null'
title: Client Id
client_cred:
anyOf:
- type: string
- type: 'null'
title: Client Cred
oauth_token:
anyOf:
- type: string
- type: 'null'
title: Oauth Token
refresh_token:
anyOf:
- type: string
- type: 'null'
title: Refresh Token
outlook_folders:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Outlook Folders
recursive:
type: boolean
title: Recursive
default: false
user_email:
type: string
title: User Email
additionalProperties: true
type: object
required:
- user_email
title: OutlookSourceConnectorConfigInput
S3SourceConnectorConfigInput:
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
recursive:
type: boolean
title: Recursive
default: true
additionalProperties: true
type: object
required:
- remote_url
title: S3SourceConnectorConfigInput
TeradataSourceConnectorConfig:
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
id_column:
type: string
title: Id Column
default: id
table_name:
type: string
title: Table Name
batch_size:
type: integer
minimum: 1.0
title: Batch Size
default: 100
fields:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Fields
additionalProperties: true
type: object
required:
- host
- user
- password
- table_name
title: TeradataSourceConnectorConfig
PostgresSourceConnectorConfig:
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
id_column:
type: string
title: Id Column
fields:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Fields
additionalProperties: true
type: object
required:
- host
- database
- port
- username
- password
- table_name
- batch_size
- id_column
title: PostgresSourceConnectorConfig
CouchbaseSourceConnectorConfigInput:
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
collection_id:
type: string
title: Collection Id
additionalProperties: true
type: object
required:
- bucket
- connection_string
- batch_size
- username
- password
- collection_id
title: CouchbaseSourceConnectorConfigInput
MongoDBConnectorConfigInput:
properties:
database:
type: string
title: Database
collection:
type: string
title: Collection
uri:
type: string
pattern: ^mongodb(?:\+srv)?:\/\/(?:([^:@/\s]+)(?::([^@/\s]*))?@)?([^/\s:,]+)(?::(\d+))?(?:,([^/\s:,]+)(?::(\d+))?)*(?:\/([^/\s?]*))?(?:\?([^/\s]*))?$
title: Uri
additionalProperties: true
type: object
required:
- database
- collection
- uri
title: MongoDBConnectorConfigInput
S3SourceConnectorConfig:
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
recursive:
type: boolean
title: Recursive
additionalProperties: true
type: object
required:
- remote_url
- anonymous
- recursive
title: S3SourceConnectorConfig
GoogleDriveSourceConnectorConfig:
properties:
drive_id:
type: string
title: Drive Id
service_account_key:
anyOf:
- $ref: '#/components/schemas/SecretReference'
- type: string
- type: 'null'
title: Service Account Key
oauth_token:
anyOf:
- $ref: '#/components/schemas/SecretReference'
- type: string
- type: 'null'
title: Oauth Token
refresh_token:
anyOf:
- type: string
- type: 'null'
title: Refresh Token
extensions:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Extensions
recursive:
type: boolean
title: Recursive
additionalProperties: true
type: object
required:
- drive_id
- recursive
title: GoogleDriveSourceConnectorConfig
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
SalesforceSourceConnectorConfigInput:
properties:
username:
type: string
title: Username
consumer_key:
type: string
title: Consumer Key
private_key:
type: string
title: Private Key
categories:
items:
type: string
type: array
title: Categories
additionalProperties: true
type: object
required:
- username
- consumer_key
- private_key
- categories
title: SalesforceSourceConnectorConfigInput
ConnectionCheckStatus:
type: string
enum:
- SCHEDULED
- SUCCESS
- FAILURE
title: ConnectionCheckStatus
JiraSourceConnectorConfigInput:
properties:
url:
type: string
title: Url
username:
anyOf:
- type: string
- type: 'null'
title: Username
cloud_id:
anyOf:
- type: string
- type: 'null'
title: Cloud Id
password:
anyOf:
- type: string
- type: 'null'
title: Password
token:
anyOf:
- type: string
- type: 'null'
title: Token
oauth_token:
anyOf:
- type: string
- type: 'null'
title: Oauth Token
refresh_token:
anyOf:
- type: string
- type: 'null'
title: Refresh Token
cloud:
anyOf:
- type: boolean
- type: 'null'
title: Cloud
default: false
projects:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Projects
boards:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Boards
issues:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Issues
status_filters:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Status Filters
download_attachments:
anyOf:
- type: boolean
- type: 'null'
title: Download Attachments
default: false
additionalProperties: true
type: object
required:
- url
title: JiraSourceConnectorConfigInput
GCSSourceConnectorConfigInput:
properties:
remote_url:
type: string
pattern: ^(gs|gcs):\/\/
title: Remote Url
service_account_key:
anyOf:
- $ref: '#/components/schemas/SecretReference'
- type: string
- type: 'null'
title: Service Account Key
recursive:
type: boolean
title: Recursive
default: true
oauth_token:
anyOf:
- type: string
- type: 'null'
title: Oauth Token
refresh_token:
anyOf:
- type: string
- type: 'null'
title: Refresh Token
oauth_client_id:
anyOf:
- type: string
- type: 'null'
title: Oauth Client Id
oauth_client_secret:
anyOf:
- type: string
- type: 'null'
title: Oauth Client Secret
additionalProperties: true
type: object
required:
- remote_url
title: GCSSourceConnectorConfigInput
ZendeskSourceConnectorConfigInput:
properties:
subdomain:
type: string
title: Subdomain
email:
type: string
title: Email
api_token:
type: string
title: Api Token
item_type:
anyOf:
- type: string
- type: 'null'
title: Item Type
default: tickets
batch_size:
anyOf:
- type: integer
- type: 'null'
title: Batch Size
default: 2
additionalProperties: true
type: object
required:
- subdomain
- email
- api_token
title: ZendeskSourceConnectorConfigInput
SharePointSourceConnectorConfig:
properties:
site:
type: string
title: Site
tenant:
type: string
title: Tenant
authority_url:
type: string
title: Authority Url
default: https://login.microsoftonline.com
user_pname:
anyOf:
- type: string
- type: 'null'
title:
# --- truncated at 32 KB (58 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/unstructured/refs/heads/main/openapi/unstructured-sources-api-openapi.yml