Emporix Reindex API

openapi: 3.2.0
info:
  title: Emporix Reindex API
  version: '1.0'
  description: 'Operations tagged Reindex across 4 of this provider''s published API definitions: emporix-ai-rag-indexer-openapi.yml, emporix-indexing-service-openapi.yml, emporix-ai-rag-indexer-openapi.yml, emporix-indexing-service-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.emporix.io
tags:
- name: Reindex
  description: Invoke Reindex
paths:
  /ai-rag-indexer/{tenant}/{type}/reindex:
    parameters:
    - $ref: '#/components/parameters/path_tenant'
    - $ref: '#/components/parameters/path_type'
    post:
      deprecated: true
      summary: Reindexing the entities of given type
      operationId: GET-ai-rag-indexer-reindex
      responses:
        '204':
          description: No Content
        '400':
          $ref: '#/components/responses/400_resp_common'
        '401':
          $ref: '#/components/responses/401_resp_common'
        '403':
          $ref: '#/components/responses/403_resp_common'
      description: 'Triggers a full reindexing process for the selected entity type. The process retrieves all entities of the given type, generates embeddings for each of them, and updates the corresponding records in the Vector Database.


        This endpoint is marked as deprecated. Use the Creating reindex job endpoint instead.'
      security:
      - OAuth2:
        - ai.agent_manage
      tags:
      - Reindex
    servers:
    - url: https://api.emporix.io
  /indexing/{tenant}/reindex:
    parameters:
    - $ref: '#/components/parameters/trait_tenant'
    post:
      deprecated: true
      summary: Reindex
      operationId: POST-indexing-reindex
      responses:
        '204':
          description: ''
        '400':
          $ref: '#/components/responses/BadRequest_400'
        '401':
          $ref: '#/components/responses/Unauthorized_401'
        '403':
          $ref: '#/components/responses/Forbidden_403'
        '502':
          $ref: '#/components/responses/BadGateway_502'
      tags:
      - Reindex
      description: 'Triggers indexing process of products for the tenant. The reindex works with a `FULL` mode - all products are reindexed.


        This endpoint is marked as deprecated. Use the Creating reindex job endpoint instead.


        For tenants on `BATTERY_INCLUDED`, the same credential validation runs before the reindex job is started.'
      security:
      - OAuth2:
        - indexing.search_manage
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Reindex'
            examples:
              Reindex request:
                value:
                  mode: FULL
    servers:
    - url: https://api.emporix.io
  /indexing/{tenant}/reindex-jobs:
    parameters:
    - $ref: '#/components/parameters/trait_tenant'
    post:
      summary: Creating a reindex job
      operationId: POST-indexing-reindex-jobs
      responses:
        '201':
          description: The new reindex job was created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReindexJob'
              examples:
                Example 1:
                  value:
                    id: 6a31424ef4ddd37d108f8168
                    status: IN_PROGRESS
                    entityType: PRODUCT
                    expectedCount: 5000
                    processedCount: 2000
                    metadata:
                      createdAt: '2026-06-16T12:32:14.132Z'
                      modifiedAt: '2026-06-16T12:32:14.150Z'
        '200':
          description: The reindex job for given entityType was already `IN_PROGRESS` and it is returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReindexJob'
              examples:
                Example 1:
                  value:
                    id: 6a31424ef4ddd37d108f8168
                    status: IN_PROGRESS
                    entityType: PRODUCT
                    expectedCount: 5000
                    processedCount: 2000
                    metadata:
                      createdAt: '2026-06-16T12:32:14.132Z'
                      modifiedAt: '2026-06-16T12:32:14.150Z'
        '400':
          $ref: '#/components/responses/BadRequest_400'
        '401':
          $ref: '#/components/responses/Unauthorized_401'
        '403':
          $ref: '#/components/responses/Forbidden_403'
        '502':
          $ref: '#/components/responses/BadGateway_502'
      tags:
      - Reindex
      description: 'Triggers indexing process of given entities for the tenant. The reindex works with a `FULL` mode - all entities are reindexed. It returns a reindex job which allows to track the progress. The `SUCCESS` means that all entities events are indexed.


        When the active search provider is `BATTERY_INCLUDED` and `entityType` is `PRODUCT`, the service validates stored credentials before creating the job. Invalid credentials return `400`. If credential validation is temporarily unavailable, the request returns `502`. In both cases, no job is created.'
      security:
      - OAuth2:
        - indexing.search_manage
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReindexRequest'
            examples:
              Reindex request:
                value:
                  entityType: PRODUCT
                  rag: true
    get:
      parameters:
      - $ref: '#/components/parameters/qParam'
      - $ref: '#/components/parameters/pageSize'
      - $ref: '#/components/parameters/pageNumber'
      - $ref: '#/components/parameters/sort'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/header_xTotalCount'
      summary: Retrieving reindex jobs
      operationId: GET-indexing-reindex-jobs
      responses:
        '200':
          description: Reindex jobs are returned.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ReindexJob'
              examples:
                Example 1:
                  value:
                  - id: 6a31424ef4ddd37d108f8168
                    status: IN_PROGRESS
                    entityType: PRODUCT
                    expectedCount: 5000
                    processedCount: 2000
                    metadata:
                      createdAt: '2026-06-16T12:32:14.132Z'
                      modifiedAt: '2026-06-16T12:32:14.150Z'
        '400':
          $ref: '#/components/responses/BadRequest_400'
        '401':
          $ref: '#/components/responses/Unauthorized_401'
        '403':
          $ref: '#/components/responses/Forbidden_403'
      tags:
      - Reindex
      description: Returns reindex jobs.
      security:
      - OAuth2:
        - indexing.search_view
    servers:
    - url: https://api.emporix.io
  /indexing/{tenant}/reindex-jobs/{reindexJobId}:
    parameters:
    - $ref: '#/components/parameters/trait_tenant'
    - schema:
        type: string
      name: reindexJobId
      in: path
      required: true
      description: Id of the reindex job.
    get:
      parameters:
      - $ref: '#/components/parameters/fields'
      summary: Retrieving a reindex job
      operationId: GET-indexing-reindex-jobs-reindex-job-id
      responses:
        '200':
          description: Reindex job is returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReindexJob'
              examples:
                Example 1:
                  value:
                    id: 6a31424ef4ddd37d108f8168
                    status: IN_PROGRESS
                    entityType: PRODUCT
                    expectedCount: 5000
                    processedCount: 2000
                    metadata:
                      createdAt: '2026-06-16T12:32:14.132Z'
                      modifiedAt: '2026-06-16T12:32:14.150Z'
        '400':
          $ref: '#/components/responses/BadRequest_400'
        '401':
          $ref: '#/components/responses/Unauthorized_401'
        '403':
          $ref: '#/components/responses/Forbidden_403'
      tags:
      - Reindex
      description: Returns reindex job.
      security:
      - OAuth2:
        - indexing.search_view
    servers:
    - url: https://api.emporix.io
