> ## Documentation Index
> Fetch the complete documentation index at: https://docs.repromptai.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Supercharge place data with Reprompt

## 1. Enrich place data

If you already have place data, you can enrich it with over 40 attributes using Reprompt

* [Live Enrichment API](#2-live-enrichment)
* [Batch Processing API](#5-batch-processing)

<Note>
  **Don't have place data yet?** You can experiment with csv data and custom AI attributes in our [Workbooks](https://app.repromptai.com/workbooks).
</Note>

***

## 2. Live Enrichment

Let's enrich a single place with basic information. The `inputs` object requires a place **name** along with either **coordinates (latitude/longitude)** or an **address**.

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST \
    'https://api.repromptai.com/v1/{org_slug}/place_enrichment/enrich' \
    -H 'Authorization: Bearer {YOUR_API_KEY}' \
    -H 'Content-Type: application/json' \
    -d '{
      "place_id": "my_place_123",
      "inputs": {
        "name": "Joe'\''s Pizza",
        "latitude": 40.7359,
        "longitude": -73.9911,
        "full_address": "7 Carmine St, New York, NY 10014"
      },
      "attributes": ["websites", "phoneNumbers", "openingHours", "closed_permanently"]
    }'
  ```

  ```python Python theme={null}
  import requests

  url = "https://api.repromptai.com/v1/{org_slug}/place_enrichment/enrich"
  headers = {
      "Authorization": "Bearer {YOUR_API_KEY}",
      "Content-Type": "application/json"
  }

  data = {
      "place_id": "my_place_123",
      "inputs": {
          "name": "Joes Pizza",
          "latitude": 40.7359,
          "longitude": -73.9911,
          "full_address": "7 Carmine St, New York, NY 10014"
      },
      "attributes": ["websites", "phoneNumbers", "openingHours", "closed_permanently"]
  }

  response = requests.post(url, headers=headers, json=data)
  result = response.json()
  print(result)
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch('https://api.repromptai.com/v1/{org_slug}/place_enrichment/enrich', {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer {YOUR_API_KEY}',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      place_id: "my_place_123",
      inputs: {
        name: "Joes Pizza",
        latitude: 40.7359,
        longitude: -73.9911,
        full_address: "7 Carmine St, New York, NY 10014"
      },
      attributes: ["websites", "phoneNumbers", "openingHours", "closed_permanently"]
    })
  });

  const result = await response.json();
  console.log(result);
  ```
</CodeGroup>

Replace `{org_slug}` with your actual organization slug. The API key variable will be automatically populated.

<Tip>
  **Include a `place_id`**: The `place_id` field is required at the top level of your request (alongside `inputs`, not inside it). We recommend providing your own stable identifier (like your database ID). This makes it easy to join enriched results back to your data.
</Tip>

### Input Flexibility

The `inputs` object accepts different combinations:

**Option 1: Name + Coordinates**

```json theme={null}
{
  "place_id": "my_place_123",
  "inputs": {
    "name": "Joes Pizza",
    "latitude": 40.7359,
    "longitude": -73.9911
  }
}
```

**Option 2: Name + Address**

```json theme={null}
{
  "place_id": "my_place_123",
  "inputs": {
    "name": "Joes Pizza",
    "full_address": "7 Carmine St, New York, NY 10014"
  }
}
```

**Option 3: Name + Address + Coordinates (Most accurate)**

```json theme={null}
{
  "place_id": "my_place_123",
  "inputs": {
    "name": "Joes Pizza",
    "latitude": 40.7359,
    "longitude": -73.9911,
    "full_address": "7 Carmine St, New York, NY 10014"
  }
}
```

Providing more input fields (e.g. `full_address` together with coordinates, or `type`, `country_code`, `website`) helps our systems resolve and enrich the place more accurately. For the full list of supported fields and guidance, see [Input Place Schema](/schemas/schemas#input-place-schema).

***

## 3. Understanding the Response

The API will return enriched data about the place, including your `place_id` for easy joining:

```json theme={null}
{
  "place_id": "my_place_123",
  "status": "completed",
  "inputs": {
    "name": "Joe's Pizza",
    "latitude": 40.7359,
    "longitude": -73.9911,
    "full_address": "7 Carmine St, New York, NY 10014"
  },
  "outputs": {
    "websites": ["https://www.joespizzanyc.com"],
    "phoneNumbers": ["+12122555803"],
    "openingHours": {
      "monday": "10:00-2:00",
      "tuesday": "10:00-2:00"
    },
    "closed_permanently": false
  },
  "job_metadata": {
    "last_enriched": "2024-03-15T10:35:00Z",
    "attribute_status": {
      "websites": "RUN",
      "phoneNumbers": "RUN",
      "openingHours": "RUN",
      "closed_permanently": "RUN"
    }
  }
}
```

## 4. Available Attributes

Specify exactly which attributes you want to enrich using the `attributes` array. Common attributes include:

| Attribute            | Description                                      |
| -------------------- | ------------------------------------------------ |
| `websites`           | Business website URLs                            |
| `phoneNumbers`       | Phone numbers                                    |
| `socialHandles`      | Social media handles (Instagram, Facebook, etc.) |
| `closed_permanently` | Whether the business is permanently closed       |
| `price_tier`         | Price range (e.g., \$, \$\$, \$\$\$)             |
| `categories`         | Business categories                              |
| `openingHours`       | Opening hours                                    |
| `names`              | Alternative names for the business               |
| `address`            | Address                                          |

You can see the entire list of attributes by calling the [Enrichment Attributes](/api-reference/attributes/get-enrichment-attributes) endpoint.

***

## 5. Batch Processing

For multiple places, use batch processing for asynchronous enrichment:

```json theme={null}
{
  "batch_name": "NYC Restaurants Batch",
  "attributes": ["websites", "phoneNumbers", "openingHours", "closed_permanently"],
  "jobs": [
    {
      "place_id": "my_db_id_456",
      "inputs": {
        "name": "Joes Pizza",
        "latitude": 40.7359,
        "longitude": -73.9911,
        "full_address": "7 Carmine St, New York, NY 10014"
      }
    },
    {
      "place_id": "my_db_id_789", 
      "inputs": {
        "name": "Tony's Deli",
        "latitude": 40.7505,
        "longitude": -73.9934,
        "full_address": "123 Main St, New York, NY 10001"
      }
    }
  ]
}
```

Submit this to the `/place_enrichment/batches` endpoint, then track progress and retrieve results using the returned batch ID. Each result will include the `place_id` you provided for easy matching back to your database.

Learn more in our [Batch Processing Guide](/guides/batch-processing).

***

## 6. Next Steps

Now that you've made your first API call, explore more:

* **[API Reference](/api-reference)** - Complete endpoint documentation
* **[Batch Processing](/guides/batch-processing)** - Process multiple places efficiently