Covendocs
API ReferenceSessionsFetch a sensitive session artifact GET
Report issue

Fetch a sensitive session artifact

1 min read

GET
/sessions/{id}/artifacts/{artifactId}

Path Parameters

id*string

The session id (stable across daemon restarts).

artifactId*string

Id of the sensitive artifact recorded for this session.

Query Parameters

raw*string

Must be 1. Explicit acknowledgement that the caller wants raw (unredacted) artifact content.

Value in"1"

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/sessions/session-1/artifacts/artifact-1?raw=1"
{
  "sessionId": "session-1",
  "artifactId": "artifact-1",
  "eventId": "event-1",
  "kind": "output",
  "payload": {
    "data": "redacted material"
  }
}
{
  "error": {
    "code": "raw_artifact_requires_raw_flag",
    "message": "Raw artifact retrieval requires raw=1.",
    "details": {
      "sessionId": "session-1",
      "artifactId": "artifact-1"
    }
  }
}
{
  "error": {
    "code": "raw_artifacts_disabled",
    "message": "Raw artifact persistence is not enabled.",
    "details": {
      "sessionId": "session-1",
      "artifactId": "artifact-1"
    }
  }
}
{
  "error": {
    "code": "artifact_not_found",
    "message": "Sensitive artifact was not found.",
    "details": {
      "sessionId": "session-1",
      "artifactId": "artifact-1"
    }
  }
}
{
  "error": {
    "code": "internal_error",
    "message": "Unexpected internal daemon error.",
    "details": {}
  }
}
Was this page helpful?No