Batch

Batch Requests

Run up to 100 API calls in one request, in any mix of endpoints. Items run concurrently server-side and each returns its own status and body, in input order. The JSON body can be at most 1 MB. Allow up to 13 minutes for a large batch to finish.

Batching is free: each item bills under its own endpoint at its normal rate and uses that endpoint's free tier, exactly like a direct call. Items the batch could not get to return status: 0 and are never billed.

post/v1/batch

Request

  • Base URL: https://apidirect.io
  • URL: https://apidirect.io/v1/batch
  • Auth: API key in header X-API-Key

Request body

Example request

{
  "requests": [
    {
      "endpoint": "/v1/twitter/user",
      "params": {
        "username": "naval"
      }
    }
  ]
}

Response

Per-item results. Check each item's status: one item failing never fails the batch.

Changes

No recorded changes to this operation across all 1 revision of this API.