taskRequestSchema

const taskRequestSchema: object

The JSON Schemas those models were generated from, for runtime use.

Type Declaration

$id

readonly $id: "https://schemas.inderun.dev/1.0/task-request.schema.json"

$schema

readonly $schema: "https://json-schema.org/draft/2020-12/schema"

additionalProperties

readonly additionalProperties: true

allOf

readonly allOf: readonly [{ if: { properties: { task: { properties: { kind: { const: "text_to_text"; }; }; type: "object"; }; }; }; then: { anyOf: readonly [{ required: readonly ["prompt"]; }, { required: readonly ["messages"]; }]; not: { anyOf: readonly [{ required: readonly […]; }, { required: readonly […]; }]; }; }; }, { if: { properties: { task: { properties: { kind: { const: "text_to_speech"; }; }; type: "object"; }; }; }; then: { not: { anyOf: readonly [{ required: readonly […]; }, { required: readonly […]; }, { required: readonly […]; }]; }; properties: { delivery: { properties: { mode: { enum: readonly […, …]; }; }; type: "object"; }; }; required: readonly ["speech", "delivery"]; }; }]

description

readonly description: "The request payload for a run() or stream() execution. The common envelope (schemaVersion, requestId, task, modelProfile, constraints, preferences, telemetry, authContextRef) is task-agnostic; each task kind owns its payload (ADR 016). text_to_text: at least one of `prompt` (single-turn) or `messages` (multi-turn) must be present — both may be present together, though callers should typically supply just one — and `speech`/`delivery` are forbidden. text_to_speech: `speech` and `delivery` are required and `prompt`, `messages` and `generation` are forbidden. `constraints`/`preferences` steer routing but never select a provider directly."

properties

readonly properties: object

properties.authContextRef

readonly authContextRef: object

properties.authContextRef.description

readonly description: "A unique identifier used to retrieve credentials from a secure local storage. Raw sensitive keys (API keys, etc.) should NEVER be placed directly in the request payload."

properties.authContextRef.minLength

readonly minLength: 1

properties.authContextRef.type

readonly type: "string"

properties.constraints

readonly constraints: object

properties.constraints.additionalProperties

readonly additionalProperties: true

properties.constraints.description

readonly description: "Request-level routing constraints used by the planner."

properties.constraints.properties

readonly properties: object

properties.constraints.properties.cloud

readonly cloud: object

properties.constraints.properties.cloud.description

readonly description: "Cloud execution constraint."

properties.constraints.properties.cloud.enum

readonly enum: readonly ["forbidden", "allowed", "required"]

properties.constraints.properties.privacy

readonly privacy: object

properties.constraints.properties.privacy.description

readonly description: "Privacy requirement or preference for execution placement."

properties.constraints.properties.privacy.enum

readonly enum: readonly ["local_required", "local_preferred", "cloud_allowed", "cloud_required"]

properties.constraints.properties.timeoutMs

readonly timeoutMs: object

properties.constraints.properties.timeoutMs.description

readonly description: "Optional timeout budget in milliseconds, passed to the planner and to providers. It bounds the time until the run commits to a provider -- its first content, its first possible audible effect, or its artifact handoff -- not the duration of audio it plays. The engines add no timers of their own."

properties.constraints.properties.timeoutMs.minimum

readonly minimum: 1

properties.constraints.properties.timeoutMs.type

readonly type: "integer"

properties.constraints.type

readonly type: "object"

properties.delivery

readonly delivery: object

properties.delivery.additionalProperties

readonly additionalProperties: true

properties.delivery.description

readonly description: "How the result of a non-text task must reach the application (ADR 016). Required for non-text tasks and forbidden for text_to_text, whose output is implicitly inline. A provider never substitutes playback for an artifact or the reverse."

properties.delivery.else

readonly else: object

properties.delivery.else.not

readonly not: object

properties.delivery.else.not.anyOf

readonly anyOf: readonly [{ required: readonly ["mediaTypes"]; }, { required: readonly ["destinationRef"]; }]

properties.delivery.if

readonly if: object

properties.delivery.if.properties

readonly properties: object

properties.delivery.if.properties.mode

readonly mode: object

properties.delivery.if.properties.mode.const

readonly const: "artifact"

