Enrich a single place synchronously

POST /place_enrichment/enrich

Enrich a single place synchronously

cURL

curl --request POST \
  --url https://api.repromptai.com/v1/{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

import requests

url = "https://api.repromptai.com/v1/{org}/place_enrichment/enrich"

payload = {
    "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"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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'
    }
  })
};

fetch('https://api.repromptai.com/v1/{org}/place_enrichment/enrich', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

200

{
  "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": "[phone]",
    "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

Show child attributes

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

200

application/json

Successfully enriched place data

place_id · string · required

status · string · required

job_metadata · JobMetadata · object · required

Show child attributes

inputs · Inputs · object · required

Show child attributes

outputs · object · required

reasoning · object · required

confidence_scores · JobConfidenceScores · object

Confidence scores for various attributes

Show child attributes