API
API documentation
Direct answerBrowse request formats, endpoints, streaming responses, and media capabilities by protocol.
Updated
Anthropic Messages API guideMessages uses x-api-key and anthropic-version headers. Content blocks and tool calls follow the Anthropic protocol. An OpenFox model key is not an upstream key; the selected model must support this endpoint.Audio, transcription, and Realtime APISpeech synthesis, transcription and realtime sessions differ in inputs, response formats and connection lifecycle. Audio streams and WebSockets cannot use ordinary chat JSON success checks. The current catalog provides route references, not complete audio or realtime examples.Complete Guide to Seedance Video Generation with Real-Person ImagesOpenFox has not verified Tuzi asset-library, compliance-review or Seedance upload routes, so this page does not provide requests for them. Obtain appropriate authorization and meet provider requirements before using an available video task protocol.Content Moderation safety classification APIModeration availability depends on channel support and permissions. Moderation results do not replace application authorization or human review. Do not build production rules around unverified response fields.DELETE · /api/user/oauth/bindings/{provider_id} · Route referenceDELETE /api/user/oauth/bindings/{provider_id}. Source route reference only; the integration contract is not verified and no executable example is provided.DELETE · 删除Passkey · Route referenceDELETE /api/user/passkey. Source route reference only; the integration contract is not verified and no executable example is provided.DELETE · 删除令牌 · Route referenceDELETE /api/token/{id}. Source route reference only; the integration contract is not verified and no executable example is provided.DELETE · 注销当前用户 · Route referenceDELETE /api/user/self. Source route reference only; the integration contract is not verified and no executable example is provided.Embedding and Rerank retrieval APIEmbeddings return vectors; reranking returns document indices and relevance scores. Confirm dimensions and encoding for the selected model. Your application owns chunking, vector storage and access control.GET · /api/audit/self · Route referenceGET /api/audit/self. Source route reference only; the integration contract is not verified and no executable example is provided.GET · /api/data/flow/self · Route referenceGET /api/data/flow/self. Source route reference only; the integration contract is not verified and no executable example is provided.GET · /api/log/get-request · Route referenceGET /api/log/get-request. Source route reference only; the integration contract is not verified and no executable example is provided.GET · /api/log/self/export · Route referenceGET /api/log/self/export. Source route reference only; the integration contract is not verified and no executable example is provided.GET · /api/perf-metrics · Route referenceGET /api/perf-metrics. Source route reference only; the integration contract is not verified and no executable example is provided.GET · /api/perf-metrics/summary · Route referenceGET /api/perf-metrics/summary. Source route reference only; the integration contract is not verified and no executable example is provided.GET · /api/subscription/plans · Route referenceGET /api/subscription/plans. Source route reference only; the integration contract is not verified and no executable example is provided.GET · /api/subscription/self · Route referenceGET /api/subscription/self. Source route reference only; the integration contract is not verified and no executable example is provided.GET · /api/task/{task_id}/artifacts · Route referenceGET /api/task/{task_id}/artifacts. Source route reference only; the integration contract is not verified and no executable example is provided.GET · /api/token/auto-groups · Route referenceGET /api/token/auto-groups. Source route reference only; the integration contract is not verified and no executable example is provided.GET · /api/user/checkin · Route referenceGET /api/user/checkin. Source route reference only; the integration contract is not verified and no executable example is provided.GET · /api/user/oauth/bindings · Route referenceGET /api/user/oauth/bindings. Source route reference only; the integration contract is not verified and no executable example is provided.GET · /api/verify/methods · Route referenceGET /api/verify/methods. Source route reference only; the integration contract is not verified and no executable example is provided.GET · /dashboard/billing/subscription · Route referenceGET /dashboard/billing/subscription. Source route reference only; the integration contract is not verified and no executable example is provided.GET · /dashboard/billing/usage · Route referenceGET /dashboard/billing/usage. Source route reference only; the integration contract is not verified and no executable example is provided.GET · /log/get-request · Route referenceGET /log/get-request. Source route reference only; the integration contract is not verified and no executable example is provided.GET · /mj/task/{id}/fetch · Route referenceGET /mj/task/{id}/fetch. Source route reference only; the integration contract is not verified and no executable example is provided.GET · /mj/task/{id}/image-seed · Route referenceGET /mj/task/{id}/image-seed. Source route reference only; the integration contract is not verified and no executable example is provided.GET · /v1/dashboard/billing/subscription · Route referenceGET /v1/dashboard/billing/subscription. Source route reference only; the integration contract is not verified and no executable example is provided.GET · /v1/dashboard/billing/usage · Route referenceGET /v1/dashboard/billing/usage. Source route reference only; the integration contract is not verified and no executable example is provided.GET · /v1/models/{model} · Route referenceGET /v1/models/{model}. Source route reference only; the integration contract is not verified and no executable example is provided.GET · /v1/responses · Route referenceGET /v1/responses. Source route reference only; the integration contract is not verified and no executable example is provided.GET · /v1/responses/{response_id} · Route referenceGET /v1/responses/{response_id}. Source route reference only; the integration contract is not verified and no executable example is provided.GET · /v1/tasks/{task_id}/artifacts/{artifact_key}/content · Route referenceGET /v1/tasks/{task_id}/artifacts/{artifact_key}/content. Source route reference only; the integration contract is not verified and no executable example is provided.GET · /v1beta/openai/models · Route referenceGET /v1beta/openai/models. Source route reference only; the integration contract is not verified and no executable example is provided.GET · /{mode}/mj/task/{id}/fetch · Route referenceGET /{mode}/mj/task/{id}/fetch. Source route reference only; the integration contract is not verified and no executable example is provided.GET · /{mode}/mj/task/{id}/image-seed · Route referenceGET /{mode}/mj/task/{id}/image-seed. Source route reference only; the integration contract is not verified and no executable example is provided.GET · API key usageGET /api/usage/token/. Authentication, parameters, examples in three languages, result validation and error handling.GET · Available ModelsGET /v1/models. Authentication, parameters, examples in three languages, result validation and error handling.GET · Gemini 格式获取 · Route referenceGET /v1beta/models. Source route reference only; the integration contract is not verified and no executable example is provided.GET · Model pricesGET /api/pricing. Authentication, parameters, examples in three languages, result validation and error handling.GET · My API keysGET /api/token/. Authentication, parameters, examples in three languages, result validation and error handling.GET · My accountGET /api/user/self. Authentication, parameters, examples in three languages, result validation and error handling.GET · My recharge recordsGET /api/user/topup/self. Authentication, parameters, examples in three languages, result validation and error handling.GET · My usage logsGET /api/log/self. Authentication, parameters, examples in three languages, result validation and error handling.GET · Recover image resultGET /v1/images/generations/result. Authentication, parameters, examples in three languages, result validation and error handling.GET · Task artifactsGET /v1/tasks/{task_id}/artifacts. Authentication, parameters, examples in three languages, result validation and error handling.GET · Task statusGET /v1/tasks/{task_id}. Authentication, parameters, examples in three languages, result validation and error handling.GET · 实时 WebSocket 连接 · Route referenceGET /v1/realtime. Source route reference only; the integration contract is not verified and no executable example is provided.GET · 搜索个人日志 · Route referenceGET /api/log/self/search. Source route reference only; the integration contract is not verified and no executable example is provided.GET · 搜索令牌 · Route referenceGET /api/token/search. Source route reference only; the integration contract is not verified and no executable example is provided.GET · 获取2FA状态 · Route referenceGET /api/user/2fa/status. Source route reference only; the integration contract is not verified and no executable example is provided.GET · 获取Passkey状态 · Route referenceGET /api/user/passkey. Source route reference only; the integration contract is not verified and no executable example is provided.GET · 获取个人Midjourney任务 · Route referenceGET /api/mj/self. Source route reference only; the integration contract is not verified and no executable example is provided.GET · 获取个人任务 · Route referenceGET /api/task/self. Source route reference only; the integration contract is not verified and no executable example is provided.GET · 获取个人日志统计 · Route referenceGET /api/log/self/stat. Source route reference only; the integration contract is not verified and no executable example is provided.GET · 获取个人额度数据 · Route referenceGET /api/data/self. Source route reference only; the integration contract is not verified and no executable example is provided.GET · 获取充值信息 · Route referenceGET /api/user/topup/info. Source route reference only; the integration contract is not verified and no executable example is provided.GET · 获取当前用户分组 · Route referenceGET /api/user/self/groups. Source route reference only; the integration contract is not verified and no executable example is provided.GET · 获取指定令牌 · Route referenceGET /api/token/{id}. Source route reference only; the integration contract is not verified and no executable example is provided.GET · 获取模型列表 · Route referenceGET /api/models. Source route reference only; the integration contract is not verified and no executable example is provided.GET · 获取用户可用模型 · Route referenceGET /api/user/models. Source route reference only; the integration contract is not verified and no executable example is provided.GET · 获取视频任务状态 · Route referenceGET /v1/videos/{task_id}. Source route reference only; the integration contract is not verified and no executable example is provided.GET · 获取视频内容 · Route referenceGET /v1/videos/{task_id}/content. Source route reference only; the integration contract is not verified and no executable example is provided.GET · 获取视频生成任务状态 · Route referenceGET /v1/video/generations/{task_id}. Source route reference only; the integration contract is not verified and no executable example is provided.GET · 获取邀请码 · Route referenceGET /api/user/aff. Source route reference only; the integration contract is not verified and no executable example is provided.GET · 通过令牌获取日志 · Route referenceGET /api/log/token. Source route reference only; the integration contract is not verified and no executable example is provided.Gemini API guide: GenerateContent, Live, and InteractionsGemini text generation uses /v1beta/models/{model}:generateContent with the model in the path. Tuzi-specific Gemini Live extensions have not been verified for OpenFox; their WebSocket routes and model names are not supported contracts here.HEAD · /v1/tasks/{task_id}/artifacts/{artifact_key}/content · Route referenceHEAD /v1/tasks/{task_id}/artifacts/{artifact_key}/content. Source route reference only; the integration contract is not verified and no executable example is provided.HEAD · /v1/videos/{task_id}/content · Route referenceHEAD /v1/videos/{task_id}/content. Source route reference only; the integration contract is not verified and no executable example is provided.Image generation and editing APIImage generation sends JSON; edits use multipart/form-data with a boundary generated by the client. Decode and validate images before saving them. After a timeout, query using the original X-Request-Id instead of automatically generating again.Kling-style asynchronous media APIKling text-to-video and image-to-video fields, states and artifacts depend on the actual channel. Tuzi-specific paths cannot be assumed to work here. Check marketplace endpoints and the installed task plugin contract before integration.Midjourney task compatibility protocolMidjourney depends on proxy or task plugins. Creation, polling, button actions and callbacks must use the same protocol. Tuzi /mj/submit/imagine examples are not verified OpenFox contracts.OpenAI-compatible API guideChat Completions and Responses use different request and result objects. Chat examples send messages; Responses examples send input. Changing only the URL does not convert a request between these protocols.POST · /api/oauth/email/bind/resend · Route referencePOST /api/oauth/email/bind/resend. Source route reference only; the integration contract is not verified and no executable example is provided.POST · /api/oauth/email/bind/start · Route referencePOST /api/oauth/email/bind/start. Source route reference only; the integration contract is not verified and no executable example is provided.POST · /api/subscription/balance/pay · Route referencePOST /api/subscription/balance/pay. Source route reference only; the integration contract is not verified and no executable example is provided.POST · /api/subscription/creem/pay · Route referencePOST /api/subscription/creem/pay. Source route reference only; the integration contract is not verified and no executable example is provided.POST · /api/subscription/epay/pay · Route referencePOST /api/subscription/epay/pay. Source route reference only; the integration contract is not verified and no executable example is provided.POST · /api/subscription/stripe/pay · Route referencePOST /api/subscription/stripe/pay. Source route reference only; the integration contract is not verified and no executable example is provided.POST · /api/subscription/waffo-pancake/pay · Route referencePOST /api/subscription/waffo-pancake/pay. Source route reference only; the integration contract is not verified and no executable example is provided.POST · /api/token/batch/keys · Route referencePOST /api/token/batch/keys. Source route reference only; the integration contract is not verified and no executable example is provided.POST · /api/token/{id}/key · Route referencePOST /api/token/{id}/key. Source route reference only; the integration contract is not verified and no executable example is provided.POST · /api/user/checkin · Route referencePOST /api/user/checkin. Source route reference only; the integration contract is not verified and no executable example is provided.POST · /api/user/topup · Route referencePOST /api/user/topup. Source route reference only; the integration contract is not verified and no executable example is provided.POST · /api/user/waffo-pancake/amount · Route referencePOST /api/user/waffo-pancake/amount. Source route reference only; the integration contract is not verified and no executable example is provided.POST · /api/user/waffo-pancake/pay · Route referencePOST /api/user/waffo-pancake/pay. Source route reference only; the integration contract is not verified and no executable example is provided.POST · /api/user/waffo/amount · Route referencePOST /api/user/waffo/amount. Source route reference only; the integration contract is not verified and no executable example is provided.POST · /api/user/waffo/pay · Route referencePOST /api/user/waffo/pay. Source route reference only; the integration contract is not verified and no executable example is provided.POST · /mj/insight-face/swap · Route referencePOST /mj/insight-face/swap. Source route reference only; the integration contract is not verified and no executable example is provided.POST · /mj/submit/action · Route referencePOST /mj/submit/action. Source route reference only; the integration contract is not verified and no executable example is provided.POST · /mj/submit/blend · Route referencePOST /mj/submit/blend. Source route reference only; the integration contract is not verified and no executable example is provided.POST · /mj/submit/change · Route referencePOST /mj/submit/change. Source route reference only; the integration contract is not verified and no executable example is provided.POST · /mj/submit/describe · Route referencePOST /mj/submit/describe. Source route reference only; the integration contract is not verified and no executable example is provided.POST · /mj/submit/edits · Route referencePOST /mj/submit/edits. Source route reference only; the integration contract is not verified and no executable example is provided.POST · /mj/submit/imagine · Route referencePOST /mj/submit/imagine. Source route reference only; the integration contract is not verified and no executable example is provided.POST · /mj/submit/modal · Route referencePOST /mj/submit/modal. Source route reference only; the integration contract is not verified and no executable example is provided.POST · /mj/submit/shorten · Route referencePOST /mj/submit/shorten. Source route reference only; the integration contract is not verified and no executable example is provided.POST · /mj/submit/simple-change · Route referencePOST /mj/submit/simple-change. Source route reference only; the integration contract is not verified and no executable example is provided.POST · /mj/submit/upload-discord-images · Route referencePOST /mj/submit/upload-discord-images. Source route reference only; the integration contract is not verified and no executable example is provided.POST · /mj/submit/video · Route referencePOST /mj/submit/video. Source route reference only; the integration contract is not verified and no executable example is provided.POST · /mj/task/list-by-condition · Route referencePOST /mj/task/list-by-condition. Source route reference only; the integration contract is not verified and no executable example is provided.POST · /v1/alpha/search · Route referencePOST /v1/alpha/search. Source route reference only; the integration contract is not verified and no executable example is provided.POST · /v1/edits · Route referencePOST /v1/edits. Source route reference only; the integration contract is not verified and no executable example is provided.POST · /v1/models/{action} · Route referencePOST /v1/models/{action}. Source route reference only; the integration contract is not verified and no executable example is provided.POST · /v1/tasks/{plugin_key} · Route referencePOST /v1/tasks/{plugin_key}. Source route reference only; the integration contract is not verified and no executable example is provided.POST · /v1/tools/fetch · Route referencePOST /v1/tools/fetch. Source route reference only; the integration contract is not verified and no executable example is provided.POST · /v1/tools/search · Route referencePOST /v1/tools/search. Source route reference only; the integration contract is not verified and no executable example is provided.POST · /v1/videos/{video_id}/remix · Route referencePOST /v1/videos/{video_id}/remix. Source route reference only; the integration contract is not verified and no executable example is provided.POST · /v1beta/models/{action} · Route referencePOST /v1beta/models/{action}. Source route reference only; the integration contract is not verified and no executable example is provided.POST · /{mode}/mj/insight-face/swap · Route referencePOST /{mode}/mj/insight-face/swap. Source route reference only; the integration contract is not verified and no executable example is provided.POST · /{mode}/mj/submit/action · Route referencePOST /{mode}/mj/submit/action. Source route reference only; the integration contract is not verified and no executable example is provided.POST · /{mode}/mj/submit/blend · Route referencePOST /{mode}/mj/submit/blend. Source route reference only; the integration contract is not verified and no executable example is provided.POST · /{mode}/mj/submit/change · Route referencePOST /{mode}/mj/submit/change. Source route reference only; the integration contract is not verified and no executable example is provided.POST · /{mode}/mj/submit/describe · Route referencePOST /{mode}/mj/submit/describe. Source route reference only; the integration contract is not verified and no executable example is provided.POST · /{mode}/mj/submit/edits · Route referencePOST /{mode}/mj/submit/edits. Source route reference only; the integration contract is not verified and no executable example is provided.POST · /{mode}/mj/submit/imagine · Route referencePOST /{mode}/mj/submit/imagine. Source route reference only; the integration contract is not verified and no executable example is provided.POST · /{mode}/mj/submit/modal · Route referencePOST /{mode}/mj/submit/modal. Source route reference only; the integration contract is not verified and no executable example is provided.POST · /{mode}/mj/submit/shorten · Route referencePOST /{mode}/mj/submit/shorten. Source route reference only; the integration contract is not verified and no executable example is provided.POST · /{mode}/mj/submit/simple-change · Route referencePOST /{mode}/mj/submit/simple-change. Source route reference only; the integration contract is not verified and no executable example is provided.POST · /{mode}/mj/submit/upload-discord-images · Route referencePOST /{mode}/mj/submit/upload-discord-images. Source route reference only; the integration contract is not verified and no executable example is provided.POST · /{mode}/mj/submit/video · Route referencePOST /{mode}/mj/submit/video. Source route reference only; the integration contract is not verified and no executable example is provided.POST · /{mode}/mj/task/list-by-condition · Route referencePOST /{mode}/mj/task/list-by-condition. Source route reference only; the integration contract is not verified and no executable example is provided.POST · Claude MessagesPOST /v1/messages. Authentication, parameters, examples in three languages, result validation and error handling.POST · EmbeddingsPOST /v1/embeddings. Authentication, parameters, examples in three languages, result validation and error handling.POST · Gemini nativePOST /v1beta/models/{model}:generateContent. Authentication, parameters, examples in three languages, result validation and error handling.POST · Gemini 嵌入(Embeddings) · Route referencePOST /v1/engines/{model}/embeddings. Source route reference only; the integration contract is not verified and no executable example is provided.POST · Image editingPOST /v1/images/edits. Authentication, parameters, examples in three languages, result validation and error handling.POST · Image generationPOST /v1/images/generations. Authentication, parameters, examples in three languages, result validation and error handling.POST · Rerank documentsPOST /v1/rerank. Authentication, parameters, examples in three languages, result validation and error handling.POST · ResponsesPOST /v1/responses. Authentication, parameters, examples in three languages, result validation and error handling.POST · Text chatPOST /v1/chat/completions. Authentication, parameters, examples in three languages, result validation and error handling.POST · 内容审核 · Route referencePOST /v1/moderations. Source route reference only; the integration contract is not verified and no executable example is provided.POST · 创建令牌 · Route referencePOST /api/token/. Source route reference only; the integration contract is not verified and no executable example is provided.POST · 创建文本补全 · Route referencePOST /v1/completions. Source route reference only; the integration contract is not verified and no executable example is provided.POST · 创建视频 · Route referencePOST /v1/videos. Source route reference only; the integration contract is not verified and no executable example is provided.POST · 创建视频生成任务 · Route referencePOST /v1/video/generations. Source route reference only; the integration contract is not verified and no executable example is provided.POST · 压缩对话 (OpenAI Responses API) · Route referencePOST /v1/responses/compact. Source route reference only; the integration contract is not verified and no executable example is provided.POST · 发起Creem支付 · Route referencePOST /api/user/creem/pay. Source route reference only; the integration contract is not verified and no executable example is provided.POST · 发起Stripe支付 · Route referencePOST /api/user/stripe/pay. Source route reference only; the integration contract is not verified and no executable example is provided.POST · 发起易支付 · Route referencePOST /api/user/pay. Source route reference only; the integration contract is not verified and no executable example is provided.POST · 启用2FA · Route referencePOST /api/user/2fa/enable. Source route reference only; the integration contract is not verified and no executable example is provided.POST · 完成注册Passkey · Route referencePOST /api/user/passkey/register/finish. Source route reference only; the integration contract is not verified and no executable example is provided.POST · 完成验证Passkey · Route referencePOST /api/user/passkey/verify/finish. Source route reference only; the integration contract is not verified and no executable example is provided.POST · 开始注册Passkey · Route referencePOST /api/user/passkey/register/begin. Source route reference only; the integration contract is not verified and no executable example is provided.POST · 开始验证Passkey · Route referencePOST /api/user/passkey/verify/begin. Source route reference only; the integration contract is not verified and no executable example is provided.POST · 批量删除令牌 · Route referencePOST /api/token/batch. Source route reference only; the integration contract is not verified and no executable example is provided.POST · 文本转语音 · Route referencePOST /v1/audio/speech. Source route reference only; the integration contract is not verified and no executable example is provided.POST · 禁用2FA · Route referencePOST /api/user/2fa/disable. Source route reference only; the integration contract is not verified and no executable example is provided.POST · 绑定微信 · Route referencePOST /api/oauth/wechat/bind. Source route reference only; the integration contract is not verified and no executable example is provided.POST · 绑定邮箱 · Route referencePOST /api/oauth/email/bind. Source route reference only; the integration contract is not verified and no executable example is provided.POST · 获取Stripe支付金额 · Route referencePOST /api/user/stripe/amount. Source route reference only; the integration contract is not verified and no executable example is provided.POST · 获取支付金额 · Route referencePOST /api/user/amount. Source route reference only; the integration contract is not verified and no executable example is provided.POST · 设置2FA · Route referencePOST /api/user/2fa/setup. Source route reference only; the integration contract is not verified and no executable example is provided.POST · 转换邀请额度 · Route referencePOST /api/user/aff_transfer. Source route reference only; the integration contract is not verified and no executable example is provided.POST · 通用安全验证 · Route referencePOST /api/verify. Source route reference only; the integration contract is not verified and no executable example is provided.POST · 重新生成备用码 · Route referencePOST /api/user/2fa/backup_codes. Source route reference only; the integration contract is not verified and no executable example is provided.POST · 音频翻译 · Route referencePOST /v1/audio/translations. Source route reference only; the integration contract is not verified and no executable example is provided.POST · 音频转录 · Route referencePOST /v1/audio/transcriptions. Source route reference only; the integration contract is not verified and no executable example is provided.PUT · /api/subscription/self/preference · Route referencePUT /api/subscription/self/preference. Source route reference only; the integration contract is not verified and no executable example is provided.PUT · 更新令牌 · Route referencePUT /api/token/. Source route reference only; the integration contract is not verified and no executable example is provided.PUT · 更新当前用户信息 · Route referencePUT /api/user/self. Source route reference only; the integration contract is not verified and no executable example is provided.PUT · 更新用户设置 · Route referencePUT /api/user/setting. Source route reference only; the integration contract is not verified and no executable example is provided.Suno music task-proxy protocolSuno depends on task plugins and configured pricing. suno_lyrics and suno_music remain unlisted; this guide provides no callable or price examples for them. Availability requires administrator-confirmed pricing and the actual plugin contract.Tool calling and structured output APITool calls express requested actions. Your application must validate arguments, execute authorized operations and return results to the model. Schema support varies by model and channel. The text examples do not implement tool loops, so tool-only responses are not successful text output.Video generation task APIVideo creation depends on installed task plugins and channels. The source contains /v1/videos, but route existence does not establish availability for every video model. Unified task lookup uses /v1/tasks/{task_id}; receiving artifact references is distinct from downloading valid video.