Skip to content

Conversation

@factory-ben
Copy link
Collaborator

Summary

Updates BYOK documentation to reflect the new custom model configuration format introduced in PR #8753.

Changes

  • New primary format: Custom models are now configured in ~/.factory/settings.json using camelCase field names
  • Field name changes:
    • custom_modelscustomModels
    • model_display_namedisplayName
    • base_urlbaseUrl
    • api_keyapiKey
    • max_tokensmaxOutputTokens
    • supports_imagessupportsImages
    • extra_argsextraArgs
    • extra_headersextraHeaders
  • Backwards compatibility note: Added documentation about legacy config.json support
  • File watching: Settings changes are detected automatically (no restart needed)

Files Updated

  • docs/cli/byok/overview.mdx - Main BYOK reference
  • docs/cli/configuration/byok.mdx - Configuration BYOK page
  • docs/cli/configuration/settings.mdx - Added customModels to settings table
  • docs/cli/byok/*.mdx - All provider-specific pages
  • docs/cli/droid-exec/overview.mdx - Exec custom model examples
  • docs/enterprise/models-llm-gateways-and-integrations.mdx - Enterprise reference

Related

- Update BYOK docs to use new settings.json format with camelCase fields
- customModels replaces custom_models
- displayName, baseUrl, apiKey, maxOutputTokens replace snake_case versions
- Add note about legacy config.json support for backwards compatibility
- Update all provider-specific pages with new JSON format
- Add customModels to settings.mdx reference table

Co-authored-by: factory-droid[bot] <138933559+factory-droid[bot]@users.noreply.github.com>
@factory-droid
Copy link
Contributor

factory-droid bot commented Dec 25, 2025

Droid finished @factory-ben's task —— View job


Code Review Complete

No high-severity issues found in this documentation PR.

Summary of changes reviewed:

  • Updates configuration file reference from ~/.factory/config.json to ~/.factory/settings.json
  • Migrates field naming convention from snake_case (custom_models, base_url, api_key, max_tokens) to camelCase (customModels, baseUrl, apiKey, maxOutputTokens)
  • Adds legacy support note for backwards compatibility with the old format
  • Updates the settings.mdx reference table to include customModels
  • Fixes the model reference format in droid-exec overview to be consistent (spaces → hyphens)

All JSON examples are syntactically valid and the documentation is consistent across all updated files.

@bentossell bentossell merged commit 7311f08 into main Dec 25, 2025
3 checks passed
@bentossell bentossell deleted the docs/custom-models-settings-json branch December 25, 2025 11:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants