batches

Submit a batch of places for enrichment

Submit a batch of places for enrichment

post/{org_slug}/place_enrichment/batches
Request
  • Base URL: https://api.repromptai.com/v1
  • URL: https://api.repromptai.com/v1/{org_slug}/place_enrichment/batches
  • Auth: HTTP bearer
Path parameters
org_slugstring nullable required
Headers
apiKeystring nullable
Request body 
batch_idstring nullable
Optional unique identifier for the batch. If not provided, a new UUID will be generated. If an existing batch ID is provided, new jobs will be added to that batch.
batch_namestring required
The name of the batch. Only for display purposes. Recommended to use a descriptive human readable name.
attribute_set'open_closed' | 'core' | 'all'
Predefined attribute group presets exposed by the API.
attributesstring[]  nullable
Batch-level attribute keys applied to every job (copied onto each PlaceJob; same merge rules as a single job: combined with attribute_set).
kick_off_jobs_nowboolean
When true, jobs are enqueued for immediate processing and either attributes or attribute_set must be provided. When false, the batch is created without starting processing (upload only); attributes and attribute_set are optional.
owner_idstring nullable
Example request
{
  "jobs": [
    {
      "place_id": "place_nyc_123",
      "inputs": {
        "country_code": "PH"
      },
      "attributes": [
        "websites",
        "categories",
        "closed_permanently"
      ]
    }
  ]
}
Response 
Successfully submitted batch for processing
idstring required
Unique identifier for tracking the batch
batch_namestring required
User-provided name to identify the batch
status'pending' | 'queued' | 'in_progress' | 'completed' | 'failed'
attribute_statusesobject  nullable
Status distribution per attribute (only populated when enrichments query param is provided)
Example response
{
  "batch_name": "NYC Restaurants March 2024",
  "id": "batch_2024_03_15_123456",
  "jobs": {
    "completed": [],
    "failed": [],
    "in_progress": [],
    "pending": [
      "place_nyc_123",
      "place_nyc_456",
      "place_nyc_789"
    ]
  },
  "status": "pending"
}
Changes
No recorded changes to this operation across all 1 revision of this API.