Approve a submission

curl --request POST \
  --url https://api.evalezy.com/v1/submissions/{submissionId}/approve \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "reviewer": {
    "ref": "TCH-031",
    "name": "Mrs. Kavita Rao"
  }
}
'

import requests

url = "https://api.evalezy.com/v1/submissions/{submissionId}/approve"

payload = { "reviewer": {
        "ref": "TCH-031",
        "name": "Mrs. Kavita Rao"
    } }
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({reviewer: {ref: 'TCH-031', name: 'Mrs. Kavita Rao'}})
};

fetch('https://api.evalezy.com/v1/submissions/{submissionId}/approve', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "exam_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "candidate": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "external_id": "<string>"
  },
  "state": "live",
  "replaced_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "queued",
  "lane": "<string>",
  "pages": 123,
  "needs_review": true,
  "review_reasons": [
    "<string>"
  ],
  "finalized": true,
  "finalized_at": "2023-11-07T05:31:56Z",
  "progress": {
    "step": "<string>",
    "questions_done": 123,
    "questions_total": 123,
    "estimated_ready_at": "2023-11-07T05:31:56Z"
  },
  "queue": {
    "position": 123,
    "estimated_ready_at": "2023-11-07T05:31:56Z"
  },
  "attempt_count": 123,
  "rubric_version": 123,
  "credits_charged": 123,
  "error": {
    "code": "<string>",
    "message": "<string>"
  },
  "metadata": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "code": "invalid_api_key",
    "message": "The API key is not valid.",
    "request_id": "req_4f9c2a7e1b3d4c8a9e6f0b2d5a7c1e3f"
  }
}

{
  "error": {
    "code": "insufficient_scope",
    "message": "This API key lacks the evaluation:write scope.",
    "request_id": "req_4f9c2a7e1b3d4c8a9e6f0b2d5a7c1e3f",
    "details": {
      "required_scope": "evaluation:write"
    }
  }
}

{
  "error": {
    "code": "not_found",
    "message": "The resource was not found.",
    "request_id": "req_4f9c2a7e1b3d4c8a9e6f0b2d5a7c1e3f"
  }
}

{
  "error": {
    "code": "conflict",
    "message": "The request conflicts with the current state.",
    "request_id": "req_4f9c2a7e1b3d4c8a9e6f0b2d5a7c1e3f"
  }
}

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Retry after 2 s.",
    "request_id": "req_4f9c2a7e1b3d4c8a9e6f0b2d5a7c1e3f"
  }
}

POST

submissions

{submissionId}

approve

Approve a submission

curl --request POST \
  --url https://api.evalezy.com/v1/submissions/{submissionId}/approve \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "reviewer": {
    "ref": "TCH-031",
    "name": "Mrs. Kavita Rao"
  }
}
'

import requests

url = "https://api.evalezy.com/v1/submissions/{submissionId}/approve"

payload = { "reviewer": {
        "ref": "TCH-031",
        "name": "Mrs. Kavita Rao"
    } }
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({reviewer: {ref: 'TCH-031', name: 'Mrs. Kavita Rao'}})
};

fetch('https://api.evalezy.com/v1/submissions/{submissionId}/approve', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "exam_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "candidate": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "external_id": "<string>"
  },
  "state": "live",
  "replaced_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "queued",
  "lane": "<string>",
  "pages": 123,
  "needs_review": true,
  "review_reasons": [
    "<string>"
  ],
  "finalized": true,
  "finalized_at": "2023-11-07T05:31:56Z",
  "progress": {
    "step": "<string>",
    "questions_done": 123,
    "questions_total": 123,
    "estimated_ready_at": "2023-11-07T05:31:56Z"
  },
  "queue": {
    "position": 123,
    "estimated_ready_at": "2023-11-07T05:31:56Z"
  },
  "attempt_count": 123,
  "rubric_version": 123,
  "credits_charged": 123,
  "error": {
    "code": "<string>",
    "message": "<string>"
  },
  "metadata": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "code": "invalid_api_key",
    "message": "The API key is not valid.",
    "request_id": "req_4f9c2a7e1b3d4c8a9e6f0b2d5a7c1e3f"
  }
}

{
  "error": {
    "code": "insufficient_scope",
    "message": "This API key lacks the evaluation:write scope.",
    "request_id": "req_4f9c2a7e1b3d4c8a9e6f0b2d5a7c1e3f",
    "details": {
      "required_scope": "evaluation:write"
    }
  }
}

{
  "error": {
    "code": "not_found",
    "message": "The resource was not found.",
    "request_id": "req_4f9c2a7e1b3d4c8a9e6f0b2d5a7c1e3f"
  }
}

{
  "error": {
    "code": "conflict",
    "message": "The request conflicts with the current state.",
    "request_id": "req_4f9c2a7e1b3d4c8a9e6f0b2d5a7c1e3f"
  }
}

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Retry after 2 s.",
    "request_id": "req_4f9c2a7e1b3d4c8a9e6f0b2d5a7c1e3f"
  }
}

Authorizations

X-API-Key

string

header

required

Your institute's API key, vak_eval_ followed by 48 hex characters. An institute admin creates keys in the dashboard under Settings -> Integrations -> API keys.

Headers

Idempotency-Key

string

Optional. Any unique string of 1-255 printable ASCII characters (a UUID works). Retrying with the same key within 48 hours replays the first response with Idempotent-Replayed: true.

Maximum string length: 255

Example:

"exam-cbse-sci-10a-2026-10-14"

Path Parameters

submissionId

string<uuid>

required

Submission id (UUID).

Body

application/json

reviewer

object

Show child attributes

Response

Status of one submission. Create, get, lists and the feed all return this shape.

string<uuid>

exam_id

string<uuid>

candidate

object

Show child attributes

state

string

live for the current submission; replaced or deleted otherwise.

Example:

"live"

replaced_by

string<uuid>

Present when this submission was replaced.

status

enum<string>

Available options:

queued,

processing,

reading,

grading,

graded,

partially_graded,

failed,

cancelled

lane

string

copy (handwritten) or typed.

pages

integer | null

Page count of the handwritten copy.

needs_review

boolean

review_reasons

string[]

Submission-level reasons, e.g. pages_beyond_vision_limit.

finalized

boolean

finalized_at

string<date-time> | null

progress

object | null

Show child attributes

queue

object | null

Only while queued.

Show child attributes

attempt_count

integer

How many evaluation runs this submission has had.

rubric_version

integer | null

credits_charged

number | null

Charged credits once graded; 0 for a typed submission with only objective answers; null while running or when failed/cancelled.

error

object | null

Only when failed, e.g. copy_unreadable or language_not_supported.

Show child attributes

metadata

object | null

created_at

string<date-time>

updated_at

string<date-time>

Overview

Endpoints

Approve a submission

Authorizations

Headers

Path Parameters

Body

Response