Get assignment constants

GET

assignment-evaluation

assignment

constant

curl --request GET \
  --url https://api.crazygoldfish.com/assignment-evaluation/v1/assignment/constant/ \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.crazygoldfish.com/assignment-evaluation/v1/assignment/constant/"

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/assignment-evaluation/v1/assignment/constant/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "status": {
    "0": "Open",
    "1": "In Progress",
    "2": "Completed",
    "3": "Failed"
  },
  "fileType": {
    "1": "pdf",
    "2": "jpeg",
    "3": "Audio Link",
    "4": "png"
  }
}

Every assignment, model answer sheet, answer sheet, and document reports progress with the same four status values. They never change, so you can hard-code them instead of calling this endpoint.

`status`	Name	What it means
`0`	Open	Created. Nothing has been sent to the AI yet.
`1`	In Progress	The AI is working. Keep polling.
`2`	Completed	Ready. Fetch the result.
`3`	Failed	The AI could not finish. Start again with a new upload.

The fileType numbers in this response do not match the fileType on a document you uploaded. A JPEG is stored as 3, and an audio link is also stored as 3. In practice you receive 1 for a PDF, 3 for a JPEG or an audio link, and 4 for a PNG. Tell a JPEG and an audio link apart by audio_link, which is set only on an audio link.

Next step

Create an assignment

Start the flow in Evaluate an assignment.

Authorizations

Authorization

string

header

required

Access token from Get an access token.

Response

The status and file type maps.

status

object

Status values used by assignments, model answer sheets, answer sheets, and documents.

Show child attributes

fileType

object

File type names. These numbers do not match the fileType on an uploaded document: a JPEG is stored as 3, and an audio link is also 3. Tell them apart by audio_link, which is set only on an audio link.

Show child attributes

Get assignment constants

curl --request GET \
  --url https://api.crazygoldfish.com/assignment-evaluation/v1/assignment/constant/ \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.crazygoldfish.com/assignment-evaluation/v1/assignment/constant/"

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/assignment-evaluation/v1/assignment/constant/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "status": {
    "0": "Open",
    "1": "In Progress",
    "2": "Completed",
    "3": "Failed"
  },
  "fileType": {
    "1": "pdf",
    "2": "jpeg",
    "3": "Audio Link",
    "4": "png"
  }
}

Get started

Guides

Exam Evaluation

Assignment Evaluation

Rubrics

Action Plans

Lesson Plan Builder

Worksheet Builder

ClassTrack

Metadata

Webhooks

Get assignment constants

Next step

Create an assignment

Authorizations

Response

​Next step

Create an assignment

Authorizations

Response

Next step