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’s sources.list_sources function (for the Python SDK) or the GET method to call the /sources endpoint (for curl or Postman). Learn more.
  • To get information about a source connector, use the UnstructuredClient object’s sources.get_source function (for the Python SDK) or the GET method to call the /sources/<connector-id> endpoint (for curl or Postman). Learn more.
  • To create a source connector, use the UnstructuredClient object’s sources.create_source function (for the Python SDK) or the POST method to call the /sources endpoint (for curl or Postman). Learn more.
  • To update a source connector, use the UnstructuredClient object’s sources.update_source function (for the Python SDK) or the PUT method to call the /sources/<connector-id> endpoint (for curl or Postman). Learn more.
  • To delete a source connector, use the UnstructuredClient object’s sources.delete_source function (for the Python SDK) or the DELETE method to call the /sources/<connector-id> endpoint (for curl 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 or azure for curl and Postman)
  • Box (BOX for the Python SDK or box for curl and Postman)
  • Confluence (CONFLUENCE for the Python SDK or confluence for curl and Postman)
  • Couchbase (COUCHBASE for the Python SDK or couchbase for curl and Postman)
  • Databricks Volumes (DATABRICKS_VOLUMES for the Python SDK or databricks_volumes for curl and Postman)
  • Dropbox (DROPBOX for the Python SDK or dropbox for curl and Postman)
  • Elasticsearch (ELASTICSEARCH for the Python SDK or elasticsearch for curl and Postman)
  • Google Cloud Storage (GCS for the Python SDK or gcs for curl and Postman)
  • Google Drive (GOOGLE_DRIVE for the Python SDK or google_drive for curl and Postman)
  • Jira (JIRA for the Python SDK or jira for curl and Postman)
  • Kafka (KAFKA_CLOUD for the Python SDK or kafka-cloud for curl and Postman)
  • Local (Supported only for curl and Postman)
  • MongoDB (MONGODB for the Python SDK or mongodb for curl and Postman)
  • OneDrive (ONEDRIVE for the Python SDK or onedrive for curl and Postman)
  • Outlook (OUTLOOK for the Python SDK or outlook for curl and Postman)
  • PostgreSQL (POSTGRES for the Python SDK or postgres for curl and Postman)
  • S3 (S3 for the Python SDK or s3 for curl and Postman)
  • Salesforce (SALESFORCE for the Python SDK or salesforce for curl and Postman)
  • SharePoint (SHAREPOINT for the Python SDK or sharepoint for curl and Postman)
  • Snowflake (SNOWFLAKE for the Python SDK or snowflake for curl and Postman)
  • Zendesk (ZENDESK for the Python SDK or zendesk for curl and Postman)

Was this page helpful?

Suggest edits