Skip to main content

Endpoint

This endpoint creates a bulk job that fans out template-based tent generations across multiple items.
POST /v1/tents/bulk is an async admission endpoint. The immediate response confirms which items were accepted or rejected and returns a bulk_job_id for polling.

Request Body

Top-Level Fields

Item Fields

Each item must provide at least one of input_data or instructions.

Important Rules

  • All items in one bulk request use the same template_id
  • The template must exist in the same workspace as the API key
  • The template must already be approved and have approved content available
  • Tented generates every tent_id; callers cannot supply or override it
  • Bulk requests support partial success. Some items can be accepted while others are rejected
  • auto_publish is batch-wide, but each item can still request its own custom_page_alias

Request Example

Instructions-Only Example

When you do not need structured template variables, you can omit input_data and use instructions alone:
Each item must provide at least one of input_data or instructions. You can provide both; input_data is applied first and instructions are treated as additional guidance.

Response Example

202 Accepted

Partial Success

Bulk requests are not all-or-nothing. Individual items can be rejected during admission while the rest of the batch proceeds.
Possible item-level rejection codes include:
  • INVALID_ITEM
  • NOT_FOUND
  • INSUFFICIENT_CREDITS

Naming Behavior

If an item omits tent_name, Tented generates a name using:
  • default_tent_name_prefix when provided
  • otherwise client_job_descriptor when provided
  • otherwise Bulk Tent
The generated counter starts at start_index and is rendered as Prefix (N).

Auto-Publish Behavior

Set top-level auto_publish to true to publish all accepted items after generation succeeds. Each item can optionally request a different custom_page_alias. Alias rules match POST /v1/tents:
  • Maximum 100 characters
  • Lowercase letters, numbers, hyphens, underscores, and dots only
  • Must start with a letter or number
  • Must not be a UUID
  • Must not use reserved words such as api, admin, submit, or assets
  • Use / to publish at the domain root
custom_page_alias requires top-level auto_publish: true. If auto_publish is false, the affected item is rejected during admission.

Polling For Results

Use the returned bulk_job_id with GET /v1/bulk-jobs/{bulkJobId} to track aggregate progress and read final published URLs.

Next: Retrieve Bulk Job Status

Poll the bulk job until all accepted items complete or fail.