Get a teacher action plan

GET

action-plan

k12

teacher

{exam_id}

Get a teacher action plan

curl --request GET \
  --url https://api.crazygoldfish.com/action-plan/v1/k12/teacher/{exam_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.crazygoldfish.com/action-plan/v1/k12/teacher/{exam_id}"

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

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

print(response.text)

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

fetch('https://api.crazygoldfish.com/action-plan/v1/k12/teacher/{exam_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": {
    "id": "d19e6868-98dd-4274-a2a5-4a616dd93ea7",
    "exam_name": "Grade 10 Science Half Yearly",
    "status": "In Progress",
    "created_at": "2026-09-17T11:24:38.512431",
    "action_plan": [],
    "overview": {},
    "learning_outcomes": [],
    "student_groups": []
  }
}

Step 2 of 4 in Create action plans. Poll every 5 seconds until status is Completed or Partial.

Rules

exam_id is the same exam UUID you sent to Create a teacher action plan.
You only see plans that your own API user started. Use the same API user for both calls.
If you started the plan more than once for this exam, you get the newest one.

Reading the response

Response	Meaning	What to do
`200` with `status: "In Progress"`	Still running. `action_plan` is an empty list, and the other parts of the plan are empty.	Poll again
`200` with `status: "Completed"`	Ready	Show the plan to the teacher
`200` with `status: "Partial"`	Finished, with part of the plan missing: some questions have no action, or the overview or the learning outcomes could not be written	Use what came back, or start the plan again
`200` with `status: "Failed"`	Nothing could be written. `action_plan` holds one entry with an `error`.	Start the plan again
`400` `Invalid exam ID format.`	`exam_id` is not a UUID	Fix the ID
`404` `Exam not found for the given exam ID.`	No such exam	Check the ID against the Exam Evaluation API
`404` `Action plan not found for the given exam ID.`	This API user has no plan for this exam	Call the POST endpoint first

status has four values: In Progress, Completed, Partial, and Failed. A plan starts as In Progress. Partial is a finished plan, not a running one, so treat it as ready and stop polling.

What the plan contains

Part of `data`	What it is
`overview`	How the class did on the whole paper, and what to act on first
`action_plan`	One action for each question where at least one student lost marks
`learning_outcomes`	The learning outcomes the paper assesses, with what to do about each
`student_groups`	The class split into score groups, with what each group needs

All four parts are always in the response with the same type. Until the plan is Completed or Partial they are empty: action_plan, learning_outcomes and student_groups are empty lists, and overview is an empty object. Every number in the plan is computed from the evaluation’s marks. The AI writes the text.

`overview`

Field	Meaning
`summary`	How the class did, in a few sentences
`strengths`	Two to four things the class does well
`priorities`	Up to three things to act on, the most important first. Each has a `title`, an `insight`, an `action`, and the `question_numbers` it rests on.
`class_stats`	The class’s marks. See below.

`class_stats` field	Meaning
`students_evaluated`	Students with at least one evaluated answer
`total_marks`	What the paper is worth
`class_average_marks`, `class_average_percent`	The class average, in marks and as a percentage
`median_marks`, `highest_marks`, `lowest_marks`	The middle, top and lowest student’s marks
`students_per_group`	How many students are in each score group

`action_plan`

Field	Meaning
`question_number`	The question the action is about
`students`	The student IDs that lost marks on it
`student_details`	The same students, each with `student_id`, `student_name` and `display_name`
`overall_insight`	What the class got wrong and why, and how widespread it is
`common_errors`	The one to three most common mistakes, as short phrases
`action_type`	`Reinforcement`, `Remediation`, or `Extension`
`action`	What the teacher should do in class
`max_marks`	What the question is worth
`class_summary`	How many students got full, partial or zero marks or left it blank, and the average marks
`learning_outcome`	The learning outcome this question assesses

class_summary counts only the students for whom the question counted. A student who chose another question in an “answer any 8 of 12” section is not in it.

`learning_outcomes`

Field	Meaning
`learning_outcome`	What a student should be able to do, written in the style of NCERT learning outcomes
`competency`	The broader competency it belongs to
`question_numbers`	The questions that assess it. Every question is under exactly one outcome.
`insight`	Why the class is at the level it is on this outcome
`action`	What to do to raise it

`student_groups`

A student is placed in a group by their percentage on the whole paper. Only groups that have students are returned.

`group_name`	`score_range`
`Needs support`	below 35%
`Developing`	35% to below 60%
`Proficient`	60% to below 80%
`Advanced`	80% and above

Field	Meaning
`student_count`, `students`	Who is in the group. Each student has `student_id`, `student_name` and `display_name`.
`group_average_percent`	The group’s average on the whole paper
`weakest_questions`	Up to five questions the group scored lowest on, each with `max_marks`, `group_average_marks` and `group_score_percent`
`insight`	What these students can already do and what holds them back
`action`	What the teacher should do with this group next

group_score_percent is the group’s score on one question, so 0.0 means nobody in the group scored on that question. The group’s overall average is group_average_percent.

How students are named

The answer sheet has	`student_id`	`display_name`
A student ID and a name	The student ID	`S-1042 - Aarav Sharma`
A student ID, no name	The student ID	`S-1042`
A name, no student ID	The answer sheet ID	`<answer sheet ID> - Aarav Sharma`
Neither	The answer sheet ID	`<answer sheet ID>`

Names come from the answer sheets and are never sent to the AI.

Instead of polling, register a webhook for teacher_action_plan. See Async jobs and webhooks.

Next step

Create a student action plan

Generate personalized next steps for one student’s answer sheet.

Authorizations

Authorization

string

header

required

Access token from Get an access token.

Path Parameters

exam_id

string<uuid>

required

The exam unique_id from the Exam Evaluation API, the same ID you send to Create a teacher action plan.

Example:

"d19e6868-98dd-4274-a2a5-4a616dd93ea7"

Response

The plan exists. It is returned with HTTP 200 for every status, including Failed.

data

object

Show child attributes

Get a teacher action plan

curl --request GET \
  --url https://api.crazygoldfish.com/action-plan/v1/k12/teacher/{exam_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.crazygoldfish.com/action-plan/v1/k12/teacher/{exam_id}"

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

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

print(response.text)

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

fetch('https://api.crazygoldfish.com/action-plan/v1/k12/teacher/{exam_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": {
    "id": "d19e6868-98dd-4274-a2a5-4a616dd93ea7",
    "exam_name": "Grade 10 Science Half Yearly",
    "status": "In Progress",
    "created_at": "2026-09-17T11:24:38.512431",
    "action_plan": [],
    "overview": {},
    "learning_outcomes": [],
    "student_groups": []
  }
}

Get started

Guides

Exam Evaluation

Assignment Evaluation

Rubrics

Action Plans

Lesson Plan Builder

Worksheet Builder

ClassTrack

Metadata

Webhooks

Get a teacher action plan

Rules

Reading the response

What the plan contains

`overview`

`action_plan`

`learning_outcomes`

`student_groups`

How students are named

Next step

Create a student action plan

Authorizations

Path Parameters

Response

​Rules

​Reading the response

​What the plan contains

​overview

​action_plan

​learning_outcomes

​student_groups

​How students are named

​Next step

Create a student action plan

Authorizations

Path Parameters

Response

Rules

Reading the response

What the plan contains

`overview`

`action_plan`

`learning_outcomes`

`student_groups`

How students are named

Next step