properties.delivery.properties

readonly properties: object

properties.delivery.properties.destinationRef

readonly destinationRef: object

properties.delivery.properties.destinationRef.description

readonly description: "Only valid with 'artifact' delivery: an opaque reference to an application destination the engine writes the finished artifact to, resolved by the host's artifact-destination service (ADR 017) -- never a raw path or URL, like authContextRef for credentials. The result's artifact is then application-owned and the engine keeps no copy. A host without the service refuses the request before routing."

properties.delivery.properties.destinationRef.minLength

readonly minLength: 1

properties.delivery.properties.destinationRef.type

readonly type: "string"

properties.delivery.properties.mediaTypes

readonly mediaTypes: object

properties.delivery.properties.mediaTypes.description

readonly description: "Only valid with 'artifact' delivery: the acceptable media types, always a hard requirement. Absent means the provider chooses and the artifact reports what it produced."

properties.delivery.properties.mediaTypes.items

readonly items: object

properties.delivery.properties.mediaTypes.items.minLength

readonly minLength: 1

properties.delivery.properties.mediaTypes.items.type

readonly type: "string"

properties.delivery.properties.mediaTypes.minItems

readonly minItems: 1

properties.delivery.properties.mediaTypes.type

readonly type: "array"

properties.delivery.properties.mediaTypes.uniqueItems

readonly uniqueItems: true

properties.delivery.properties.mode

readonly mode: object

properties.delivery.properties.mode.$ref

readonly $ref: "provider-descriptor.schema.json#/$defs/outputDelivery"

properties.delivery.required

readonly required: readonly ["mode"]

properties.delivery.title

readonly title: "OutputDeliveryRequest"

properties.delivery.type

readonly type: "object"

properties.generation

readonly generation: object

properties.generation.additionalProperties

readonly additionalProperties: true

properties.generation.description

readonly description: "Optional configuration for fine-tuning how the AI model generates its response."

properties.generation.properties

readonly properties: object

properties.generation.properties.maxOutputTokens

readonly maxOutputTokens: object

properties.generation.properties.maxOutputTokens.description

readonly description: "The maximum number of tokens to generate in a single response."

properties.generation.properties.maxOutputTokens.minimum

readonly minimum: 1

properties.generation.properties.maxOutputTokens.type

readonly type: "integer"

properties.generation.properties.seed

readonly seed: object

properties.generation.properties.seed.description

readonly description: "A fixed seed for deterministic generation (where supported by the underlying provider)."

properties.generation.properties.seed.type

readonly type: "integer"

properties.generation.properties.stop

readonly stop: object

properties.generation.properties.stop.description

readonly description: "Sequence tokens that should terminate the generation process."

properties.generation.properties.stop.items

readonly items: object

properties.generation.properties.stop.items.type

readonly type: "string"

properties.generation.properties.stop.type

readonly type: "array"

properties.generation.properties.temperature

readonly temperature: object

properties.generation.properties.temperature.description

readonly description: "Controls the randomness of the output. Range: 0 (most deterministic) to 2 (highest variance)."

properties.generation.properties.temperature.maximum

readonly maximum: 2

properties.generation.properties.temperature.minimum

readonly minimum: 0

properties.generation.properties.temperature.type

readonly type: "number"

properties.generation.properties.topP

readonly topP: object

properties.generation.properties.topP.description

readonly description: "Nucleus sampling parameter for controlling diversity vs focus in the output."

properties.generation.properties.topP.maximum

readonly maximum: 1

properties.generation.properties.topP.minimum

readonly minimum: 0

properties.generation.properties.topP.type

readonly type: "number"

properties.generation.type

readonly type: "object"

properties.messages

readonly messages: object

properties.messages.description

readonly description: "A list of interaction messages for multi-turn conversation or chat-style execution."

properties.messages.items

readonly items: object

properties.messages.items.additionalProperties

readonly additionalProperties: true

properties.messages.items.description

readonly description: "An individual message in a conversation."

properties.messages.items.properties

readonly properties: object

properties.messages.items.properties.content

readonly content: object

properties.messages.items.properties.content.description

readonly description: "The actual text content of the message."

properties.messages.items.properties.content.minLength

readonly minLength: 1

properties.messages.items.properties.content.type

readonly type: "string"

