> ## 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. # Upload a file > Streams one file in: the raw file is the request body (its `Content-Type` and `Content-Length`), and what it is goes in the query. A daemon names `run_id` and `phase`; a person answering a Hug names `hug_id` and `requested_input` — the file must suit that input (its accepted types, by declared type, extension and leading bytes; its size) and is kept until it is part of an answer. Files are limited to 50 MB unless the deployment says otherwise. Answers `201`. With `hug_id` (query string) in the body: Requires a realm member (or higher) with the `runs.view` permission on the realm that owns the hug given by `hug_id` (query string). Addressed to the caller; open; a file input. Without it: Daemon push: requires the daemon's realm token (`cliq_dt_…`) for the realm that owns the run given by `run_id` (query string). ## OpenAPI ````yaml /openapi/hub-by-tag/hub-artifacts.yaml post /v1/artifacts/upload 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/upload: post: tags: - Artifacts summary: Upload a file description: >- Streams one file in: the raw file is the request body (its `Content-Type` and `Content-Length`), and what it is goes in the query. A daemon names `run_id` and `phase`; a person answering a Hug names `hug_id` and `requested_input` — the file must suit that input (its accepted types, by declared type, extension and leading bytes; its size) and is kept until it is part of an answer. Files are limited to 50 MB unless the deployment says otherwise. Answers `201`. With `hug_id` (query string) in the body: Requires a realm member (or higher) with the `runs.view` permission on the realm that owns the hug given by `hug_id` (query string). Addressed to the caller; open; a file input. Without it: Daemon push: requires the daemon's realm token (`cliq_dt_…`) for the realm that owns the run given by `run_id` (query string). operationId: POST_v1_artifacts_upload parameters: - in: query name: run_id description: The run (daemon uploads, with `phase`). schema: type: string - in: query name: phase description: The phase that produced it (daemon uploads). schema: type: string - in: query name: hug_id description: The Hug whose file input this answers (with `requested_input`). schema: type: string - in: query name: requested_input description: The Hug's file input. schema: type: string - in: query name: name required: true description: File name. schema: type: string - in: query name: description description: Shown with the file. schema: type: string requestBody: required: true content: application/json: schema: type: object description: The request body is not documented yet. additionalProperties: true responses: '201': description: Created. content: application/json: schema: type: object required: - ok - data properties: ok: type: boolean enum: - true description: Always `true` on success. data: type: object properties: artifact_id: type: string name: type: string size: type: integer content_type: type: string sha256: type: string status: type: string enum: - ready - pending description: '`pending` until a Hug answer uses it.' download_url: type: string example: ok: true data: artifact_id: 8f7e6d5c-4b3a-4291-8e7f-6a5b4c3d2e1f name: MSA.pdf size: 48213 content_type: application/pdf sha256: 9f2b5c… status: pending download_url: >- https://cliqhub.io/v1/artifacts/download?artifact_id=8f7e6d5c-4b3a-4291-8e7f-6a5b4c3d2e1f '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 record 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 '411': description: '`ARTIFACT_LENGTH_REQUIRED`: No `Content-Length` was sent.' content: application/json: schema: $ref: '#/components/schemas/HubErr' examples: ARTIFACT_LENGTH_REQUIRED: summary: ARTIFACT_LENGTH_REQUIRED value: ok: false error: Content-Length is required code: ARTIFACT_LENGTH_REQUIRED '413': description: >- `ARTIFACT_TOO_LARGE`: The file is larger than the limit (50 MB, or the Hug input's `max_bytes`). content: application/json: schema: $ref: '#/components/schemas/HubErr' examples: ARTIFACT_TOO_LARGE: summary: ARTIFACT_TOO_LARGE value: ok: false error: File is larger than the 50 MB limit code: ARTIFACT_TOO_LARGE '422': description: >- `HUG_FILE_INVALID`: `requested_input` isn't a file input of the Hug, the file isn't an accepted type, or 20 of your files already wait for an answer. content: application/json: schema: $ref: '#/components/schemas/HubErr' examples: HUG_FILE_INVALID: summary: HUG_FILE_INVALID value: ok: false error: >- contract: photo.png is not an accepted type (application/pdf) code: HUG_FILE_INVALID '500': description: >- `internal_error`: An unexpected server fault. Retry later; if it persists, report it with the time of the request. `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 '503': description: >- `ARTIFACT_STORAGE_UNAVAILABLE`: This CliqHub has no file storage configured. content: application/json: schema: $ref: '#/components/schemas/HubErr' examples: ARTIFACT_STORAGE_UNAVAILABLE: summary: ARTIFACT_STORAGE_UNAVAILABLE value: ok: false error: File storage is not configured code: ARTIFACT_STORAGE_UNAVAILABLE security: - BearerAuth: [] components: schemas: 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.