Conversations

Request an image upload URL

Request a presigned URL for uploading an image attachment. Upload the image bytes to the returned signed_url with an HTTP PUT, then include the returned file_reference in a message's image_attachments.

get/conversations/upload_image

Request

  • Base URL: https://console.hyperstack.cloud/ai/api/v1
  • URL: https://console.hyperstack.cloud/ai/api/v1/conversations/upload_image
  • Auth: API key in header api_key

Query parameters

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

The MIME type of the image you will upload. Supported types: image/jpeg, image/png, image/webp, image/gif.

Response

Presigned upload details were created.

file_referencestring required

A reference to the uploaded image. Include this in a message's image_attachments when calling Send message.

signed_urlstring required

A short-lived URL. Upload the image bytes to it with an HTTP PUT before sending the message.

Changes

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