POST /v1/jobs/{jobId}/artifacts/verify
Check output files against their SHA-256
ivy_ API key (Authorization: Bearer ivy_… or X-Ivy-Api-Key), a Clerk session JWT (Authorization: Bearer …) or the Clerk __session cookie (browser sessions). See Authentication.Computes the SHA-256 of each stored file you name and, when you give an expected_sha256, reports whether they match. Files are hashed one after another. Requires write access to the job, so a project viewer cannot use it.
Each results entry describes one item, in request order, and a problem with one file does not fail the request. A key you cannot read is reported as error: "not_found", the same as a missing file. A file larger than 200 MiB (or the limit the server is configured with) is reported as error: "object-too-large" and not hashed. Items without a string s3_key are dropped, and a request left with no items returns 400.
Add persist=true, as a query parameter or in the body, to also save the results as verification records for the job; read them back with GET /api/v1/jobs/{job_id}/artifacts/list-verifications. A failure to save is not reported in the response.
Request
Path parameters
Job UUID.
Query parameters
Set to true to save the results as verification records. May instead be sent as persist in the body.
Request body
The files to hash. Entries without a string s3_key are dropped.
Set to true to save the results as verification records. May instead be sent as a query parameter.
Responses
200 OK
Response shape:
400 Bad Request
Response shape: object
401 Unauthorized
Response shape: object
404 Not Found
Response shape: object
429 Too Many Requests
Response shape: object
500 Internal Server Error
Response shape: object
Was this page helpful?