Generate worksheet explanations

POST

worksheet

generate-explanations

{work_sheet_id}

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

import requests

url = "https://api.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.crazygoldfish.com/worksheet/v1/generate-explanations/{work_sheet_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "detail": [
    {
      "id": "152764ca-1685-427c-aba7-4b92dcc0d60f",
      "msg": "Worksheet explanation generation initiated successfully."
    }
  ]
}

Step 4 of 4 (optional) in Generate a worksheet. Call this after questions are Completed. There is no request body.

This step runs once per worksheet. A second call returns 400 unless the first one failed.

The API doesn’t reliably reject an early call. If question generation has never started for the worksheet, this call is accepted and the job is queued with nothing to explain. Waiting for questions to reach Completed is your responsibility.

Next step

Get worksheet explanations

Poll until the response is 200, or wait for the worksheet_explanation_generation webhook.

Authorizations

Authorization

string

header

required

Access token from Get an access token.

Path Parameters

work_sheet_id

string<uuid>

required

The worksheet id returned by Start a worksheet.

Example:

"152764ca-1685-427c-aba7-4b92dcc0d60f"

Response

The job was queued. Poll the matching GET endpoint or wait for the webhook.

detail

object[]

Show child attributes

Get started

Guides

Exam Evaluation

Assignment Evaluation

Rubrics

Action Plans

Lesson Plan Builder

Worksheet Builder

ClassTrack

Metadata

Webhooks

Generate worksheet explanations

Next step

Get worksheet explanations

Authorizations

Path Parameters

Response

​Next step

Get worksheet explanations

Authorizations

Path Parameters

Response

Next step