New Synchronous API Subdomain: sync.api.docspring.com

We're excited to introduce our new dedicated synchronous API subdomains:

• sync.api.docspring.com (for our US region)
• sync.api-eu.docspring.com (for our EU region)

These new API subdomains allow you to generate PDFs with a single API request, with no need to poll for status updates. The HTTP request will wait for the PDF to be ready and then return a download_url where you can download the PDF.

These synchronous subdomains support:

• Synchronous POST endpoints:
  • Create PDF Submission: POST /api/v1/templates/{template_id}/submissions
  • Create PDF Submission Batch: POST /api/v1/submissions/batches
  • Create Combined Submission: POST /api/v1/combined_submissions
  • Create Template: POST /api/v1/templates

• All other API endpoints: You can use the sync subdomain for all of your API requests, in addition to the requests that need to wait for PDFs or templates to be ready.

• Optional asynchronous requests: Add the ?wait=false query parameter to your URL to receive an immediate pending response. (DocSpring also has support for webhooks, so our server can notify your application once the PDF is ready if that suits your use-case better.)

The latest versions of our API client libraries now use the sync.api.docspring.com host by default. They also include support for the wait query parameter for all of the POST endpoints above.

• C#: DocSpring.Client v3.0.1
• Elixir: docspring v2.0.0
• Go: docspring-go v2.0.1
• Java: DocSpring v2.0.0
• JavaScript: docspring v2.0.0
• PHP: docspring v2.0.1
• Python: docspring v2.0.0
• Ruby: docspring v3.0.0
• TypeScript: docspring-ts v2.0.0

You can also configure the host manually in case you're using our EU region or an older API client library.

Our asynchronous domains will remain available forever, so you don't need to change anything if you don't want to:

• api.docspring.com (for US customers)
• api-eu.docspring.com (for EU customers)
• api.formapi.io (for customers who are still using our old domain!)

All requests to these domains will remain asynchronous and the wait query parameter has no effect. Backwards compatibility is one of our foundational values: You should be able to set up DocSpring once and then never touch it again.

Let us know if you run into any issues with our sync subdomains or the new API clients. And let us know if you would like us to release an API client for a different programming language.