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

# Get a result

> Question-wise marks, criteria, feedback and totals for one submission. Marks are drafts until you finalize. `extracted_answer` (what the AI read) is included by default; add `include=annotations,model_answer` for more.

**Scope:** `evaluation:read`



## OpenAPI

````yaml /api-reference/openapi.json get /submissions/{submissionId}/result
openapi: 3.0.1
info:
  title: Evalezy AI Evaluation API
  version: v1
  description: >-
    Create exams, register candidates, submit scanned answer copies or typed
    answers, and read question-wise AI marks with feedback. Results are drafts
    until you finalize them.


    Server-to-server only: never ship an API key inside a browser or mobile app.
    English answers only for now (Hindi and regional languages are on the
    roadmap).
  contact:
    name: Evalezy
    email: hello@evalezy.com
    url: https://evalezy.com
servers:
  - url: https://api.evalezy.com/v1
    description: Production
security:
  - ApiKey: []
tags:
  - name: Exams
    description: Create, open, edit and look up exams.
  - name: Questions
    description: Add, edit and remove the questions of an exam.
  - name: Rubrics
    description: Marking criteria and model answers for long-answer questions.
  - name: Choice groups
    description: Internal choice ("attempt any N of M"). Beta, enabled on request.
  - name: Candidates
    description: >-
      Your students, keyed by your own external_id, and their exam
      registrations.
  - name: Uploads
    description: Presigned uploads for scanned answer copies (PDF).
  - name: Submissions
    description: Submit a copy or typed answers for a candidate and track its evaluation.
  - name: Results
    description: Question-wise marks, feedback and the checked (annotated) copy.
  - name: Review
    description: Teacher overrides, approval, finalize and unfinalize.
  - name: Credits
    description: Credit balance, rate card and price quotes.
  - name: Account
    description: Check which institute and scopes an API key has.
paths:
  /submissions/{submissionId}/result:
    get:
      tags:
        - Results
      summary: Get a result
      description: >-
        Question-wise marks, criteria, feedback and totals for one submission.
        Marks are drafts until you finalize. `extracted_answer` (what the AI
        read) is included by default; add `include=annotations,model_answer` for
        more.


        **Scope:** `evaluation:read`
      operationId: getResult
      parameters:
        - name: submissionId
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: Submission id (UUID).
        - name: include
          in: query
          required: false
          schema:
            type: string
            example: model_answer
          description: >-
            Comma-separated: `annotations`, `model_answer`. `extracted_answer`
            is included by default; `-extracted_answer` leaves it out.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
              example:
                submission_id: 9b2e4f71-5c3a-4d8e-b6f0-1a7c3e5d9b24
                exam_id: 3f6c1d2e-8b4a-4c7e-9a51-2d0e7b9c4f18
                candidate:
                  id: c41a7e93-2f58-4b6d-8e0a-5d9f1b3c7e62
                  external_id: STU-10A-0142
                  name: Aarav Sharma
                  roll_number: '14'
                status: graded
                needs_review: false
                review_reasons: []
                finalized: false
                finalized_at: null
                rubric_version: 1
                totals:
                  awarded: 3
                  max: 4
                  percentage: 75
                  questions_graded: 2
                  questions_failed: 0
                questions:
                  - question_id: b2e1d3c5-7f9a-4b4d-8e6f-0a2c3d4e5f6a
                    label: Q24
                    section: C
                    status: graded
                    counted: true
                    awarded: 2
                    max: 3
                    source: ai
                    confidence: 0.86
                    needs_review: false
                    review_reasons: []
                    extracted_answer: >-
                      In the stomach HCl makes the medium acidic and kills
                      germs. Pepsin breaks proteins...
                    feedback: >-
                      Correctly explains the role of HCl and names pepsin. Does
                      not mention mucus protecting the stomach lining.
                    criteria:
                      - name: Role of hydrochloric acid
                        awarded: 1
                        max: 1
                        reason: Acidic medium and germ-killing stated.
                      - name: Enzymes named
                        awarded: 1
                        max: 1
                        reason: Pepsin named with its function.
                      - name: Mucus and protection
                        awarded: 0
                        max: 1
                        reason: Not mentioned.
                    error: null
                checked_copy:
                  available: true
                  download_path: >-
                    /submissions/9b2e4f71-5c3a-4d8e-b6f0-1a7c3e5d9b24/checked-copy
                graded_at: '2026-10-14T06:03:18Z'
                credits_charged: 12
                error: null
        '401':
          $ref: '#/components/responses/Error401'
        '403':
          $ref: '#/components/responses/Error403'
        '404':
          $ref: '#/components/responses/Error404'
        '429':
          $ref: '#/components/responses/Error429'
