skip to content
$worker

llm-router

v1.4.21

One front door + provider protocol in front of every LLM provider.

iiiverified
3,771 installs0 in 7d0 today
install
$iii trigger compose::add worker=llm-router@1.4.21
binarylicense: Apache-2.0llmmodelsprovidersrouter
  • macOS: arm64
  • Linux: arm64 · armv7 · x64
  • Windows: arm64 · x64

exact versions are immutable; binary and bundle artifacts are digest-pinned.

functions

20

llm-router::ui-content

function

Serve the llm-router worker's injected console UI assets (content function for its console:script / console:style triggers).

request
  • pathstringrequired

    The asset path from the trigger config (e.g. `state/page.js`).

response
  • contentstringrequired

    The asset source, verbatim.

  • content_typestringrequired

    MIME type the console should serve the asset with.

router::abort

function

Abort an in-flight router::chat/complete by request_id; reports whether a live request was cancelled.

request
  • request_idstringrequired
response
  • abortedbooleanrequired

router::chat

function

Stream a chat completion: route {model, provider?} to a provider, relay assistant frames to writer_ref, and return the terminal response.

request
  • max_output_tokensinteger· uint64min 0
  • messagesunknownrequired
  • metadataunknown
  • modelstringrequired
  • providerstring
  • provider_optionsunknown
  • request_idstring
  • response_formatunknown
  • session_idstring

    Stable conversation identity, forwarded separately from the per-turn request id.

  • system_promptstring
  • thinking_levelunknown
  • toolsunknown
  • writer_refall ofrequired

    The caller's write channel (direction "write"); frames are relayed here.

    all of (1)
    variant 1
    • access_keystringrequired
    • channel_idstringrequired
    • directionstringrequiredenum: read, write
response
  • errorany of
    any of (2)
    variant 1
    • codestringrequired
    • detailstring

      Provider/transport diagnostics for logs and expandable UI details. `message` remains the stable, user-facing explanation.

    • kindany of
      … expand 2 nested
      any of (2)
      variant 1
      valuestringenum: auth_expired, rate_limited, context_overflow, transient, permanent
      variant 2
      valuenull
    • messagestringrequired
    • retryableboolean
    variant 2
    valuenull
  • modelstringrequired
  • okbooleanrequired
  • providerstringrequired
  • stop_reasonany of
    any of (2)
    variant 1
    valuestringenum: end, length, function_call, aborted, error
    variant 2
    valuenull
  • usageany of
    any of (2)
    variant 1
    • cache_readinteger· uint64min 0
    • cache_writeinteger· uint64min 0
    • cost_usdnumber· double
    • inputinteger· uint64min 0
    • outputinteger· uint64min 0
    • reasoninginteger· uint64min 0
    variant 2
    valuenull

router::complete

function

Non-streaming convenience over router::chat: run the turn on an internal channel and return the final assistant message + usage.

request
  • max_output_tokensinteger· uint64min 0
  • messagesunknownrequired
  • metadataunknown
  • modelstringrequired
  • providerstring
  • provider_optionsunknown
  • request_idstring
  • response_formatunknown
  • session_idstring

    Stable conversation identity, forwarded separately from the per-turn request id.

  • system_promptstring
  • thinking_levelunknown
  • toolsunknown
