docs(byok): document apiKeyHelper and keyless custom models - #12
Closed
nikhil-factory wants to merge 1 commit into
Closed
docs(byok): document apiKeyHelper and keyless custom models#12nikhil-factory wants to merge 1 commit into
nikhil-factory wants to merge 1 commit into
Conversation
Custom-model auth changed in factory-mono: apiKey is now optional for HTTP models (keyless), a new apiKeyHelper command mints short-lived tokens at request time, and org-managed settings block net-new static-apiKey models. - Mark apiKey optional; note baseUrl still required for non-Bedrock - Add apiKeyHelper + apiKeyHelperTtlMs to the Supported Fields table - Add a "Dynamic credentials with apiKeyHelper" section (TTL resolution, 401 refresh, trusted-source restriction, no-logging, Claude Code parity) - Note the managed-settings static-key restriction - Add an apiKeyHelper troubleshooting bullet Refs: factory-mono #17051, #17527, #17819, #17655 Co-authored-by: factory-droid[bot] <138933559+factory-droid[bot]@users.noreply.github.com>
Contributor
|
Droid encountered an error —— View job |
Contributor
Author
|
Superseded by Factory-AI/factory-public-web#464 — docs moved to factory-public-web/content/docs. Closing this one. |
nikhil-factory
deleted the
docs/byok-apikeyhelper-keyless-custom-models
branch
August 11, 2026 22:49
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Documents recent custom-model auth changes from
factory-monoincli/byok/overview.mdx:apiKeyis now optional for HTTP custom models — you can run a keyless endpoint or useapiKeyHelper.baseUrlis still required for non-Bedrock models. (factory-mono #17819)apiKeyHelper+apiKeyHelperTtlMsfields — a shell command whose stdout is used as the credential, resolved at request time, refreshed on a TTL and after a401. (factory-mono #17051, #17527)apiKey; useapiKeyHelper, a keyless endpoint, or Bedrock. Existing keyed models keep working and can rotate keys. (factory-mono #17655)Changes
apiKeyoptional in the Supported Fields table; clarifybaseUrlrequirementapiKeyHelperandapiKeyHelperTtlMsrowsFACTORY_API_KEY_HELPER_TTL_MS-> per-model -> 5-min default), 401 refresh, trusted-source (org-managed only) restriction, no-logging guarantee, Claude Code parityapiKeyHelpertroubleshooting bulletVerification
Field names, optionality, TTL precedence, trust boundary, and the managed-settings block were checked against current source:
packages/droid-sdk-core/src/protocol/settings/schema.ts,packages/common/src/settings/types.ts, andpackages/droid-core/src/llms/client/apiKeyHelper.ts.Notes