Skip to main content
You can use data catalogs via the Vantage API as follows:
  • To get a list of all available data catalogs, send a GET request to the catalogs resource as follows: 
    GET https://your-instance.vantage.abbyy.com/api/publicapi/v1/catalogs
  • To get detailed information about a data catalog, send a GET request to the catalogs/ resource as follows: 
    GET https://your-instance.vantage.abbyy.com/api/publicapi/v1/catalogs/{catalogId}
  • To see values that are identical for both the data catalog columns and the skill fields, send the following request: 
    GET https://your-instance.vantage.abbyy.com/api/publicapi/v1/{skillId}/catalogsMapping

​
Updating data catalogs using the Vantage API

To update a data catalog with data in JSON format, do the following:
  1. To add a record to a data catalog, send a POST request to the records resource as follows: 
    POST https://your-instance.vantage.abbyy.com/api/publicapi/v1/catalogs/{catalogId}/records
  2. Once you have finished updating a data catalog, it will need to be indexed for your newly added data to become searchable. To do this, send a POST request to the catalogs/ resource as follows: 
    POST https://your-instance.vantage.abbyy.com/api/publicapi/v1/catalogs/{catalogId}/reindex
    Important! If you do not send the above request, your searches will return data from the outdated version of the data catalog.
  3. To find out the status of the indexing operation, send the following request: 
    POST https://your-instance.vantage.abbyy.com/api/publicapi/v1/catalogs/{catalogId}/reindex/reindexOperationId/download
Once the data catalog has been populated with data and indexed, the skill can be applied to documents. To delete all records, send the following request: 
POST https://your-instance.vantage.abbyy.com/api/publicapi/v1/catalogs/{catalogId}/records/delete/download
For more information about the Vantage API, see the Swagger documentation.