# QFOXAI

> QFOXAI is an AI chat and OpenAI-compatible API platform for teams building customer-facing apps, internal workflows, support tools, CRM helpers, billing assistants, document workflows, and automation.

## Primary URLs

- Website: https://qfoxai.com
- API docs: https://qfoxai.com/docs/api
- OpenAPI schema: https://qfoxai.com/openapi.json
- Markdown docs: https://qfoxai.com/docs.md
- Integration marketplace: https://qfoxai.com/integrations
- Solutions: https://qfoxai.com/solutions
- Migration guides: https://qfoxai.com/migration-guides
- Model benchmarks: https://qfoxai.com/benchmarks
- Partner program: https://qfoxai.com/partners
- Security and trust: https://qfoxai.com/trust
- API terms: https://qfoxai.com/api-terms

## OpenAI-Compatible API

- Base URL: https://qfoxai.com/v1
- Default public model alias: QFOXAI
- Auth: Authorization: Bearer qf_your_full_secret_key
- Models: GET https://qfoxai.com/v1/models
- Chat: POST https://qfoxai.com/v1/chat/completions
- Key status: GET https://qfoxai.com/v1/key
- Embeddings: POST https://qfoxai.com/v1/embeddings
- Moderation: POST https://qfoxai.com/v1/moderations
- Batches: POST https://qfoxai.com/v1/batches

## Integration Rules For AI Coding Agents

- Store QFOXAI_API_KEY on the server only. Never expose the full key in frontend JavaScript.
- Use https://qfoxai.com/v1 as the base URL. Do not append /chat/completions when a client asks for base URL.
- Use public model aliases returned by GET /v1/models. Do not invent or expose private backend model names.
- Handle JSON errors through error.type, error.message, request_id, and quota details.
- Add short retry/backoff for 429, 500, 502, 503, and 504 responses.
- Read quota and lifecycle headers such as X-QFOXAI-Request-ID, X-QFOXAI-API-Version, X-RateLimit-Remaining, and X-Subscription-Tokens-Remaining.

## Recommended Developer Downloads

- Postman: https://qfoxai.com/docs/api/postman
- Starter kit: https://qfoxai.com/docs/api/starter-kit
- Laravel package starter: https://qfoxai.com/docs/api/laravel-package
- OpenAI drop-in guide: https://qfoxai.com/docs/api/openai-drop-in
- WordPress starter: https://qfoxai.com/docs/api/wordpress-plugin
- n8n starter: https://qfoxai.com/docs/api/n8n-node
- Cookbook: https://qfoxai.com/docs/api/cookbook
- Agent integration prompt: https://qfoxai.com/docs/api/integration-prompt