Async batch processing in Rest API

Introduction

Async batch processing helps handle many tasks at once without waiting for each to finish. It makes programs faster and more efficient.

When you need to process many user requests without delay.

When uploading multiple files and want to start processing immediately.

When sending many emails and don't want to wait for each to send.

When running reports on large data sets without blocking other actions.

Syntax

Rest API

POST /batch
{
  "requests": [
    {"method": "GET", "path": "/api/item1"},
    {"method": "POST", "path": "/api/item2", "body": {"data": "value"}}
  ]
}

Response:
{
  "responses": [
    {"status": 200, "body": {}},
    {"status": 201, "body": {}}
  ]
}

The client sends many requests in one batch call.

The server processes requests asynchronously and returns results together.

Examples

Batch request to get two users at once.

Rest API

POST /batch
{
  "requests": [
    {"method": "GET", "path": "/users/1"},
    {"method": "GET", "path": "/users/2"}
  ]
}

Batch request to create an order and delete another.

Rest API

POST /batch
{
  "requests": [
    {"method": "POST", "path": "/orders", "body": {"item": "book"}},
    {"method": "DELETE", "path": "/orders/5"}
  ]
}

Sample Program

This program sends two API calls in one batch: one to get an item and one to create a new item. It prints each response's status and body.

Rest API

import requests

batch_url = 'https://example.com/api/batch'

batch_request = {
    "requests": [
        {"method": "GET", "path": "/items/1"},
        {"method": "POST", "path": "/items", "body": {"name": "NewItem"}}
    ]
}

response = requests.post(batch_url, json=batch_request)

if response.status_code == 200:
    results = response.json().get('responses', [])
    for i, res in enumerate(results, 1):
        print(f"Response {i}: Status {res['status']}, Body: {res.get('body')}")
else:
    print("Batch request failed")

Important Notes

Batch processing reduces network overhead by combining requests.

Responses may come in any order; match them by request index or ID.

Not all APIs support batch processing; check API docs first.

Summary

Async batch processing sends many requests at once to save time.

It helps handle large workloads without waiting for each task.

Use batch endpoints to improve app speed and efficiency.