Skip to content

Partition Endpoint: link to available quickstart notebook #724

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 20, 2025
Merged

Partition Endpoint: link to available quickstart notebook #724

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions api-reference/partition/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,11 @@ import Pricing from '/snippets/general-shared-text/pricing-platform.mdx';

## Quickstart

<Tip>
To use the Unstructured Python SDK instead of `curl` for the following quickstart,
[skip ahead](/api-reference/partition/quickstart) to the SDK version instead.
</Tip>

This example uses the [curl](https://curl.se/) utility on your local machine to call the Unstructured Partition Endpoint. It sends a source (input) file from your local machine to the Unstructured Partition Endpoint which then delivers the processed data to a destination (output) location, also on your local machine. Data is processed on Unstructured-hosted compute resources.

If you do not have a source file readily available, you could use for example a sample PDF file containing the text of the United States Constitution,
Expand Down
7 changes: 6 additions & 1 deletion api-reference/partition/quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,12 @@
title: Unstructured API Quickstart
---

<Tip>Just need to copy the sample code? [Skip ahead](#sample-code) to it now!</Tip>
<Tip>
Do you want to run this quickstart without modifying your local machine?
[Skip ahead](https://colab.research.google.com/github/Unstructured-IO/notebooks/blob/main/notebooks/Unstructured_Partition_Endpoint_Quickstart.ipynb) to run this quickstart as a notebook on Google Colab now!

Do you want to just copy the sample code for use on your local machine? [Skip ahead](#sample-code) to the code now!
</Tip>

<iframe
width="560"
Expand Down
7 changes: 7 additions & 0 deletions examplecode/notebooks.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,13 @@ description: "Notebooks contain complete working sample code for end-to-end solu
---

<CardGroup cols={2}>
<Card title="Unstructured Partition Endpoint Quickstart" href="https://colab.research.google.com/github/Unstructured-IO/notebooks/blob/main/notebooks/Unstructured_Partition_Endpoint_Quickstart.ipynb">
<br/>
This notebook calls the Unstructured Python SDK to have Unstructured process a local file by using the Unstructured Partition Endpoint.
<br/>
``Unstructured API`` ``Partition Endpoint`` ``Local file``
<br/>
</Card>
<Card title="Preserving Table Structure for Better Retrieval" href="https://colab.research.google.com/drive/1__axq0MRDR9i1M_uEW-pR8aKYH_Qk1hj?usp=sharing">
<br/>
This notebook explores using Unstructured API to process financial documents while preserving tabular structure in a way that's usable by downstream applications.
Expand Down
2 changes: 2 additions & 0 deletions welcome.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,8 @@ You can use Unstructured through a user interface (UI), an API, or both. Read on
allowfullscreen
></iframe>

<Icon icon="note-sticky" />&nbsp;&nbsp;[Run this quickstart as a notebook on Google Colab instead](https://colab.research.google.com/github/Unstructured-IO/notebooks/blob/main/notebooks/Unstructured_Partition_Endpoint_Quickstart.ipynb).

<Icon icon="code" />&nbsp;&nbsp;[Get the sample code for this video](/api-reference/partition/quickstart#sample-code).

<Icon icon="gear" />&nbsp;&nbsp;[Get the full setup instructions for this video](/api-reference/partition/quickstart).
Expand Down