AGagnost
Onboarding

Stream an LLM-generated product description from a website

Changed on

Fetches the user's website (either a URL passed directly or inferred from a corporate email domain) and streams a 2-3 sentence product description over Server-Sent Events. Used during organization setup so the user does not have to write the description by hand.

Returns 422 if the email domain is a free email provider, the site cannot be reached, or extraction yielded too little content. The client should ask the user to describe the product manually in those cases.

Response is text/event-stream. Each event is a JSON object: {"text": "..."} for incremental tokens, {"error": "..."} for terminal failure. The stream ends with a [DONE] sentinel.

post/dashboard/api/onboarding/describe-product

Request

  • Base URL
    https://api.agnost.ai
  • URL
    https://api.agnost.ai/dashboard/api/onboarding/describe-product
  • Auth
    • HTTP bearer and API key in header x-org-id
    • or API key in header x-api-key

Request body

urlstring

Website URL (preferred). Either url or email is required.

emailstring email

Falls back to the email's domain if url is not provided.

Response

Server-Sent Events stream of description tokens

Changes