Media

Upload a media file

Changed on

Uploads a file via the unified media dispatcher. Send a multipart form with file (binary) and purpose (one of board_logo, board_hero, account_avatar, company_logo, or blog_image). Optionally include resourceType and resourceId to bind the upload to an owning resource. The request is idempotent when an Idempotency-Key header is supplied.

post/media/upload

Request

  • Base URL: https://api.cavuno.com/v1
  • URL: https://api.cavuno.com/v1/media/upload
  • Auth: HTTP bearer

Response

Successful response.

idstring required

Unique identifier for the object. Use this value as the {id} path parameter for GET /v1/media/{id}.

object'media_upload' required

String representing the object's type. Objects of the same type share the same value.

urlstring nullable required

URL where the file can be downloaded. Permanent for files served from the assets domain; a signed URL for legacy files. Always set on the upload response; may be null on retrieval if the underlying blob has been deleted.

urlExpiresAtstring nullable required

Time at which the signed url expires (ISO 8601 datetime), or null when the url is permanent and never expires.

mimeTypestring required

MIME type of the uploaded file.

sizeBytesnumber required

Size of the uploaded file, in bytes.

purpose'board_logo' | 'board_hero' | 'account_avatar' | 'company_logo' | 'blog_image' required

Resource type the file was uploaded for.

Changes

  • c34152c38176Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status