Get enrichment jobs

curl --request GET \
  --url https://api.repromptai.com/v1/{org}/place_enrichment/jobs \
  --header 'Authorization: Bearer <token>'

{
  "jobs": [
    {
      "place_id": "<string>",
      "status": "<string>",
      "job_metadata": {
        "attribute_status": {},
        "last_enriched": "2023-11-07T05:31:56Z",
        "enrichment_metadata": {},
        "country_code": "<string>"
      },
      "inputs": {
        "type": "<unknown>"
      },
      "outputs": {},
      "reasoning": {},
      "confidence_scores": {
        "open_closed_status": "VERY_HIGH",
        "phone": "VERY_HIGH",
        "website": "VERY_HIGH",
        "address": "VERY_HIGH",
        "categories": "VERY_HIGH",
        "opening_hours": "VERY_HIGH",
        "entity_type": "VERY_HIGH",
        "name": "VERY_HIGH",
        "parking_spaces": "VERY_HIGH",
        "parking_spaces_total": "VERY_HIGH",
        "parking_spaces_street": "VERY_HIGH",
        "parking_spaces_shared": "VERY_HIGH",
        "parking_spaces_dedicated": "VERY_HIGH",
        "chain": "VERY_HIGH",
        "tiktok": "VERY_HIGH",
        "price_tier": "VERY_HIGH",
        "approximate_user_reviews": "VERY_HIGH",
        "menu": "VERY_HIGH",
        "school_geofence": "VERY_HIGH"
      }
    }
  ],
  "total": 123,
  "limit": 123,
  "offset": 123
}

GET

place_enrichment

jobs

Get enrichment jobs

curl --request GET \
  --url https://api.repromptai.com/v1/{org}/place_enrichment/jobs \
  --header 'Authorization: Bearer <token>'

{
  "jobs": [
    {
      "place_id": "<string>",
      "status": "<string>",
      "job_metadata": {
        "attribute_status": {},
        "last_enriched": "2023-11-07T05:31:56Z",
        "enrichment_metadata": {},
        "country_code": "<string>"
      },
      "inputs": {
        "type": "<unknown>"
      },
      "outputs": {},
      "reasoning": {},
      "confidence_scores": {
        "open_closed_status": "VERY_HIGH",
        "phone": "VERY_HIGH",
        "website": "VERY_HIGH",
        "address": "VERY_HIGH",
        "categories": "VERY_HIGH",
        "opening_hours": "VERY_HIGH",
        "entity_type": "VERY_HIGH",
        "name": "VERY_HIGH",
        "parking_spaces": "VERY_HIGH",
        "parking_spaces_total": "VERY_HIGH",
        "parking_spaces_street": "VERY_HIGH",
        "parking_spaces_shared": "VERY_HIGH",
        "parking_spaces_dedicated": "VERY_HIGH",
        "chain": "VERY_HIGH",
        "tiktok": "VERY_HIGH",
        "price_tier": "VERY_HIGH",
        "approximate_user_reviews": "VERY_HIGH",
        "menu": "VERY_HIGH",
        "school_geofence": "VERY_HIGH"
      }
    }
  ],
  "total": 123,
  "limit": 123,
  "offset": 123
}

Authorizations

Authorization

string

header

required

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

Headers

apiKey

string | null

Query Parameters

batchId

string | null

limit

integer

default:10000

offset

integer

default:0

Response

200 - application/json

Successful Response

jobs

PlaceJobResult · object[]

required

Show child attributes

jobs.place_id

string

required

jobs.status

string

required

jobs.job_metadata

JobMetadata · object

required

Show child attributes

jobs.job_metadata.attribute_status

Attribute Status · object

required

Show child attributes

jobs.job_metadata.attribute_status.{key}

enum<string>

Available options:

NOT FOUND,

ADDED,

VERIFIED,

CORRECTED,

NOT VERIFIED,

NOT ENRICHED,

RUN,

RUN_CONDITION_FAILED,

ERROR,

NOT_RUN

jobs.job_metadata.last_enriched

string<date-time> | null

Timestamp of the last enrichment

jobs.job_metadata.enrichment_metadata

Enrichment Metadata · object

Show child attributes

