Ryan/documenso
1
0
Fork 1
mirror of https://github.com/documenso/documenso.git synced 2025-11-15 01:01:49 +10:00
Code Issues Packages Projects Releases Wiki Activity

chore: add envelope docs (#2186)

Browse Source
This commit is contained in:
David Nguyen
2025-11-13 11:50:06 +11:00
committed by GitHub
parent ce53bcea8c
commit 4304fc1d35
96 changed files with 466 additions and 979 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
apps/documentation/pages/developers/public-api/index.mdx
View File

@ -9,19 +9,13 @@ import { Callout, Steps } from 'nextra/components';
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:
- retrieving, uploading, deleting, and sending documents for signing
- creating, updating, and deleting recipients
- creating, updating, and deleting document fields
- Retrieving, uploading, deleting, and sending documents for signing
- Creating, updating, and deleting recipients
- Creating, updating, and deleting document fields
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.
## API V1 - Stable
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
<Callout type="warning">API V2 is currently beta, and will be subject to breaking changes</Callout>
## API V2 - Stable
Check out the [API V2 documentation](https://documen.so/api-v2-docs) for details about the API endpoints, request parameters, response formats, and authentication methods.
@ -32,18 +26,15 @@ Our new API V2 supports the following typed SDKs:
- [Go](https://github.com/documenso/sdk-go)
<Callout type="info">
For the staging API, please use the following base URL:
`https://stg-app.documenso.com/api/v2-beta/`
For the staging API, please use the following base URL: `https://stg-app.documenso.com/api/v2/`
</Callout>
🚀 [V2 Announcement](https://documen.so/sdk-blog)
## API V1 - Deprecated
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.
📖 [Documentation](https://documen.so/api-v2-docs)
💬 [Leave Feedback](https://documen.so/sdk-feedback)
🔔 [Breaking Changes](https://documen.so/sdk-breaking)
## Availability
The API is available to individual users, teams and higher plans. [Fair Use](https://documen.so/fair) applies.