HelpLink

A help link for error resolution.

Usage profiles

Usage	Fields and validation
In requests	View fields
In responses	View fields
In webhook payloads	View fields

In requests

API JSON uses JSON field names (camelCase).

Field	Type	Presence	Meaning
url	string	Optional	URL to documentation or resolution guide.
description	string	Optional	Description of what the link provides.

In responses

API JSON uses JSON field names (camelCase).

Field	Type	Presence	Meaning
url	string	Optional	URL to documentation or resolution guide.
description	string	Optional	Description of what the link provides.

In webhook payloads

Webhook JSON uses protobuf field names (snake_case).

Field	Type	Presence	Meaning
url	string	Optional	URL to documentation or resolution guide.
description	string	Optional	Description of what the link provides.

Where used

Reference	Relationship
Submit client-side tool execution results	POST /api/v1/llm/submit-client-tool-results
Submit client-side tool results and wait for the next segment	POST /api/v1/llm/submit-client-tool-results-sync
Send a message and wait for the result	POST /api/v1/llm/send-message-sync
llm.generation_completed	Webhook JSON uses protobuf field names (snake_case).
ErrorDetails	Nested in model
ErrorDetails	Nested in model
ErrorDetails	Nested in model

Download the public reference contract.

• conversations OpenAPI

Document: DOC-API-MODEL-help-link.