Section ID:
DOC-API-MODEL-schema-1f0qdi91b8#overview
HelpLink
A help link for error resolution.
Meaning and usage
Section ID: DOC-API-MODEL-schema-1f0qdi91b8#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-1f0qdi91b8#fields
| Usage | Fields and validation |
|---|---|
| In requests | View fields |
| In responses | View fields |
In requests
Section ID: DOC-API-MODEL-schema-1f0qdi91b8#request
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-1f0qdi91b8#request-field-urlurl | string | Optional | URL to documentation or resolution guide. |
Section ID: DOC-API-MODEL-schema-1f0qdi91b8#request-field-descriptiondescription | string | Optional | Description of what the link provides. |
In responses
Section ID: DOC-API-MODEL-schema-1f0qdi91b8#response
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-1f0qdi91b8#field-urlSection ID: DOC-API-MODEL-schema-1f0qdi91b8#response-field-urlurl | string | Optional | URL to documentation or resolution guide. |
Section ID: DOC-API-MODEL-schema-1f0qdi91b8#field-descriptionSection ID: DOC-API-MODEL-schema-1f0qdi91b8#response-field-descriptiondescription | string | Optional | Description of what the link provides. |
Where used
Section ID: DOC-API-MODEL-schema-1f0qdi91b8#where-used
| Reference | Relationship |
|---|---|
| Send a message and wait for the result | POST /api/v1/llm/send-message-sync |
| Submit client-side tool results and wait for the next segment | POST /api/v1/llm/submit-client-tool-results-sync |
| Submit client-side tool execution results | POST /api/v1/llm/submit-client-tool-results |
Models containing this value
| Model | Relationship |
|---|---|
| ErrorDetails | Nested in model |
| ErrorDetails | Nested in model |
Download the public reference contract.
Document ID: DOC-API-MODEL-schema-1f0qdi91b8