> ## 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.

# Get an artifact

> Returns one artifact with a fresh download link; for a run record (`rec:…`), its full text in `content`.

Requires a realm member (or higher) with the `runs.view` permission on the realm that owns the artifact given by `artifact_id`.



## OpenAPI

````yaml /openapi/hub-by-tag/hub-artifacts.yaml post /v1/artifacts/get_by_id
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; anyone

    who can see the run lists and downloads them. Download links are presigned
    and expire after

    5 minutes; ask again for a fresh one.
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; anyone

      who can see the run lists and downloads them. Download links are presigned
      and expire after

      5 minutes; ask again for a fresh one.
paths:
  /v1/artifacts/get_by_id:
    post:
      tags:
        - Artifacts
      summary: Get an artifact
      description: >-
        Returns one artifact with a fresh download link; for a run record
        (`rec:…`), its full text in `content`.


        Requires a realm member (or higher) with the `runs.view` permission on
        the realm that owns the artifact given by `artifact_id`.
      operationId: POST_v1_artifacts_get_by_id
      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:
                type: object
                required:
                  - ok
                  - data
                properties:
                  ok:
                    type: boolean
                    enum:
                      - true
                    description: Always `true` on success.
                  data:
                    $ref: '#/components/schemas/ArtifactData'
              example:
                ok: true
                data:
                  artifact_id: 8f7e6d5c-4b3a-4291-8e7f-6a5b4c3d2e1f
                  source: file
                  kind: file
                  run_id: 0c8d7e6f-5a4b-4c3d-9e2f-1a0b9c8d7e6f
                  phase: review
                  name: review.md
                  description: Findings from the review phase
                  mime_type: text/markdown
                  size_bytes: 2048
                  download_url: https://files.cliqhub.io/a/8f7e6d5c?sig=…
                  content_preview: null
                  created_at: 1759834480000
        '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).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HubErr'
              examples:
                not_found:
                  summary: not_found
                  value:
                    ok: false
                    error:
                      code: not_found
                      message: 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:
    ArtifactData:
      type: object
      properties:
        artifact_id:
          type: string
          description: Artifact UUID; a run record is `rec:<id>`
        source:
          type: string
          enum:
            - file
            - record
          description: A stored file (R2) or a run record (text)
        kind:
          type: string
          description: >-
            'file' for stored files; the record kind otherwise (output,
            chat_transcript, review, …)
        run_id:
          type: string
          description: Owning run
        phase:
          type: string
          description: Phase that produced the artifact
        name:
          type: string
          description: Display name / filename
        description:
          type: string
          nullable: true
          description: Human-readable description
        mime_type:
          type: string
          description: MIME type
        size_bytes:
          type: number
          description: File size in bytes
        download_url:
          type: string
          nullable: true
          description: Presigned R2 GET URL (5-min TTL); null for a run record
        content_preview:
          type: string
          nullable: true
          description: First ~2 KB of a run record; null for a stored file
        content:
          type: string
          description: Full text of a run record (get_by_id only)
        created_at:
          type: number
          description: Unix timestamp ms
      required:
        - artifact_id
        - source
        - kind
        - run_id
        - phase
        - name
        - description
        - mime_type
        - size_bytes
        - download_url
        - content_preview
        - created_at
    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.