batches

Embed
Preview of the card
<a href="https://hermeticor.com/docs/ref-batches"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/98ef587f-6b71-4b97-90c4-ac7ae9280219/social-card.svg?v=3e7ae33eec8b" alt="batches" width="600" height="315"></a>
GEThttps://hermeticor.com/v1/batches

Parameters

limitintegerquery
= 50
cursorstringquery

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/batches" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "status": "queued",
      "total": 0,
      "succeeded": 0,
      "failed": 0,
      "pending": 0,
      "stopOnError": true,
      "createdAt": "2024-01-01T00:00:00Z",
      "startedAt": "2024-01-01T00:00:00Z",
      "finishedAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsPostV1BatchesResponse[]required
Show child parameters
idstringrequired
statusstringrequired
queued | running | finished | cancelled
totalintegerrequired
succeededintegerrequired
failedintegerrequired
pendingintegerrequired
stopOnErrorbooleanrequired
createdAtstringrequired
startedAtstringrequired
finishedAtstringrequired
nextCursorstringrequired
4XX Default Response
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
detailsobject
5XX Default Response

Same as 4XX · GET /v1/batches

POSThttps://hermeticor.com/v1/batches

Queue up to 1,000 API calls; they run in order in the background (not atomic). Poll the batch or subscribe to batch.finished

Request body

application/json
operationsobject[]required
Show child parameters
methodstringrequired
GET | POST | PUT | PATCH | DELETE
pathstringrequired
body
stopOnErrorboolean
= false
idempotencyKeystring
{
  "operations": [
    {
      "method": "GET",
      "path": "string",
      "body": {}
    }
  ],
  "stopOnError": false,
  "idempotencyKey": "string"
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/batches" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"operations":[{"method":"GET","path":"string","body":{}}],"stopOnError":false,"idempotencyKey":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

202 Default Response
Example
{
  "id": "string",
  "status": "queued",
  "total": 0,
  "succeeded": 0,
  "failed": 0,
  "pending": 0,
  "stopOnError": true,
  "createdAt": "2024-01-01T00:00:00Z",
  "startedAt": "2024-01-01T00:00:00Z",
  "finishedAt": "2024-01-01T00:00:00Z"
}
Schema
idstringrequired
statusstringrequired
queued | running | finished | cancelled
totalintegerrequired
succeededintegerrequired
failedintegerrequired
pendingintegerrequired
stopOnErrorbooleanrequired
createdAtstringrequired
startedAtstringrequired
finishedAtstringrequired
4XX Default Response

Same as 4XX · GET /v1/batches

5XX Default Response

Same as 4XX · GET /v1/batches

GEThttps://hermeticor.com/v1/batches/{id}

Parameters

idstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/batches/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 202 · POST /v1/batches

4XX Default Response

Same as 4XX · GET /v1/batches

5XX Default Response

Same as 4XX · GET /v1/batches

DELETEhttps://hermeticor.com/v1/batches/{id}

Cancel: calls not yet run are skipped (one already in flight completes)

Parameters

idstringpathrequired

Code samples

cURL
curl -X DELETE "https://hermeticor.com/v1/batches/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 202 · POST /v1/batches

4XX Default Response

Same as 4XX · GET /v1/batches

5XX Default Response

Same as 4XX · GET /v1/batches

GEThttps://hermeticor.com/v1/batches/{id}/results

Each call's status and response body, in call order (page with `after`)

Parameters

afterintegerquery
= -1
limitintegerquery
= 200
idstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/batches/{id}/results" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "index": 0,
      "method": "string",
      "path": "string",
      "status": "pending",
      "responseStatus": 0,
      "body": {},
      "finishedAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextAfter": 0
}
Schema
itemsobject[]required
Show child parameters
indexintegerrequired
methodstringrequired
pathstringrequired
statusstringrequired
pending | succeeded | failed | cancelled
responseStatusintegerrequired
bodyrequired
finishedAtstringrequired
nextAfterintegerrequired
4XX Default Response

Same as 4XX · GET /v1/batches

5XX Default Response

Same as 4XX · GET /v1/batches

Updated