This page was recently updated. What do you think about it? Let us know!.
- A Notion access token for an internal integration or public integration.
-
The IDs of any specific target Notion databases. To get a database’s ID:
- Open the database as a full page in Notion.
- Click Share, and then click Copy link.
-
Paste the link in your text editor. The URL uses the following format:
-
Find the part that corresponds to
{database_id}
in the URL you pasted. It is a 36-character string. This value is the database’s ID. Note that if you receive a database ID by calling the Notion API, for example from the Notion search endpoint, it will contain hyphens in the UUIDv4 format. You may use either the hyphenated or un-hyphenated ID.
-
The IDs of any specific target Notion pages. To get a page’s ID:
- Open the page in Notion.
- Click Share, and then click Copy link.
- Paste the link in your text editor. The URL ends in a page ID. It should be a 32-character string.
-
Format this value by inserting hyphens (
-
) in the following pattern:8-4-4-4-12
(each number is the length of characters between the hyphens). Example:1429989fe8ac4effbc8f57f56486db54
becomes1429989f-e8ac-4eff-bc8f-57f56486db54
. This value is the page’s ID.
CLI, Python
NOTION_ACCESS_TOKEN
- The API key for the Notion integration, represented by--notion-api-key
(CLI) ornotion_api_key
(Python).
--partition-by-api
option (CLI) or partition_by_api
(Python) parameter to specify where files are processed:
-
To do local file processing, omit
--partition-by-api
(CLI) orpartition_by_api
(Python), or explicitly specifypartition_by_api=False
(Python). Local file processing does not use an Unstructured API key or API URL, so you can also omit the following, if they appear:--api-key $UNSTRUCTURED_API_KEY
(CLI) orapi_key=os.getenv("UNSTRUCTURED_API_KEY")
(Python)--partition-endpoint $UNSTRUCTURED_API_URL
(CLI) orpartition_endpoint=os.getenv("UNSTRUCTURED_API_URL")
(Python)- The environment variables
UNSTRUCTURED_API_KEY
andUNSTRUCTURED_API_URL
-
To send files to the Unstructured Partition Endpoint for processing, specify
--partition-by-api
(CLI) orpartition_by_api=True
(Python). Unstructured also requires an Unstructured API key and API URL, by adding the following:--api-key $UNSTRUCTURED_API_KEY
(CLI) orapi_key=os.getenv("UNSTRUCTURED_API_KEY")
(Python)--partition-endpoint $UNSTRUCTURED_API_URL
(CLI) orpartition_endpoint=os.getenv("UNSTRUCTURED_API_URL")
(Python)- The environment variables
UNSTRUCTURED_API_KEY
andUNSTRUCTURED_API_URL
, representing your API key and API URL, respectively.
You must specify the API URL only if you are not using the default API URL for Unstructured Ingest, which applies to Starter and Team accounts.The default API URL for Unstructured Ingest ishttps://api.unstructuredapp.io/general/v0/general
, which is the API URL for the Unstructured Partition Endpoint. However, you should always use the URL that was provided to you when your Unstructured account was created. If you do not have this URL, email Unstructured Support at support@unstructured.io.If you do not have an API key, get one now.If you are using an Enterprise account, the process for generating Unstructured API keys, and the Unstructured API URL that you use, are different. For instructions, see your Unstructured account administrator, or email Unstructured Support at support@unstructured.io.