batches

Get batch status

get/{org_slug}/place_enrichment/batches/{batch_id}

Request

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

Path parameters

org_slugstring nullable required
batch_idstring required

Query parameters

enrichmentsstring nullable

Comma-separated list of enrichment names to get status for

Headers

apiKeystring nullable

Response

Successful Response

idstring required

Unique identifier for tracking the batch

batch_namestring required

User-provided name to identify the batch

status'pending' | 'queued' | 'in_progress' | 'completed' | 'failed'
attribute_statusesobject nullable

Status distribution per attribute (only populated when enrichments query param is provided)

Example response

{
  "batch_name": "NYC Restaurants March 2024",
  "id": "batch_2024_03_15_123456",
  "jobs": {
    "completed": [],
    "failed": [],
    "in_progress": [],
    "pending": [
      "place_nyc_123",
      "place_nyc_456",
      "place_nyc_789"
    ]
  },
  "status": "pending"
}

Changes

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