response
  • messageobjectrequired
    • contentone of[]required
      one of (7)
      variant 1
      • textstringrequired
      • typestringrequiredenum: text
      variant 2
      • attachment_idstring

        Optional link to the stored original in the session-manager attachment store. Transcript bookkeeping for lazy readers only: the harness clears it before `router::chat`, and no provider mapping reads it. Tolerated here so a block that still carries it deserializes instead of failing the request; omitted on the wire when absent.

      • datastringrequired
      • mimestringrequired
      • typestringrequiredenum: image
      variant 3
      • attachment_idstringrequired
      • mimestringrequired
      • namestringrequired
      • sizeinteger· uint64requiredmin 0
      • typestringrequiredenum: file
      variant 4
      • signaturestring
      • textstringrequired
      • typestringrequiredenum: thinking
      variant 5
      • datastringrequired
      • typestringrequiredenum: redacted_thinking
      variant 6
      • argumentsunknownrequired
      • function_idstringrequired
      • idstringrequired
      • typestringrequiredenum: function_call
      variant 7
      • contentunknown[]required
      • function_call_idstringrequired
      • is_errorboolean
      • typestringrequiredenum: function_result
    • error_kindany of
      any of (2)
      variant 1
      valuestringenum: auth_expired, rate_limited, context_overflow, transient, permanent
      variant 2
      valuenull
    • error_messagestring
    • modelstringrequired
    • native_stop_reasonstring
    • providerstringrequired
    • rolestringrequiredenum: assistant
    • stop_reasonstringrequiredenum: end, length, function_call, aborted, error
    • timestampinteger· int64required
    • usageany of
      any of (2)
      variant 1
      • cache_readinteger· uint64min 0
      • cache_writeinteger· uint64min 0
      • cost_usdnumber· double
      • inputinteger· uint64min 0
      • outputinteger· uint64min 0
      • reasoninginteger· uint64min 0
      variant 2
      valuenull
    • warningsstring[]
  • modelstringrequired
  • providerstringrequired
  • usageany of
    any of (2)
    variant 1
    • cache_readinteger· uint64min 0
    • cache_writeinteger· uint64min 0
    • cost_usdnumber· double
    • inputinteger· uint64min 0
    • outputinteger· uint64min 0
    • reasoninginteger· uint64min 0
    variant 2
    valuenull

router::count_tokens

function

Count prompt tokens for {model, provider?, system_prompt?, tools?, messages} through the resolved provider's provider::<id>::count_tokens surface; never runs the model and costs nothing.

