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

# Get knowledge base status

> Returns the processing status. Poll it after creating a knowledge base until it's `ready` or `failed`.



## OpenAPI

````yaml /api-reference/rest/openapi.yaml get /v1/knowledge-bases/{knowledgeId}/status
openapi: 3.1.0
info:
  title: Zero Runtime REST API
  version: '1.0'
  description: >-
    Create, configure, version and deploy agents, and wire SIP telephony to
    them.
servers:
  - url: https://api.zeroruntime.ai
security:
  - token: []
tags:
  - name: Agents
  - name: Versions
  - name: Deployment
  - name: Phone numbers
  - name: Routing rules
  - name: Calls
  - name: Batch calls
  - name: Knowledge bases
  - name: Knowledge base folders
paths:
  /v1/knowledge-bases/{knowledgeId}/status:
    parameters:
      - $ref: '#/components/parameters/knowledgeId'
    get:
      tags:
        - Knowledge bases
      summary: Get knowledge base status
      description: >-
        Returns the processing status. Poll it after creating a knowledge base
        until it's `ready` or `failed`.
      responses:
        '200':
          description: The current status.
          content:
            application/json:
              schema:
                type: object
                properties:
                  knowledgeId:
                    type: string
                  status:
                    $ref: '#/components/schemas/KnowledgeBaseStatus'
                  statusReason:
                    type:
                      - string
                      - 'null'
                    description: Why processing failed.
                  failureCode:
                    type:
                      - string
                      - 'null'
                    description: For example `upload_failed` or `job_not_scheduled`.
                  updatedAt:
                    type: string
                    format: date-time
                  sizeInBytes:
                    type:
                      - integer
                      - 'null'
                  pageCount:
                    type:
                      - integer
                      - 'null'
                  sectionCount:
                    type:
                      - integer
                      - 'null'
              example:
                knowledgeId: k7x2m
                status: ready
                statusReason: null
                failureCode: null
                updatedAt: '2026-10-13T09:30:41.000Z'
                sizeInBytes: 482113
                pageCount: 12
                sectionCount: 48
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          description: The knowledge base isn't yours or is deleted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Message'
              example:
                message: Knowledge base not found
components:
  parameters:
    knowledgeId:
      name: knowledgeId
      in: path
      required: true
      schema:
        type: string
      example: k7x2m
  schemas:
    KnowledgeBaseStatus:
      type: string
      enum:
        - processing
        - ready
        - failed
      description: |
        - `processing`: being parsed and indexed. Not available to agents yet.
        - `ready`: indexed and available to agents.
        - `failed`: processing stopped. `statusReason` says why.
    Message:
      type: object
      properties:
        message:
          type: string
    Error:
      type: object
      properties:
        error:
          type: string
  responses:
    Unauthorized:
      description: Missing or invalid `Authorization` header.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    token:
      type: apiKey
      in: header
      name: Authorization
      description: Your API token, sent raw (no `Bearer` prefix).
      x-default: <auth-token>

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.