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

# Get collection readiness

> Read whether a collection's Files are ready to use.

**Operation ID:** `http.collections.readiness`

```http theme={null}
GET /v1/orgs/{org}/projects/{project}/files/collections/{collection}/readiness
```


## OpenAPI

````yaml openapi.json GET /v1/orgs/{org}/projects/{project}/files/collections/{collection}/readiness
openapi: 3.1.0
info:
  title: Penumbra API
  version: v1
  description: >-
    HTTP reference for Files, search, extraction, reviews, Graph, Shapes and
    sharing.
servers:
  - url: https://api.pnbr.io
    description: Penumbra API
security: []
paths:
  /v1/orgs/{org}/projects/{project}/files/collections/{collection}/readiness:
    get:
      tags:
        - Collections
      summary: Get collection readiness
      description: |-
        Read whether a collection's Files are ready to use.

        Product guidance: [Collection](/concepts/collection).
      operationId: http.collections.readiness
      parameters:
        - name: org
          in: path
          required: true
          schema:
            type: string
        - name: project
          in: path
          required: true
          schema:
            type: string
        - name: collection
          in: path
          required: true
          schema:
            type: string
      responses:
        2XX:
          description: Success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/http_collections_readiness_response'
      security:
        - bearerAuth: []
components:
  schemas:
    http_collections_readiness_response:
      type: object
      properties:
        data:
          type: object
          properties:
            collection_id:
              type: string
            file_count:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
            total_bytes:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
            searchable:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
            processing:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
            unreadable:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
            no_text:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
            meaning_pending:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
            meaning_failed:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
            failures:
              type: array
              items:
                type: object
                properties:
                  error_code:
                    type: string
                  error_retryable:
                    anyOf:
                      - type: boolean
                      - type: 'null'
                  count:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  examples:
                    type: array
                    items:
                      type: object
                      properties:
                        file_id:
                          type: string
                        name:
                          type: string
                        bytes:
                          type: integer
                          minimum: -9007199254740991
                          maximum: 9007199254740991
                      required:
                        - file_id
                        - name
                        - bytes
                      additionalProperties: {}
                required:
                  - error_code
                  - error_retryable
                  - count
                  - examples
                additionalProperties: {}
            meaning_failures:
              type: array
              items:
                type: object
                properties:
                  error_code:
                    type: string
                  error_retryable:
                    anyOf:
                      - type: boolean
                      - type: 'null'
                  count:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  examples:
                    type: array
                    items:
                      type: object
                      properties:
                        file_id:
                          type: string
                        name:
                          type: string
                        bytes:
                          type: integer
                          minimum: -9007199254740991
                          maximum: 9007199254740991
                      required:
                        - file_id
                        - name
                        - bytes
                      additionalProperties: {}
                required:
                  - error_code
                  - error_retryable
                  - count
                  - examples
                additionalProperties: {}
          required:
            - collection_id
            - file_count
            - total_bytes
            - searchable
            - processing
            - unreadable
            - no_text
            - meaning_pending
            - meaning_failed
            - failures
            - meaning_failures
          additionalProperties: {}
      required:
        - data
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````

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