components:
  schemas:
    ErrorMessage:
      type: object
      properties:
        code:
          type: integer
        type:
          type: string
        message:
          type: string
        moreInfo:
          type: string
        details:
          type: array
          items:
            type: object
            properties:
              field:
                type: string
              type:
                type: string
              message:
                type: string
              moreInfo:
                type: string
      description: ''
    ErrorMessageFault:
      type: object
      properties:
        fault:
          type: object
          properties:
            faultstring:
              type: string
            detail:
              type: object
              properties:
                errorcode:
                  type: string
    ReindexJobStatus:
      type: string
      description: Informs about status of reindex job. `PENDING` means that the maximum number of parallel `IN_PROGRESS` jobs is reached and such job will be processed when one of current `IN_PROGRESS` jobs is released. `PUBLISHED` means that all the indexing events were emitted. `SUCCESS` means that all the indexing events were consumed.
      enum:
      - FAILURE
      - IN_PROGRESS
      - PENDING
      - PUBLISHED
      - SUCCESS
    errorMessage:
      title: error
      description: Schema for API specified errors.
      type: object
      properties:
        code:
          description: Original HTTP error code, should be consistent with the response HTTP code
          type: integer
        status:
          description: Classification of the error type
          type: string
        message:
          description: Descriptive error message for debugging
          type: string
        details:
          type: array
          description: Error details
          items:
            type: string
    ReindexEntityType:
      type: string
      description: Entity type which should be reindexed. It supports `ORDER`, `PRODUCT` and custom schema types.
    ReindexRequest:
      type: object
      properties:
        entityType:
          $ref: '#/components/schemas/ReindexEntityType'
        rag:
          type: boolean
          default: false
          description: Whether products should be reindexed for RAG. This property is applicable only when `entityType` is `PRODUCT`.
      required:
      - entityType
    Metadata:
      type: object
      properties:
        createdAt:
          description: 'Date and time when the object was created. The value is approved as an ISO-8601 representation of an Instant. For example: `2022-04-30T13:18:02.379Z`'
          type: string
          format: date-time
        modifiedAt:
          description: 'Date and time when the object was last modified. The value is approved as an ISO-8601 representation of an Instant. For example: `2022-04-30T13:18:02.379Z`'
          type: string
          format: date-time
    ReindexJob:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier of the reindex job.
        entityType:
          $ref: '#/components/schemas/ReindexEntityType'
        message:
          type: string
          description: In case if reindex job finishes with `FAILURE` status, the message is populated with information what was the reason of the failure.
        status:
          $ref: '#/components/schemas/ReindexJobStatus'
        expectedCount:
          type: integer
          description: Expected number of entities which need to be indexed.
        processedCount:
          type: integer
          description: Actual number of entities which were indexed. Allows to track the progress of reindexing process.
        metadata:
          $ref: '#/components/schemas/Metadata'
    Reindex:
      title: Reindex
      type: object
      properties:
        mode:
          type: string
          enum:
          - FULL
          description: 'Indicates reindex mode. Supported modes: `FULL`.'
  responses:
    403_resp_common:
      description: Authorization scopes of the access token are not sufficient and do not match the scopes required by the endpoint.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorMessage'
          examples:
            Access forbidden:
              value:
                code: 403
                status: Forbidden
                message: The access to the requested resource has been forbidden by the server.
    401_resp_common:
      description: The authorization token is invalid or has expired.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorMessageFault'
          examples:
            Invalid access token:
              value:
                fault:
                  faultstring: Invalid access token
                  detail:
                    errorcode: oauth.v2.InvalidAccessToken
            Access token expired:
              value:
                fault:
                  faultstring: Access Token expired
                  detail:
                    errorcode: keymanagement.service.access_token_expired
    400_resp_common:
      description: The request was syntactically incorrect.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorMessage'
          examples:
            Code must not be null:
              value:
                code: 400
                status: Bad Request
                message: Validation problem with request body.
                details:
                - message: code must not be null nor blank
    BadGateway_502:
      description: Upstream dependency was unavailable. Details will be provided in the response payload.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/errorMessage'
          examples:
            Battery Included credential validation unavailable:
              value:
                code: 502
                status: Bad Gateway
                message: Battery Included credential validation is temporarily unavailable. Try again later.
    Unauthorized_401:
      description: Given request is unauthorized - the authorization token is invalid or has expired. Details will be provided in the response payload.
      content:
        application/json:
          schema:
            type: object
            properties:
              fault:
                type: object
                properties:
                  faultstring:
                    type: string
                  detail:
                    type: object
                    properties:
                      errorcode:
                        type: string
          examples:
            UnauthorizedExample:
              value:
                fault:
                  faultstring: Invalid access token
                  detail:
                    errorcode: oauth.v2.InvalidAccessToken
            AccessTokenExpiredExample:
              value:
                fault:
                  faultstring: Access Token expired
                  detail:
                    errorcode: keymanagement.service.access_token_expired
    BadRequest_400:
      description: Request was syntactically incorrect. Details will be provided in the response payload.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/errorMessage'
          examples:
            Unsupported provider:
              value:
                code: 400
                status: Bad Request
                message: The provider UNKNOWN_PROVIDER is not supported.
            Battery Included invalid credentials:
              value:
                code: 400
                status: Bad Request
                message: Battery Included credentials are invalid. Verify the write key and index name.
    Forbidden_403:
      description: Given authorization scopes are not sufficient and do not match scopes required by the endpoint.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/errorMessage'
          examples:
            ForbiddenExample:
              value:
                status: Forbidden
                details:
                - Missing required scopes '[indexing.search_view]'
                code: 403
                message: Scope validation failed
  parameters:
    path_tenant:
      name: tenant
      in: path
      required: true
      schema:
        type: string
      description: 'Your Emporix tenant name.


        **Note**: The tenant name should always be provided in lowercase.

        '
    path_type:
      schema:
        type: string
      in: path
      required: true
      name: type
      description: 'Rag Entity Type. Supported predefined types: [ORDER, PRODUCT] and custom entity types.'
    qParam:
      in: query
      name: q
      description: 'A standard query parameter is used to search for specific values.


        See: [Standard Practices - Query parameter](https://developer.emporix.io/api-documentation/standard-practices/q-param)

        '
      schema:
        type: string
    header_xTotalCount:
      schema:
        type: boolean
      in: header
      name: X-Total-Count
      description: Flag indicating whether the total number of retrieved results should be returned.
    pageNumber:
      schema:
        type: integer
        default: 1
        minimum: 1
      in: query
      name: pageNumber
      description: The page number to be retrieved. The size of the pages should be specified by the `pageSize` parameter.
    pageSize:
      schema:
        type: integer
        default: 60
        minimum: 1
        maximum: 2000
      in: query
      name: pageSize
      description: The number of documents to be retrieved per page.
    trait_tenant:
      name: tenant
      in: path
      required: true
      description: 'The tenant that the caller is acting upon.


        Please note that this value is always lowercase.

        '
      schema:
        pattern: ^[a-z][a-z0-9]+$
        minLength: 3
        maxLength: 16
        type: string
    sort:
      schema:
        type: string
      in: query
      name: sort
      description: List of properties used to sort the results, separated by colons.
    fields:
      schema:
        type: string
      in: query
      name: fields
      description: Fields to be returned in the response.
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        clientCredentials:
          scopes:
            ai.text_manage: Needed to execute actions related to the text generation.
            ai.completion_manage: Needed to execute actions related to the AI completions.
            ai.agent_read: Needed to read AI agents.
            ai.agent_manage: Needed to manage AI agents.
          tokenUrl: https://api.emporix.io/oauth/token
x-refined-from:
- emporix-ai-rag-indexer-openapi.yml
- emporix-indexing-service-openapi.yml
- emporix-ai-rag-indexer-openapi.yml
- emporix-indexing-service-openapi.yml