/amnesty/research

POST /api/amnesty/research

Price: 1 credit

Get an Amnesty International document: report, briefing, statement or urgent action, with its PDF

How to use it

Returns one document by URL, index number, alias or id. An index number without a language resolves the English edition; every language edition is its own document with its own id.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• document string required — Document URL, index number, alias or id (examples: "https://www.amnesty.org/en/documents/afr62/1454/2026/en/", "AFR 62/1454/2026", "afr62-1454-2026-en", "242478"; minLength: 1)

Response

• @type string (default: "AmnestyDocument")
• id string required
• alias string nullable
• url string nullable
• description string nullable
• index_number string nullable
• language string nullable
• language_name string nullable
• published_year integer nullable
• classification string nullable
• subclassification string nullable
• file_url string nullable
• file_size integer nullable
• mime_type string nullable
• thumbnail string nullable
• published_at integer nullable
• updated_at integer nullable
• categories array (default: [])
  • @type string (default: "AmnestyTerm")
  • id string required
  • name string nullable
  • alias string nullable
• countries array (default: [])
  • @type string (default: "AmnestyTerm")
  • id string required
  • name string nullable
  • alias string nullable
• resource_types array (default: [])
  • @type string (default: "AmnestyTerm")
  • id string required
  • name string nullable
  • alias string nullable
• topics array (default: [])
  • @type string (default: "AmnestyTerm")
  • id string required
  • name string nullable
  • alias 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 — No document with that URL, index number, alias or 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.