jobs

Submit a single enrichment job

Submit a place for asynchronous enrichment processing.

post/{org_slug}/place_enrichment/jobs

Request

  • Base URL: https://api.repromptai.com/v1
  • URL: https://api.repromptai.com/v1/{org_slug}/place_enrichment/jobs
  • Auth: HTTP bearer

Path parameters

org_slugstring nullable required

Headers

apiKeystring nullable

Request body

place_idstring required

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

attributesstring[] nullable

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, both are merged (explicit attributes are added to the set from attribute_set).

attribute_set'open_closed' | 'core' | 'all'

Predefined attribute group presets exposed by the API.

attributes_enrichmentsEnrichments[] nullable
refreshboolean

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

Example request

{
  "place_id": "place_nyc_123",
  "inputs": {
    "country_code": "PH"
  },
  "attributes": [
    "websites",
    "categories",
    "closed_permanently"
  ]
}

Response

Successful Response

object required

Changes

No recorded changes to this operation across all 1 revision of this API.