properties.messages.items.properties.role

readonly role: object

properties.messages.items.properties.role.description

readonly description: "The role of the author (e.g., 'user', 'assistant')."

properties.messages.items.properties.role.enum

readonly enum: readonly ["system", "user", "assistant"]

properties.messages.items.required

readonly required: readonly ["role", "content"]

properties.messages.items.type

readonly type: "object"

properties.messages.minItems

readonly minItems: 1

properties.messages.type

readonly type: "array"

properties.modelProfile

readonly modelProfile: object

properties.modelProfile.description

readonly description: "Name of the model profile to route within, as configured on the engine. Absent or 'auto' means every registered target, ranked by constraints and preferences alone. A profile is an application-defined, ordered allow-list of targets (provider instances bound to one model each); raw model or provider identifiers are never accepted here. An unknown profile name fails request validation."

properties.modelProfile.minLength

readonly minLength: 1

properties.modelProfile.type

readonly type: "string"

properties.preferences

readonly preferences: object

properties.preferences.additionalProperties

readonly additionalProperties: true

properties.preferences.description

readonly description: "Soft routing preferences used for deterministic provider ordering."

properties.preferences.properties

readonly properties: object

properties.preferences.properties.optimizeFor

readonly optimizeFor: object

properties.preferences.properties.optimizeFor.description

readonly description: "Primary optimization goal when multiple providers remain eligible."

properties.preferences.properties.optimizeFor.enum

readonly enum: readonly ["privacy", "latency", "cost", "balanced"]

properties.preferences.type

readonly type: "object"

properties.prompt

readonly prompt: object

properties.prompt.description

readonly description: "A simple, single-turn text prompt used to trigger a response from the AI model."

properties.prompt.minLength

readonly minLength: 1

properties.prompt.type

readonly type: "string"

properties.requestId

readonly requestId: object

properties.requestId.description

readonly description: "Optional identifier for tracking or correlating this specific execution attempt."

properties.requestId.minLength

readonly minLength: 1

properties.requestId.type

readonly type: "string"

properties.schemaVersion

readonly schemaVersion: object

properties.schemaVersion.const

readonly const: "1.0"

properties.schemaVersion.description

readonly description: "Contract schema version used to interpret the request payload."

properties.speech

readonly speech: object

properties.speech.additionalProperties

readonly additionalProperties: true

properties.speech.description

readonly description: "The text_to_speech payload. Required for text_to_speech and forbidden for every other kind."

properties.speech.properties

readonly properties: object

properties.speech.properties.locale

readonly locale: object

properties.speech.properties.locale.description

readonly description: "BCP 47 tag of the language to speak, e.g. 'de-AT'."

properties.speech.properties.locale.minLength

readonly minLength: 1

properties.speech.properties.locale.type

readonly type: "string"

properties.speech.properties.localeMatch

readonly localeMatch: object

properties.speech.properties.localeMatch.description

readonly description: "'language' (default): the primary language subtag is a hard requirement and the region is a preference. 'exact': the full tag is a hard requirement."

properties.speech.properties.localeMatch.enum

readonly enum: readonly ["exact", "language"]

properties.speech.properties.localeMatch.title

readonly title: "LocaleMatch"

properties.speech.properties.text

readonly text: object

properties.speech.properties.text.description

readonly description: "Plain text to speak. Markup such as SSML is out of scope."

properties.speech.properties.text.minLength

readonly minLength: 1

properties.speech.properties.text.type

readonly type: "string"

properties.speech.properties.voice

readonly voice: object

properties.speech.properties.voice.additionalProperties

readonly additionalProperties: true

properties.speech.properties.voice.dependentRequired

readonly dependentRequired: object

properties.speech.properties.voice.dependentRequired.id

readonly id: readonly ["providerId"]

properties.speech.properties.voice.description

readonly description: "The voice to speak with: one catalog voice by providerId and id, or provider-neutral traits. A 'preferred' voice (default) shapes which voice speaks and is never a reason to fail; a 'required' one takes part in routing and is never relaxed silently."

properties.speech.properties.voice.if

readonly if: object

properties.speech.properties.voice.if.properties

readonly properties: object

properties.speech.properties.voice.if.properties.requirement

readonly requirement: object

