/studocu/documents/search

POST /api/studocu/documents/search

Price: 20 credits

Search Studocu study documents

How to use it

Search Studocu documents by text. One query reaches at most 1000 documents, so narrow with the filters rather than asking for more; the course and institution ids come from the other Studocu endpoints or from earlier results.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• query string required — Search text. (examples: "pharmacology"; minLength: 1)
• count integer required — Number of documents to return. (min: 1; max: 1000)
• sort_by string — Result order. (default: "relevance"; one of: "relevance", "newest", "oldest", "most_pages", "fewest_pages")
• category_ids array — Document category ids, matched as any-of; the ids are the `category_id` values results carry (for example 3 is lecture notes, 7 summaries). (default: []; examples: ["3"])
• language string nullable — Two-letter language code as carried in `language` of results. (examples: "en"; pattern: ^[a-z]{2}$)
• min_academic_year integer nullable — Earliest academic start year covered by the document. (min: 1990; max: 2100)
• max_academic_year integer nullable — Latest academic start year covered by the document. (min: 1990; max: 2100)
• min_page_count integer nullable — Minimum number of pages. (min: 1)
• max_page_count integer nullable — Maximum number of pages. (min: 1)
• institution_id string nullable — Studocu institution id. (examples: "10023"; pattern: ^\d+$)
• course_id string nullable — Studocu course id. (examples: "4502877"; pattern: ^\d+$)
• has_quizzes boolean nullable — Only documents with (true) or without (false) a quiz.

Response

• @type string (default: "StudocuDocumentCard")
• id string required
• name string required
• generated_name string nullable
• summary string nullable
• url string required
• published_at integer nullable
• page_count integer nullable
• language string nullable
• category_id string nullable
• category_name string nullable
• academic_year string nullable
• academic_years array (default: [])
• is_premium boolean nullable
• rating_count integer nullable
• positive_rating_count integer nullable
• negative_rating_count integer nullable
• positive_experience_probability number nullable
• has_quizzes boolean nullable
• quizzes array (default: [])
  • @type string (default: "StudocuQuiz")
  • id string required
  • name string nullable
  • question_count integer 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

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 — The entity was not found, or a precondition failed 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.