HAhappyscribe
Files

Get a file

Any key that belongs to the file's workspace can read it. The url is signed again on every read.

get/files/{id}

Request

  • Base URL
    https://www.happyscribe.com/api/v1
  • Auth
    API key in header Authorization

Response

The file.

idstring required

File ID, beginning with file_.

objectstring required

Always file.

purpose'brand_kit' required

What the file is for. brand_kit: an image for a brand kit.

workspace_idstring required

The workspace the file belongs to, a wks_ id.

filenamestring required

The name the file was uploaded with. Its extension is replaced when it does not match the image type.

content_type'image/png' | 'image/jpeg' | 'image/gif' | 'image/webp' | 'image/svg+xml' required

The image type, read from the file's bytes.

  • image/png: PNG.
  • image/jpeg: JPEG.
  • image/gif: GIF.
  • image/webp: WebP.
  • image/svg+xml: SVG.
sizeinteger required

Size in bytes.

urlstring uri required

A signed URL to download the file, valid for one year. Every read returns a fresh one. An SVG is served as a download, never inline.

created_atstring date-time required

When the file was uploaded, in ISO 8601.

Example response

{
  "id": "file_01k6d8q4z7m2n5p8r1s3t6v9wx",
  "object": "file",
  "purpose": "brand_kit",
  "workspace_id": "wks_01k6a2r9s8x7c2dvq3m5n6p4ab",
  "filename": "logo.png",
  "content_type": "image/png",
  "size": 48213,
  "url": "https://assets.happyscribe.com/files/logo.png?Expires=1822298280&Signature=…",
  "created_at": "2026-09-30T09:58:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.