request
  • messagesany of[]required

    Wire agent messages, the same shape `router::chat` accepts. Must be non-empty.

    any of (4)
    variant 1
    • contentone of[]required
      … expand 7 nested
      one of (7)
      variant 1
      • textstringrequired
      • typestringrequiredenum: text
      variant 2
      • attachment_idstring

        Optional link to the stored original in the session-manager attachment store. Transcript bookkeeping for lazy readers only: the harness clears it before `router::chat`, and no provider mapping reads it. Tolerated here so a block that still carries it deserializes instead of failing the request; omitted on the wire when absent.

      • datastringrequired
      • mimestringrequired
      • typestringrequiredenum: image
      variant 3
      • attachment_idstringrequired
      • mimestringrequired
      • namestringrequired
      • sizeinteger· uint64requiredmin 0
      • typestringrequiredenum: file
      variant 4
      • signaturestring
      • textstringrequired
      • typestringrequiredenum: thinking
      variant 5
      • datastringrequired
      • typestringrequiredenum: redacted_thinking
      variant 6
      • argumentsunknownrequired
      • function_idstringrequired
      • idstringrequired
      • typestringrequiredenum: function_call
      variant 7
      • contentunknown[]required
      • function_call_idstringrequired
      • is_errorboolean
      • typestringrequiredenum: function_result
    • error_kindany of
      … expand 2 nested
      any of (2)
      variant 1
      valuestringenum: auth_expired, rate_limited, context_overflow, transient, permanent
      variant 2
      valuenull
    • error_messagestring
    • modelstringrequired
    • native_stop_reasonstring
    • providerstringrequired
    • rolestringrequiredenum: assistant
    • stop_reasonstringrequiredenum: end, length, function_call, aborted, error
    • timestampinteger· int64required
    • usageany of
      … expand 2 nested
      any of (2)
      variant 1
      • cache_readinteger· uint64min 0
      • cache_writeinteger· uint64min 0
      • cost_usdnumber· double
      • inputinteger· uint64min 0
      • outputinteger· uint64min 0
      • reasoninginteger· uint64min 0
      variant 2
      valuenull
    • warningsstring[]
    variant 2
    • contentone of[]required
      … expand 7 nested
      one of (7)
      variant 1
      • textstringrequired
      • typestringrequiredenum: text
      variant 2
      • attachment_idstring

        Optional link to the stored original in the session-manager attachment store. Transcript bookkeeping for lazy readers only: the harness clears it before `router::chat`, and no provider mapping reads it. Tolerated here so a block that still carries it deserializes instead of failing the request; omitted on the wire when absent.

      • datastringrequired
      • mimestringrequired
      • typestringrequiredenum: image
      variant 3
      • attachment_idstringrequired
      • mimestringrequired
      • namestringrequired
      • sizeinteger· uint64requiredmin 0
      • typestringrequiredenum: file
      variant 4
      • signaturestring
      • textstringrequired
      • typestringrequiredenum: thinking
      variant 5
      • datastringrequired
      • typestringrequiredenum: redacted_thinking
      variant 6
      • argumentsunknownrequired
      • function_idstringrequired
      • idstringrequired
      • typestringrequiredenum: function_call
      variant 7
      • contentunknown[]required
      • function_call_idstringrequired
      • is_errorboolean
      • typestringrequiredenum: function_result
    • detailsunknownrequired
    • function_call_idstringrequired
    • function_idstringrequired
    • is_errorbooleanrequired
    • rolestringrequiredenum: function_result
    • timestampinteger· int64required
    variant 3
    • contentone of[]required
      … expand 7 nested
      one of (7)
      variant 1
      • textstringrequired
      • typestringrequiredenum: text
      variant 2
      • attachment_idstring

        Optional link to the stored original in the session-manager attachment store. Transcript bookkeeping for lazy readers only: the harness clears it before `router::chat`, and no provider mapping reads it. Tolerated here so a block that still carries it deserializes instead of failing the request; omitted on the wire when absent.

      • datastringrequired
      • mimestringrequired
      • typestringrequiredenum: image
      variant 3
      • attachment_idstringrequired
      • mimestringrequired
      • namestringrequired
      • sizeinteger· uint64requiredmin 0
      • typestringrequiredenum: file
      variant 4
      • signaturestring
      • textstringrequired
      • typestringrequiredenum: thinking
      variant 5
      • datastringrequired
      • typestringrequiredenum: redacted_thinking
      variant 6
      • argumentsunknownrequired
      • function_idstringrequired
      • idstringrequired
      • typestringrequiredenum: function_call
      variant 7
      • contentunknown[]required
      • function_call_idstringrequired
      • is_errorboolean
      • typestringrequiredenum: function_result
    • custom_typestringrequired
    • detailsunknown
    • displaystring
    • rolestringrequiredenum: custom
    • timestampinteger· int64required
    variant 4
    • contentone of[]required
      … expand 7 nested
      one of (7)
      variant 1
      • textstringrequired
      • typestringrequiredenum: text
      variant 2
      • attachment_idstring

        Optional link to the stored original in the session-manager attachment store. Transcript bookkeeping for lazy readers only: the harness clears it before `router::chat`, and no provider mapping reads it. Tolerated here so a block that still carries it deserializes instead of failing the request; omitted on the wire when absent.

      • datastringrequired
      • mimestringrequired
      • typestringrequiredenum: image
      variant 3
      • attachment_idstringrequired
      • mimestringrequired
      • namestringrequired
      • sizeinteger· uint64requiredmin 0
      • typestringrequiredenum: file
      variant 4
      • signaturestring
      • textstringrequired
      • typestringrequiredenum: thinking
      variant 5
      • datastringrequired
      • typestringrequiredenum: redacted_thinking
      variant 6
      • argumentsunknownrequired
      • function_idstringrequired
      • idstringrequired
      • typestringrequiredenum: function_call
      variant 7
      • contentunknown[]required
      • function_call_idstringrequired
      • is_errorboolean
      • typestringrequiredenum: function_result
    • rolestringrequiredenum: user

      Single-variant role tags: exact-match on deserialize, correct wire string on serialize, and they let `AgentMessage` be an untagged union.

    • timestampinteger· int64required
  • modelstring

    Model id the prompt targets; routes exactly like `router::chat` and selects the provider's tokenizer. Optional only when `provider` pins the destination.

  • providerstring

    Pin an explicit provider, bypassing heuristics (optional).

  • system_promptstring

    System prompt counted as part of the request (optional).

  • toolsobject[]

    Function invocation schemas the turn would carry; their serialized schemas count toward the total (optional).

    • descriptionstringrequired
    • execution_modestring
    • labelstring
    • namestringrequired
    • parametersunknownrequired
