Web applications¶
Choose an API for the resource you need to operate on, then prepare the identity, IDs, and parameters listed on its action page.
Choose a task¶
Task |
Page |
Description |
|---|---|---|
Archive a visitor conversation |
200 means archived, with data retained. |
|
Create a visitor Web app conversation |
201 returns data.id, not conversation_id. |
|
Create a visitor session |
Each call creates a new anonymous visitor identity without restoring the original visitor’s history. |
|
Download a visitor task artifact |
Returns original file bytes with attachment Content-Disposition and application/octet-stream when media type is absent. |
|
Public links and visitor identity |
Public Web Apps provide anonymous visitor conversations within the publication record’s permitted scope. |
|
List this visitor’s conversations |
Lists only this visitor’s active Web App conversations, without administration-side status=all semantics. |
|
Read visitor task events incrementally |
after_seq echoes the request cursor, not the server’s next cursor. total counts projections returned in this response. |
|
Read visitor conversation messages |
Returns items/total/limit/offset. See common objects for message top-level and answer_versions fields. |
|
Call an MCP App tool for a visitor task |
HTTP 200/code 0 still requires checking data.is_error. content and optional structured_content contain tool results. |
|
Read an MCP application resource for a visitor task |
Resources are bound to the task list and cannot proxy arbitrary URLs. Execution uses identity restored from the publisher. |
|
Public Web application objects |
These objects serve visitor calls. Publication management and deployment site configuration use separate protocols. |
|
Preview visitor task artifacts |
Returns preview bytes/streams, not a JSON envelope. Unsupported formats return 415, size overflow 413/code19, and conversion failure 422/code20. |
|
Refresh the same visitor session |
Returns new credentials and a full 604800 seconds while retaining end_user_id. Old credentials remain valid until natural expiration. |
|
Change a visitor conversation title |
Response contains conversation_id/title/updated_at. |
|
Resolve a public Web app link |
Short-code responses include agent_id; the webapp/t form returns only agent_name. |
|
Send a visitor message and read the event stream |
Create a conversation first. message/send, task control, provider interaction answers, and feedback data variants are unsupported. |
|
Visitor event streams and file boundaries |
Streaming messages, attachment staging, and task artifact reads have distinct completion conditions. HTTP success alone is insufficient. |
|
Submit visitor feedback |
201 confirms only the recorded feedback ID; it does not trigger regeneration. |
|
Upload a visitor attachment |
Validate visitor and conversation first, then reserve the entire multipart request length. Request limit: 201 MiB. |