provider::openai::abort
Cancel the in-flight upstream stream for a request_id (router::abort fan-out), stopping billed generation immediately.
- request_idstringrequired
- abortedbooleanrequired
$worker
provider-openai
v1.2.2OpenAI Responses provider worker with Chat Completions compatibility; implements provider::openai::stream and provider::openai::refresh_models behind llm-router.
iiiverifiedinstall
$iii worker add provider-openai@1.2.2
- macOS: arm64 · x64
- Linux: arm64 · armv7 · x64
- Windows: arm64 · x64 · x86
repoiii-hq/workers
exact versions are immutable; binary and bundle artifacts are digest-pinned.
functions
6function
provider::openai::count_tokens
Count prompt tokens for {model, system_prompt?, tools?, messages} locally with the tiktoken tokenizers; never runs the model and costs nothing.
- messagesany of[]required
Wire agent messages, the same shape `provider::openai::stream` accepts. Must be non-empty.
any of (4)variant 1- contentone of[]required
… expand 6 nestedcollapse
one of (6)variant 1- textstringrequired
- typestringrequiredenum: text
variant 2- datastringrequired
- mimestringrequired
- typestringrequiredenum: image
variant 3- signaturestring
- textstringrequired
- typestringrequiredenum: thinking
variant 4- datastringrequired
- typestringrequiredenum: redacted_thinking
variant 5- argumentsunknownrequired
- function_idstringrequired
- idstringrequired
- typestringrequiredenum: function_call
variant 6- contentunknown[]required
- function_call_idstringrequired
- is_errorboolean
- typestringrequiredenum: function_result
- error_kindany of
… expand 2 nestedcollapse
any of (2)variant 1valuestringenum: auth_expired, rate_limited, context_overflow, transient, permanentvariant 2valuenull - error_messagestring
- modelstringrequired
- native_stop_reasonstring
- providerstringrequired
- rolestringrequiredenum: assistant
- stop_reasonstringrequiredenum: end, length, function_call, aborted, error
- timestampinteger· int64required
- usageany of
… expand 2 nestedcollapse
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 2valuenull - warningsstring[]
variant 2- contentone of[]required
… expand 6 nestedcollapse
one of (6)variant 1- textstringrequired
- typestringrequiredenum: text
variant 2- datastringrequired
- mimestringrequired
- typestringrequiredenum: image
variant 3- signaturestring
- textstringrequired
- typestringrequiredenum: thinking
variant 4- datastringrequired
- typestringrequiredenum: redacted_thinking
variant 5- argumentsunknownrequired
- function_idstringrequired
- idstringrequired
- typestringrequiredenum: function_call
variant 6- 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 6 nestedcollapse
one of (6)variant 1- textstringrequired
- typestringrequiredenum: text
variant 2- datastringrequired
- mimestringrequired
- typestringrequiredenum: image
variant 3- signaturestring
- textstringrequired
- typestringrequiredenum: thinking
variant 4- datastringrequired
- typestringrequiredenum: redacted_thinking
variant 5- argumentsunknownrequired
- function_idstringrequired
- idstringrequired
- typestringrequiredenum: function_call
variant 6- contentunknown[]required
- function_call_idstringrequired
- is_errorboolean
- typestringrequiredenum: function_result
- custom_typestringrequired
- detailsunknown
- displaystring
- rolestringrequiredenum: custom
- timestampinteger· int64required
variant 4- contentone of[]required
… expand 6 nestedcollapse
one of (6)variant 1- textstringrequired
- typestringrequiredenum: text
variant 2- datastringrequired
- mimestringrequired
- typestringrequiredenum: image
variant 3- signaturestring
- textstringrequired
- typestringrequiredenum: thinking
variant 4- datastringrequired
- typestringrequiredenum: redacted_thinking
variant 5- argumentsunknownrequired
- function_idstringrequired
- idstringrequired
- typestringrequiredenum: function_call
variant 6- 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 (o200k_base for gpt-4o/gpt-5/o-series and anything unknown-modern, cl100k_base for gpt-3.5 and non-o gpt-4 families).
- system_promptstring
System prompt counted as its own wire message when present.
- toolsobject[]
Function invocation schemas; each serialized schema counts toward the total.
- descriptionstringrequired
- execution_modestring
- labelstring
- namestringrequired
- parametersunknownrequired
- estimatorstringrequired
Always `tiktoken`: a local tokenizer produced the estimate.
- modelstringrequired
- tokensinteger· uint64requiredmin 0
Estimated prompt tokens for the assembled request.
provider::openai::embed
Batch text embeddings via the OpenAI embeddings endpoint, using the router-resolved credential. One vector per input, order preserved. Default model text-embedding-3-small.
- inputstring[]required
Texts to embed, one vector returned per input, order preserved.
- modelstring
Embedding model id; the provider default when omitted.
- embeddingsnumber[][]required
One embedding per input, in input order.
- modelstringrequired
provider::openai::on_router_ready
Internal: router::ready subscriber that re-declares this provider and refreshes its catalog.
empty object
- okbooleanrequired
provider::openai::refresh_models
Refresh the OpenAI catalog slice from GET /v1/models and reconcile it through the router; returns the model count written.
empty object
- countinteger· uintrequiredmin 0
- okbooleanrequired
provider::openai::stream
Stream an OpenAI response: resolve credentials, call the configured Responses or Chat Completions endpoint, and relay AssistantMessageEvent frames to writer_ref.
- max_output_tokensinteger· uint64min 0
- messagesany of[]requiredany of (4)variant 1
- contentone of[]required
… expand 6 nestedcollapse
one of (6)variant 1- textstringrequired
- typestringrequiredenum: text
variant 2- datastringrequired
- mimestringrequired
- typestringrequiredenum: image
variant 3- signaturestring
- textstringrequired
- typestringrequiredenum: thinking
variant 4- datastringrequired
- typestringrequiredenum: redacted_thinking
variant 5- argumentsunknownrequired
- function_idstringrequired
- idstringrequired
- typestringrequiredenum: function_call
variant 6- contentunknown[]required
- function_call_idstringrequired
- is_errorboolean
- typestringrequiredenum: function_result
- error_kindany of
… expand 2 nestedcollapse
any of (2)variant 1valuestringenum: auth_expired, rate_limited, context_overflow, transient, permanentvariant 2valuenull - error_messagestring
- modelstringrequired
- native_stop_reasonstring
- providerstringrequired
- rolestringrequiredenum: assistant
- stop_reasonstringrequiredenum: end, length, function_call, aborted, error
- timestampinteger· int64required
- usageany of
… expand 2 nestedcollapse
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 2valuenull - warningsstring[]
variant 2- contentone of[]required
… expand 6 nestedcollapse
one of (6)variant 1- textstringrequired
- typestringrequiredenum: text
variant 2- datastringrequired
- mimestringrequired
- typestringrequiredenum: image
variant 3- signaturestring
- textstringrequired
- typestringrequiredenum: thinking
variant 4- datastringrequired
- typestringrequiredenum: redacted_thinking
variant 5- argumentsunknownrequired
- function_idstringrequired
- idstringrequired
- typestringrequiredenum: function_call
variant 6- 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 6 nestedcollapse
one of (6)variant 1- textstringrequired
- typestringrequiredenum: text
variant 2- datastringrequired
- mimestringrequired
- typestringrequiredenum: image
variant 3- signaturestring
- textstringrequired
- typestringrequiredenum: thinking
variant 4- datastringrequired
- typestringrequiredenum: redacted_thinking
variant 5- argumentsunknownrequired
- function_idstringrequired
- idstringrequired
- typestringrequiredenum: function_call
variant 6- contentunknown[]required
- function_call_idstringrequired
- is_errorboolean
- typestringrequiredenum: function_result
- custom_typestringrequired
- detailsunknown
- displaystring
- rolestringrequiredenum: custom
- timestampinteger· int64required
variant 4- contentone of[]required
… expand 6 nestedcollapse
one of (6)variant 1- textstringrequired
- typestringrequiredenum: text
variant 2- datastringrequired
- mimestringrequired
- typestringrequiredenum: image
variant 3- signaturestring
- textstringrequired
- typestringrequiredenum: thinking
variant 4- datastringrequired
- typestringrequiredenum: redacted_thinking
variant 5- argumentsunknownrequired
- function_idstringrequired
- idstringrequired
- typestringrequiredenum: function_call
variant 6- 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 ofany of (2)variant 1
- context_windowinteger· uint64requiredmin 0
- display_namestring
- idstringrequired
- input_limitinteger· uint64min 0
- max_output_tokensinteger· uint64requiredmin 0
- pricingany of
… expand 2 nestedcollapse
any of (2)variant 1- cache_readnumber· double
- cache_writenumber· double
- inputnumber· double
- outputnumber· double
variant 2valuenull - providerstringrequired
- reasoning_effortsobject[]
… expand 2 nestedcollapse
- descriptionstring
- effortstringrequired
- supports_cacheboolean
- supports_structured_outputboolean
- supports_thinkingboolean
- supports_toolsboolean
- supports_visionboolean
- supports_xhighboolean
- thinking_budgetsobject
variant 2valuenull - provider_optionsunknown
- resolution_keystring
- response_formatany ofany of (2)variant 1
- schemaunknown
- typestringrequired
variant 2valuenull - system_promptstring
- thinking_levelany ofany of (2)variant 1valuestringenum: minimal, low, medium, high, xhighvariant 2valuenull
- toolsobject[]
- descriptionstringrequired
- execution_modestring
- labelstring
- namestringrequired
- parametersunknownrequired
- writer_refobjectrequired
- access_keystringrequired
- channel_idstringrequired
- directionstringrequiredenum: read, write
- okbooleanrequired
triggers
0no triggers registered