From 3e106c1a2d526687edce92d8ae8da3f2969fa1d3 Mon Sep 17 00:00:00 2001 From: Timur Ercan Date: Fri, 31 Jan 2025 09:11:47 +0100 Subject: [PATCH] chore: api v2 docs (#1620) chore update docs for api v2 announce --- .../pages/developers/public-api/index.mdx | 22 ++++++++++++++++--- 1 file changed, 19 insertions(+), 3 deletions(-) diff --git a/apps/documentation/pages/developers/public-api/index.mdx b/apps/documentation/pages/developers/public-api/index.mdx index 94b728b53..f2745ee82 100644 --- a/apps/documentation/pages/developers/public-api/index.mdx +++ b/apps/documentation/pages/developers/public-api/index.mdx @@ -3,6 +3,8 @@ title: Public API description: Learn how to interact with your documents programmatically using the Documenso public API. --- +import { Callout, Steps } from 'nextra/components'; + # Public API Documenso provides a public REST API enabling you to interact with your documents programmatically. The API exposes various HTTP endpoints that allow you to perform operations such as: @@ -13,10 +15,24 @@ Documenso provides a public REST API enabling you to interact with your document The documentation walks you through creating API keys and using them to authenticate your API requests. You'll also learn about the available endpoints, request and response formats, and how to use the API. -## Swagger Documentation +## API V1 - Stable -The [Swagger documentation](https://app.documenso.com/api/v1/openapi) also provides information about the API endpoints, request parameters, response formats, and authentication methods. +Check out the [API V1 documentation](https://app.documenso.com/api/v1/openapi) for details about the API endpoints, request parameters, response formats, and authentication methods. + +## API V2 - Beta + +Our new API V2 is currently in Beta. The new API features typed SDKs for TypeScript, Python and Go and example code for many more. + + + NOW IN BETA: [API V2 Documentation](https://documen.so/api-v2-docs) + + +🚀 [V2 Announcement](https://documen.so/sdk-blog) + +💬 [Leave Feedback](https://documen.so/sdk-feedback) + +🔔 [Breaking Changes](https://documen.so/sdk-breaking) ## Availability -The API is available to individual users and teams. +The API is available to individual users, teams and higher plans. [Fair Use](https://documen.so/fair) applies.