ABBYY Vantage Processing REST API

openapi: 3.0.1
servers:
- url: https://vantage-us.abbyy.com
  description: Production United States
- url: https://vantage-eu.abbyy.com
  description: Production Europe
- url: https://vantage-au.abbyy.com
  description: Production Australia
info:
  title: Vantage processing REST API
  description: 'The Vantage Processing REST API lets you process documents programmatically: create transactions, upload files,
    launch skills, monitor progress, and download results. For authentication and a first end-to-end request, see the [Getting
    started guide](/vantage/developer/getting-started).'
  version: '1.0'
  x-application-version: 1.0.0-20251028.13+6e102d0c2a7a440df9ee9615e09b3c8c333587ac
paths:
  /api/publicapi/v1/catalogs/{catalogId}/records:
    post:
      tags:
      - CatalogRecords
      summary: Adds records to the specified catalog
      description: 'Adds up to 5000 records to the data catalog in one request. Each record''s `id` is chosen by you and becomes
        the record''s identifier. The endpoint returns HTTP 200 even when records are rejected: check `insertedRowCount` and
        `errorRows` in the response. Rows are rejected individually with reasons such as `CannotBeEmpty Column: <name>` (a
        required column is missing) or `UnknownColumn Column: <name>`. After you finish updating the catalog, start a reindex
        operation so that skills search the updated data.'
      operationId: AddRecords
      parameters:
      - name: catalogId
        in: path
        description: Catalog identifier. You can find it in the list of all catalogs.
        required: true
        schema:
          type: string
      requestBody:
        description: Records to add
        content:
          application/json-patch+json:
            schema:
              maxItems: 5000
              minItems: 1
              type: array
              items:
                $ref: '#/components/schemas/Abbyy.Vantage.PublicApi.Contract.Catalogs.Requests.RecordModel'
          application/json:
            schema:
              maxItems: 5000
              minItems: 1
              type: array
              items:
                $ref: '#/components/schemas/Abbyy.Vantage.PublicApi.Contract.Catalogs.Requests.RecordModel'
          text/json:
            schema:
              maxItems: 5000
              minItems: 1
              type: array
              items:
                $ref: '#/components/schemas/Abbyy.Vantage.PublicApi.Contract.Catalogs.Requests.RecordModel'
          application/*+json:
            schema:
              maxItems: 5000
              minItems: 1
              type: array
              items:
                $ref: '#/components/schemas/Abbyy.Vantage.PublicApi.Contract.Catalogs.Requests.RecordModel'
      responses:
        '200':
          description: Operation completed successfully. The details can be found in the response.
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Abbyy.Vantage.PublicApi.Contract.Catalogs.Results.AddRecordsResultResult'
            application/json:
              schema:
                $ref: '#/components/schemas/Abbyy.Vantage.PublicApi.Contract.Catalogs.Results.AddRecordsResultResult'
            text/json:
              schema:
                $ref: '#/components/schemas/Abbyy.Vantage.PublicApi.Contract.Catalogs.Results.AddRecordsResultResult'
        '400':
          description: Wrong number of records
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
        '404':
          description: Catalog not found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
    get:
      tags:
      - CatalogRecords
      summary: Lists a portion of the records in the specified catalog
      operationId: GetRecords
      parameters:
      - name: catalogId
        in: path
        description: Catalog identifier. You can find it in the list of all catalogs.
        required: true
        schema:
          type: string
      - name: offset
        in: query
        description: Pagination offset
        schema:
          type: integer
          format: int32
          default: 0
      - name: limit
        in: query
        description: Maximum number of items to return
        schema:
          type: integer
          format: int32
          default: 1000
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Abbyy.Vantage.PublicApi.Contract.Catalogs.Results.RecordDto'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Abbyy.Vantage.PublicApi.Contract.Catalogs.Results.RecordDto'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Abbyy.Vantage.PublicApi.Contract.Catalogs.Results.RecordDto'
        '404':
          description: Not Found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
      description: Returns a page of records from the data catalog. Use the `offset` and `limit` query parameters to page
        through large catalogs. Each record contains the column values defined by the catalog structure.
  /api/publicapi/v1/catalogs/{catalogId}/records/{recordId}:
    get:
      tags:
      - CatalogRecords
      summary: Gets a record
      operationId: GetRecord
      parameters:
      - name: catalogId
        in: path
        description: Catalog identifier. You can find it in the list of all catalogs.
        required: true
        schema:
          type: string
      - name: recordId
        in: path
        description: Record identifier. You can find it in the list of records.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Abbyy.Vantage.PublicApi.Contract.Catalogs.Results.RecordDto'
            application/json:
              schema:
                $ref: '#/components/schemas/Abbyy.Vantage.PublicApi.Contract.Catalogs.Results.RecordDto'
            text/json:
              schema:
                $ref: '#/components/schemas/Abbyy.Vantage.PublicApi.Contract.Catalogs.Results.RecordDto'
        '404':
          description: Not Found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
      description: Returns a single record from the data catalog by its identifier. You can find record identifiers in the
        response of the list records request.
  /api/publicapi/v1/catalogs/{catalogId}/records/delete:
    post:
      tags:
      - CatalogRecords
      summary: Deletes the specified records from the catalog
      operationId: DeleteRecords
      parameters:
      - name: catalogId
        in: path
        description: Catalog identifier. You can find it in the list of all catalogs.
        required: true
        schema:
          type: string
      requestBody:
        description: An array of record identifiers to delete
        content:
          application/json-patch+json:
            schema:
              maxItems: 5000
              minItems: 1
              type: array
              items:
                type: string
          application/json:
            schema:
              maxItems: 5000
              minItems: 1
              type: array
              items:
                type: string
          text/json:
            schema:
              maxItems: 5000
              minItems: 1
              type: array
              items:
                type: string
          application/*+json:
            schema:
              maxItems: 5000
              minItems: 1
              type: array
              items:
                type: string
      responses:
        '200':
          description: Deletion completed. The response body is empty; unlike adding records, no per-record report is returned.
        '404':
          description: Not Found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
      description: Deletes up to 5000 records from the data catalog in one request. Pass the identifiers of the records to
        delete as a JSON array in the request body. After you finish updating the catalog, start a reindex operation so that
        skills search the updated data.
  /api/publicapi/v1/catalogs:
    get:
      tags:
      - Catalogs
      summary: Lists all available catalogs
      operationId: GetCatalogs
      responses:
        '200':
          description: All catalogs are successfully returned
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Abbyy.Vantage.PublicApi.Contract.Catalogs.Results.CatalogListItemDto'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Abbyy.Vantage.PublicApi.Contract.Catalogs.Results.CatalogListItemDto'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Abbyy.Vantage.PublicApi.Contract.Catalogs.Results.CatalogListItemDto'
      description: Returns all data catalogs available to your tenant. Use the returned `id` values as the `catalogId` in
        other catalog requests. Catalog ids are the catalog names (they can contain spaces, so URL-encode them in request
        paths). For more on managing catalogs through the API, see [Data catalogs and the Vantage API](/vantage/documentation/skill-designer/document/using-data-catalogs/use-with-api).
  /api/publicapi/v1/catalogs/{catalogId}:
    get:
      tags:
      - Catalogs
      summary: Gets detailed information about the catalog
      description: Gets detailed information about the catalog structure, e.g. required column set
      operationId: GetCatalog
      parameters:
      - name: catalogId
        in: path
        description: Catalog identifier. You can find it in the list of all catalogs.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Catalog info is successfully returned
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Abbyy.Vantage.PublicApi.Contract.Catalogs.Results.CatalogDto'
            application/json:
              schema:
                $ref: '#/components/schemas/Abbyy.Vantage.PublicApi.Contract.Catalogs.Results.CatalogDto'
            text/json:
              schema:
                $ref: '#/components/schemas/Abbyy.Vantage.PublicApi.Contract.Catalogs.Results.CatalogDto'
        '404':
          description: Catalog not found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
  /api/publicapi/v1/catalogs/{catalogId}/clear:
    post:
      tags:
      - Catalogs
      summary: Deletes all records from the catalog
      operationId: ClearCatalog
      parameters:
      - name: catalogId
        in: path
        description: Catalog identifier. You can find it in the list of all catalogs.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: All records are successfully deleted from the catalog
        '404':
          description: Catalog not found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
      description: Deletes every record from the data catalog while keeping the catalog itself and its column structure. This
        operation cannot be undone. After clearing and repopulating the catalog, start a reindex operation so that skills
        search the updated data.
  /api/publicapi/v1/catalogs/{catalogId}/reindex:
    post:
      tags:
      - Catalogs
      summary: Starts a catalog reindex operation
      description: 'Starts an asynchronous reindex of the catalog. The response contains the operation''s `id`; poll the reindex
        status endpoint with it until `currentState` is `Completed` (observed transitional value: `InProgress`). Until reindexing
        completes, skills continue to search the previous version of the catalog data.'
      operationId: StartCatalogReindex
      parameters:
      - name: catalogId
        in: path
        description: Catalog identifier. You can find it in the list of all catalogs.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Abbyy.Vantage.PublicApi.Contract.Catalogs.Results.ReindexOperationResult'
            application/json:
              schema:
                $ref: '#/components/schemas/Abbyy.Vantage.PublicApi.Contract.Catalogs.Results.ReindexOperationResult'
            text/json:
              schema:
                $ref: '#/components/schemas/Abbyy.Vantage.PublicApi.Contract.Catalogs.Results.ReindexOperationResult'
        '404':
          description: Not Found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
  /api/publicapi/v1/catalogs/{catalogId}/reindex/{reindexOperationId}:
    get:
      tags:
      - Catalogs
      summary: Gets detailed information of reindex operation
      operationId: GetReindexOperation
      parameters:
      - name: catalogId
        in: path
        description: Catalog identifier. You can find it in the list of all catalogs.
        required: true
        schema:
          type: string
      - name: reindexOperationId
        in: path
        description: Operation identifier. You can find it in response to start reindex operation.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Abbyy.Vantage.PublicApi.Contract.Catalogs.Results.ReindexOperationResult'
            application/json:
              schema:
                $ref: '#/components/schemas/Abbyy.Vantage.PublicApi.Contract.Catalogs.Results.ReindexOperationResult'
            text/json:
              schema:
                $ref: '#/components/schemas/Abbyy.Vantage.PublicApi.Contract.Catalogs.Results.ReindexOperationResult'
        '404':
          description: Not Found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
      description: Returns the status of a catalog reindex operation started with the reindex request. Poll this endpoint
        until `currentState` is `Completed` (or `Failed`). Until reindexing completes, skills continue to search the previous
        version of the catalog data.
  /api/publicapi/v1/invites:
    post:
      tags:
      - Invites
      summary: Creates invite for new tenant
      description: To access this method, you need to contact support
      operationId: CreateInvite
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                Model:
                  required:
                  - email
                  - tenantName
                  type: object
                  properties:
                    email:
                      minLength: 1
                      type: string
                      description: Email to send invite to
                      format: email
                    validWithin:
                      type: string
                      description: Time when the invite will be valid
                      nullable: true
                      example: 14.00:00:00
                    tenantName:
                      minLength: 1
                      type: string
                      description: Name of tenant to be created
                    useMySubscription:
                      type: boolean
                      description: Use active subscription from current tenant
                      default: false
                    tenantDescription:
                      type: string
                      description: Description of tenant to be created
                      nullable: true
                  additionalProperties: false
                  description: See CreateAdminInviteData model.
                File:
                  type: string
                  format: binary
            encoding:
              Model:
                contentType: application/json
                style: form
                explode: true
              File:
                contentType: application/octet-stream
                style: form
                explode: true
      responses:
        '200':
          description: Success
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
        '403':
          description: Forbidden
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
  /api/publicapi/v1/skills:
    get:
      tags:
      - Skills
      summary: Lists all available skills
      operationId: GetAvailableSkills
      responses:
        '200':
          description: All skills are successfully returned
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Abbyy.Vantage.PublicApi.Contract.Skills.Results.SkillListItemDto'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Abbyy.Vantage.PublicApi.Contract.Skills.Results.SkillListItemDto'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Abbyy.Vantage.PublicApi.Contract.Skills.Results.SkillListItemDto'
      description: Returns all published skills available to your account, with their identifiers, names, and types. Skills
        that have never been published are not included. Use the returned `id` as the `skillId` when creating or launching
        transactions. Note that `id` is not always a GUID; built-in skills use ids such as `workspace.default.processing`.
  /api/publicapi/v1/skills/{skillId}:
    get:
      tags:
      - Skills
      summary: Gets the detailed information about a skill
      operationId: GetSkillInfo
      parameters:
      - name: skillId
        in: path
        description: Skill identifier. You can find it in the list of all skills.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Skill info is successfully returned
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Abbyy.Vantage.PublicApi.Contract.Skills.Results.SkillDto'
            application/json:
              schema:
                $ref: '#/components/schemas/Abbyy.Vantage.PublicApi.Contract.Skills.Results.SkillDto'
            text/json:
              schema:
                $ref: '#/components/schemas/Abbyy.Vantage.PublicApi.Contract.Skills.Results.SkillDto'
        '404':
          description: Skill not found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
      description: Returns detailed information about a skill. For document skills the response includes the extracted field
        structure, and for classification skills it includes the list of classes. Requesting a skill that exists but has never
        been published returns 404.
  /api/publicapi/v1/transactions/{transactionId}/documents:
    post:
      tags:
      - TransactionDocuments
      summary: Creates a transaction document that will be used to group some files in single processing unit
      description: Non-process skills allow only one document
      operationId: CreateTransactionDocument
      parameters:
      - name: transactionId
        in: path
        description: "Transaction identifier. You receive it in the response after the transaction has been\r\nsuccessfully\
          \ created."
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/Abbyy.Vantage.PublicApi.Contract.Transactions.Requests.TransactionDocumentCreateRequest'
          application/json:
            schema:
              $ref: '#/components/schemas/Abbyy.Vantage.PublicApi.Contract.Transactions.Requests.TransactionDocumentCreateRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/Abbyy.Vantage.PublicApi.Contract.Transactions.Requests.TransactionDocumentCreateRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/Abbyy.Vantage.PublicApi.Contract.Transactions.Requests.TransactionDocumentCreateRequest'
      responses:
        '201':
          description: Transaction document successfully added
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Abbyy.Vantage.PublicApi.Contract.Transactions.Results.NewTransactionDocumentResult'
            application/json:
              schema:
                $ref: '#/components/schemas/Abbyy.Vantage.PublicApi.Contract.Transactions.Results.NewTransactionDocumentResult'
            text/json:
              schema:
                $ref: '#/components/schemas/Abbyy.Vantage.PublicApi.Contract.Transactions.Results.NewTransactionDocumentResult'
        '400':
          description: Some parameters are invalid
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
        '403':
          description: Forbidden
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
        '404':
          description: Transaction not found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
    get:
      tags:
      - TransactionDocuments
      summary: Gets transaction documents
      operationId: GetTransactionDocuments
      parameters:
      - name: transactionId
        in: path
        description: "Transaction identifier. You receive it in the response after the transaction has been\r\nsuccessfully\
          \ created."
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Transaction documents
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Abbyy.Vantage.PublicApi.Contract.Transactions.Results.TransactionDocumentResult'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Abbyy.Vantage.PublicApi.Contract.Transactions.Results.TransactionDocumentResult'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Abbyy.Vantage.PublicApi.Contract.Transactions.Results.TransactionDocumentResult'
        '400':
          description: Some parameters are invalid
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
        '403':
          description: Forbidden
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
        '404':
          description: Transaction not found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
      description: Returns the documents that belong to the transaction, including the files attached to each document. Use
        this to check how uploaded files were grouped into documents before or after processing.
  /api/publicapi/v1/transactions/{transactionId}/documents/{documentId}:
    get:
      tags:
      - TransactionDocuments
      summary: Gets transaction document info
      operationId: GetTransactionDocument
      parameters:
      - name: transactionId
        in: path
        description: Transaction identifier
        required: true
        schema:
          type: string
          format: uuid
      - name: documentId
        in: path
        description: Transaction document identifier
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Transaction document info
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Abbyy.Vantage.PublicApi.Contract.Transactions.Results.TransactionDocumentResult'
            application/json:
              schema:
                $ref: '#/components/schemas/Abbyy.Vantage.PublicApi.Contract.Transactions.Results.TransactionDocumentResult'
            text/json:
              schema:
                $ref: '#/components/schemas/Abbyy.Vantage.PublicApi.Contract.Transactions.Results.TransactionDocumentResult'
        '400':
          description: Some parameters are invalid
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
        '403':
          description: Forbidden
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
        '404':
          description: Transaction not found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            application/json:
              schema:
                $ref:

# --- truncated at 32 KB (111 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/abbyy/refs/heads/main/openapi/abbyy-vantage-processing-openapi.yml