Start a batch
POST
/templates/{id}/versions/{version}/batch
const url = 'https://necodoc.example.com/api/v1/templates/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/versions/latest/batch';const options = { method: 'POST', headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'}, body: '{"rows":[{"additionalProperty":"example"}],"filename":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://necodoc.example.com/api/v1/templates/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/versions/latest/batch \ --header 'Content-Type: application/json' \ --header 'x-api-key: <x-api-key>' \ --data '{ "rows": [ { "additionalProperty": "example" } ], "filename": "example" }'One document per row, queued behind interactive renders. Invalid rows fail alone with their field errors. Poll the batch, or subscribe a webhook to batch.completed.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
rows
required
Array<object>
object
key
additional properties
filename
string
Example generated
{ "rows": [ { "additionalProperty": "example" } ], "filename": "example"}Responses
Section titled “Responses”Queued.
Media typeapplication/json
object
id
required
string format: uuid
templateName
required
string
version
required
integer
userId
required
string | null
userName
required
string | null
status
required
string
total
required
integer
done
required
integer
failed
required
integer
cancelled
required
integer
createdAt
required
string format: date-time
Example
{ "status": "running"}Missing, unknown, revoked or expired key, or the key’s account is disabled.
Media typeapplication/json
object
error
required
string
code
required
string
fieldErrors
object
key
additional properties
Array<string>
generationId
string format: uuid
Example generated
{ "error": "example", "code": "example", "fieldErrors": { "additionalProperty": [ "example" ] }, "generationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}The key lacks the scope, role, template or source address this call needs.
Media typeapplication/json
object
error
required
string
code
required
string
fieldErrors
object
key
additional properties
Array<string>
generationId
string format: uuid
Example generated
{ "error": "example", "code": "example", "fieldErrors": { "additionalProperty": [ "example" ] }, "generationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}Not found, or not yours.
Media typeapplication/json
object
error
required
string
code
required
string
fieldErrors
object
key
additional properties
Array<string>
generationId
string format: uuid
Example generated
{ "error": "example", "code": "example", "fieldErrors": { "additionalProperty": [ "example" ] }, "generationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}The template is archived.
Media typeapplication/json
object
error
required
string
code
required
string
fieldErrors
object
key
additional properties
Array<string>
generationId
string format: uuid
Example generated
{ "error": "example", "code": "example", "fieldErrors": { "additionalProperty": [ "example" ] }, "generationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}Invalid request or data; fieldErrors lists each.
Media typeapplication/json
object
error
required
string
code
required
string
fieldErrors
object
key
additional properties
Array<string>
generationId
string format: uuid
Example generated
{ "error": "example", "code": "example", "fieldErrors": { "additionalProperty": [ "example" ] }, "generationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}Rate limit exceeded.
Media typeapplication/json
object
error
required
string
code
required
string
fieldErrors
object
key
additional properties
Array<string>
generationId
string format: uuid
Example generated
{ "error": "example", "code": "example", "fieldErrors": { "additionalProperty": [ "example" ] }, "generationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}Headers
Section titled “Headers”Retry-After
integer
Seconds until the key may call again.