Skip to content

Commit a43ee28

Browse files
authored
chore: Update signup and docs links at the top of the readme (#139)
Note that the platform workflow functionality is coming soon. Also, swap out the URL for pulling the partitioning endpoint spec.
1 parent 1fc08c8 commit a43ee28

File tree

3 files changed

+6
-5
lines changed

3 files changed

+6
-5
lines changed

.speakeasy/workflow.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ speakeasyVersion: latest
33
sources:
44
my-source:
55
inputs:
6-
- location: https://api.unstructured.io/general/openapi.json
6+
- location: https://api.unstructuredapp.io/general/openapi.json
77
overlays:
88
- location: ./overlay_client.yaml
99
registry:

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ PACKAGE_NAME := unstructured-js-client
22
CURRENT_DIR := $(shell pwd)
33
ARCH := $(shell uname -m)
44
DOCKER_IMAGE ?= quay.io/unstructured-io/unstructured-api:latest
5-
OPENAPI_DOCS_URL ?= https://api.unstructured.io/general/openapi.json
5+
OPENAPI_DOCS_URL ?= https://api.unstructuredapp.io/general/openapi.json
66

77
###########
88
# Install #

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,13 @@
1010
</div>
1111

1212
<h2 align="center">
13-
<p>Typescript SDK for the Unstructured API</p>
13+
<p>TypeScript SDK for the Unstructured API</p>
1414
</h2>
1515

16-
This is a Typescript client for the [Unstructured API](https://docs.unstructured.io/api-reference/api-services/saas-api-development-guide) and you can sign up for your API key on https://app.unstructured.io.
16+
This is a HTTP client for the [Unstructured Platform API](https://docs.unstructured.io/platform-api/overview). You can sign up [here](https://unstructured.io/developers) and process 1000 free pages per day for 14 days.
17+
18+
Please refer to the our documentation for a full guide on integrating the [Partition Endpoint](https://docs.unstructured.io/platform-api/partition-api/sdk-jsts) into your JavaScript/TypeScript code. Support for the [Workflow Endpoint](https://docs.unstructured.io/platform-api/api/overview) is coming soon.
1719

18-
Please refer to the [Unstructured docs](https://docs.unstructured.io/api-reference/api-services/sdk-jsts) for a full guide to using the client.
1920

2021
## SDK Installation
2122

0 commit comments

Comments
 (0)