response
  • estimatorstringrequired

    `provider` when a provider metering API produced the count, `tiktoken` when a local tokenizer estimated it.

  • modelstringrequired
  • providerstringrequired
  • tokensinteger· uint64requiredmin 0

    Prompt tokens the provider counted for the assembled request.

router::embed

function

Batch text embeddings through a provider's provider::<id>::embed surface. Names a provider or discovers the first embed-capable one from the live registry; one vector per input, order preserved.

request
  • inputstring[]required

    Texts to embed, one vector returned per input, order preserved.

  • modelstring

    Embedding model id; the provider's default when omitted.

  • providerstring

    Provider id (e.g. `openai`); the first embed-capable provider in the live registry when omitted.

response
  • embeddingsnumber[][]required

    One embedding per input, in input order.

  • modelstringrequired
  • providerstringrequired

router::models::budget

function

Resolve the effective model output budget using the same precedence as router::chat.

request
  • idstring

    Model id to budget.

  • max_output_tokensinteger· uint64min 0

    Optional caller-requested output budget. When absent, the same provider and router defaults used by `router::chat` apply.

  • providerstring

    Provider id that owns the model. Empty resolves an unambiguous model id.

response
any of (2)
variant 1
  • effective_max_output_tokensinteger· uint64requiredmin 0
  • modelobjectrequired

    The capability record (README § Model descriptor).

    • context_windowinteger· uint64requiredmin 0
    • display_namestring
    • idstringrequired
    • input_limitinteger· uint64min 0
    • max_output_tokensinteger· uint64requiredmin 0
    • pricingany of
      … expand 2 nested
      any of (2)
      variant 1
      • cache_readnumber· double
      • cache_writenumber· double
      • inputnumber· double
      • outputnumber· double
      variant 2
      valuenull
    • providerstringrequired
    • reasoning_effortsobject[]
      … expand 2 nested
      • descriptionstring
      • effortstringrequired
    • speechany of

      Set on speech models only; see [`SpeechModel`].

      … expand 2 nested
      any of (2)
      variant 1
      • languagesstring[]

        BCP-47 tags of the languages the model handles; empty when the provider does not say.

      • modalityone ofrequired

        What a speech model does. Chat models carry no `speech` block.

        … expand 2 nested
        one of (2)
        variant 1
        valuestringenum: stt
        variant 2
        valuestringenum: tts
      • streamingboolean

        Realtime input (stt) or streamed audio output (tts) is available.

      variant 2
      valuenull
    • supports_cacheboolean
    • supports_structured_outputboolean
    • supports_thinkingboolean
    • supports_toolsboolean
    • supports_visionboolean
    • supports_xhighboolean
    • thinking_budgetsobject
variant 2
valuenull

router::models::get

function

Read one catalog model by {provider, id}; null when the model is not registered.

request
  • idstring

    Model id to look up.

  • providerstring

    Provider id that owns the model.

