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

# List Predictions

> List Predictions



## OpenAPI

````yaml /api-reference/openapi.json get /predictions
openapi: 3.1.0
info:
  title: Cradl API
  version: '2026-01-28T09:00:46Z'
servers:
  - url: https://api.cradl.ai/{basePath}
    variables:
      basePath:
        default: v1
security: []
paths:
  /predictions:
    get:
      parameters:
        - in: query
          name: nextToken
          schema:
            type: string
        - in: query
          name: maxResults
          schema:
            type: string
        - in: query
          name: sortBy
          schema:
            type: string
        - in: query
          name: order
          schema:
            type: string
        - in: query
          name: modelId
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Predictions'
          description: 200 response
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: 400 response
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: 403 response
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: 404 response
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: 415 response
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: 500 response
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
            Access-Control-Allow-Origin:
              schema:
                type: string
      security:
        - OAuth2:
            - predictions:read
components:
  schemas:
    Predictions:
      title: predictions
      required:
        - nextToken
        - predictions
      type: object
      properties:
        modelId:
          pattern: >-
            ^(|(cradl|las):organization:[a-z0-9-_]+/)(cradl|las):model:[a-z0-9-_]+$
          type: string
        nextToken:
          maxLength: 4096
          type: string
          nullable: true
        sortBy:
          type: string
          enum:
            - createdTime
        predictions:
          type: array
          items:
            required:
              - createdBy
              - createdTime
              - description
              - documentId
              - metadata
              - modelId
              - name
              - predictionId
              - predictions
              - updatedBy
              - updatedTime
            type: object
            properties:
              updatedTime:
                pattern: >-
                  ^[0-9]{4}-?[0-9]{2}-?[0-9]{2}(
                  |T)?[0-9]{2}:?[0-9]{2}:?[0-9]{2}(.[0-9]{1,6})?(Z|[+][0-9]{2}(:|)[0-9]{2})$
                type: string
                nullable: true
              metadata:
                type: object
                nullable: true
              updatedBy:
                maxLength: 4096
                type: string
                nullable: true
              trainingId:
                pattern: ^las:model-training:[a-z0-9-_]+$
                type: string
                nullable: true
              modelId:
                pattern: >-
                  ^(|(cradl|las):organization:[a-z0-9-_]+/)(cradl|las):model:[a-z0-9-_]+$
                type: string
              nextPage:
                type: integer
                nullable: true
              postprocessConfig:
                oneOf:
                  - required:
                      - strategy
                    type: object
                    properties:
                      strategy:
                        type: string
                        enum:
                          - BEST_FIRST
                      outputFormat:
                        type: string
                        enum:
                          - v1
                          - v2
                    additionalProperties: false
                  - required:
                      - parameters
                      - strategy
                    type: object
                    properties:
                      strategy:
                        type: string
                        enum:
                          - BEST_N_PAGES
                      outputFormat:
                        type: string
                        enum:
                          - v1
                          - v2
                      parameters:
                        required:
                          - 'n'
                        type: object
                        properties:
                          'n':
                            maximum: 100
                            minimum: 1
                            type: integer
                          collapse:
                            type: boolean
                    additionalProperties: false
                nullable: true
              warnings:
                type: array
                items:
                  type: string
                nullable: true
              description:
                maxLength: 4096
                type: string
                nullable: true
              inferenceTime:
                minimum: 0
                type: number
                nullable: true
              error:
                maxLength: 4096
                type: string
                nullable: true
              agentRunId:
                pattern: >-
                  ^((cradl|las):organization:[a-z0-9-_]+/)?cradl:agent:[a-z0-9-_]+/cradl:run:[a-z0-9-_]+$
                type: string
                nullable: true
              predictions:
                anyOf:
                  - type: array
                    items:
                      anyOf:
                        - required:
                            - confidence
                            - label
                            - value
                          type: object
                          properties:
                            validators:
                              type: array
                            confidence:
                              maximum: 1
                              minimum: 0
                              type: number
                            warnings:
                              type: array
                              items:
                                type: string
                              nullable: true
                            rotation:
                              type: integer
                            label:
                              maxLength: 36
                              minLength: 1
                              pattern: ^[0-9A-Za-z-_]+$
                              type: string
                            source:
                              type: string
                              enum:
                                - llm
                                - model
                            formatters:
                              type: array
                            rawValue:
                              maxLength: 1024
                              minLength: 1
                              type: string
                              nullable: true
                            attentionMap:
                              type: array
                              items:
                                type: array
                                items:
                                  type: number
                            location:
                              maxItems: 4
                              minItems: 4
                              type: array
                              items:
                                maximum: 1
                                minimum: 0
                                type: number
                            page:
                              type: integer
                            value:
                              maxLength: 1024
                              minLength: 1
                              type: string
                              nullable: true
                            errors:
                              type: array
                              items:
                                type: string
                              nullable: true
                          additionalProperties: false
                        - required:
                            - label
                            - value
                          type: object
                          properties:
                            label:
                              maxLength: 36
                              minLength: 1
                              pattern: ^[0-9A-Za-z-_]+$
                              type: string
                            page:
                              minimum: 0
                              type: integer
                            value:
                              type: array
                              items:
                                type: array
                                items:
                                  required:
                                    - confidence
                                    - label
                                    - value
                                  type: object
                                  properties:
                                    validators:
                                      type: array
                                    confidence:
                                      maximum: 1
                                      minimum: 0
                                      type: number
                                    warnings:
                                      type: array
                                      items:
                                        type: string
                                      nullable: true
                                    rotation:
                                      type: integer
                                    label:
                                      maxLength: 36
                                      minLength: 1
                                      pattern: ^[0-9A-Za-z-_]+$
                                      type: string
                                    source:
                                      type: string
                                      enum:
                                        - llm
                                        - model
                                    formatters:
                                      type: array
                                    rawValue:
                                      maxLength: 1024
                                      minLength: 1
                                      type: string
                                      nullable: true
                                    attentionMap:
                                      type: array
                                      items:
                                        type: array
                                        items:
                                          type: number
                                    location:
                                      maxItems: 4
                                      minItems: 4
                                      type: array
                                      items:
                                        maximum: 1
                                        minimum: 0
                                        type: number
                                    page:
                                      type: integer
                                    value:
                                      maxLength: 1024
                                      minLength: 1
                                      type: string
                                      nullable: true
                                    errors:
                                      type: array
                                      items:
                                        type: string
                                      nullable: true
                                  additionalProperties: false
                          additionalProperties: false
                    nullable: true
                  - type: object
                    additionalProperties: false
                    nullable: true
              preprocessConfig:
                minProperties: 1
                type: object
                properties:
                  trimMargins:
                    type: boolean
                  useGhostScript:
                    type: boolean
                  startPage:
                    type: integer
                  pages:
                    maxItems: 100
                    type: array
                    items:
                      type: integer
                  usePoppler:
                    type: boolean
                  padToFit:
                    type: boolean
                  useTextDetection:
                    type: boolean
                  maxPages:
                    maximum: 100
                    minimum: 1
                    type: integer
                  rotation:
                    type: integer
                    enum:
                      - 0
                      - 90
                      - 180
                      - 270
                  deskewImage:
                    type: boolean
                  autoRotate:
                    type: boolean
                  imageQuality:
                    type: string
                    enum:
                      - LOW
                      - HIGH
                additionalProperties: false
                nullable: true
              createdBy:
                maxLength: 4096
                type: string
              name:
                maxLength: 4096
                type: string
                nullable: true
              createdTime:
                pattern: >-
                  ^[0-9]{4}-?[0-9]{2}-?[0-9]{2}(
                  |T)?[0-9]{2}:?[0-9]{2}:?[0-9]{2}(.[0-9]{1,6})?(Z|[+][0-9]{2}(:|)[0-9]{2})$
                type: string
              documentId:
                pattern: ^(cradl|las):document:[a-f0-9]{32}$
                type: string
              fileUrl:
                pattern: ^http://localhost.*|^https://.*
                type: string
                nullable: true
              predictionId:
                pattern: ^(cradl|las):prediction:[a-f0-9]{32}$
                type: string
              errors:
                type: array
                items:
                  type: string
                nullable: true
              status:
                type: string
                enum:
                  - pending
                  - succeeded
                  - failed
            additionalProperties: false
        order:
          type: string
          enum:
            - ascending
            - descending
      additionalProperties: false
    Error:
      title: Error Schema
      type: object
      properties:
        message:
          type: string
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://auth.cradl.ai/oauth2/token
          scopes:
            actions.runs:read: Read permissions
            actions.runs:write: Write permissions
            actions:read: Read permissions
            actions:write: Write permissions
            agents.runs:read: Read permissions
            agents.runs:write: Write permissions
            agents.statistics:read: Read permissions
            agents:read: Read permissions
            agents:write: Write permissions
            appclients:read: Read permissions
            appclients:write: Write permissions
            documents:read: Read permissions
            documents:write: Write permissions
            hooks.runs:read: Read permissions
            hooks.runs:write: Write permissions
            hooks:read: Read permissions
            hooks:write: Write permissions
            logs:read: Read permissions
            models:read: Read permissions
            models:write: Write permissions
            organizations:read: Read permissions
            organizations:write: Write permissions
            predictions:read: Read permissions
            predictions:write: Write permissions
            users:read: Read permissions
            users:write: Write permissions
            validations.tasks:read: Read permissions
            validations.tasks:write: Write permissions
            validations:read: Read permissions
            validations:write: Write permissions
            workflows:read: Read permissions
            workflows:write: Write permissions

````