> ## 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.

# v1/toefl/evaluation

> Submit a request for evaluation directly by providing questions and respective answers in a json format. The API generates an evaluation report based on the provided data, and returns an acknowledgment along with an evaluation ID.



## OpenAPI

````yaml POST /v1/toefl/evaluation
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:
  /v1/toefl/evaluation:
    post:
      summary: Submit Evaluation Request
      description: >-
        Allows B2B clients to submit a request for evaluation directly by
        providing questions and respective answers in JSON format.
      parameters:
        - name: accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
            default: application/json
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                client_id:
                  type: string
                  description: Unique identifier assigned to the client accessing the API.
                  example: '1'
                institution_id:
                  type: string
                  description: Unique identifier of the institution (optional).
                  example: inst_456
                teacher_id:
                  type: string
                  description: Identifier of the teacher (optional).
                  example: ''
                parent_id:
                  type: string
                  description: >-
                    Unique identifier of the parent associated with the student
                    (optional).
                  example: ''
                student_id:
                  type: string
                  description: >-
                    Identifies the specific student for whom the evaluation is
                    being requested.
                  example: '123'
                exam_type:
                  type: string
                  description: Type of TOEFL exam (essentials, ibt).
                  example: IB
                  enum:
                    - ES
                    - IB
                student_name:
                  type: string
                  description: >-
                    Name of the student for whom the evaluation is being
                    requested.
                  example: Jhon Doe
                image_urls:
                  type: array
                  items:
                    type: string
                  description: >-
                    List of URLs pointing to the images of the evaluated work
                    (optional).
                  example:
                    - http://example.com/image1.jpg
                    - http://example.com/image2.jpg
                evaluation_text:
                  type: array
                  items:
                    type: object
                    properties:
                      question_id:
                        type: string
                        description: Identifier of the question.
                        example: q1
                      question_number:
                        type: string
                        description: Number of the question.
                        example: '1'
                      question_section:
                        type: string
                        description: Section of the question (currently 'writing').
                        example: writing
                        enum:
                          - writing
                      question_type:
                        type: string
                        description: >-
                          Type of the question. Check product description page
                          for [Question Types
                          details.](https://docs.crazygoldfish.com/products/toefl)
                        example: TF-ES-W-02
                        enum:
                          - TF-ES-W-01
                          - TF-ES-W-02
                          - TF-ES-W-03
                          - TF-ES-W-04
                          - TF-ES-W-05
                          - TF-IB-W-01
                          - TF-IB-W-02
                      question_text:
                        type: string
                        description: Text of the question.
                        example: >-
                          Write your personal opinion on the academic topic.
                          answer the question based on the discussion.Minimum of
                          100 words 
                           Academic Discussion Professor John: Many universities offer online courses as an alternative to traditional classroom-based learning. Do you think online courses provide the same quality of education as traditional classroom-based learning? Why or why not? Use examples and details in your response.Jason: I believe online courses can provide a similar quality of education as traditional classroom-based learning. With advanced technology and interactive platforms, students can access high-quality lectures, engage in virtual discussions, and submit assignments online, often at their own pace and convenience. So, personally, I think that online courses provide the same quality of education as traditional classroom-based learning while being more accessible. 
                           Anna: In my opinion, online courses offer convenience and flexibility, but they often fall short of delivering the same quality of education as traditional classroom-based learning. In a traditional classroom setting, students can actively engage in discussions, ask questions, and receive immediate feedback from professors, which facilitates deeper understanding and retention of the material. While online courses offer certain advantages, such as accessibility, they often lack the personalized attention and immersive learning experience provided by traditional classroom-based learning.
                      question_multimedia_url:
                        type: string
                        description: URL of multimedia related to the question (optional).
                        example: ''
                      answer_text:
                        type: string
                        description: Text of the answer.
                        example: >-
                          In fact, online courses could provide the same quality
                          of education similar to the one a student will
                          experience in a classroom.But it all depends on how
                          they are designed and delivered. eg universities
                          employing advanced technology with interactive
                          platforms are able to offer quality lectures, virtual
                          discussions, and online assignments. These ingredients
                          allow learning at a self-determined pace which is
                          essential for people who have other commitments, such
                          as work or family. Moreover, the flexibility and
                          accessibilities of online courses could let more types
                          of students be involved in the learning process,
                          enriching it for everyone. For example, suppose some
                          student lives in a remote area and is unable to
                          commute to any university. With the help of online
                          courses, he or she can obtain top-class education. At
                          the same time, it is also necessary to be aware of the
                          negative side, like the impossibility of immediate
                          feedback and interaction with professors and peers,
                          which is more available in a traditional class.
                    required:
                      - question_id
                      - question_number
                      - question_section
                      - question_type
                      - question_text
                      - answer_text
                  description: List of evaluation questions and answers.
              required:
                - client_id
                - student_id
                - exam_type
                - student_name
                - evaluation_text
      responses:
        '200':
          description: Evaluation request submitted successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  status_code:
                    type: string
                    example: '200'
                  status:
                    type: string
                    example: Processing
                  message:
                    type: string
                    example: Evaluation request submitted successfully
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        evaluation_id:
                          type: string
                          example: bbb264b6-4780-4095-a973-25daa5e8545f
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Invalid request body
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: array
                    items:
                      type: object
                      properties:
                        loc:
                          type: array
                          items:
                            type: string
                        msg:
                          type: string
                        type:
                          type: string
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````