jobs.job_metadata.enrichment_metadata.{key}

object

jobs.job_metadata.country_code

string | null

jobs.inputs

Inputs · object

required

Show child attributes

jobs.inputs.type

any

jobs.outputs

object

required

jobs.reasoning

object

required

jobs.confidence_scores

JobConfidenceScores · object

Confidence scores for various attributes

Show child attributes

jobs.confidence_scores.open_closed_status

enum<string> | null

Confidence score for the open/closed status of a place. VERY_HIGH (95% accuracy) indicates extremely reliable open/closed status. HIGH (90% accuracy) indicates very reliable status. MEDIUM (80% accuracy) indicates reasonably reliable status. LOW (70% accuracy) indicates limited online evidence but likely correct status.NONE indicates insufficient evidence to determine status. This happens when a place has no internet presence at all.

Available options:

VERY_HIGH,

HIGH,

MEDIUM,

LOW,

NONE

jobs.confidence_scores.phone

enum<string> | null

Available options:

VERY_HIGH,

HIGH,

MEDIUM,

LOW,

NONE

jobs.confidence_scores.website

enum<string> | null

Available options:

VERY_HIGH,

HIGH,

MEDIUM,

LOW,

NONE

jobs.confidence_scores.address

enum<string> | null

Available options:

VERY_HIGH,

HIGH,

MEDIUM,

LOW,

NONE

jobs.confidence_scores.categories

enum<string> | null

Available options:

VERY_HIGH,

HIGH,

MEDIUM,

LOW,

NONE

jobs.confidence_scores.opening_hours

enum<string> | null

Available options:

VERY_HIGH,

HIGH,

MEDIUM,

LOW,

NONE

jobs.confidence_scores.entity_type

enum<string> | null

Available options:

VERY_HIGH,

HIGH,

MEDIUM,

LOW,

NONE

jobs.confidence_scores.name

enum<string> | null

Available options:

VERY_HIGH,

HIGH,

MEDIUM,

LOW,

NONE

jobs.confidence_scores.parking_spaces

enum<string> | null

Available options:

VERY_HIGH,

HIGH,

MEDIUM,

LOW,

NONE

jobs.confidence_scores.parking_spaces_total

enum<string> | null

Available options:

VERY_HIGH,

HIGH,

MEDIUM,

LOW,

NONE

jobs.confidence_scores.parking_spaces_street

enum<string> | null

Available options:

VERY_HIGH,

HIGH,

MEDIUM,

LOW,

NONE

jobs.confidence_scores.parking_spaces_shared

enum<string> | null

Available options:

VERY_HIGH,

HIGH,

MEDIUM,

LOW,

NONE

jobs.confidence_scores.parking_spaces_dedicated

enum<string> | null

Available options:

VERY_HIGH,

HIGH,

MEDIUM,

LOW,

NONE

jobs.confidence_scores.chain

enum<string> | null

Available options:

VERY_HIGH,

HIGH,

MEDIUM,

LOW,

NONE

jobs.confidence_scores.tiktok

enum<string> | null

Available options:

VERY_HIGH,

HIGH,

MEDIUM,

LOW,

NONE

jobs.confidence_scores.price_tier

enum<string> | null

Available options:

VERY_HIGH,

HIGH,

MEDIUM,

LOW,

NONE

jobs.confidence_scores.approximate_user_reviews

enum<string> | null

Available options:

VERY_HIGH,

HIGH,

MEDIUM,

LOW,

NONE

Available options:

VERY_HIGH,

HIGH,

MEDIUM,

LOW,

NONE

jobs.confidence_scores.school_geofence

enum<string> | null

Confidence score for school geofence data. HIGH indicates OSM-based geofence with reliable school boundary data. MEDIUM indicates parcel-based geofence using property data analysis. NONE indicates no data

Available options:

VERY_HIGH,

HIGH,

MEDIUM,

LOW,

NONE

total

integer

required

Total number of jobs available

limit

integer

required

Number of jobs per page

offset

integer

required

Starting position of the current page

Enrich a single place synchronously

Submit a single enrichment job

⌘I

API Reference

Guides

Get enrichment jobs

Authorizations

Headers

Query Parameters

Response