Create a deposit for a new RO-Crate
POST/deposits
Optional core — provided when deposit.supported is true. See the Deposits guide.
Open a deposit session that will create a new RO-Crate. The RO-Crate comes into existence only at the deposit's first successful finalise — until then nothing is readable and no entities exist.
The request body MAY propose a roCrateId where the implementation's idMinting capability is client or both; when the body or the field is absent the server mints one (server or both). Proposing an ID that is not supported by the declared idMinting mode is rejected with 422; proposing an ID that already exists is rejected with 409. The RO-Crate ID is returned immediately so the client can reference it from the deposited metadata document; whether the metadata document MUST reference it is implementation-defined and enforced at finalise.
A previously deleted RO-Crate ID MAY be reused; implementations MAY refuse with 409. Recreation is a new RO-Crate, not a continuation — no relationship to the deleted RO-Crate's history or entities is implied.
To update an existing RO-Crate, use POST /ro-crate/{id}/deposits instead.
Request
Responses
- 201
- 400
- 401
- 403
- 409
- 422
- 429
- 500
Deposit created
Response Headers
The URL of the created deposit
Bad Request - Invalid request body
Not authenticated
Access token does not have the required scope
Conflict - an RO-Crate with the proposed ID already exists, or the implementation refuses to reuse a deleted ID
Unprocessable Entity - the request does not match the implementation's declared idMinting mode (an ID was proposed but not accepted, or omitted where the client must propose one)
Rate limit exceeded
Response Headers
Request limit per time window
Requests remaining in current time window
Unix timestamp when the rate limit resets
Number of seconds to wait before retrying
Internal Server Error