Sign in
conversations

Show an agent's self-contained HTML page inline in its chat thread

Changed on
post/api/v1/sessions/{sessionId}/renders

Request

  • Base URL: http://127.0.0.1:3001
  • URL: http://127.0.0.1:3001/api/v1/sessions/{sessionId}/renders
  • Auth: none declared

Path parameters

sessionIdstring required

Session identifier, e.g. project-1.

Request body

artifactboolean

Also keep the page as a session artifact, a deliverable the user keeps.

heightinteger

First-paint frame height in CSS pixels, clamped to 80-2000; the frame then fits the page.

htmlstring required

A complete, self-contained HTML document, at most 25 MiB.

titlestring required

Short name for the page.

Response

Created

activityIdstring required
artifactErrorstring

With artifact: why the page was not kept. The page is still published.

artifactPathstring

With artifact: the absolute path of the kept page.

pathstring required
renderIdstring required

Changes