Automation

List run artifacts

Read run artifacts and their file references.

Read run artifacts and their file references. Entries follow ledger order and include content types, sizes and associated steps.

GET /automation/v1/runs/{id}/artifacts

Authentication

Authorization: Bearer $PRAXIS_API_KEY

Request fields

ParameterTypeDescription
path: idstringrequired; Run ID (run_).
query: limitintegeroptional; Page size: integer 1–100, default 50. minimum: 1; maximum: 100
query: cursorstringoptional; Opaque next_cursor from the previous page; keep the original filters when paging.

Examples

Set these environment variables to your own resources:

: "${RUN_ID:?Set RUN_ID}"
curl --fail-with-body -X GET "https://api.deepraxis.ai/automation/v1/runs/${RUN_ID}/artifacts" \
  -H "Authorization: Bearer $PRAXIS_API_KEY"
import { createAutomationClient } from '@deepraxis/sdk/automation';

function env(name: string): string {
  const value = process.env[name];
  if (!value) throw new Error(`Set ${name}`);
  return value;
}
const automation = createAutomationClient({
  apiKey: env('PRAXIS_API_KEY'),
  baseUrl: 'https://api.deepraxis.ai',
  maxRetries: 0,
  timeoutMs: 90_000,
});
const result = await automation.runs.artifacts.list({
  "path": {
    "id": env("RUN_ID")
  }
});
console.log(result);

Response

HTTP 200

Success

application/json

FieldTypeDescription
dataobject[]required; Run artifacts on this page, ordered by created_at descending, then id descending.
data[].idstringrequired; Artifact id; treat it as an opaque string.
data[].file_idstringrequired; Id of the artifact in the file service; download the content through the files API.
data[].namestringrequired; File name of the artifact.
data[].content_typestringrequired; MIME type of the artifact.
data[].size_in_bytesnumberrequired; Size of the artifact in bytes.
data[].tasknull / stringrequired; JSON Pointer of the workflow step that produced the artifact, or null when it did not come from a step.
data[].created_atstringrequired; Time the artifact was created (RFC 3339 UTC).
next_cursornull / stringrequired; Cursor for the next page: pass it unchanged as cursor with the same filters; null when there are no more pages. No total is returned.

Measured response

HTTP 200

{
  "data": [],
  "next_cursor": null
}

Errors

HTTPCodes and description
400INVALID_PARAMS: Invalid request parameters, path, cursor, or body format.
404RUN_NOT_FOUND: The run does not exist or is not visible to this tenant.
defaultRFC 9457 automation problem. 429 includes Retry-After.

Authentication and common errors · Retain the X-Request-Id response header for troubleshooting.

Export

On this page