Skip to main content
POST
/
place_enrichment
/
batches
curl --request POST \
--url https://api.repromptai.com/v1/{org}/place_enrichment/batches \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"batch_id": "d98e206f-ff1d-4b5a-b0d8-18fff0757fef",
"batch_name": "NYC Restaurants March 2024",
"jobs": [
{
"place_id": "place_nyc_123",
"inputs": {
"name": "Joes Pizza",
"latitude": 40.7359,
"longitude": -73.9911,
"full_address": "7 Carmine St, New York, NY 10014"
}
}
],
"attribute_set": "core",
"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": []
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

apiKey
string | null

Body

application/json
batch_name
string
required

The name of the batch. Only for display purposes. Recommended to use a descriptive human readable name.

jobs
PlaceJob · object[]
required

List of jobs to process. Maximum of 50,000 jobs per batch.

batch_id
string | null

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.

attribute_set
enum<string> | null

Specifies the set of attributes to enrich. Defines the set of attributes to enrich for a place.

Available options:
open_closed,
core,
all
attributes
string[] | null

Specifies the list of attributes to enrich. If this is specified it will override the attribute_set. You cannot specify both.

kick_off_jobs_now
boolean
default:true

Flag to determine if jobs should be kicked off immediately. Only for internal use.

Response

Successfully submitted batch for processing

Represents the response when submitting a new batch of places for enrichment

id
string
required

Unique identifier for tracking the batch

Example:

"batch_2024_03_15_123456"

batch_name
string
required

User-provided name to identify the batch

Example:

"NYC Restaurants March 2024"

jobs
object
required
status
enum<string>

Current processing status of the batch. Initially PENDING, changes to IN_PROGRESS when processing starts

Available options:
pending,
queued,
in_progress,
completed,
failed
metadata
null

Batch statistics and metadata. Basic stats available to all organizations, detailed stats only for Reprompt.

I