Skip to content
API docs
Sign inOpen app

Website reads

Get a website read

GET/v1/sites/reads/{readId}

A website read's look, brand name and form ideas. A site that can't be fetched still gets a readable default theme, and ideas based on its address alone. If the AI fails, the theme is kept.

Path parameters

  • readIdstringrequired

    The read, from POST /v1/sites/read.

Query parameters

  • workspaceIdstring

    Optional. Your API key already belongs to one workspace.

Response

  • urlstringrequired

    The address that was read, with https and without a hash.

  • hoststringrequired

    The address's host, in lowercase, without www..

  • themeobject or nullrequired

    Theme values read from the site. Null until themeStatus is ready.

  • themeStatusenumrequired

    One of "reading", "ready", "failed"

  • brandNamestring or nullrequired

    The brand name suggested from the site. Null until suggestStatus is ready.

  • ideasarray of object or nullrequired

    Three form ideas, the first being the suggested one. Null until suggestStatus is ready.

  • suggestStatusenumrequired

    One of "waiting", "ready", "failed"

Errors answer with a status and the error shape.