/studocu/documents

POST /api/studocu/documents

Price: 10 credits

Get a Studocu study document by id or URL

How to use it

Get one Studocu document (lecture notes, exam guides, summaries) by numeric id or document URL. Returns the document metadata, its course and institution, the uploader, ratings and the open preview text.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• document string required — Studocu document id or document URL. (examples: "89750778", "https://www.studocu.com/en-us/document/chamberlain-university/advanced-pathophysiology/nr507-final-exam-study-guide/89750778"; minLength: 1)

Response

• @type string (default: "StudocuDocument")
• id string required
• alias string nullable
• name string required
• summary string nullable
• url string required
• image string nullable
• created_at integer nullable
• published_at integer nullable
• page_count integer nullable
• preview_page_count integer nullable
• category_id string nullable
• academic_year string nullable
• is_premium boolean nullable
• premium_reason string nullable
• rating_count integer nullable
• positive_rating_count integer nullable
• negative_rating_count integer nullable
• positive_experience_probability number nullable
• text string nullable
• is_text_markdown boolean nullable
• course object nullable
  • @type string (default: "StudocuCourseRef")
  • id string required
  • name string nullable
  • code string nullable
  • url string nullable
  • course_type string nullable
  • document_count integer nullable
  • follower_count integer nullable
  • institution object nullable
    • @type string (default: "StudocuInstitutionRef")
    • id string required
    • name string nullable
    • short_name string nullable
    • url string nullable
    • level string nullable
    • institution_type string nullable
    • country_id string nullable
    • region_code string nullable
    • city string nullable
• institution object nullable
  • @type string (default: "StudocuInstitutionRef")
  • id string required
  • name string nullable
  • short_name string nullable
  • url string nullable
  • level string nullable
  • institution_type string nullable
  • country_id string nullable
  • region_code string nullable
  • city string nullable
• author object nullable
  • @type string (default: "StudocuUser")
  • id string required
  • name string nullable
  • first_name string nullable
  • last_name string nullable
  • image string nullable
  • is_anonymous boolean nullable
  • is_expert boolean nullable
  • upload_count integer nullable
  • follower_count integer nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — No document with this id. Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.