Skip to main content
POST
/
api
/
publicapi
/
v1
/
catalogs
/
{catalogId}
/
records
Adds records to the specified catalog
curl --request POST \
  --url https://vantage-us.abbyy.com/api/publicapi/v1/catalogs/{catalogId}/records \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
[
  {
    "id": "<string>",
    "fields": {}
  }
]
'
{
  "insertedRowCount": 123,
  "errorRows": {}
}

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.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
catalogId
string
required

Catalog identifier. You can find it in the list of all catalogs.

Body

Records to add

Required array length: 1 - 5000 elements
​
id
string
required

Unique id of the record

Minimum string length: 1
​
fields
object
required

Record fields

Response

Operation completed successfully. The details can be found in the response.

​
insertedRowCount
integer<int32>
required

Number of successfully inserted rows

​
errorRows
object
required

List of the errors occurred