Download the report

GET

/v1/submissions/{id}/report

const url = 'https://api.learningaide.ai/v1/submissions/example/report';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.learningaide.ai/v1/submissions/example/report \
  --header 'Authorization: Bearer <token>'

Authorizations

bearer
submissions:read

Parameters

Path Parameters

required

string

Query Parameters

sections

string

<= 64 characters /^\s*(?:marks|summary|feedback)\s*(?:,\s*(?:marks|summary|feedback)\s*)*$/

Responses

200

The request succeeded.

application/json

object

object

required

string

Allowed value: report

submission_id

required

string

status

required

string

Allowed values: ready rendering

sections

required

Array<string>

Allowed values: marks summary feedback

url

required

Any of:

string
null

string format: uri

expires_at

required

Any of:

string
null

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": "report",
  "status": "ready",
  "sections": [
    "marks"
  ]
}

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.

202

Not ready yet. Retry after the number of seconds in Retry-After.

application/json

object

object

required

string

Allowed value: report

submission_id

required

string

status

required

string

Allowed values: ready rendering

sections

required

Array<string>

Allowed values: marks summary feedback

url

required

Any of:

string
null

string format: uri

expires_at

required

Any of:

string
null

string format: date-time

Example

{
  "object": "report",
  "status": "ready",
  "sections": [
    "marks"
  ]
}

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.

default

An error (client docs, “Errors”).

application/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
null

string

resource_id

required

Any of:

string
null

string

request_id

required

Any of:

string
null

string

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.