API endpoint catalog
All paths use https://apps.inkit.com and API-key authentication. See authentication. Documentation v2.0 retains the /api/v1 route prefix.
| Method | Path | Reference |
|---|---|---|
| POST | /api/v1/generate | Send a template for signature |
| GET | /api/v1/digital-signature/metadata/{public_id} | Get digital signature metadata |
| GET | /api/v1/renders | List renders |
| POST | /api/v1/renders | Generate a document (alias) |
| GET | /api/v1/renders/{public_id} | Get render by ID |
| POST | /api/v1/files/upload | Upload a file |
| GET | /api/v1/files | List files |
| GET | /api/v1/files/retrieve/{public_id} | Retrieve file metadata |
| GET | /api/v1/files/download/{public_id} | Download a file |
| DELETE | /api/v1/files/delete | Batch delete files |
| DELETE | /api/v1/files/delete/{public_id} | Delete a single file |
| POST | /api/v1/workflows-invoke | Invoke a workflow |
| GET | /api/v1/events | List events |
| GET | /api/v1/events/types | List event types |
| GET | /api/v1/events/{evnt_id} | Get event by ID |
| PATCH | /api/v1/files/{public_id}/move | Move a file |
| GET | /api/v1/documents | List documents |
| GET | /api/v1/documents/{public_id}/retrieve | Retrieve a document |
| GET | /api/v1/documents/{public_id}/download | Download a document |
| DELETE | /api/v1/documents/delete | Delete documents |
| DELETE | /api/v1/documents/delete/{public_id} | Delete a document |
| GET | /api/v1/documents/templates | List templates |
| GET | /api/v1/documents/templates/{public_id}/retrieve | Retrieve a template |
| GET | /api/v1/documents/templates/{public_id}/{version}/retrieve | Retrieve a template version |
| DELETE | /api/v1/documents/templates/{public_id}/delete | Delete a template |
| GET | /api/v1/documents/templates/merge-variables | List template merge variables |
| POST | /api/v1/documents/templates/{public_id}/duplicate | Duplicate a template |
| POST | /api/v1/documents/templates/create | Create a template |
| POST | /api/v1/ai-chats | Create an AI chat |
| GET | /api/v1/studio/items | List Studio items |
| GET | /api/v1/apps/salesforce | Get Salesforce connection status |
| GET | /api/v1/apps/salesforce/resources | List Salesforce deliveries |
| GET | /api/v1/apps/salesforce/resources/{public_id} | Retrieve a Salesforce delivery |
| GET | /api/v1/apps/salesforce/objects-types/{salesforce_env} | List Salesforce object types |
| GET | /api/v1/apps/salesforce/objects/{salesforce_env}/{object_name} | List Salesforce object fields |
Updated 10 days ago
Did this page help you?