Update a paper

PATCH

/v1/papers/{id}

curl --request PATCH \
  --url https://api.learningaide.ai/v1/papers/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "title": "example", "external_id": "example", "metadata": { "additionalProperty": "example" } }'

Authorizations

• bearer
  papers:write

Parameters

Path Parameters

id

required

string

Request Body^required

Media typeapplication/json

object

title

string

>= 1 characters <= 255 characters /^[^\u0000-\u001f\u007f]*$/

external_id

Any of:

string

string

>= 1 characters <= 128 characters /^[^\u0000-\u001f\u007f]*$/

null

null

metadata

object

<= 20 properties

key

additional properties

string

<= 500 characters

Example ^generated

{
  "title": "example",
  "external_id": "example",
  "metadata": {
    "additionalProperty": "example"
  }
}

Responses

200

The request succeeded.

Media typeapplication/json

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

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

null

null

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

string

null

null

pages

required

Any of:

integer

integer

null

null

marking_scheme

required

object

file_id

required

Any of:

string

string

null

null

pages

required

Any of:

integer

integer

null

null

question_count

required

Any of:

integer

integer

null

null

total_marks

required

Any of:

number

number

null

null

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

string

null

null

billing

required

object

status

required

string

Allowed values: pending held charged not_charged

pages

required

Any of:

integer

integer

null

null

credits

required

Any of:

integer

integer

null

null

submission_counts

required

object

key

additional properties

integer

external_id

required

Any of:

string

string

null

null

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

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))$/

null

null

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))$/

Example

{
  "object": "paper",
  "status": "processing",
  "failure": {
    "code": "file_download_failed"
  },
  "warnings": [
    "questions_may_be_incomplete"
  ],
  "results_release": "automatic",
  "grading": {
    "strictness": "lenient",
    "feedback": "none"
  },
  "billing": {
    "status": "pending"
  }
}

Headers

X-Request-Id

required

string

This request’s ID. Quote it when you contact support.

RateLimit-Limit

integer

Requests allowed per window.

RateLimit-Remaining

integer

Requests left in the current window.

RateLimit-Reset

integer

Seconds until the window resets.

default

An error (client docs, “Errors”).

Media typeapplication/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error billing_error permission_error rate_limit_error api_error

code

required

string

Allowed values: parameter_missing parameter_invalid parameter_unknown invalid_json idempotency_key_missing api_key_missing api_key_invalid api_key_revoked insufficient_credits credits_expired insufficient_scope ip_not_allowed account_suspended resource_missing route_not_found idempotency_key_reused idempotency_request_in_progress external_id_taken paper_not_ready paper_not_awaiting_review paper_in_progress paper_has_empty_question review_link_unavailable file_already_attached file_purpose_mismatch file_not_uploaded file_expired submission_exists submission_not_cancelable submission_not_releasable submission_in_progress result_not_available report_not_available too_many_webhook_endpoints request_too_large unsupported_media_type rate_limit_exceeded internal_error service_unavailable

message

required

string

param

required

Any of:

string

string

null

null

resource_id

required

Any of:

string

string

null

null

request_id

required

Any of:

string

string

null

null

Example

{
  "error": {
    "type": "invalid_request_error",
    "code": "parameter_missing"
  }
}

Headers

X-Request-Id

required

string

This request’s ID. Quote it when you contact support.

RateLimit-Limit

integer

Requests allowed per window.

RateLimit-Remaining

integer

Requests left in the current window.

RateLimit-Reset

integer

Seconds until the window resets.

Retry-After

integer

Seconds to wait before asking again.