Skip to content

docs: add DaoXE OpenAI-compatible gateway example#1011

Open
seven7763 wants to merge 1 commit into
potpie-ai:mainfrom
seven7763:docs/add-daoxe-openai-compat
Open

docs: add DaoXE OpenAI-compatible gateway example#1011
seven7763 wants to merge 1 commit into
potpie-ai:mainfrom
seven7763:docs/add-daoxe-openai-compat

Conversation

@seven7763

Copy link
Copy Markdown

Summary

  • Document using DaoXE (multi-model multi-protocol API gateway) with Potpie via the existing OpenAI path: LLM_PROVIDER=openai + LLM_API_BASE=https://daoxe.com/v1 and OPENAI_API_KEY set to the DaoXE key.
  • Place the example next to the existing Ollama note in legacy/README.md (docs-only; no runtime changes).
  • Clarify optional LLM_API_BASE in legacy/.env.template.
  • Model IDs are account-scoped — placeholders / authenticated GET /v1/models only (no hardcoded public catalog).
  • Note multi-protocol scope (Chat Completions for this Potpie path; DaoXE also exposes other routes such as Anthropic Messages for clients that speak those APIs).
  • Note service availability outside mainland China.
  • Links: https://daoxe.com · https://daoxe.com/pricing · https://github.com/seven7763/DaoXE-AI

Potpie already reads LLM_API_BASE into provider config (LLMProviderConfig / LiteLLM base_url) for OpenAI-compatible endpoints.

Disclosure

I am affiliated with DaoXE.

Test plan

  • README renders the new note under AI / LLM configuration
  • Example env keys match legacy/.env.template (LLM_PROVIDER, OPENAI_API_KEY, CHAT_MODEL, INFERENCE_MODEL, LLM_API_BASE)
  • Links resolve (daoxe.com, DaoXE-AI, pricing)
  • Optional live check with a real OPENAI_API_KEY (DaoXE key) and account-scoped model IDs (no credentials in this PR)

Document using DaoXE (https://daoxe.com/v1) via LLM_PROVIDER=openai and
LLM_API_BASE. Model IDs are account-scoped; note multi-protocol scope and
mainland China availability.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Jul 14, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI (base), Organization UI (inherited)

Review profile: ASSERTIVE

Plan: Pro

Run ID: 3164a673-b38e-4e58-810b-06922c00642c

📥 Commits

Reviewing files that changed from the base of the PR and between d9bd564 and 63dd26a.

📒 Files selected for processing (2)
  • legacy/.env.template
  • legacy/README.md

📝 Walkthrough

Summary by CodeRabbit

  • Documentation
    • Added guidance for configuring an OpenAI-compatible gateway.
    • Documented account-scoped model IDs and regional availability considerations.
    • Included environment variable examples and clarified supported protocol routes.

Walkthrough

Changes

DaoXE gateway documentation

Layer / File(s) Summary
Gateway configuration guidance
legacy/.env.template, legacy/README.md
Adds DaoXE OpenAI-compatible gateway instructions, including LLM_API_BASE, LLM_PROVIDER, account-scoped model IDs, and protocol routing notes.

Possibly related PRs

  • potpie-ai/potpie#599: Related LLM configuration guidance for LLM_API_BASE and model selection variables.
  • potpie-ai/potpie#897: Related updates to legacy installation and environment-variable documentation.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the docs-only DaoXE OpenAI-compatible gateway example added in the README and env template.
Description check ✅ Passed The description matches the changes by documenting DaoXE setup, model IDs, and the optional env var clarification.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

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.

1 participant