Retrieve Batch Information

Retrieves information about a batch of generated documents

Endpoint URLSDK Method
https://api.inkit.com/v1/batch/{batchId}Batch.get()

Request properties

PropertyTypeRequiredDescription
batchIdStringYesThe ID of a batch that was previously created.

Response properties

PropertyTypeDescription
idStringThe ID of the batch.
nameStringThe name of the batch.
created_atStringThe date and time the batch was created.
destinationsObjectThe status of document generations within the batch.
statusStringThe batch creation status.
totalIntegerThe number of documents in the batch.

destinations

PropertyTypeDescription
inkit_storageObjectThe status of Inkit Storage document generations within the batch.

inkit_storage

PropertyTypeDescription
countIntegerThe total number of Inkit Storage document generations within the batch.
completedIntegerThe total number of completed Inkit Storage document generations within the batch.
failedIntegerThe total number of failed Inkit Storage document generations within the batch.
in_progressIntegerThe total number of in-progress Inkit Storage document generations within the batch.

Example request and response

# Import the Inkit Python package
import inkit
from inkit.exceptions import InkitResponseException
# Import json package
import json

# Replace the string below with your API key
inkit.api_token = "ENTER YOUR API KEY"

try:
   # Get batch
   resp = inkit.Batch.get('ENTER YOUR BATCH ID')
   # Print the JSON repsonse code of the API call
   print(json.dumps(resp.data, indent = 3))
except InkitResponseException as err:
   # Print any error
   print(err.response.data)
// Import the Inkit Node.js package
const Inkit = require("inkit");

// Replace the string below with your API key
Inkit.apiToken = "ENTER YOUR API KEY";

// Call get batch
getBatch();

// Get batch
async function getBatch() {
    try {
        const result = await Inkit.Batch.get('ENTER YOUR BATCH ID');
        // Print the JSON response of the API call
        console.log(JSON.stringify(result.data, null, 3));
    } catch (error) {
        // Print any error
        console.error(error.response.status, error.response.statusText);
    }
}
curl --request GET \
     --url https://api.inkit.com/v1/batch/ENTER_YOUR_BATCH_ID \
     --header 'X-Inkit-API-Token: ENTER YOUR API KEY' \
     --header 'accept: application/json'
{
  "created_at": "2023-08-14T14:32:48.872931Z",
  "destinations": {
    "inkit_storage": {
      "completed": 1,
      "count": 1,
      "failed": 0,
      "in_progress": 0
    }
  },
  "id": "rb_6WtDgF7RGqdS5Uzea9neZJ",
  "name": "test",
  "status": "Completed",
  "total": 1
}