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:

  GET https://your-instance.vantage.abbyy.com/api/publicapi/v1/catalogs
  

• Get detailed information about a specific data catalog:

  GET https://your-instance.vantage.abbyy.com/api/publicapi/v1/catalogs/{catalogId}
  

• Get the mapping between a skill’s fields and a data catalog’s columns:

  GET https://your-instance.vantage.abbyy.com/api/publicapi/v1/{skillId}/catalogsMapping
  

Update a data catalog

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

1. Add records

   Send a POST request to the records resource:

   POST https://your-instance.vantage.abbyy.com/api/publicapi/v1/catalogs/{catalogId}/records
   
2. Reindex

   Once updates are complete, reindex the catalog so new data becomes searchable:

   POST https://your-instance.vantage.abbyy.com/api/publicapi/v1/catalogs/{catalogId}/reindex
   

   Without this reindex request, searches return data from the outdated version of the data catalog.

3. Check reindex status

   Use the operation ID returned from the reindex request to check status:

   POST https://your-instance.vantage.abbyy.com/api/publicapi/v1/catalogs/{catalogId}/reindex/reindexOperationId/download
   

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

Delete all records

Remove every record from a data catalog:

POST https://your-instance.vantage.abbyy.com/api/publicapi/v1/catalogs/{catalogId}/records/delete/download

API reference

For the full Vantage API reference, see the Swagger documentation.

Related topics

• Using data catalogs
• Create data catalogs
• Update data catalogs
• Create data catalog lookup rules