response
any of (2)
variant 1
  • modelobjectrequired

    The capability record (README § Model descriptor).

    • context_windowinteger· uint64requiredmin 0
    • display_namestring
    • idstringrequired
    • input_limitinteger· uint64min 0
    • max_output_tokensinteger· uint64requiredmin 0
    • pricingany of
      … expand 2 nested
      any of (2)
      variant 1
      • cache_readnumber· double
      • cache_writenumber· double
      • inputnumber· double
      • outputnumber· double
      variant 2
      valuenull
    • providerstringrequired
    • reasoning_effortsobject[]
      … expand 2 nested
      • descriptionstring
      • effortstringrequired
    • speechany of

      Set on speech models only; see [`SpeechModel`].

      … expand 2 nested
      any of (2)
      variant 1
      • languagesstring[]

        BCP-47 tags of the languages the model handles; empty when the provider does not say.

      • modalityone ofrequired

        What a speech model does. Chat models carry no `speech` block.

        … expand 2 nested
        one of (2)
        variant 1
        valuestringenum: stt
        variant 2
        valuestringenum: tts
      • streamingboolean

        Realtime input (stt) or streamed audio output (tts) is available.

      variant 2
      valuenull
    • supports_cacheboolean
    • supports_structured_outputboolean
    • supports_thinkingboolean
    • supports_toolsboolean
    • supports_visionboolean
    • supports_xhighboolean
    • thinking_budgetsobject
variant 2
valuenull

router::models::list

function

List catalog models, optionally filtered by provider, a capability flag, and modality (chat by default; stt, tts, or any).

request
  • capabilitystring

    Keep only models that support this capability flag (optional).

  • modalityany of

    Model family: `chat` (default), `stt`, `tts`, or `any`.

    any of (2)
    variant 1
    valuestringenum: chat, stt, tts, any
    variant 2
    valuenull
  • providerstring

    Filter to a single provider id (optional).

response
  • modelsobject[]required
    • context_windowinteger· uint64requiredmin 0
    • display_namestring
    • idstringrequired
    • input_limitinteger· uint64min 0
    • max_output_tokensinteger· uint64requiredmin 0
    • pricingany of
      any of (2)
      variant 1
      • cache_readnumber· double
      • cache_writenumber· double
      • inputnumber· double
      • outputnumber· double
      variant 2
      valuenull
    • providerstringrequired
    • reasoning_effortsobject[]
      • descriptionstring
      • effortstringrequired
    • speechany of

      Set on speech models only; see [`SpeechModel`].

      any of (2)
      variant 1
      • languagesstring[]

        BCP-47 tags of the languages the model handles; empty when the provider does not say.

      • modalityone ofrequired

        What a speech model does. Chat models carry no `speech` block.

        … expand 2 nested
        one of (2)
        variant 1
        valuestringenum: stt
        variant 2
        valuestringenum: tts
      • streamingboolean

        Realtime input (stt) or streamed audio output (tts) is available.

      variant 2
      valuenull
    • supports_cacheboolean
    • supports_structured_outputboolean
    • supports_thinkingboolean
    • supports_toolsboolean
    • supports_visionboolean
    • supports_xhighboolean
    • thinking_budgetsobject

router::models::reconcile

function

Replace a provider's catalog slice — the only catalog write path (token-gated).

request
  • modelsobject[]

    The full replacement set of models for this provider.

    • context_windowinteger· uint64requiredmin 0
    • display_namestring
    • idstringrequired
    • input_limitinteger· uint64min 0
    • max_output_tokensinteger· uint64requiredmin 0
    • pricingany of
      any of (2)
      variant 1
      • cache_readnumber· double
      • cache_writenumber· double
      • inputnumber· double
      • outputnumber· double
      variant 2
      valuenull
    • providerstringrequired
    • reasoning_effortsobject[]
      • descriptionstring
      • effortstringrequired
    • speechany of

      Set on speech models only; see [`SpeechModel`].

      any of (2)
      variant 1
      • languagesstring[]

        BCP-47 tags of the languages the model handles; empty when the provider does not say.

      • modalityone ofrequired

        What a speech model does. Chat models carry no `speech` block.

        … expand 2 nested
        one of (2)
        variant 1
        valuestringenum: stt
        variant 2
        valuestringenum: tts
      • streamingboolean

        Realtime input (stt) or streamed audio output (tts) is available.

      variant 2
      valuenull
    • supports_cacheboolean
    • supports_structured_outputboolean
    • supports_thinkingboolean
    • supports_toolsboolean
    • supports_visionboolean
    • supports_xhighboolean
    • thinking_budgetsobject
  • providerstring

    Provider whose catalog slice is being replaced.

  • tokenstring

    Registration token gating the write (optional).

