Skip to main content
POST
/
api
/
v1
/
batches
curl -X POST https://nearnode.io/api/v1/batches \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "label": "Q1 2026 Business Cards",
    "prefix": "VID-2026",
    "quantity": 100,
    "function_type": "vcard",
    "base_payload": {
      "organization": "VidiaI",
      "website": "https://vidiai.ch"
    }
  }'

{
  "data": {
    "id": "batch_xyz789...",
    "label": "Q1 2026 Business Cards",
    "prefix": "VID-2026",
    "quantity": 100,
    "status": "generating",
    "manifest_url": null
  }
}

​
Body

​
label
string
required
Human-readable batch name (e.g., “Q1 2026 Business Cards”).
​
prefix
string
required
Serial ID prefix (e.g., “VID-2026”). Nodes will be numbered VID-2026-001, VID-2026-002, etc.
​
quantity
integer
required
Number of nodes to generate (max 500).
​
function_type
string
required
The function type for all nodes. One of redirect, vcard, wifi, microsite.
​
base_payload
object
Default payload applied to all generated nodes.
​
template_id
string
Optional template ID to bind all nodes to a template.
curl -X POST https://nearnode.io/api/v1/batches \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "label": "Q1 2026 Business Cards",
    "prefix": "VID-2026",
    "quantity": 100,
    "function_type": "vcard",
    "base_payload": {
      "organization": "VidiaI",
      "website": "https://vidiai.ch"
    }
  }'

{
  "data": {
    "id": "batch_xyz789...",
    "label": "Q1 2026 Business Cards",
    "prefix": "VID-2026",
    "quantity": 100,
    "status": "generating",
    "manifest_url": null
  }
}
Batch generation is asynchronous. Poll the batch status or set up a webhook to receive a batch.completed event when all nodes are ready.