Section ID:
DOC-API-MODEL-schema-ohoj3j73c1#overview
PromptParameter
A parameter used by a prompt template
Meaning and usage
Section ID: DOC-API-MODEL-schema-ohoj3j73c1#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-ohoj3j73c1#fields
| Usage | Fields and validation |
|---|---|
| In responses | View fields |
In responses
Section ID: DOC-API-MODEL-schema-ohoj3j73c1#response
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-ohoj3j73c1#field-nameSection ID: DOC-API-MODEL-schema-ohoj3j73c1#response-field-namename | string | Optional | Name used to bind a value to this prompt-template parameter. |
Section ID: DOC-API-MODEL-schema-ohoj3j73c1#field-descriptionSection ID: DOC-API-MODEL-schema-ohoj3j73c1#response-field-descriptiondescription | string | Optional | Explanation of the value expected for this prompt parameter. |
Section ID: DOC-API-MODEL-schema-ohoj3j73c1#field-typeSection ID: DOC-API-MODEL-schema-ohoj3j73c1#response-field-typetype | string | Optional | Free-form type hint, e.g. "string", "number" |
Section ID: DOC-API-MODEL-schema-ohoj3j73c1#field-requiredSection ID: DOC-API-MODEL-schema-ohoj3j73c1#response-field-requiredrequired | boolean | Optional | Whether the prompt parameter must be supplied by the caller. |
Where used
Section ID: DOC-API-MODEL-schema-ohoj3j73c1#where-used
| Reference | Relationship |
|---|---|
| Get an MCP prompt template | POST /api/v1/llm/mcp-get-prompt |
| List MCP prompt templates | POST /api/v1/llm/mcp-list-prompts |
Models containing this value
| Model | Relationship |
|---|---|
| PromptDefinition | Nested in model |
Download the public reference contract.
Document ID: DOC-API-MODEL-schema-ohoj3j73c1