skip to content
iii / worker
$worker

provider-xai

v1.3.15

xAI Chat Completions provider worker; implements provider::xai::stream and provider::xai::refresh_models behind llm-router.

iiiverified
28 installs0 in 7d0 today
install
$iii trigger compose::add worker=provider-xai
binarylicense: Apache-2.0chat-completionsgrokllmproviderxai
  • macOS: arm64 · x64
  • Linux: arm64 · armv7 · x64
  • Windows: arm64 · x64
6functions0triggers0skills2depsv1.3.15version
repoiii-hq/workers

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

functions

6

provider::xai::abort

function

Cancel the in-flight upstream stream for a request_id (router::abort fan-out), stopping billed generation immediately.

request
  • request_idstringrequired
response
  • abortedbooleanrequired

provider::xai::count_tokens

function

Count prompt tokens for {model, system_prompt?, tools?, messages} with Grok's tokenizer upstream; never runs the model and costs nothing.

request
  • messagesany of[]required

    Wire agent messages, the same shape `provider::xai::stream` 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
  • modelstringrequired

    Model id the prompt targets; selects the tokenizer upstream.

  • system_promptstring

    System prompt counted as its own framed wire row when present.

  • toolsobject[]

    Function invocation schemas; each serialized schema counts toward the total.

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

    Always `tokenizer`: a real vocabulary produced the count, but the upstream metered the text rather than the request.

  • modelstringrequired
  • tokensinteger· uint64requiredmin 0

    Prompt tokens for the assembled request: Grok's tokenizer over the text, this worker's framing on top.

provider::xai::on-config-change

function

Internal: reload provider-xai configuration when it changes.

request
empty object
response
  • okboolean

provider::xai::on_router_ready

function

Internal: router::ready subscriber that re-declares this provider and refreshes its catalog.

request
empty object
response
  • okbooleanrequired

provider::xai::refresh_models

function

Refresh the xAI catalog slice from GET /v1/models and reconcile it through the router; returns the model count written.

request
empty object
response
  • countinteger· uintrequiredmin 0
  • okbooleanrequired

provider::xai::stream

function

Stream an xAI chat completion: resolve credentials, call the upstream Chat Completions API, and relay AssistantMessageEvent frames to writer_ref.

request
  • cache_intentany of
    any of (2)
    variant 1
    • surface_digeststringrequired
    variant 2
    valuenull
  • max_output_tokensinteger· uint64min 0
  • messagesany of[]required
    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
  • modelstringrequired
  • model_metaany of
    any of (2)
    variant 1
    • 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
  • provider_optionsunknown
  • resolution_keystring
  • response_formatany of
    any of (2)
    variant 1
    • schemaunknown
    • typestringrequired
    variant 2
    valuenull
  • session_idstring

    Stable conversation identity for provider cache affinity.

  • system_promptstring
  • system_sectionsobject[]

    Ordered sections behind `system_prompt` (always forwarded alongside the flat string, which equals the sections joined with "\n\n").

    • cache_boundaryboolean
    • textstringrequired
  • thinking_levelany of
    any of (2)
    variant 1
    valuestringenum: minimal, low, medium, high, xhigh
    variant 2
    valuenull
  • toolsobject[]
    • descriptionstringrequired
    • execution_modestring
    • labelstring
    • namestringrequired
    • parametersunknownrequired
  • writer_refobjectrequired
    • access_keystringrequired
    • channel_idstringrequired
    • directionstringrequiredenum: read, write
response
  • okbooleanrequired

triggers

0
no triggers registered