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

# Data catalogs and the Vantage API

> List, inspect, update, reindex, and delete data catalog records via the Vantage API.

Manage data catalogs programmatically using the Vantage API: list catalogs, inspect their structure, add records, reindex after changes, and delete records.

## List and inspect data catalogs

* List all available data catalogs ([reference](/api-reference/catalogs/lists-all-available-catalogs)):

  <CodeGroup>
    ```text US theme={null}
    GET https://vantage-us.abbyy.com/api/publicapi/v1/catalogs
    ```

    ```text EU theme={null}
    GET https://vantage-eu.abbyy.com/api/publicapi/v1/catalogs
    ```

    ```text AU theme={null}
    GET https://vantage-au.abbyy.com/api/publicapi/v1/catalogs
    ```
  </CodeGroup>

* Get detailed information about a specific data catalog, including its column structure ([reference](/api-reference/catalogs/gets-detailed-information-about-the-catalog)):

  <CodeGroup>
    ```text US theme={null}
    GET https://vantage-us.abbyy.com/api/publicapi/v1/catalogs/{catalogId}
    ```

    ```text EU theme={null}
    GET https://vantage-eu.abbyy.com/api/publicapi/v1/catalogs/{catalogId}
    ```

    ```text AU theme={null}
    GET https://vantage-au.abbyy.com/api/publicapi/v1/catalogs/{catalogId}
    ```
  </CodeGroup>

## Update a data catalog

Use the following endpoints to update a data catalog with JSON records.

<Steps>
  <Step title="Add records">
    Send a **POST** request to the **records** resource ([reference](/api-reference/catalogrecords/adds-records-to-the-specified-catalog)):

    <CodeGroup>
      ```text US theme={null}
      POST https://vantage-us.abbyy.com/api/publicapi/v1/catalogs/{catalogId}/records
      ```

      ```text EU theme={null}
      POST https://vantage-eu.abbyy.com/api/publicapi/v1/catalogs/{catalogId}/records
      ```

      ```text AU theme={null}
      POST https://vantage-au.abbyy.com/api/publicapi/v1/catalogs/{catalogId}/records
      ```
    </CodeGroup>
  </Step>

  <Step title="Reindex">
    Once updates are complete, reindex the catalog so new data becomes searchable ([reference](/api-reference/catalogs/starts-a-catalog-reindex-operation)):

    <CodeGroup>
      ```text US theme={null}
      POST https://vantage-us.abbyy.com/api/publicapi/v1/catalogs/{catalogId}/reindex
      ```

      ```text EU theme={null}
      POST https://vantage-eu.abbyy.com/api/publicapi/v1/catalogs/{catalogId}/reindex
      ```

      ```text AU theme={null}
      POST https://vantage-au.abbyy.com/api/publicapi/v1/catalogs/{catalogId}/reindex
      ```
    </CodeGroup>

    <Warning>
      Without this reindex request, searches return data from the outdated version of the data catalog.
    </Warning>
  </Step>

  <Step title="Check reindex status">
    Send a **GET** request with the operation ID returned from the reindex request, and poll until the operation completes ([reference](/api-reference/catalogs/gets-detailed-information-of-reindex-operation)):

    <CodeGroup>
      ```text US theme={null}
      GET https://vantage-us.abbyy.com/api/publicapi/v1/catalogs/{catalogId}/reindex/{reindexOperationId}
      ```

      ```text EU theme={null}
      GET https://vantage-eu.abbyy.com/api/publicapi/v1/catalogs/{catalogId}/reindex/{reindexOperationId}
      ```

      ```text AU theme={null}
      GET https://vantage-au.abbyy.com/api/publicapi/v1/catalogs/{catalogId}/reindex/{reindexOperationId}
      ```
    </CodeGroup>
  </Step>
</Steps>

After indexing completes, the catalog is ready for use by Document skills.

## Delete records

* Delete specific records (up to 5000 per request) by passing their identifiers in the request body ([reference](/api-reference/catalogrecords/deletes-the-specified-records-from-the-catalog)):

  <CodeGroup>
    ```text US theme={null}
    POST https://vantage-us.abbyy.com/api/publicapi/v1/catalogs/{catalogId}/records/delete
    ```

    ```text EU theme={null}
    POST https://vantage-eu.abbyy.com/api/publicapi/v1/catalogs/{catalogId}/records/delete
    ```

    ```text AU theme={null}
    POST https://vantage-au.abbyy.com/api/publicapi/v1/catalogs/{catalogId}/records/delete
    ```
  </CodeGroup>

* Delete every record from a data catalog while keeping the catalog and its column structure ([reference](/api-reference/catalogs/deletes-all-records-from-the-catalog)):

  <CodeGroup>
    ```text US theme={null}
    POST https://vantage-us.abbyy.com/api/publicapi/v1/catalogs/{catalogId}/clear
    ```

    ```text EU theme={null}
    POST https://vantage-eu.abbyy.com/api/publicapi/v1/catalogs/{catalogId}/clear
    ```

    ```text AU theme={null}
    POST https://vantage-au.abbyy.com/api/publicapi/v1/catalogs/{catalogId}/clear
    ```
  </CodeGroup>

<Warning>
  Deletions cannot be undone. After deleting records, reindex the catalog so that skills stop matching against the removed data.
</Warning>

## API reference

For request and response details of every catalog endpoint, see the **Catalogs** and **CatalogRecords** sections of the [Vantage API reference](/api-reference/catalogs/lists-all-available-catalogs).

## Related topics

* [Using data catalogs](/vantage/documentation/skill-designer/document/using-data-catalogs/use)
* [Create data catalogs](/vantage/documentation/skill-designer/document/using-data-catalogs/create)
* [Update data catalogs](/vantage/documentation/skill-designer/document/using-data-catalogs/update)
* [Create data catalog lookup rules](/vantage/documentation/skill-designer/document/rule-verification/setting-lookup-rules)