Thank you! Your feedback helps us improve.

Does Superhuman Docs have an API?

The Superhuman Docs API is a RESTful API that lets you programmatically interact with Docs


Superhuman Docs has a public API available to all users. The API allows you to get data in and out of tables in Docs as well as access computed values from formulas and user-selected values from controls.
 


 

What can I do with Superhuman Docs API?

The Superhuman Docs REST API allows users to programmatically interact with docs in a number of ways, including:

  • List and search Superhuman Docs

  • Listing docs

  • Creating and copying docs

  • Listing tables within a doc

  • Retrieving rows

  • Inserting and updating rows

  • Listing pages in a doc

  • Updating page title/image/icon

  • Publishing a doc

Check out our full API documentation here.

To see examples of the Superhuman Docs API in action, take a look at this doc.

ℹ️ Enterprise customers wanting to learn about our Admin Audit API, check out this article.

 

FAQs

Are there API size limits on requests?

The limit for requests is 2 MB, but there is also a limit of 85 KB for any given row. See this community post for more details. 

Are API limits per workspace, user, or token?

Limits are attached to a user/IP.

Why am I getting a 429 rate limit error?

If you're getting a 429 error when trying to use Superhuman Docs' API, you are running into the API rate limit. Superhuman Docs sets a limit on the number of requests that can be made per minute. For the latest info on the specific rate limits, check out this resource.

Why do I get a 401 error when trying to connect Superhuman Docs to Zapier?

Go to superhuman.docs.com/account and check that there aren’t any restrictions on the API token for Zapier. Zapier can’t connect to Docs with anything less than a full access API token.

How do I use the Zapier upsert action? Why can’t I upsert using the row’s ID?

The Zapier Docs integration’s upsert action is a bit confusing to set up. You have to specify the column you want to look for a match on as well as specify the value of that and any other columns you want to update.

However, you can’t update a column that’s based on a formula. Since upsert combines search, update, and create steps, this also effectively prevents you from upserting based on something like a rowID column that is filled by a formula. 

One way around this is to add a column to your table and fill it with the row’s ID via automation instead of using a formula. (Note that default value settings won’t work to capture the row ID.)

To learn more about connecting Docs and Zapier, check out this article.

The API is returning a date and time stamp different than I’d expect. Why is that?

The API returns dates in Pacific time. The user can write code to offset from there.

How do I send an image to the API?

Right now our API doesn’t accept image files. Instead, the closest we can come is passing an Image URL to an Image URL column.

For Cross-doc, does the API limit of 125Mb count the source doc or the destination doc?

Only the source doc.

 

 


 

Related resources

Was this article helpful?

Tell us what you think. We promise to act on your feedback to make Grammarly's support pages even more helpful.
Have more questions? Submit a request