Skip to main content
An exam tells you what a student got wrong. An action plan says what to do about it. The Action Plan API reads the marking on a paper and writes the next steps as text, either for one student or for a teacher looking at the whole exam.

​
What is an action plan?

A short piece of written advice, built from the feedback recorded when a paper was marked. It names the questions where marks were lost, says what was misunderstood, and suggests what to do next. It is text, not a document or a screen, so your platform decides how it looks and who sees it.

​
Which action plans can I create?

Two, and they are separate requests.
There is no parent action plan in the API. The Action Plan API creates student plans and teacher plans, and nothing else. See Parent Action Plan for what a school can share with families today.

​
What does an action plan need?

A marked exam, and nothing else from you but its ID.
1

An exam with a model answer

The exam paper and its model answer are set up first. A model answer, the correct answer used for marking, has to be in place before any student paper can be evaluated.
2

At least one evaluated answer sheet

Marking records two things the plans depend on: the marks for each answer, and the feedback explaining what was wrong with it. A student plan needs one evaluated answer sheet. A teacher plan needs the exam to have at least one.
3

The ID

Send the answer sheet ID for a student plan, or the exam ID for a teacher plan. There are no other settings: no language, no length, no style.
See Evaluate an exam for the marking steps, and Create action plans for the calls.

​
What do the action types mean?

Every plan, and every question inside it, carries one of three labels.

Remediation

Teach the concept again. The feedback points at wrong answers or a basic misunderstanding.

Reinforcement

Give the student practice. The feedback suggests the idea is mostly there but not secure.

Extension

Move on to more advanced work on the concept.
The AI picks these labels from the wording of the marking feedback. They are not worked out from the marks, and nothing checks a label against the score. Because only answers that lost marks are ever sent, Extension does not mean the question was answered correctly or that the concept is mastered. Treat all three as the AI’s suggestion, not as a measurement.

​
What are the limits?

The same limits apply to both plans:
  • Only where marks were lost. Questions answered for full marks are never discussed. A paper with no marks deducted gives the AI nothing to write about.
  • English only. There is no language option.
  • Text only. No PDF, spreadsheet, worksheet, or lesson plan comes with a plan.
  • No editing. Plans cannot be edited or approved through the API. Ask for a new one instead.
  • The newest plan wins. Reading a plan returns the most recent one for that exam or answer sheet. Older plans are not returned.
  • Only the API user that created a plan can read it. The read is matched on the user, not the account, so a second API user on the same account gets nothing back. Use one API user for plans, or store the result on your side.
  • 20 requests a day per account by default, counted across both kinds of plan. The limit is a server setting, so the number on your account can differ.

​
Frequently asked questions

No. Nothing is created until you ask for it. Marking an answer sheet does not start a plan.
No. The Action Plan API does not pass anything to another product. If you want a worksheet from a plan, your platform reads the plan and then calls the AI Worksheet Builder or the AI Lesson Plan with what it decides to use.
Read it and check its status, or register the student_action_plan or teacher_action_plan webhook so the service calls your URL when the work ends. A plan is In Progress, Completed, or Failed. A teacher plan can also be Partial, when some questions were written up and others were not. A student plan is written in one go, so it is never Partial.
Not in the API. Nothing about a plan can be changed once written. If your product needs review before publishing, build that step on your side, using the plan text as the draft.
Only through the paper it reads. The plan is written from the exam’s own questions, model answers, and marking feedback. It is not mapped to a board or curriculum framework, and it does not carry topic or standard codes.
There is nothing to build a plan from. A teacher plan for such an exam comes back with the status Failed, and a student plan comes back with nothing useful in it.

​
Next steps

Student action plans

One marked answer sheet, one plan for that student.

Teacher action plans

One exam, one plan across the whole class.

Developer guide

Create student and teacher action plans with the API, step by step.

All APIs

Everything the CrazyGoldFish API offers.