Skip to main content
Use the Vantage API to manage data catalogs programmatically. You can list catalogs, inspect their structure, add records, reindex after changes, and delete records.

​
List and inspect data catalogs

  • List all available data catalogs (reference):
  • Get detailed information about a specific data catalog, including its column structure (reference):

​
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 (reference):
2

Reindex

After the updates are complete, reindex the catalog so new data becomes searchable. Without this reindex request, searches return data from the outdated version of the data catalog. Send the request (reference):
3

Check reindex status

Send a GET request with the operation ID returned from the reindex request, and poll until the operation completes (reference):
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):
  • Delete every record from a data catalog while keeping the catalog and its column structure (reference):
Deletions cannot be undone. After deleting records, reindex the catalog so that skills stop matching against the removed data.

​
API reference

For request and response details of every catalog endpoint, see the Catalogs and CatalogRecords sections of the Vantage API reference.