BlueAI Documents
Create, update, send, cancel, and remind document signing.
|
Endpoints
| GET | /api/v1/sign/documents | List documents |
| POST | /api/v1/sign/documents | Create a document |
| GET | /api/v1/sign/documents/{id} | Get a document |
| PATCH | /api/v1/sign/documents/{id} | Update a document |
| DELETE | /api/v1/sign/documents/{id} | Delete a document |
| POST | /api/v1/sign/documents/{id}/send | Send for signing |
| POST | /api/v1/sign/documents/{id}/cancel | Cancel signing request |
| POST | /api/v1/sign/documents/{id}/remind | Send signing reminder |
GET
/api/v1/sign/documentsList documents
Authentication required— Include session cookie or Bearer token
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
status | string | Optional | Filter by status (draft / sent / signed / cancelled) |
limit | integer | Optional | Number of items to return (default: 50, max: 200) |
offset | integer | Optional | Number of items to skip |
Code Examples
curl "https://api.blueai.jp/api/v1/sign/documents" \
-H "Cookie: better-auth.session_token=<token>"POST
/api/v1/sign/documentsCreate a document
Authentication required— Include session cookie or Bearer token
Code Examples
curl -X POST "https://api.blueai.jp/api/v1/sign/documents" \
-H "Cookie: better-auth.session_token=<token>"GET
/api/v1/sign/documents/{id}Get a document
Authentication required— Include session cookie or Bearer token
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Optional | Document ID |
Code Examples
curl "https://api.blueai.jp/api/v1/sign/documents/doc_123e4567e89b12d3a456426614174000" \
-H "Cookie: better-auth.session_token=<token>"PATCH
/api/v1/sign/documents/{id}Update a document
Authentication required— Include session cookie or Bearer token
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Optional | Document ID |
Code Examples
curl -X PATCH "https://api.blueai.jp/api/v1/sign/documents/doc_123e4567e89b12d3a456426614174000" \
-H "Cookie: better-auth.session_token=<token>"DELETE
/api/v1/sign/documents/{id}Delete a document
Authentication required— Include session cookie or Bearer token
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Optional | Document ID |
Code Examples
curl -X DELETE "https://api.blueai.jp/api/v1/sign/documents/doc_123e4567e89b12d3a456426614174000" \
-H "Cookie: better-auth.session_token=<token>"POST
/api/v1/sign/documents/{id}/sendSend for signing
Authentication required— Include session cookie or Bearer token
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Optional | Document ID |
Code Examples
curl -X POST "https://api.blueai.jp/api/v1/sign/documents/doc_123e4567e89b12d3a456426614174000/send" \
-H "Cookie: better-auth.session_token=<token>"POST
/api/v1/sign/documents/{id}/cancelCancel signing request
Authentication required— Include session cookie or Bearer token
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Optional | Document ID |
Code Examples
curl -X POST "https://api.blueai.jp/api/v1/sign/documents/doc_123e4567e89b12d3a456426614174000/cancel" \
-H "Cookie: better-auth.session_token=<token>"POST
/api/v1/sign/documents/{id}/remindSend signing reminder
Authentication required— Include session cookie or Bearer token
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Optional | Document ID |
Code Examples
curl -X POST "https://api.blueai.jp/api/v1/sign/documents/doc_123e4567e89b12d3a456426614174000/remind" \
-H "Cookie: better-auth.session_token=<token>"