> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Indexing Status

> Get the current status.

NsApiSlow threshold: 1000 ms.
<para />## Experimental: ## The AI agent is experimental, subject to change, and not intended for partners.



## OpenAPI

````yaml /openapi/agent/openapi-v3-AIAgent.json post /api/v1/Agents/AI/GetIndexingStatus
openapi: 3.0.0
info:
  version: v1-Agents
  title: SuperOffice Agent API v1
  description: SuperOffice Agent API - AIAgent
  contact:
    name: SuperOffice DevNet
    url: https://docs.superoffice.com/en/api/index.html
    email: sdk@superoffice.com
servers:
  - url: http://localhost:56350
  - url: https://localhost:56350
security: []
tags: []
externalDocs:
  description: >-
    The SuperOffice DevNet Community has more documentation, examples, and
    discussion forums.
  url: https://community.superoffice.com/en/developer/
paths:
  /api/v1/Agents/AI/GetIndexingStatus:
    post:
      tags:
        - AI_Agent
      summary: Get Indexing Status
      description: "Get the current status.\n\nNsApiSlow threshold: 1000 ms.\r\n<para />## Experimental: ## The AI agent is experimental, subject to change, and not intended for partners."
      operationId: v1AIAgent_GetIndexingStatus
      parameters:
        - name: $select
          in: query
          description: >-
            Optional comma separated list of properties to include in the
            result. Other fields are then nulled out to reduce payload size:
            "Name,department,category". Default = show all fields.
          required: false
          schema:
            type: string
        - name: Accept-Language
          in: header
          description: >-
            Convert string references and multi-language values into a specified
            language (iso2) code.
          required: false
          schema:
            type: string
        - name: SO-Language
          in: header
          description: >-
            Convert string references and multi-language values into a specified
            language (iso2) code. Overrides Accept-Language value.
          required: false
          schema:
            type: string
        - name: SO-Culture
          in: header
          description: >-
            Number, date formatting in a specified culture (iso2 language) code.
            Partially overrides SO-Language/Accept-Language value. Ignored if no
            Language set.
          required: false
          schema:
            type: string
        - name: SO-TimeZone
          in: header
          description: >-
            Specify the timezone code that you would like date/time responses
            converted to.
          required: false
          schema:
            type: string
        - name: SO-AppToken
          in: header
          description: >-
            The application token that identifies the partner app. Used when
            calling Online WebAPI from a server.
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.AICarriers.GetIndexingStatusRequest
          text/json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.AICarriers.GetIndexingStatusRequest
          application/xml:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.AICarriers.GetIndexingStatusRequest
          text/xml:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.AICarriers.GetIndexingStatusRequest
          application/x-www-form-urlencoded:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.AICarriers.GetIndexingStatusRequest
          application/json-patch+json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.AICarriers.GetIndexingStatusRequest
          application/merge-patch+json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.AICarriers.GetIndexingStatusRequest
        description: NamespaceName
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.RagStatus'
            text/json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.RagStatus'
            application/xml:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.RagStatus'
            text/xml:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.RagStatus'
            application/json-patch+json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.RagStatus'
            application/merge-patch+json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.RagStatus'
      security:
        - SuperOffice_Password: []
          SuperId_Authentication: []
components:
  schemas:
    SuperOffice.WebApi.v1.Carriers.AICarriers.GetIndexingStatusRequest:
      description: 'GetIndexingStatus: Get the current status.'
      type: object
      properties:
        NamespaceName:
          type: string
    SuperOffice.CRM.Services.RagStatus:
      description: "RAG namespace status. How is the indexing going?\r\n<para />\r\nCarrier object for RagStatus.\r\nServices for the RagStatus Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IAIAgent\">AI Agent</see>."
      type: object
      properties:
        StartedAt:
          format: date-time
          description: UTC timestamp - when content indexeing started.
          type: string
        CompletedAt:
          format: date-time
          description: UTC timestamp - when content indexing finished.
          type: string
        NamespaceName:
          description: Namespace the status belongs to.
          type: string
        CurrentRunTag:
          description: Unique identifier for current indexing job.
          type: string
        IsCompleted:
          description: Is the indexing run finished?
          type: boolean
        IsCancelled:
          description: Was the indexing cancelled before completion?
          type: boolean
        LastIndexed:
          format: date-time
          description: UTC timestamp - when last content was added/updated to index.
          type: string
        StatusAll:
          $ref: '#/components/schemas/SuperOffice.CRM.Services.RagStatusChunks'
        StatusDocuments:
          $ref: '#/components/schemas/SuperOffice.CRM.Services.RagStatusChunks'
        StatusFAQ:
          $ref: '#/components/schemas/SuperOffice.CRM.Services.RagStatusChunks'
        StatusNone:
          $ref: '#/components/schemas/SuperOffice.CRM.Services.RagStatusChunks'
        StatusProduct:
          $ref: '#/components/schemas/SuperOffice.CRM.Services.RagStatusChunks'
        StatusTicket:
          $ref: '#/components/schemas/SuperOffice.CRM.Services.RagStatusChunks'
        StatusWebpage:
          $ref: '#/components/schemas/SuperOffice.CRM.Services.RagStatusChunks'
    SuperOffice.CRM.Services.RagStatusChunks:
      description: "RAG namespace document index statistics\r\n<para />\r\nCarrier object for RagStatusChunks.\r\nServices for the RagStatusChunks Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IAIAgent\">AI Agent</see>."
      type: object
      properties:
        NumberOfChunks:
          format: int32
          description: How many chunks stored in the database
          type: integer
        NumberOfDocuments:
          format: int32
          description: How many documents stored in the database
          type: integer

````

## Related topics

- [SuperOffice.WebApi.Data.AI GetIndexingStatusRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.AI_GetIndexingStatusRequest.md)
- [SuperOffice.WebApi.Agents.AIAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.AIAgent.md)
- [SuperOffice.WebApi.Agents.IAIAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IAIAgent.md)
- [Get Status](/en/api/reference/restful/agent/freetext_agent/get-status.md)
- [Get Project Status](/en/api/reference/restful/rest/list_projectstatus/get-project-status.md)