response
  • countinteger· uintrequiredmin 0
  • providerstringrequired

router::models::supports

function

Check whether a model supports a capability flag (fails open for unknown models).

request
  • capabilitystring

    Capability flag to check (e.g. `structured_output`, `vision`).

  • idstring

    Model id to check.

  • providerstring

    Provider id that owns the model.

response
  • supportedbooleanrequired

router::on_config_changed

function

Internal: reactively reload the in-memory configuration snapshot and fan out provider model discovery after configuration changes.

request
  • idstring

    Configuration id that changed (advisory).

response
  • okbooleanrequired

router::on_functions_changed

function

Internal: a worker's function registrations changed — re-discover live providers and nudge them to re-declare, so a provider that reconnected is resolvable again without waiting for its own catalog timer.

request
  • eventstring

    Engine event tag (advisory).

  • worker_idstring

    Worker whose registered functions changed (advisory).

response
  • okbooleanrequired

router::provider::list

function

List registered providers with their configured/available status.

request
empty object
response
  • providersobject[]required
    • availablebooleanrequired
    • configuredbooleanrequired
    • credential_env_varstring

      Environment variable declared by API-key providers. `None` means the provider owns authentication (OAuth, local app login, device flow).

    • display_namestringrequired
    • icon_svgstring

      The provider's mark as inline SVG, copied from its declaration. Absent when the provider declared none.

    • idstringrequired
    • supports_model_listingbooleanrequired

router::provider::register

function

Provider self-declaration at attach time (token-gated upsert); composes the configuration entry schema and reconciles static models.

request
  • config_schemaunknown
  • credential_env_varstring
  • defaultsany of
    any of (2)
    variant 1
    • api_urlstring
    • max_tokensinteger· uint64min 0
    variant 2
    valuenull
  • display_namestring
  • icon_svgstring

    The provider's mark: one self-contained `<svg>` document, monochrome, drawn with a square `viewBox` and no fixed size. Consoles paint it as a `currentColor` mask next to the provider's models, so colour and scripts are ignored. Keep it under [`PROVIDER_ICON_SVG_MAX_BYTES`]; the router drops anything larger or not starting with `<svg`.

  • idstringrequired
  • modelsobject[]
    • context_windowinteger· uint64requiredmin 0
    • display_namestring
    • idstringrequired
    • input_limitinteger· uint64min 0
    • max_output_tokensinteger· uint64requiredmin 0
    • pricingany of
      any of (2)
      variant 1
      • cache_readnumber· double
      • cache_writenumber· double
      • inputnumber· double
      • outputnumber· double
      variant 2
      valuenull
    • providerstringrequired
    • reasoning_effortsobject[]
      • descriptionstring
      • effortstringrequired
    • speechany of

      Set on speech models only; see [`SpeechModel`].

      any of (2)
      variant 1
      • languagesstring[]

        BCP-47 tags of the languages the model handles; empty when the provider does not say.

      • modalityone ofrequired

        What a speech model does. Chat models carry no `speech` block.

        … expand 2 nested
        one of (2)
        variant 1
        valuestringenum: stt
        variant 2
        valuestringenum: tts
      • streamingboolean

        Realtime input (stt) or streamed audio output (tts) is available.

      variant 2
      valuenull
    • supports_cacheboolean
    • supports_structured_outputboolean
    • supports_thinkingboolean
    • supports_toolsboolean
    • supports_visionboolean
    • supports_xhighboolean
    • thinking_budgetsobject
  • supports_model_listingboolean
  • tokenstring

    Registration token proving ownership on re-register (omit on first declare).

  • worker_idstring
response
  • idstringrequired
  • okbooleanrequired
  • registration_tokenstringrequired

router::provider::resolve

function

Resolve a provider's effective credential + api_url + max_tokens (token-gated).

