VOvoygr
core

Enrich places in bulk

Changed on

Enrich up to 10,000 places asynchronously using /v1/enrich request bodies. Poll GET /v1/jobs/{batch_id} until completed, then download result.jsonl.gz: one result per input row, in order. A standard attribute the quick extraction leaves empty is also researched, at no extra charge, so rows that need it take minutes rather than seconds. Each row holds what its /v1/enrich call would cost and is charged as that call would be. A value research found counts like any other, and unused credits are released. Failed rows are free. Save batch_id and poll GET /v1/jobs/{batch_id} after acceptance. For an uncertain submission, retry promptly with the same Idempotency-Key and identical body. Replay only applies while the idempotency record is retained and the job is not cancelled. Reusing a key after cancellation or retention expiry can create new work and charges. While replay applies, a different body returns 409 IDEMPOTENCY_CONFLICT. Use a new key for new work.

post/v1/jobs/enrich

Request

  • Base URL
    https://api.voygr.tech
  • URL
    https://api.voygr.tech/v1/jobs/enrich
  • Auth
    API key in header X-API-Key

Headers

Idempotency-Keystring nullable

Request body

Example request

{
  "pois": [
    {
      "id": "bakery-001",
      "poi_name": "Example Bakery",
      "address": "123 Example Street",
      "country": "US",
      "latitude": 37.7749,
      "longitude": -122.4194,
      "attributes": [
        "opening_hours",
        "phone",
        "website"
      ]
    },
    {
      "id": "cafe-002",
      "poi_name": "Example Cafe",
      "address": "456 Sample Avenue",
      "country": "US",
      "latitude": 37.7755,
      "longitude": -122.4183,
      "attributes": [
        "opening_hours",
        "phone",
        "website"
      ]
    }
  ]
}

Response

Successful Response

batch_idstring required
type'validate' | 'enrich' nullable
status'queued' | 'running' | 'completed' | 'failed' | 'cancelled' required
created_atstring required
total_itemsinteger required
eta_secondsinteger required
eta_completion_atstring required

Changes

  • 03b7688c4c40Revision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • e8adfc0a3ec6Revision changes
    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      the request property // became optional

    • info

      the request property default value opening_hours phone website existence open_closed was removed

    • info

      request property // list-of-types was widened by adding types null to media type application/json

    • info

      request property // list-of-types was widened by adding types null to media type application/json

    • info

      the // request property's minLength was decreased from 1 to 0