> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getcliq.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Download a file

> Streams one stored file out, with its `Content-Type`, `Content-Length` and file name. `Range` is honoured (`206` with `Content-Range`). For token callers (daemons, scripts).

Requires a realm member (or higher) with the `runs.view` permission on the realm that owns the artifact given by `artifact_id`. A daemon's realm token (`cliq_dt_…`) from the same realm may also read it. Pending: uploader only.



## OpenAPI

````yaml /openapi/hub-by-tag/hub-artifacts.yaml post /v1/artifacts/download
openapi: 3.0.3
info:
  title: 'CliqHub API: Artifacts'
  version: 1.0.0
  description: >-
    Files a run produced (reports, patches, screenshots), stored by CliqHub, and
    the run's

    records (phase outputs, transcripts). Daemons upload files while the run is
    going, and a

    person answering a Hug uploads files for its `file` inputs; anyone who can
    view the run lists

    and downloads them. Files stream through CliqHub in both directions (the
    storage itself is

    never exposed), so a `download_url` is a CliqHub link that doesn't expire.
servers:
  - url: https://{host}
    variables:
      host:
        default: cliqhub.io
        description: CliqHub host
security: []
tags:
  - name: Artifacts
    description: >-
      Files a run produced (reports, patches, screenshots), stored by CliqHub,
      and the run's

      records (phase outputs, transcripts). Daemons upload files while the run
      is going, and a

      person answering a Hug uploads files for its `file` inputs; anyone who can
      view the run lists

      and downloads them. Files stream through CliqHub in both directions (the
      storage itself is

      never exposed), so a `download_url` is a CliqHub link that doesn't expire.
paths:
  /v1/artifacts/download:
    post:
      tags:
        - Artifacts
      summary: Download a file
      description: >-
        Streams one stored file out, with its `Content-Type`, `Content-Length`
        and file name. `Range` is honoured (`206` with `Content-Range`). For
        token callers (daemons, scripts).


        Requires a realm member (or higher) with the `runs.view` permission on
        the realm that owns the artifact given by `artifact_id`. A daemon's
        realm token (`cliq_dt_…`) from the same realm may also read it. Pending:
        uploader only.
      operationId: POST_v1_artifacts_download
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                artifact_id:
                  type: string
                  minLength: 1
                  description: Artifact UUID
              required:
                - artifact_id
            examples:
              default:
                value:
                  artifact_id: 8f7e6d5c-4b3a-4291-8e7f-6a5b4c3d2e1f
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/HubOk'
                  - type: object
                    properties:
                      data:
                        type: object
                        additionalProperties: true
                        description: Route-specific payload
                        nullable: true
        '401':
          description: >-
            `unauthorized`: No `Authorization` header, or the token is
            malformed, expired or revoked.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HubErr'
              examples:
                unauthorized:
                  summary: unauthorized
                  value:
                    ok: false
                    error:
                      code: unauthorized
                      message: Authentication required
        '403':
          description: >-
            `forbidden`: You can see the record but your role in its realm is
            too low or lacks the required permission.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HubErr'
              examples:
                forbidden:
                  summary: forbidden
                  value:
                    ok: false
                    error:
                      code: forbidden
                      message: You do not have access to do this
        '404':
          description: >-
            `not_found`: The artifact does not exist or is in a realm you cannot
            see (404 rather than 403, so its existence is not revealed).


            `not_found`: No file has this id, or you can't view its run.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HubErr'
              examples:
                not_found:
                  summary: not_found
                  value:
                    ok: false
                    error:
                      code: not_found
                      message: Not found
                not_found (endpoint):
                  summary: not_found (endpoint)
                  value:
                    ok: false
                    error: Artifact '8f7e6d5c-4b3a-4291-8e7f-6a5b4c3d2e1f' not found
                    code: not_found
        '422':
          description: >-
            `invalid_params`: The body fails the request schema: a required
            field is missing or a value has the wrong type or format. The
            message lists every issue as `field: problem`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HubErr'
              examples:
                invalid_params:
                  summary: invalid_params
                  value:
                    ok: false
                    error: 'artifact_id: Required'
                    code: invalid_params
        '500':
          description: >-
            `internal_error`: An unexpected server fault. Retry later; if it
            persists, report it with the time of the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HubErr'
              examples:
                internal_error:
                  summary: internal_error
                  value:
                    ok: false
                    error: Internal server error
                    code: internal_error
      security:
        - BearerAuth: []
components:
  schemas:
    HubOk:
      type: object
      required:
        - ok
      properties:
        ok:
          type: boolean
          description: Always true on success
      description: Success envelope. Additional data fields vary by route.
    HubErr:
      type: object
      required:
        - ok
        - error
      description: >-
        Every failure. Route-policy denials (401/403/404, and 400 when neither
        realm_id nor org_id was sent) answer `error` as `{ code, message }`;
        errors raised by the endpoint answer `error` as the message with the
        code beside it in `code`. Every error has a code. See
        [Errors](/hub-api/errors).
      properties:
        ok:
          type: boolean
          description: Always false on error
        error:
          description: The message, or `{ code, message }` for an access denial.
          oneOf:
            - type: string
            - type: object
              required:
                - code
                - message
              properties:
                code:
                  type: string
                message:
                  type: string
        code:
          type: string
          description: Stable error code of an endpoint error.
        details:
          type: object
          additionalProperties: true
          description: Structured detail, when there is some.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: cliq_tok_* | cliq_dt_*
      description: >-
        User PAT (`cliq_tok_…`, including session-scoped) or realm token
        (`cliq_dt_…`).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.