Skip to main content
POST
/
place_enrichment
/
enrich
Enrich a single place synchronously
curl --request POST \
  --url https://reprompt-mikhail--reprompt-fastapi-fastapi-app-dev.modal.run/{org}/place_enrichment/enrich \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "place_id": "place_nyc_123",
  "inputs": {
    "country_code": "US",
    "full_address": "7 Carmine St, New York, NY 10014",
    "latitude": 40.7359,
    "longitude": -73.9911,
    "name": "Joe's Pizza"
  }
}
EOF
{
  "place_id": "place_nyc_123",
  "status": "completed",
  "inputs": {
    "name": "Joe's Pizza",
    "latitude": 40.7359,
    "longitude": -73.9911,
    "full_address": "7 Carmine St, New York, NY 10014"
  },
  "outputs": {
    "website": "https://www.joespizzanyc.com",
    "phone": "+12122555803",
    "social_profiles": {
      "instagram": "joespizzanyc",
      "facebook": "joespizzanyc"
    },
    "open_closed_status": "Open",
    "price_tier": "$$",
    "last_enriched": "2024-03-15T10:35:00Z"
  },
  "job_metadata": {
    "last_enriched": "2024-03-15T10:35:00Z",
    "attribute_status": {
      "website": "RUN",
      "phone": "RUN",
      "address": "RUN",
      "name": "RUN"
    }
  }
}

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
​
place_id
string
required

The customer-identifier for the place and retained as external_customer_id in the database. When not set, will automatically generate a UUID.

Example:

"place_nyc_123"

​
inputs
UniversalPlace · object
required

The place to enrich

Example:
{
  "country_code": "US",
  "full_address": "7 Carmine St, New York, NY 10014",
  "latitude": 40.7359,
  "longitude": -73.9911,
  "name": "Joe's Pizza"
}
​
attributes
string[] | null

List of attribute keys to enrich. See GET /{org_slug}/place_enrichment/attributes_internal for available keys and their required inputs. If both attribute_set and attributes are provided, attributes takes precedence.

Example:
[
  "websites",
  "categories",
  "closed_permanently"
]
​
attribute_set
enum<string> | null

Specifies the set of attributes to enrich

Available options:
open_closed,
core,
all
​
attributes_enrichments
Attributes Enrichments · object[] | null
​
refresh
boolean
default:false

If true, will force a refresh of the place even if it has already been enriched.

Response

Successfully enriched place data

​
place_id
string
required
​
status
string
required
​
job_metadata
JobMetadata · object
required
​
inputs
Inputs · object
required
​
outputs
object
required
​
reasoning
object
required
​
confidence_scores
JobConfidenceScores · object

Confidence scores for various attributes