Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.unstructured.io/llms.txt

Use this file to discover all available pages before exploring further.

If you’re new to Unstructured, read this note first.Before you can create a source connector, you must first sign in to your Unstructured account:After you sign in, the Unstructured user interface (UI) appears, which you use to get your Unstructured API key, as follows:
  1. After you sign in to your Unstructured Let’s Go, Pay-As-You-Go, or Business account, click API Keys on the sidebar.
    For a Business account, before you click API Keys, make sure you have selected the organizational workspace you want to create an API key for. Each API key works with one and only one organizational workspace. Learn more.
  2. Click Generate API Key.
  3. Follow the on-screen instructions to finish generating the key.
  4. Click the Copy icon next to your new key to add the key to your system’s clipboard. If you lose this key, simply return and click the Copy icon again.
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 the notebook Dropbox-To-Pinecone Connector API Quickstart for Unstructured, 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, email Unstructured Support at support@unstructured.io.You are now ready to start creating a source connector! Keep reading to learn how.
To use the Unstructured API’s workflow operations to manage source connectors, do the following:
TaskPython functioncURL
Get a list of available source connectorssources.list_sourcesGET /sources
Get information about a source connectorsources.get_sourceGET /sources/<connector-id>
Create a source connectorsources.create_sourcePOST /sources
Update a source connectorsources.update_sourcePUT /sources/<connector-id>
Delete a source connectorsources.delete_sourceDELETE /sources/<connector-id>
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:
ConnectorPython SDKcURL
AzureAZUREazure
BoxBOXbox
ConfluenceCONFLUENCEconfluence
CouchbaseCOUCHBASEcouchbase
Databricks VolumesDATABRICKS_VOLUMESdatabricks_volumes
DropboxDROPBOXdropbox
ElasticsearchELASTICSEARCHelasticsearch
Google Cloud StorageGCSgcs
Google DriveGOOGLE_DRIVEgoogle_drive
IBM FileNetFILNETfilenet
JiraJIRAjira
KafkaKAFKA_CLOUDkafka-cloud
Local
MongoDBMONGODBmongodb
OneDriveONEDRIVEonedrive
OpenSearchOPENSEARCHopensearch
OutlookOUTLOOKoutlook
PostgreSQLPOSTGRESpostgres
S3S3s3
SalesforceSALESFORCEsalesforce
SharePointSHAREPOINTsharepoint
SlackSLACKslack
SnowflakeSNOWFLAKEsnowflake
TeradataTERADATAteradata
ZendeskZENDESKzendesk