Builder

Show the builder a picture (PNG, JPEG, WebP, GIF, AVIF, at most 10 MB) or a document (PDF, CSV, text, at most 8 MB) as the request body. Pictures are downscaled and stripped of metadata; documents keep only their text. Kept for a week, never part of the site; attach it to a message as a context item (reference or document)

post/builder/sessions/{sessionId}/references

Request

  • Base URL: https://hostingsurge.com/api/v1
  • URL: https://hostingsurge.com/api/v1/builder/sessions/{sessionId}/references
  • Auth: one of:
    • HTTP bearer
    • API key in cookie __Host-hs_session

Path parameters

sessionIdstring uuid required

Query parameters

filenamestring
source'upload' | 'annotation'

Response

Stored

idstring uuid required
kind'image' | 'document' required
source'upload' | 'url' | 'figma' | 'annotation' required
namestring required
mediaTypestring required
widthinteger nullable required
heightinteger nullable required
charsinteger nullable required

document: characters of text read from it

sourceUrlstring nullable required

url / figma: the address it came from

sizeBytesinteger required
createdAtstring required

ISO-8601 timestamp

expiresAtstring required

Deleted after this (references are kept for a week)

Changes

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