Overview
If you’re new to Unstructured, read this note first.
Before you can create a source connector, you must first sign up for Unstructured and get your Unstructured API key. After you sign up, the Unstructured user interface (UI) appears, which you use to get the key. To learn how, watch this 40-second how-to video.
After you create the source connector, add it along with a destination connector to a workflow. Then run the worklow as a job. To learn how, try out the hands-on Workflow Endpoint quickstart, go directly to the quickstart notebook, or watch the two 4-minute video tutorials for the Unstructured Python SDK.
You can also create source connectors with the Unstructured user interface (UI). Learn how.
If you need help, reach out to the community on Slack, or contact us directly.
You are now ready to start creating a source connector! Keep reading to learn how.
To use the Unstructured Workflow Endpoint to manage source connectors, do the following:
- To get a list of available source connectors, use the
UnstructuredClient
object’ssources.list_sources
function (for the Python SDK) or theGET
method to call the/sources
endpoint (forcurl
or Postman). Learn more. - To get information about a source connector, use the
UnstructuredClient
object’ssources.get_source
function (for the Python SDK) or theGET
method to call the/sources/<connector-id>
endpoint (forcurl
or Postman). Learn more. - To create a source connector, use the
UnstructuredClient
object’ssources.create_source
function (for the Python SDK) or thePOST
method to call the/sources
endpoint (forcurl
or Postman). Learn more. - To update a source connector, use the
UnstructuredClient
object’ssources.update_source
function (for the Python SDK) or thePUT
method to call the/sources/<connector-id>
endpoint (forcurl
or Postman). Learn more. - To delete a source connector, use the
UnstructuredClient
object’ssources.delete_source
function (for the Python SDK) or theDELETE
method to call the/sources/<connector-id>
endpoint (forcurl
or Postman). Learn more.
To create or update a source connector, you must also provide settings that are specific to that connector. For the list of specific settings, see:
- Azure (
AZURE
for the Python SDK orazure
forcurl
and Postman) - Box (
BOX
for the Python SDK orbox
forcurl
and Postman) - Confluence (
CONFLUENCE
for the Python SDK orconfluence
forcurl
and Postman) - Couchbase (
COUCHBASE
for the Python SDK orcouchbase
forcurl
and Postman) - Databricks Volumes (
DATABRICKS_VOLUMES
for the Python SDK ordatabricks_volumes
forcurl
and Postman) - Dropbox (
DROPBOX
for the Python SDK ordropbox
forcurl
and Postman) - Elasticsearch (
ELASTICSEARCH
for the Python SDK orelasticsearch
forcurl
and Postman) - Google Cloud Storage (
GCS
for the Python SDK orgcs
forcurl
and Postman) - Google Drive (
GOOGLE_DRIVE
for the Python SDK orgoogle_drive
forcurl
and Postman) - Jira (
JIRA
for the Python SDK orjira
forcurl
and Postman) - Kafka (
KAFKA_CLOUD
for the Python SDK orkafka-cloud
forcurl
and Postman) - Local (Supported only for
curl
and Postman) - MongoDB (
MONGODB
for the Python SDK ormongodb
forcurl
and Postman) - OneDrive (
ONEDRIVE
for the Python SDK oronedrive
forcurl
and Postman) - Outlook (
OUTLOOK
for the Python SDK oroutlook
forcurl
and Postman) - PostgreSQL (
POSTGRES
for the Python SDK orpostgres
forcurl
and Postman) - S3 (
S3
for the Python SDK ors3
forcurl
and Postman) - Salesforce (
SALESFORCE
for the Python SDK orsalesforce
forcurl
and Postman) - SharePoint (
SHAREPOINT
for the Python SDK orsharepoint
forcurl
and Postman) - Snowflake (
SNOWFLAKE
for the Python SDK orsnowflake
forcurl
and Postman) - Zendesk (
ZENDESK
for the Python SDK orzendesk
forcurl
and Postman)
Was this page helpful?