Submit a batch of places for enrichment
Submit a batch of places for enrichment
HTTPBearerAuthorizationBearer <token>apiKey?string|nullapplication/json- body
batch_id?|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_name*Batch NameThe name of the batch. Only for display purposes. Recommended to use a descriptive human readable name.
jobs*array<>List of jobs to process. Maximum of 50,000 jobs per batch.
attribute_set?|Deprecated preset applied to every job. Prefer an explicit attributes list. open_closed checks whether a place is open or permanently closed, while core and all both request closed_permanently, websites, phoneNumbers, openingHours, names, address, and categories. Merged with any explicit attributes.
attributes?array<string>|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_now?Kick Off Jobs NowWhen 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.
trueowner_id?string|nullSuccessfully submitted batch for processing
application/json- response
Represents the response when submitting a new batch of places for enrichment
id*IdUnique identifier for tracking the batch
batch_name*Batch NameUser-provided name to identify the batch
status?BatchJobStatusCurrent processing status of the batch. Initially PENDING, changes to IN_PROGRESS when processing starts
"pending""pending""queued""in_progress""completed""failed"jobs*metadata?Batch statistics and metadata. Basic stats available to all organizations, detailed stats only for Reprompt.
attribute_statuses?|Status distribution per attribute (only populated when enrichments query param is provided)
curl -X POST 'https://api.repromptai.com/v1/reprompt/place_enrichment/batches' \ -H 'Content-Type: application/json' \ -d '{ "batch_id": "d98e206f-ff1d-4b5a-b0d8-18fff0757fef", "batch_name": "NYC Restaurants March 2024", "jobs": [ { "place_id": "place_nyc_123", "inputs": { "name": "Joe'\''s Pizza", "latitude": 40.7359, "longitude": -73.9911, "full_address": "7 Carmine St, New York, NY 10014" } } ], "attributes": [ "websites", "phoneNumbers", "socialHandles", "openingHours", "categories", "closed_permanently" ], "kick_off_jobs_now": true}'{ "id": "batch_2024_03_15_123456", "batch_name": "NYC Restaurants March 2024", "status": "pending", "jobs": { "pending": [ "place_nyc_123", "place_nyc_456" ], "in_progress": [], "completed": [], "failed": [] }}