/dryad/datasets/files

POST /api/dryad/datasets/files

Price: 5 credits

List the files of a Dryad dataset's current version. Returns each file's name, size in bytes, MIME type, checksum with its algorithm, the depositor's description of it, and a download link.

How to use it

This always describes the dataset's current version; Dryad keeps earlier versions but this endpoint does not reach them. `download_url` is the file's own address on Dryad, but Dryad answers it with 401 unless the caller carries a Dryad bearer token, so treat it as a citable location rather than as bytes you can pull. A README.md is present on most deposits and describes what the other files contain. `size` is bytes, so compare it with the dataset's `storage_size` to see whether one file dominates the deposit.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• dataset string required — Dryad dataset DOI, with or without the 'doi:' prefix, or the address of its Dryad page (examples: "10.5061/dryad.qbzkh190b", "doi:10.5061/dryad.qbzkh190b"; minLength: 1)
• count integer required — Max number of files (examples: 100; min: 1; max: 1000)

Response

• @type string (default: "DryadFile")
• id string required
• name string required
• url string required
• download_url string nullable
• size integer nullable
• mime_type string nullable
• status string nullable
• digest string nullable
• digest_type string nullable
• description string nullable
• dataset_id 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 Dryad dataset carries this DOI 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.