FOfocusbear
project-note-images

Start an image upload: returns a presigned PUT URL and the future image id

post/projects/{project_id}/notes/{note_id}/images/upload-url

Request

  • Base URL
    https://api.focusbear.io (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Path parameters

project_idstring uuid required
note_idstring uuid required

Request body

content_type'image/png' | 'image/jpeg' | 'image/gif' | 'image/webp' required

MIME type the client will upload with

file_sizenumber required

File size in bytes

Response

image_idstring required

Id the image will have once confirmed; use it in the complete call

referencestring required

Embed reference to write into the note body once the upload is confirmed

upload_urlstring required

Presigned URL to PUT the raw file bytes to

upload_headersobject required

Headers the PUT must send exactly (the signature covers them)

upload_url_expires_atstring required

When upload_url stops working (ISO 8601)

Example response

{
  "upload_headers": {
    "Content-Type": "image/png"
  }
}

Changes

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