Skip to content
AIDE AI Partner API

A paper's questions, marks and answer keys have been read

POST

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
AIDE-Signature
required
string

Verify it before you trust the body (client docs, “Verify the signature”).

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
id
required
string
object
required
string
Allowed value: event
type
required
string
Allowed value: paper.awaiting_review
livemode
required
boolean
created_at
required
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:Z))$/
data
required
object
object
required
Any of:
object
id
required
string
object
required
string
Allowed value: paper
livemode
required
boolean
title
required
string
subject_id
required
string
status
required
string
Allowed values: processing awaiting_review ready failed
failure
required
Any of:
object
code
required
string
Allowed values: file_download_failed file_unreadable unsupported_file_type file_too_large too_many_pages insufficient_credits credits_expired processing_timeout no_questions_found processing_failed
message
required
string
warnings
required
Array<string>
Allowed values: questions_may_be_incomplete answer_keys_missing scheme_instructions_not_used
question_paper
required
object
file_id
required
Any of:
string
pages
required
Any of:
integer
marking_scheme
required
object
file_id
required
Any of:
string
pages
required
Any of:
integer
question_count
required
Any of:
integer
total_marks
required
Any of:
number
results_release
required
string
Allowed values: automatic after_review
grading
required
object
strictness
required
string
Allowed values: lenient standard strict
feedback
required
string
Allowed values: none brief standard detailed
instructions
required
Any of:
string
billing
required
object
status
required
string
Allowed values: pending held charged not_charged
pages
required
Any of:
integer
credits
required
Any of:
integer
submission_counts
required
object
key
additional properties
integer
external_id
required
Any of:
string
metadata
required
object
key
additional properties
string
created_at
required
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:Z))$/
approved_at
required
Any of:
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:Z))$/
updated_at
required
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:Z))$/

Responses

Section titled “Responses”

2XX

Section titled “2XX”

Received. Anything else, or no answer within 10 seconds, is retried.