Get Generated PDF Document

GET

https://api.staple.io/v2/supernova/models/document/:requestId

Retrieves the status and result of a document generation request. The response includes the request status (success or failed), the generated document’s ID and name, the queue and user involved, and error details if generation or scanning failed. Poll this endpoint after creating a document to confirm it has been generated.

Authentication

x-api-keystring

API key issued by Staple.

AuthorizationBearer

JWT obtained from the login endpoint.

Path parameters

requestIdstringRequired

1	{
2	"documentCreationRequest": {
3	"createdAt": 1685693539620,
4	"data": {
5	"document_name": "newPDF",
6	"json_data": {
7	"InvoiceNumber": "12345678"
8	},
9	"model_name": "invoice"
10	},
11	"documentId": 1,
12	"documentName": "01",
13	"id": "18e193bf-f890-4d99-b111-05b816647c71",
14	"modelName": "invoice",
15	"qid": 1,
16	"requestErrorMessage": null,
17	"requestStatusCode": 200,
18	"scanningErrorMessage": null,
19	"status": "success",
20	"uid": 1
21	}
22	}

$	curl https://api.staple.io/v2/supernova/models/document/requestId \
>	-H "x-api-key: <apiKey>"

Authentication

Path parameters

Response