POST - Generate Worksheet Explanations

Initiates the worksheet explanation generation process for a given worksheet.
This step generates detailed explanations for each question in the worksheet after question generation is completed.

Prerequisites:

The worksheet must exist.
The question generation step (QUESTION_GENERATION) must be completed.
The explanation generation must not already be in progress or completed.

How to Use:

Call POST /worksheet/v1/generate-explanations/{work_sheet_id} with a valid worksheet ID.
The API validates that:
- The worksheet exists.
- Question generation is completed.
- Explanation generation has not already started or completed.
If validation passes, the explanation generation job is queued asynchronously.
You receive a confirmation message with the worksheet ID.

Path Parameters:

work_sheet_id (UUID, required): The unique ID of the worksheet.

Response Codes:

200 OK: Explanation generation initiated successfully.
400 Bad Request: Question generation not completed yet, or explanation generation already in progress/completed.
404 Not Found: Worksheet not found.

POST

worksheet

generate-explanations

{work_sheet_id}

Generate Worksheet Explanations

curl --request POST \
  --url https://api-staging.crazygoldfish.com/worksheet/v1/generate-explanations/{work_sheet_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api-staging.crazygoldfish.com/worksheet/v1/generate-explanations/{work_sheet_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api-staging.crazygoldfish.com/worksheet/v1/generate-explanations/{work_sheet_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-staging.crazygoldfish.com/worksheet/v1/generate-explanations/{work_sheet_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-staging.crazygoldfish.com/worksheet/v1/generate-explanations/{work_sheet_id}"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api-staging.crazygoldfish.com/worksheet/v1/generate-explanations/{work_sheet_id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-staging.crazygoldfish.com/worksheet/v1/generate-explanations/{work_sheet_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "detail": [
    {
      "id": "d7494c99-0539-ce2-92e0c2ede6d1",
      "msg": "Worksheet explanation generation initiated successfully."
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

work_sheet_id

string<uuid>

required

Unique identifier of the worksheet

Response

Worksheet explanation generation initiated successfully.

detail

object[]

Show child attributes

GET - Get Worksheet ExplanationsRetrieves all questions with their explanations for a given worksheet. The response includes worksheet metadata along with questions that have an `explanation` key added to each question object. **Prerequisites:** - The worksheet must exist. - The question generation step must be completed. - The explanation generation step must be completed. **How to Use:** 1. Call `GET /worksheet/v1/generate-explanations/{work_sheet_id}` with the worksheet ID. 2. On success, you will receive worksheet metadata along with questions and their explanations. 3. If the worksheet or any required step is missing, a `404` error is returned. 4. If the generation steps are not yet completed, a `400` error is returned with the current status. 5. If explanation generation failed, a `400` error is returned with the failure message. **Path Parameters:** - `work_sheet_id` (UUID, required): The unique ID of the worksheet. **Response Data:** - `id`: Worksheet ID. - `board`: Board details (id and name). - `grade`: Grade details (id and name). - `section`: Worksheet section. - `subject`: Subject details (id and name). - `status`: Current status of the explanation generation step. - `number_of_questions`: Total number of questions in the worksheet. - `topic`: Topic of the worksheet. - `documents`: List of document URLs associated with the worksheet. - `audio`: Audio URL if available. - `questions`: Array of questions with explanations merged. **Response Codes:** - `200 OK`: Questions with explanations returned successfully. - `400 Bad Request`: Questions or explanations not yet generated, or generation failed. - `404 Not Found`: Worksheet, questions, or explanations not found. - `500 Internal Server Error`: Unexpected error occurred.

Generate Worksheet Explanations

curl --request POST \
  --url https://api-staging.crazygoldfish.com/worksheet/v1/generate-explanations/{work_sheet_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api-staging.crazygoldfish.com/worksheet/v1/generate-explanations/{work_sheet_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api-staging.crazygoldfish.com/worksheet/v1/generate-explanations/{work_sheet_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-staging.crazygoldfish.com/worksheet/v1/generate-explanations/{work_sheet_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-staging.crazygoldfish.com/worksheet/v1/generate-explanations/{work_sheet_id}"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api-staging.crazygoldfish.com/worksheet/v1/generate-explanations/{work_sheet_id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-staging.crazygoldfish.com/worksheet/v1/generate-explanations/{work_sheet_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "detail": [
    {
      "id": "d7494c99-0539-ce2-92e0c2ede6d1",
      "msg": "Worksheet explanation generation initiated successfully."
    }
  ]
}

Overview

Authentication

K12

Assignment Rubrics

Meta Data

Lesson Plan

Worksheet Generation

Action Plans

Webhook

Classroom Observation

Standardized Language Exams

POST - Generate Worksheet Explanations

Authorizations

Path Parameters

Response