components:
  schemas:
    Result:
      type: object
      properties:
        submission_id:
          type: string
          format: uuid
        exam_id:
          type: string
          format: uuid
        candidate:
          type: object
          properties:
            id:
              type: string
              format: uuid
            external_id:
              type: string
            name:
              type: string
              nullable: true
              description: Null on blind exams.
            roll_number:
              type: string
              nullable: true
        status:
          type: string
        needs_review:
          type: boolean
        review_reasons:
          type: array
          items:
            type: string
        finalized:
          type: boolean
        finalized_at:
          type: string
          format: date-time
          nullable: true
        rubric_version:
          type: integer
          nullable: true
        totals:
          type: object
          properties:
            awarded:
              type: number
            max:
              type: number
            percentage:
              type: number
              nullable: true
            questions_graded:
              type: integer
            questions_failed:
              type: integer
        questions:
          type: array
          items:
            $ref: '#/components/schemas/QuestionResult'
        checked_copy:
          type: object
          properties:
            available:
              type: boolean
            download_path:
              type: string
              nullable: true
              example: /submissions/{id}/checked-copy
        graded_at:
          type: string
          format: date-time
          nullable: true
        credits_charged:
          type: number
          nullable: true
        error:
          type: object
          nullable: true
    QuestionResult:
      type: object
      properties:
        question_id:
          type: string
          format: uuid
        label:
          type: string
        section:
          type: string
          nullable: true
        status:
          type: string
          enum:
            - graded
            - failed
            - pending
            - cancelled
            - not_answered
        counted:
          type: boolean
          description: False when the answer does not count towards the total.
        awarded:
          type: number
          nullable: true
        max:
          type: number
        source:
          type: string
          nullable: true
          description: >-
            `ai`, `ai_reviewed` (a teacher edited it) or `auto` (objective
            answer scored by key).
        confidence:
          type: number
          nullable: true
        needs_review:
          type: boolean
        review_reasons:
          type: array
          items:
            type: string
          description: e.g. `low_confidence`, `failed`.
        extracted_answer:
          type: string
          nullable: true
          description: >-
            What the AI read (on by default; `include=-extracted_answer` turns
            it off).
        feedback:
          type: string
          nullable: true
        criteria:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              awarded:
                type: number
                nullable: true
              max:
                type: number
                nullable: true
              reason:
                type: string
                nullable: true
        model_answer:
          type: string
          nullable: true
          description: With `include=model_answer`.
        annotations:
          type: array
          items:
            type: object
          description: With `include=annotations`.
        review:
          type: object
          properties:
            reviewer:
              type: object
              properties:
                ref:
                  type: string
                name:
                  type: string
            reason:
              type: string
            edited:
              type: boolean
            edited_at:
              type: string
              format: date-time
              nullable: true
            approved:
              type: boolean
        error:
          type: object
          nullable: true
          properties:
            code:
              type: string
            message:
              type: string
    Error:
      type: object
      description: >-
        Every error uses this envelope. Branch on `error.code`; the message is
        for humans.
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: Stable machine code, e.g. `validation_failed`.
              example: validation_failed
            message:
              type: string
              description: Human-readable explanation.
              example: questions[1].max_marks must be a multiple of 0.5.
            request_id:
              type: string
              description: >-
                Quote this when you contact support (also sent as the
                X-Request-Id header).
            details:
              type: object
              description: >-
                Extra context. For `validation_failed`, `details.errors` lists
                every failing field.
              additionalProperties: true
  responses:
    Error401:
      description: Missing or invalid API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: invalid_api_key
              message: The API key is not valid.
              request_id: req_4f9c2a7e1b3d4c8a9e6f0b2d5a7c1e3f
    Error403:
      description: >-
        The key lacks the required scope, or the API is not enabled for the
        institute.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: insufficient_scope
              message: This API key lacks the evaluation:write scope.
              request_id: req_4f9c2a7e1b3d4c8a9e6f0b2d5a7c1e3f
              details:
                required_scope: evaluation:write
    Error404:
      description: Not found (ids of other institutes are also 404).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: not_found
              message: The resource was not found.
              request_id: req_4f9c2a7e1b3d4c8a9e6f0b2d5a7c1e3f
    Error429:
      description: Rate limit or daily quota reached. Retry after the Retry-After header.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: rate_limited
              message: Too many requests. Retry after 2 s.
              request_id: req_4f9c2a7e1b3d4c8a9e6f0b2d5a7c1e3f
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        Your institute's API key, `vak_eval_` followed by 48 hex characters. An
        institute admin creates keys in the dashboard under Settings ->
        Integrations -> API keys.

````

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