---
title: "Register a file upload"
method: POST
path: "/uploads"
tags: ["uploads"]
---

# Register a file upload

`POST /uploads`

Registers an image or video in the org's file library and returns a presigned S3 URL to upload the bytes to. PUT the raw file to upload_url with the declared Content-Type and Content-Length headers before the URL expires, then call the complete endpoint to make it ready. Uploads are capped per file and per org by total size.

## Request body

- FileCreateRequest — Registers an upload and requests a presigned PUT URL.
  - `$schema` string, uri — A URL to the JSON Schema for this object.
  - `filename` string, required — Display name for the file (also its name on the phone).
  - `mime_type` string, required — MIME type of the upload; must be an allowed image or video type.
  - `size_bytes` integer, required — Exact size of the upload in bytes; the presigned URL pins it.

## Response `201`

Created

- FileUploadResponse — The registered file and its presigned upload URL.
  - `$schema` string, uri — A URL to the JSON Schema for this object.
  - `file` FileSummary, required — One file in the org's library.
    - `attachment_url` string — Short-lived signed URL that downloads the file as an attachment under its name. Present only for ready files.
    - `bytes_transferred` integer — Bytes moved so far for an in-flight phone transfer. Absent until the phone reports progress.
    - `created_at` string, date-time, required — When the upload was registered.
    - `download_url` string — Short-lived signed URL to read the file's bytes. Present only for ready files; re-list to refresh an expired one.
    - `duration_seconds` integer — Video duration in seconds.
    - `filename` string, required — Original filename; used as the display name when the file lands on a phone.
    - `height` integer — Intrinsic pixel height of the source.
    - `id` string, required — File identifier. Unique across uploads and downloads.
    - `mime_type` string, required — Declared MIME type, pinned by the presigned upload.
    - `on_phone_count` integer, required — Distinct phones currently holding or receiving a copy. Deleting the file recalls these.
    - `preview_state` 'processing' | 'ready' | 'unavailable', required — Whether the preview exists, is still being generated, or will never be available for this format.
    - `reel_url` string — Short-lived signed URL for the animated hover preview. Videos only; absent until generated.
    - `size_bytes` integer, required — Declared size in bytes, pinned by the presigned upload.
    - `status` 'uploading' | 'ready', required — uploading until the object is verified in storage, then ready. Complete an upload to move it to ready.
    - `thumbnail_url` string — Short-lived signed URL for the generated preview image. Absent while generation is pending, and permanently absent for formats without a preview.
    - `width` integer — Intrinsic pixel width of the source.
  - `upload_expires_in_seconds` integer, required — How long the upload URL stays valid.
  - `upload_url` string, required — Presigned S3 PUT URL. PUT the raw file bytes to it with the declared Content-Type and Content-Length headers.

## Other responses

- `default` — Error

---

[API](https://skmtc.net/axilioai/apis/axilio-api.md) · [All operations](https://skmtc.net/axilioai/apis/axilio-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/axilioai/axilio-api/revisions/108ab4b41051/schema)