Builder

A picture of a public web page the customer likes (look and structure only, never its words or pictures). Only where the screenshot worker runs; otherwise 501 and the customer pastes a screenshot

post/builder/sessions/{sessionId}/references/url

Request

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

Path parameters

sessionIdstring uuid required

Request body

urlstring required
intent'look' | 'screen'

Response

Captured

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.