API
Models, inference and Connections data models
Read the shared models, inference and connections fields used by the customer API.
Shared contract
Models, inference and Connections
These 20 models come from the same Product owned OpenAPI 3.2 contract as the operation reference.
ChatCompletedEvent2 fields
Shared ChatCompletedEvent representation.
ChatCompletedEvent fields
| Field | Presence | Type | Meaning | Empty and default | Limits and example | Access, sensitivity and lifecycle |
|---|---|---|---|---|---|---|
data | required | string | JSON encoded direct final ChatResult. No data envelope is present in this event payload. | Omission, null, an empty value, zero, and false have distinct JSON meanings. Only values permitted by this schema and the operation may be used. Default: No client default is assumed unless a JSON Schema default is present. | Example: {"model":"example model","message":{"role":"assistant","content":"Hello."}} | Inherits the operation access boundary. Shared across documented Pūnaha HTTP operations. No special sensitivity is marked. Do not copy customer content, credentials, or personal information into examples or unsupported logs. Lifecycle: Next Product release. |
event | required | string | The chat event type that selects the data payload schema. | Omission, null, an empty value, zero, and false have distinct JSON meanings. Only values permitted by this schema and the operation may be used. Default: No client default is assumed unless a JSON Schema default is present. | Example: chat.completed | Inherits the operation access boundary. Shared across documented Pūnaha HTTP operations. No special sensitivity is marked. Do not copy customer content, credentials, or personal information into examples or unsupported logs. Lifecycle: Next Product release. |
ChatDeltaData1 fields
Shared ChatDeltaData representation.
ChatDeltaData fields
| Field | Presence | Type | Meaning | Empty and default | Limits and example | Access, sensitivity and lifecycle |
|---|---|---|---|---|---|---|
content | required | string | Incremental text fragment. Append fragments in arrival order. The complete successful message is also returned by chat.completed. | Omission, null, an empty value, zero, and false have distinct JSON meanings. Only values permitted by this schema and the operation may be used. Default: No client default is assumed unless a JSON Schema default is present. | Example: Hello. | Inherits the operation access boundary. Shared across documented Pūnaha HTTP operations. No special sensitivity is marked. Do not copy customer content, credentials, or personal information into examples or unsupported logs. Lifecycle: Next Product release. |
ChatDeltaEvent2 fields
Shared ChatDeltaEvent representation.
ChatDeltaEvent fields
| Field | Presence | Type | Meaning | Empty and default | Limits and example | Access, sensitivity and lifecycle |
|---|---|---|---|---|---|---|
data | required | string | JSON encoded incremental content object, not a bare JSON string. | Omission, null, an empty value, zero, and false have distinct JSON meanings. Only values permitted by this schema and the operation may be used. Default: No client default is assumed unless a JSON Schema default is present. | Example: {"content":"Hello."} | Inherits the operation access boundary. Shared across documented Pūnaha HTTP operations. No special sensitivity is marked. Do not copy customer content, credentials, or personal information into examples or unsupported logs. Lifecycle: Next Product release. |
event | required | string | The chat event type that selects the data payload schema. | Omission, null, an empty value, zero, and false have distinct JSON meanings. Only values permitted by this schema and the operation may be used. Default: No client default is assumed unless a JSON Schema default is present. | Example: chat.delta | Inherits the operation access boundary. Shared across documented Pūnaha HTTP operations. No special sensitivity is marked. Do not copy customer content, credentials, or personal information into examples or unsupported logs. Lifecycle: Next Product release. |
ChatFailedData3 fields
Shared ChatFailedData representation.
ChatFailedData fields
| Field | Presence | Type | Meaning | Empty and default | Limits and example | Access, sensitivity and lifecycle |
|---|---|---|---|---|---|---|
error | required | object | Terminal stream error after events have started. Partial content is incomplete and no final ChatResult follows. | Omission, null, an empty value, zero, and false have distinct JSON meanings. Only values permitted by this schema and the operation may be used. Default: No client default is assumed unless a JSON Schema default is present. | No additional schema limit is listed | Inherits the operation access boundary. Shared across documented Pūnaha HTTP operations. No special sensitivity is marked. Do not copy customer content, credentials, or personal information into examples or unsupported logs. Lifecycle: Next Product release. |
error.code | required | string | Stable stream failure code. | Omission, null, an empty value, zero, and false have distinct JSON meanings. Only values permitted by this schema and the operation may be used. Default: No client default is assumed unless a JSON Schema default is present. | Example: CHAT_STREAM_FAILED | Inherits the operation access boundary. Shared across documented Pūnaha HTTP operations. No special sensitivity is marked. Do not copy customer content, credentials, or personal information into examples or unsupported logs. Lifecycle: Next Product release. |
error.message | required | string | Safe explanation of the incomplete generation. | Omission, null, an empty value, zero, and false have distinct JSON meanings. Only values permitted by this schema and the operation may be used. Default: No client default is assumed unless a JSON Schema default is present. | Example: Chat generation did not complete. | Inherits the operation access boundary. Shared across documented Pūnaha HTTP operations. No special sensitivity is marked. Do not copy customer content, credentials, or personal information into examples or unsupported logs. Lifecycle: Next Product release. |
ChatFailedEvent2 fields
Shared ChatFailedEvent representation.
ChatFailedEvent fields
| Field | Presence | Type | Meaning | Empty and default | Limits and example | Access, sensitivity and lifecycle |
|---|---|---|---|---|---|---|
data | required | string | JSON encoded terminal stream error object with code and message. Unlike an ordinary APIError, it has no details property. | Omission, null, an empty value, zero, and false have distinct JSON meanings. Only values permitted by this schema and the operation may be used. Default: No client default is assumed unless a JSON Schema default is present. | Example: {"error":{"code":"CHAT_STREAM_FAILED","message":"Chat generation did not complete."}} | Inherits the operation access boundary. Shared across documented Pūnaha HTTP operations. No special sensitivity is marked. Do not copy customer content, credentials, or personal information into examples or unsupported logs. Lifecycle: Next Product release. |
event | required | string | The chat event type that selects the data payload schema. | Omission, null, an empty value, zero, and false have distinct JSON meanings. Only values permitted by this schema and the operation may be used. Default: No client default is assumed unless a JSON Schema default is present. | Example: chat.failed | Inherits the operation access boundary. Shared across documented Pūnaha HTTP operations. No special sensitivity is marked. Do not copy customer content, credentials, or personal information into examples or unsupported logs. Lifecycle: Next Product release. |
ChatResponse8 fields
Shared ChatResponse representation.
ChatResponse fields
| Field | Presence | Type | Meaning | Empty and default | Limits and example | Access, sensitivity and lifecycle |
|---|---|---|---|---|---|---|
data | required | ModelsChatResult | Completed chat result in the ordinary JSON response envelope. | Omission, null, an empty value, zero, and false have distinct JSON meanings. Only values permitted by this schema and the operation may be used. Default: No client default is assumed unless a JSON Schema default is present. | No additional schema limit is listed | Inherits the operation access boundary. Shared across documented Pūnaha HTTP operations. No special sensitivity is marked. Do not copy customer content, credentials, or personal information into examples or unsupported logs. Lifecycle: Next Product release. |
data.message | required | ModelsMessageResponse | Completed assistant message. | Omission, null, an empty value, zero, and false have distinct JSON meanings. Only values permitted by this schema and the operation may be used. Default: No client default is assumed unless a JSON Schema default is present. | No additional schema limit is listed | Inherits the operation access boundary. Shared across documented Pūnaha HTTP operations. No special sensitivity is marked. Do not copy customer content, credentials, or personal information into examples or unsupported logs. Lifecycle: Next Product release. |
data.message.content | required | string | Complete generated message text. | Omission, null, an empty value, zero, and false have distinct JSON meanings. Only values permitted by this schema and the operation may be used. Default: No client default is assumed unless a JSON Schema default is present. | Example: Hello. | Inherits the operation access boundary. Shared across documented Pūnaha HTTP operations. No special sensitivity is marked. Do not copy customer content, credentials, or personal information into examples or unsupported logs. Lifecycle: Next Product release. |
data.message.role | required | string | Role of the message returned by the selected provider. | Omission, null, an empty value, zero, and false have distinct JSON meanings. Only values permitted by this schema and the operation may be used. Default: No client default is assumed unless a JSON Schema default is present. | Example: assistant | Inherits the operation access boundary. Shared across documented Pūnaha HTTP operations. No special sensitivity is marked. Do not copy customer content, credentials, or personal information into examples or unsupported logs. Lifecycle: Next Product release. |
data.model | required | string | Model identifier reported by the selected runtime or provider. | Omission, null, an empty value, zero, and false have distinct JSON meanings. Only values permitted by this schema and the operation may be used. Default: No client default is assumed unless a JSON Schema default is present. | Example: example model | Inherits the operation access boundary. Shared across documented Pūnaha HTTP operations. No special sensitivity is marked. Do not copy customer content, credentials, or personal information into examples or unsupported logs. Lifecycle: Next Product release. |
data.performance | optional | object | Optional runtime specific performance measurements, available for local llama.cpp replies. | Omission, null, an empty value, zero, and false have distinct JSON meanings. Only values permitted by this schema and the operation may be used. Default: No client default is assumed unless a JSON Schema default is present. | No additional schema limit is listed | Inherits the operation access boundary. Shared across documented Pūnaha HTTP operations. No special sensitivity is marked. Do not copy customer content, credentials, or personal information into examples or unsupported logs. Lifecycle: Next Product release. |
data.raw | optional | JSON value | Optional original provider response as JSON. May contain provider specific response details and should follow tenant data handling rules. | Omission, null, an empty value, zero, and false have distinct JSON meanings. Only values permitted by this schema and the operation may be used. Default: No client default is assumed unless a JSON Schema default is present. | No additional schema limit is listed | Inherits the operation access boundary. Shared across documented Pūnaha HTTP operations. No special sensitivity is marked. Do not copy customer content, credentials, or personal information into examples or unsupported logs. Lifecycle: Next Product release. |
data.usage | optional | object | Optional provider specific token or usage measurements. Field names and availability vary by provider. | Omission, null, an empty value, zero, and false have distinct JSON meanings. Only values permitted by this schema and the operation may be used. Default: No client default is assumed unless a JSON Schema default is present. | No additional schema limit is listed | Inherits the operation access boundary. Shared across documented Pūnaha HTTP operations. No special sensitivity is marked. Do not copy customer content, credentials, or personal information into examples or unsupported logs. Lifecycle: Next Product release. |
ChatServerSentEvent0 fields
Parsed chat SSE frame. Decode its data string as JSON using the schema selected by event. The handler emits no id or retry fields and provides no replay protocol.
ChatServerSentEvent fields
ChatDeltaEvent or ChatCompletedEvent or ChatFailedEvent. Parsed chat SSE frame. Decode its data string as JSON using the schema selected by event. The handler emits no id or retry fields and provides no replay protocol.
ConnectionsDefinitionResponse22 fields
Shared ConnectionsDefinitionResponse representation.
ConnectionsDefinitionResponse fields
| Field | Presence | Type | Meaning | Empty and default | Limits and example | Access, sensitivity and lifecycle |
|---|---|---|---|---|---|---|
authenticationType | required | string | The authentication type associated with this resource or operation. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
clientId | optional | string | The client id associated with this resource or operation. | The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
configuration | required | object | Keys are defined by the selected configuration, provider, or resource type. Values follow the documented field schema. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: {} | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
connectionType | required | string | The connection type associated with this resource or operation. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
createdAt | required | string in date-time format | The UTC date and time when the resource was created. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: 2026 08 28T00:00:00Z | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
databaseName | optional | string | The database name associated with this resource or operation. | The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
description | required | string | The description associated with this resource or operation. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
enabled | required | boolean | The enabled associated with this resource or operation. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: Yes | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
endpoint | optional | string | The endpoint associated with this resource or operation. | The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
host | optional | string | The host associated with this resource or operation. | The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
id | required | string | The stable identifier of this resource. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
lastTestMessage | optional | string | The last test message associated with this resource or operation. | The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
lastTestStatus | required | string | The last test status associated with this resource or operation. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
lastTestedAt | optional | string in date-time format or null | The last tested at associated with this resource or operation. | The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present. | Example: 2026 08 28T00:00:00Z | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
name | required | string | The name associated with this resource or operation. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
organizationId | required | string | The organization id associated with this resource or operation. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
port | optional | integer in int64 format | The port associated with this resource or operation. | The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present. | Example: 1 | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
secretStatus | required | object | Keys are defined by the selected configuration, provider, or resource type. Values follow the documented field schema. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value not a real secret | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. Sensitive. Treat as sensitive. Do not place real values in examples or logs. Apply the Product redaction and access controls. Lifecycle: Next Product release. |
tenantId | optional | string | The tenant identifier that owns or scopes the resource. | The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
tlsMode | required | string | The tls mode associated with this resource or operation. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
updatedAt | required | string in date-time format | The UTC date and time when the resource was last changed. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: 2026 08 28T00:00:00Z | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
username | optional | string | The username associated with this resource or operation. | The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
ConnectionsInputRequest16 fields
Shared ConnectionsInputRequest representation.
ConnectionsInputRequest fields
| Field | Presence | Type | Meaning | Empty and default | Limits and example | Access, sensitivity and lifecycle |
|---|---|---|---|---|---|---|
authenticationType | required | string | The authentication type associated with this resource or operation. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
clearSecrets | required | list of string | The clear secrets associated with this resource or operation. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. Sensitive. Treat as sensitive. Do not place real values in examples or logs. Apply the Product redaction and access controls. Lifecycle: Next Product release. |
clientId | required | string | The client id associated with this resource or operation. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
configuration | required | object | Keys are defined by the selected configuration, provider, or resource type. Values follow the documented field schema. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: {} | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
connectionType | required | string | The connection type associated with this resource or operation. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
databaseName | required | string | The database name associated with this resource or operation. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
description | required | string | The description associated with this resource or operation. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
enabled | optional | boolean or null | The enabled associated with this resource or operation. | The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present. | Example: Yes | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
endpoint | required | string | The endpoint associated with this resource or operation. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
host | required | string | The host associated with this resource or operation. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
name | required | string | The name associated with this resource or operation. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
port | required | integer in int64 format | The port associated with this resource or operation. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: 1 | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
secrets | required | object | Keys are defined by the selected configuration, provider, or resource type. Values follow the documented field schema. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value not a real secret | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. Sensitive. Treat as sensitive. Do not place real values in examples or logs. Apply the Product redaction and access controls. Lifecycle: Next Product release. |
tenantId | required | string | The tenant identifier that owns or scopes the resource. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
tlsMode | required | string | The tls mode associated with this resource or operation. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
username | required | string | The username associated with this resource or operation. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
ConnectionsOptionResponse4 fields
Shared ConnectionsOptionResponse representation.
ConnectionsOptionResponse fields
| Field | Presence | Type | Meaning | Empty and default | Limits and example | Access, sensitivity and lifecycle |
|---|---|---|---|---|---|---|
connectionType | required | string | The connection type associated with this resource or operation. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
enabled | required | boolean | The enabled associated with this resource or operation. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: Yes | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
id | required | string | The stable identifier of this resource. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
name | required | string | The name associated with this resource or operation. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
DomainEmbeddingModelConfigurationRequest9 fields
Shared DomainEmbeddingModelConfigurationRequest representation.
DomainEmbeddingModelConfigurationRequest fields
| Field | Presence | Type | Meaning | Empty and default | Limits and example | Access, sensitivity and lifecycle |
|---|---|---|---|---|---|---|
available | required | boolean | The available associated with this resource or operation. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: Yes | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
contextTokens | optional | integer in int64 format | The context tokens associated with this resource or operation. | The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present. | Example: 1 | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. Sensitive. Treat as sensitive. Do not place real values in examples or logs. Apply the Product redaction and access controls. Lifecycle: Next Product release. |
dimensions | required | integer in int64 format | The dimensions associated with this resource or operation. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: 1 | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
id | required | string | The stable identifier of this resource. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
local | required | boolean | The local associated with this resource or operation. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: Yes | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
name | required | string | The name associated with this resource or operation. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
provider | required | string | The provider associated with this resource or operation. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
runtime | required | string | The runtime associated with this resource or operation. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
status | required | string | The current lifecycle or processing state. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
DomainModelConnectionResponse9 fields
Shared DomainModelConnectionResponse representation.
DomainModelConnectionResponse fields
| Field | Presence | Type | Meaning | Empty and default | Limits and example | Access, sensitivity and lifecycle |
|---|---|---|---|---|---|---|
baseUrl | optional | string | The base url associated with this resource or operation. | The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
configuration | required | JSON value | A JSON value whose structure is defined by the selected operation. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
createdAt | required | string in date-time format | The UTC date and time when the resource was created. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: 2026 08 28T00:00:00Z | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
displayName | required | string | The display name associated with this resource or operation. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
enabled | required | boolean | The enabled associated with this resource or operation. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: Yes | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
id | required | string | The stable identifier of this resource. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
organizationId | required | string | The organization id associated with this resource or operation. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
providerType | required | string | The provider type associated with this resource or operation. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
updatedAt | required | string in date-time format | The UTC date and time when the resource was last changed. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: 2026 08 28T00:00:00Z | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
DomainModelDeploymentResponse12 fields
Shared DomainModelDeploymentResponse representation.
DomainModelDeploymentResponse fields
| Field | Presence | Type | Meaning | Empty and default | Limits and example | Access, sensitivity and lifecycle |
|---|---|---|---|---|---|---|
capabilities | required | JSON value | A JSON value whose structure is defined by the selected operation. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
configuration | required | JSON value | A JSON value whose structure is defined by the selected operation. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
connectionId | required | string | The connection id associated with this resource or operation. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
createdAt | required | string in date-time format | The UTC date and time when the resource was created. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: 2026 08 28T00:00:00Z | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
displayName | required | string | The display name associated with this resource or operation. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
enabled | required | boolean | The enabled associated with this resource or operation. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: Yes | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
id | required | string | The stable identifier of this resource. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
organizationId | required | string | The organization id associated with this resource or operation. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
pinnedRevision | optional | string | The pinned revision associated with this resource or operation. | The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
preload | required | boolean | The preload associated with this resource or operation. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: Yes | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
providerModelId | required | string | The provider model id associated with this resource or operation. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
updatedAt | required | string in date-time format | The UTC date and time when the resource was last changed. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: 2026 08 28T00:00:00Z | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
DomainProcessingModelConfigurationRequest1 fields
Shared DomainProcessingModelConfigurationRequest representation.
DomainProcessingModelConfigurationRequest fields
| Field | Presence | Type | Meaning | Empty and default | Limits and example | Access, sensitivity and lifecycle |
|---|---|---|---|---|---|---|
deploymentId | required | string | The deployment id associated with this resource or operation. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
ModelsChatResult7 fields
Shared ModelsChatResult representation.
ModelsChatResult fields
| Field | Presence | Type | Meaning | Empty and default | Limits and example | Access, sensitivity and lifecycle |
|---|---|---|---|---|---|---|
message | required | ModelsMessageResponse | Completed assistant message. | Omission, null, an empty value, zero, and false have distinct JSON meanings. Only values permitted by this schema and the operation may be used. Default: No client default is assumed unless a JSON Schema default is present. | No additional schema limit is listed | Inherits the operation access boundary. Shared across documented Pūnaha HTTP operations. No special sensitivity is marked. Do not copy customer content, credentials, or personal information into examples or unsupported logs. Lifecycle: Next Product release. |
message.content | required | string | Complete generated message text. | Omission, null, an empty value, zero, and false have distinct JSON meanings. Only values permitted by this schema and the operation may be used. Default: No client default is assumed unless a JSON Schema default is present. | Example: Hello. | Inherits the operation access boundary. Shared across documented Pūnaha HTTP operations. No special sensitivity is marked. Do not copy customer content, credentials, or personal information into examples or unsupported logs. Lifecycle: Next Product release. |
message.role | required | string | Role of the message returned by the selected provider. | Omission, null, an empty value, zero, and false have distinct JSON meanings. Only values permitted by this schema and the operation may be used. Default: No client default is assumed unless a JSON Schema default is present. | Example: assistant | Inherits the operation access boundary. Shared across documented Pūnaha HTTP operations. No special sensitivity is marked. Do not copy customer content, credentials, or personal information into examples or unsupported logs. Lifecycle: Next Product release. |
model | required | string | Model identifier reported by the selected runtime or provider. | Omission, null, an empty value, zero, and false have distinct JSON meanings. Only values permitted by this schema and the operation may be used. Default: No client default is assumed unless a JSON Schema default is present. | Example: example model | Inherits the operation access boundary. Shared across documented Pūnaha HTTP operations. No special sensitivity is marked. Do not copy customer content, credentials, or personal information into examples or unsupported logs. Lifecycle: Next Product release. |
performance | optional | object | Optional runtime specific performance measurements, available for local llama.cpp replies. | Omission, null, an empty value, zero, and false have distinct JSON meanings. Only values permitted by this schema and the operation may be used. Default: No client default is assumed unless a JSON Schema default is present. | No additional schema limit is listed | Inherits the operation access boundary. Shared across documented Pūnaha HTTP operations. No special sensitivity is marked. Do not copy customer content, credentials, or personal information into examples or unsupported logs. Lifecycle: Next Product release. |
raw | optional | JSON value | Optional original provider response as JSON. May contain provider specific response details and should follow tenant data handling rules. | Omission, null, an empty value, zero, and false have distinct JSON meanings. Only values permitted by this schema and the operation may be used. Default: No client default is assumed unless a JSON Schema default is present. | No additional schema limit is listed | Inherits the operation access boundary. Shared across documented Pūnaha HTTP operations. No special sensitivity is marked. Do not copy customer content, credentials, or personal information into examples or unsupported logs. Lifecycle: Next Product release. |
usage | optional | object | Optional provider specific token or usage measurements. Field names and availability vary by provider. | Omission, null, an empty value, zero, and false have distinct JSON meanings. Only values permitted by this schema and the operation may be used. Default: No client default is assumed unless a JSON Schema default is present. | No additional schema limit is listed | Inherits the operation access boundary. Shared across documented Pūnaha HTTP operations. No special sensitivity is marked. Do not copy customer content, credentials, or personal information into examples or unsupported logs. Lifecycle: Next Product release. |
ModelsConnectionInputRequest11 fields
Shared ModelsConnectionInputRequest representation.
ModelsConnectionInputRequest fields
| Field | Presence | Type | Meaning | Empty and default | Limits and example | Access, sensitivity and lifecycle |
|---|---|---|---|---|---|---|
baseUrl | required | string | The base url associated with this resource or operation. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
configuration | required | object | Keys are defined by the selected configuration, provider, or resource type. Values follow the documented field schema. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: {} | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
credentials | required | ModelsProviderSecretRequest | The credentials associated with this resource or operation. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | No additional schema limit is listed | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. Sensitive. Treat as sensitive. Do not place real values in examples or logs. Apply the Product redaction and access controls. Lifecycle: Next Product release. |
credentials.apiKey | optional | string | The api key associated with this resource or operation. | The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
credentials.awsAccessKeyId | optional | string | The aws access key id associated with this resource or operation. | The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
credentials.awsSecretAccessKey | optional | string | The aws secret access key associated with this resource or operation. | The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. Sensitive. Treat as sensitive. Do not place real values in examples or logs. Apply the Product redaction and access controls. Lifecycle: Next Product release. |
credentials.awsSessionToken | optional | string | The aws session token associated with this resource or operation. | The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. Sensitive. Treat as sensitive. Do not place real values in examples or logs. Apply the Product redaction and access controls. Lifecycle: Next Product release. |
credentials.headers | optional | object | Keys are defined by the selected configuration, provider, or resource type. Values follow the documented field schema. | The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present. | Example: {} | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
displayName | required | string | The display name associated with this resource or operation. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
enabled | optional | boolean or null | The enabled associated with this resource or operation. | The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present. | Example: Yes | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
providerType | required | string | The provider type associated with this resource or operation. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
ModelsDeploymentInputRequest7 fields
Shared ModelsDeploymentInputRequest representation.
ModelsDeploymentInputRequest fields
| Field | Presence | Type | Meaning | Empty and default | Limits and example | Access, sensitivity and lifecycle |
|---|---|---|---|---|---|---|
capabilities | required | object | Keys are defined by the selected configuration, provider, or resource type. Values follow the documented field schema. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: {} | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
configuration | required | object | Keys are defined by the selected configuration, provider, or resource type. Values follow the documented field schema. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: {} | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
displayName | required | string | The display name associated with this resource or operation. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
enabled | optional | boolean or null | The enabled associated with this resource or operation. | The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present. | Example: Yes | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
pinnedRevision | required | string | The pinned revision associated with this resource or operation. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
preload | optional | boolean or null | The preload associated with this resource or operation. | The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present. | Example: Yes | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
providerModelId | required | string | The provider model id associated with this resource or operation. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
ModelsMessageRequest2 fields
Shared ModelsMessageRequest representation.
ModelsMessageRequest fields
| Field | Presence | Type | Meaning | Empty and default | Limits and example | Access, sensitivity and lifecycle |
|---|---|---|---|---|---|---|
content | required | string | The content associated with this resource or operation. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. Sensitive. Treat as sensitive. Do not place real values in examples or logs. Apply the Product redaction and access controls. Lifecycle: Next Product release. |
role | required | string | The role associated with this resource or operation. | The field is present. Empty strings or collections are valid only when the field constraints and operation rules allow them. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
ModelsMessageResponse2 fields
Shared ModelsMessageResponse representation.
ModelsMessageResponse fields
| Field | Presence | Type | Meaning | Empty and default | Limits and example | Access, sensitivity and lifecycle |
|---|---|---|---|---|---|---|
content | required | string | Complete generated message text. | Omission, null, an empty value, zero, and false have distinct JSON meanings. Only values permitted by this schema and the operation may be used. Default: No client default is assumed unless a JSON Schema default is present. | Example: Hello. | Inherits the operation access boundary. Shared across documented Pūnaha HTTP operations. No special sensitivity is marked. Do not copy customer content, credentials, or personal information into examples or unsupported logs. Lifecycle: Next Product release. |
role | required | string | Role of the message returned by the selected provider. | Omission, null, an empty value, zero, and false have distinct JSON meanings. Only values permitted by this schema and the operation may be used. Default: No client default is assumed unless a JSON Schema default is present. | Example: assistant | Inherits the operation access boundary. Shared across documented Pūnaha HTTP operations. No special sensitivity is marked. Do not copy customer content, credentials, or personal information into examples or unsupported logs. Lifecycle: Next Product release. |
ModelsProviderSecretRequest5 fields
Shared ModelsProviderSecretRequest representation.
ModelsProviderSecretRequest fields
| Field | Presence | Type | Meaning | Empty and default | Limits and example | Access, sensitivity and lifecycle |
|---|---|---|---|---|---|---|
apiKey | optional | string | The api key associated with this resource or operation. | The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
awsAccessKeyId | optional | string | The aws access key id associated with this resource or operation. | The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
awsSecretAccessKey | optional | string | The aws secret access key associated with this resource or operation. | The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. Sensitive. Treat as sensitive. Do not place real values in examples or logs. Apply the Product redaction and access controls. Lifecycle: Next Product release. |
awsSessionToken | optional | string | The aws session token associated with this resource or operation. | The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present. | Example: example value | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. Sensitive. Treat as sensitive. Do not place real values in examples or logs. Apply the Product redaction and access controls. Lifecycle: Next Product release. |
headers | optional | object | Keys are defined by the selected configuration, provider, or resource type. Values follow the documented field schema. | The field may be omitted. Omission is different from null, an empty string, an empty collection, zero, or false. Default: No client default is assumed unless a JSON Schema default is present. | Example: {} | Inherits the operation access rules. Inherits the operation availability unless an operation specific rule says otherwise. No special sensitivity is marked. No special handling is inferred beyond normal tenant access, audit, retention, and data classification controls. Lifecycle: Next Product release. |
Was this page helpful?
Your answer helps us improve the documentation.
Do not include personal information, customer information, passwords, or keys.