GET /v1/jobs/{jobId}/artifact-content
Read a job's result content
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.Returns the content of one of a finished job's result files, either as a parsed summary with metrics (format=parsed, the default) or as the raw text (format=raw). Raw text is cut at maxLength characters and truncated says so.
artifactType picks the file; it defaults to output, and the types a job offers depend on its tool. For a job whose results are a zip archive, member names one file inside it. With preflight=true the route only checks that the file exists and is readable and returns that verdict, without the content.
A job that is still running returns 404 with code JOB_NOT_COMPLETE: the file does not exist yet, so retry after the job finishes. A job that failed returns 422 JOB_FAILED with its error message, and that one is permanent. A job you cannot read and a job outside your API key's project scope are reported like a job that does not exist (404 JOB_NOT_FOUND).
Request
Path parameters
Job UUID.
Query parameters
Which result file to read. Defaults to output.
parsed for a summary and metrics, raw for the file text. Defaults to parsed.
Most characters of raw content to return. Defaults to 100000 and is capped at 500000.
true to check availability instead of returning content.
One relative file path inside a results archive to serve instead of the type-selected file.
Responses
200 OK
Response shape:
A text summary of the parsed result (format=parsed).
Parsed metrics (format=parsed).
The file text (format=raw), cut at maxLength characters.
true when rawContent was cut.
Size of the full content before it was cut.
true on a preflight response, which carries no content.
Availability verdict for one artifact type (preflight with artifactType).
Availability of every artifact the job offers (preflight without artifactType).
What was served, when the content came from a results archive.
The served archive members with their names, when more than one was served.
400 Bad Request
format or member is invalidResponse shape: object
401 Unauthorized
Response shape: object
403 Forbidden
Response shape: object
404 Not Found
JOB_NOT_COMPLETE while the job is still running; that 404 is retryable, so retry after the job finishes.Response shape: object
405
Response shape: object
422 Unprocessable Entity
JOB_FAILED, permanent) or the file could not be read; code says whichResponse shape: object
429 Too Many Requests
Response shape: object
500 Internal Server Error
Response shape: object
Was this page helpful?