request
  • idstring

    Provider id to resolve credentials/config for.

  • tokenstring

    Registration token gating the resolve (optional).

response
  • api_urlstring
  • configuredbooleanrequired
  • credentialany of
    any of (2)
    variant 1
    one of (2)
    variant 1
    • keystringrequired
    • typestringrequiredenum: api_key
    variant 2
    • access_tokenstringrequired
    • expires_atinteger· int64
    • provider_extraunknown
    • refresh_tokenstring
    • scopesstring[]
    • typestringrequiredenum: oauth
    variant 2
    valuenull
  • max_tokensinteger· uint64min 0
  • sourcestringrequiredenum: config, env, none

router::provider::update_credential

function

OAuth write-back: store a provider credential in the configuration entry under the entry write lock (token-gated).

request
  • credentialunknown

    The credential object to store (provider-specific shape).

  • idstring

    Provider id whose credential slice is being written.

  • tokenstring

    Registration token gating the write (optional).

response
  • okbooleanrequired

router::route

function

Read-only routing preview: resolve {model, provider?} to the chosen provider + ordered candidates without streaming.

request
  • modelstring

    Model id to route.

  • providerstring

    Pin an explicit provider, bypassing heuristics (optional).

response
  • candidatesstring[]required
  • providerstringrequired

router::speak

function

Text to speech through provider::<id>::speak: {model?, provider?, text, voice?, format?} to {provider, model, audio_base64, mime}. Resolves the provider from the catalog's tts models when none is named.

request
  • formatstring

    Audio container wanted: `mp3` (default), `wav`, `pcm16`, `opus`. Providers answer with what they can and say so in `mime`.

  • languagestring

    BCP-47 language hint for multilingual voices.

  • modelstring

    Text-to-speech model id (a `tts` model from `router::models::list`); the provider's default when omitted.

  • providerstring

    Provider id; resolved from the model's catalog owner when omitted.

  • speednumber· double

    Speaking-rate multiplier; 1.0 is the voice's own pace.

  • textstringrequired

    Text to speak.

  • voicestring

    Voice id or name as the provider knows it; the provider's default when omitted.

response
  • audio_base64stringrequired

    The audio, base64.

  • duration_secsnumber· double
  • mimestringrequired

    MIME type of the audio, e.g. `audio/mpeg`.

  • modelstringrequired
  • providerstringrequired
  • voicestring

    Voice the provider used.

router::transcribe

function

Speech to text through provider::<id>::transcribe: {model?, provider?, audio_base64, mime?, language?} to {provider, model, text, segments?}. Resolves the provider from the catalog's stt models when none is named.

request
  • audio_base64stringrequired

    The audio, base64. WAV unless `mime` says otherwise.

  • languagestring

    BCP-47 language hint; the model detects the language when omitted.

  • mimestring

    MIME type of the audio: `audio/wav` (default), `audio/mpeg`, `audio/webm`, `audio/ogg`, `audio/flac`.

  • modelstring

    Speech-to-text model id (an `stt` model from `router::models::list`); the provider's default when omitted.

  • promptstring

    Vocabulary or context hint for the recognizer, when the provider takes one.

  • providerstring

    Provider id; resolved from the model's catalog owner when omitted.

response
  • duration_secsnumber· double
  • languagestring

    Language the provider detected or was told (BCP-47).

  • modelstringrequired
  • providerstringrequired
  • segmentsobject[]

    Timed spans when the provider produces them.

    • end_secsnumber· double
    • start_secsnumber· double
    • textstringrequired
  • textstringrequired

    The whole transcript.

triggers

3

router::models::changed

trigger

A provider reconciled its catalog slice. Payload: { provider, count }.

invocation
empty object
return
valueunknown

router::provider::changed

trigger

The provider registry changed (declare / availability flip). Payload: { provider, op }.

invocation
empty object
return
valueunknown

router::ready

trigger

The router finished booting; providers bind here and re-declare after a restart.

invocation
empty object
return
valueunknown