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

# POST - Embeddable UI Link

>  The Embeddable UI API allows platforms to generate a unique embeddable link for a pre-configured user interface. This UI enables users to upload handwritten answer sheets, view model answers, and receive detailed evaluations. The API simplifies the integration process, making it easy for platforms to offer this functionality as part of their workflows. 

**Scenario: Integrating the Embeddable UI into an Educational Platform:**

1. **Platform Integration:**
   - An educational platform wants to provide users with the ability to upload handwritten answer sheets, view model answers, and receive evaluations. Instead of building a custom interface, they use the Embeddable UI API to generate a unique embeddable link.
   - The link is pre-configured to provide:
     - Upload options for handwritten answer sheets in PDF or image format.
     - A view to compare their answers with model answers.
     - Detailed evaluations of their answers based on the model answers and marking scheme.

2. **Outcome:**
   - The platform seamlessly embeds the UI into their system, allowing users to interact with the grading and evaluation features without navigating away from the main educational platform. 



## OpenAPI

````yaml POST /evaluation-platform/v1/embeddable-ui-link/
openapi: 3.0.1
info:
  title: Evaluation Report API
  description: An API for retrieving evaluation reports.
  version: 1.0.0
servers:
  - url: https://api-staging.crazygoldfish.com
    description: SandBox endpoint
  - url: https://api.crazygoldfish.com
    description: Prod End Point
security: []
paths:
  /evaluation-platform/v1/embeddable-ui-link/:
    post:
      summary: Get Embeddable UI Link
      description: Get Embeddable UI Link
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                examId:
                  type: string
                  description: Unique identifier of the exam
                  example: 4340132f-50fa-4877-9ffa-e9b7ee59d51f
                studentId:
                  type: string
                  description: Unique identifier of the student
                  example: '2017009807'
                instituteId:
                  type: string
                  description: Unique identifier of the institution
                  nullable: true
                  example: '98765'
                teacherId:
                  type: string
                  nullable: true
                  description: Unique identifier of the teacher
                  example: '54321'
                studentName:
                  type: string
                  nullable: true
                  description: Name of the student
                  example: John Doe
                parentId:
                  type: string
                  nullable: true
                  description: Unique identifier of the parent
                  example: '11223'
              required:
                - examId
                - studentId
      responses:
        '201':
          description: Answer sheet created successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  link:
                    type: string
                    description: Link to the embeddable UI
                    example: >-
                      https://k12.crazygoldfish.com/evaluate/4340132f-50fa-4877-9ffa-e9b7ee59d51f/answers/f5f2576f-1e3a-4869-88ae-a2c6cd2b9eab
                  studentId:
                    type: string
                    description: Unique identifier of the student
                    example: '2017009807'
                  instituteId:
                    type: string
                    description: Unique identifier of the institution
                    example: '98765'
                  teacherId:
                    type: string
                    description: Unique identifier of the teacher
                    example: '54321'
                  studentName:
                    type: string
                    description: Name of the student
                    example: John Doe
                  parentId:
                    type: string
                    description: Unique identifier of the parent
                    example: '11223'
        '400':
          description: Bad Request - Invalid input or missing required fields
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: integer
                        example: 400
                      message:
                        type: object
                        properties:
                          examId:
                            type: array
                            items:
                              type: string
                              example: Must be a valid UUID.
        '403':
          description: Authentication failed.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    example: Token has expired
              example:
                detail: Token has expired
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````