properties.speech.properties.voice.if.properties.requirement.const

readonly const: "required"

properties.speech.properties.voice.if.required

readonly required: readonly ["requirement"]

properties.speech.properties.voice.properties

readonly properties: object

properties.speech.properties.voice.properties.gender

readonly gender: object

properties.speech.properties.voice.properties.gender.$ref

readonly $ref: "provider-dynamic-capabilities.schema.json#/$defs/voiceGender"

properties.speech.properties.voice.properties.id

readonly id: object

properties.speech.properties.voice.properties.id.description

readonly description: "A voice id read from listVoices(), never written by hand. Opaque, and meaningful only on providerId and the device that listed it, so a stored id can go stale: a 'preferred' one then falls back to the other traits."

properties.speech.properties.voice.properties.id.minLength

readonly minLength: 1

properties.speech.properties.voice.properties.id.type

readonly type: "string"

properties.speech.properties.voice.properties.providerId

readonly providerId: object

properties.speech.properties.voice.properties.providerId.description

readonly description: "The provider that listed id. Required with id, because voice ids share no namespace across providers."

properties.speech.properties.voice.properties.providerId.minLength

readonly minLength: 1

properties.speech.properties.voice.properties.providerId.type

readonly type: "string"

properties.speech.properties.voice.properties.requirement

readonly requirement: object

properties.speech.properties.voice.properties.requirement.description

readonly description: "'preferred' (default) or 'required'. A required voice must name an id or a trait."

properties.speech.properties.voice.properties.requirement.enum

readonly enum: readonly ["required", "preferred"]

properties.speech.properties.voice.properties.requirement.title

readonly title: "RequirementLevel"

properties.speech.properties.voice.then

readonly then: object

properties.speech.properties.voice.then.anyOf

readonly anyOf: readonly [{ required: readonly […]; }, { required: readonly […]; }]

properties.speech.properties.voice.title

readonly title: "SpeechVoice"

properties.speech.properties.voice.type

readonly type: "object"

properties.speech.required

readonly required: readonly ["text", "locale"]

properties.speech.title

readonly title: "SpeechInput"

properties.speech.type

readonly type: "object"

properties.task

readonly task: object

properties.task.additionalProperties

readonly additionalProperties: true

properties.task.description

readonly description: "A descriptor specifying the type of work to be performed. The kind selects which payload the request must carry."

properties.task.properties

readonly properties: object

properties.task.properties.kind

readonly kind: object

properties.task.properties.kind.description

readonly description: "The operation: 'text_to_text' (prompt-based text generation) or 'text_to_speech' (speech synthesis from text). A consumer built against an older revision rejects a kind it does not know through validation."

properties.task.properties.kind.enum

readonly enum: readonly ["text_to_text", "text_to_speech"]

properties.task.properties.kind.title

readonly title: "TaskKind"

properties.task.required

readonly required: readonly ["kind"]

properties.task.type

readonly type: "object"

properties.telemetry

readonly telemetry: object

properties.telemetry.additionalProperties

readonly additionalProperties: true

properties.telemetry.description

readonly description: "Execution preferences for tracking usage and performance metrics."

properties.telemetry.properties

readonly properties: object

properties.telemetry.properties.consent

readonly consent: object

properties.telemetry.properties.consent.description

readonly description: "Whether the user consents to telemetry collection for this specific request."

properties.telemetry.properties.consent.type

readonly type: "boolean"

properties.telemetry.properties.level

readonly level: object

properties.telemetry.properties.level.description

readonly description: "The granularity of the collected metrics (off, minimal, or debug)."

properties.telemetry.properties.level.enum

readonly enum: readonly ["off", "minimal", "debug"]

properties.telemetry.properties.tags

readonly tags: object

properties.telemetry.properties.tags.additionalProperties

readonly additionalProperties: object

properties.telemetry.properties.tags.additionalProperties.type

readonly type: "string"

properties.telemetry.properties.tags.description

readonly description: "Optional key-value pairs for correlating telemetry data with specific features or users."

properties.telemetry.properties.tags.type

readonly type: "object"

properties.telemetry.type

readonly type: "object"

required

readonly required: readonly ["schemaVersion", "task"]

title

readonly title: "TaskRequest"

type

readonly type: "object"