Skip to content

Commit a19e01e

Browse files
authored
Add Postman collection for Workflow Endpoint (#622)
1 parent dc76947 commit a19e01e

File tree

2 files changed

+1108
-0
lines changed

2 files changed

+1108
-0
lines changed

api-reference/workflow/overview.mdx

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -169,6 +169,30 @@ The following Postman examples use variables, which you can set as follows:
169169
These variables enable you to more easily run the following examples in Postman and help prevent you from storing
170170
Postman collections that contain sensitive URLs and API keys in public source code repositories.
171171

172+
Unstructured offers a [Postman collection](https://learning.postman.com/docs/collections/collections-overview/) that you can import into Postman to make Workflow Endpoint requests through a graphical user interface.
173+
174+
1. [Install Postman](https://learning.postman.com/docs/getting-started/installation/installation-and-updates/).
175+
2. [Sign in to Postman](https://learning.postman.com/docs/getting-started/installation/postman-account/#signing-in-to-postman).
176+
3. In your workspace, click **Import**.
177+
178+
![Import a Postman collection](/img/api/post/import.png)
179+
180+
4. In the **Paste cURL, Raw text or URL** box, enter the following URL, and then press `Enter`:
181+
182+
```
183+
https://raw.githubusercontent.com/Unstructured-IO/docs/main/examplecode/codesamples/api/Unstructured-REST-API-Workflow-Endpoint.postman_collection.json
184+
185+
5. On the sidebar, click **Collections**.
186+
6. Expand **Unstructured REST API - Workflow Endpoint**.
187+
7. Select the request that you want to use.
188+
8. As applicable, modify the URL as needed to specify any required resource IDs for the request.
189+
9. On the **Headers** tab, next to `unstructured-api-key`, enter your Unstructured API key in the **Value** column.
190+
As applicable, add, remove, or modify any other required headers for the request.
191+
10. As applicable, on the **Params** tab, add, remove, or modify any required parameters for the request.
192+
11. As applicable, on the **Body** tab, add, remove, or modify the required request body for the request.
193+
12. Click **Send**.
194+
13. To save the response, in the response area, click the ellipses, and then click **Save response to file**.
195+
172196
To get your Unstructured API key, do the following:
173197
174198
<GetStartedSimpleAPIOnly/>

0 commit comments

Comments
 (0)