Artifacts

Download an artifact

Authorize ownership and redirect to a private, short-lived download URL. Redirect targets are never persisted or returned in logs.

GET/api/v2/artifacts/{artifactId}/download

Required scopedocuments.read

Parameters

artifactId

pathstring<uuid>required

Owner-scoped artifact identifier.

Request body

This operation does not accept a request body.

Operational behavior

Idempotency

Mode: naturally safe. No idempotency header is required.

Retries

Retry transport failures, 429, and 503 with exponential backoff and full jitter. Honor Retry-After. Retry statuses: 429, 503. Honor Retry-After.

Retention

The redirect URL lasts at most five minutes; the underlying artifact retains its own expiresAt and may be deleted earlier. Response field: retention.

Responses

302Redirect to the authorized private artifact.

Response headers

Cache-ControlLocationX-Correlation-Id

401The bearer credential is missing, malformed, expired, revoked, or belongs to the wrong environment.

Response headers

X-Correlation-Id

Response schema

PublishingErrorEnvelope

Publishing Error Envelope object used by the Publishing API.

contractVersion

stringrequired

Contract Version value.

error

objectrequired

Error value.

401 example

{
  "contractVersion": "publishing.lifecycle.v1",
  "error": {
    "category": "authentication",
    "code": "unauthorized",
    "httpStatus": 401,
    "message": "A valid API key is required.",
    "retryable": false
  }
}

403The principal is authenticated but lacks the operation's required scope.

Response headers

X-Correlation-Id

Response schema

PublishingErrorEnvelope

Publishing Error Envelope object used by the Publishing API.

contractVersion

stringrequired

Contract Version value.

error

objectrequired

Error value.

403 example

{
  "contractVersion": "publishing.lifecycle.v1",
  "error": {
    "category": "authorization",
    "code": "forbidden",
    "httpStatus": 403,
    "message": "The API key does not have the required scope.",
    "retryable": false
  }
}

404The resource does not exist or is not visible to this principal. Cross-tenant misses use the same response.

Response headers

X-Correlation-Id

Response schema

PublishingErrorEnvelope

Publishing Error Envelope object used by the Publishing API.

contractVersion

stringrequired

Contract Version value.

error

objectrequired

Error value.

404 example

{
  "contractVersion": "publishing.lifecycle.v1",
  "error": {
    "category": "authorization",
    "code": "not_found",
    "httpStatus": 404,
    "message": "The requested resource was not found.",
    "retryable": false
  }
}

410The artifact has expired or was deleted.

Response headers

X-Correlation-Id

Response schema

PublishingErrorEnvelope

Publishing Error Envelope object used by the Publishing API.

contractVersion

stringrequired

Contract Version value.

error

objectrequired

Error value.

410 example

{
  "contractVersion": "publishing.lifecycle.v1",
  "error": {
    "category": "storage",
    "code": "artifact_expired",
    "httpStatus": 410,
    "message": "The artifact has expired and is no longer downloadable.",
    "retryable": false
  }
}

429The request is temporarily rate limited. No final publication unit is consumed.

Response headers

X-Correlation-IdRetry-After

Response schema

PublishingErrorEnvelope

Publishing Error Envelope object used by the Publishing API.

contractVersion

stringrequired

Contract Version value.

error

objectrequired

Error value.

429 example

{
  "contractVersion": "publishing.lifecycle.v1",
  "error": {
    "category": "entitlement",
    "code": "rate_limited",
    "details": {
      "retryAfterSeconds": 30
    },
    "httpStatus": 429,
    "message": "Too many publishing requests. Retry after 30 seconds.",
    "retryable": true
  }
}

503A transient publishing, queue, renderer, or storage dependency is unavailable. No failed render consumes a final publication unit.

Response headers

X-Correlation-IdRetry-After

Response schema

PublishingErrorEnvelope

Publishing Error Envelope object used by the Publishing API.

contractVersion

stringrequired

Contract Version value.

error

objectrequired

Error value.

503 example

{
  "contractVersion": "publishing.lifecycle.v1",
  "error": {
    "category": "internal",
    "code": "service_unavailable",
    "details": {
      "retryAfterSeconds": 30
    },
    "httpStatus": 503,
    "message": "Publishing is temporarily unavailable.",
    "retryable": true
  }
}