API 协议

GET · My account

直接答案GET /api/user/self。包含鉴权、请求参数、三种语言示例、结果判定与错误处理。

更新 · 审核信息

OpenFox · My account

GET https://api.openfox.vip/api/user/self

Model ID: YOUR_MODEL_ID

Authentication

Authorization: Bearer $OPENFOX_PAT

Use a personal access token created in your signed-in account. Model API keys cannot authenticate account APIs.

Scope: profile:read

Keep credentials in environment variables on your server. Do not paste real keys, cookies or account records into this guide.

Request parameters

Example values are not server defaults. Model-specific parameter support must be confirmed for the selected channel.

Model and channel limitations

Requires profile:read. Model API keys cannot access this account endpoint.

Request example

Run one language example only. Creation requests may be charged; do not run every example or retry automatically.

Set OPENFOX_REQUEST_ID from the original X-Request-Id when recovering images. Set OPENFOX_TASK_ID from a real task creation response when querying tasks.

curl

# Bash / WSL; curl 7.76+ and jq. Run ONE language example, not all of them.
umask 077
RESULT=$(mktemp)
trap 'rm -f "$RESULT"' EXIT
: "${OPENFOX_PAT:?Set OPENFOX_PAT}"
curl --silent --show-error --fail-with-body --max-time 180 'https://api.openfox.vip/api/user/self' \
  -H "Authorization: Bearer $OPENFOX_PAT" \
  --output "$RESULT" || exit 1
jq -e 'type == "object" and (.error | not) and (.success != false) and (.code != false)' "$RESULT" >/dev/null || exit 1
# HTTP/business envelope checked only. Complete result validation is required:
# Require success=true and data. Only operate on your own account resources. Do not print private account data.
# Use the Python or JavaScript example in this guide for result processing.

python

# Python 3.10+; install: pip install httpx
import asyncio, json, os
from urllib.parse import quote, urlparse
import httpx

async def main():
    url = "https://api.openfox.vip/api/user/self"
    headers = {}
    headers["Authorization"] = "Bearer " + os.environ["OPENFOX_PAT"]
    params = {}
    async with httpx.AsyncClient(timeout=30, follow_redirects=False) as client:
        async def read(target, method='GET', payload=None):
            response = await client.request(method, target, headers=headers, params=params, json=payload)
            response.raise_for_status()
            value = response.json()
            if not isinstance(value, dict) or value.get('error') or value.get('success') is False or value.get('code') is False:
                raise RuntimeError('API business error')
            return value
        data = await read(url, "GET")

    if not (data.get('success') is True and data.get('data') is not None):
        raise RuntimeError('Unexpected result')
    print('Response validated; private data is not logged.')

async def bounded():
    await asyncio.wait_for(main(), timeout=180)

asyncio.run(bounded())

javascript

// Node.js 20+; save as example.mjs and run: node example.mjs
const controller = new AbortController();
const timer = setTimeout(() => controller.abort(), 180000);
const signal = controller.signal;
try {
const url = new URL("https://api.openfox.vip/api/user/self");
const headers = {};
if (!process.env.OPENFOX_PAT) throw Error('Set OPENFOX_PAT');
headers["Authorization"] = "Bearer " + process.env.OPENFOX_PAT;
const read = async (target, method = 'GET', payload) => {
  const response = await fetch(target, { method, headers, signal, redirect: 'error', body: payload === undefined ? undefined : JSON.stringify(payload) });
  if (!response.ok) throw Error('HTTP ' + response.status);
  const data = await response.json();
  if (!data || typeof data !== 'object' || data.error || data.success === false || data.code === false) throw Error('API business error');
  return data;
};
let data = await read(url, "GET");

if (!(data.success === true && data.data != null)) throw Error('Unexpected result');
console.log('Response validated; private data is not logged.');
} finally { clearTimeout(timer); }

Results and success criteria

Require success=true and data. Only operate on your own account resources. Do not print private account data.

Error handling

Check both HTTP status and business errors. A timeout does not prove the operation failed. Do not automatically retry creation requests; inspect the original request or usage first.

401/403: check credentials, scopes, model permissions and IP rules. 429: check quota and rate limits. 5xx: preserve a non-secret request ID and contact support.

Python and JavaScript share a 180-second network deadline. Read-only polling is bounded. Unknown or failure states stop the flow. Image decoding is local CPU work with byte and pixel limits.

Only the image editing example uploads a local file. Set OPENFOX_IMAGE_PATH to a supported image. Other examples do not upload files. Download external results without platform credentials. Task artifacts require format-specific verification.

Full request schema

{
  "parameters": [],
  "requestBody": null
}

Sources and verification

docs/openapi/api.json · controller/user.go · 2026-11-03

SHA-256: 983fd652147b9d3d8de84113bdcda369c6cdbf31062f1bb7396685e3a84555dc

source-reviewed; upstream-not-tested; legacy-schema-needs-field-review

Source review is not upstream business verification. Availability and billing depend on your account, group and channel.

适用场景

  • getting-started
  • troubleshooting

API 协议

  • /api/user/self

常见问题

这里是否保证模型可调用?

不保证。请在模型广场核对精确型号、账号分组与端点权限。

示例是否使用真实密钥?

不使用。请在自己的服务端设置环境变量,并将 YOUR_MODEL_ID 替换为可用的精确模型 ID。

接口超时可以立即重试吗?

创建请求不应自动重试。先核对请求编号、任务状态和用量,避免重复收费。

官方来源

  1. OpenFox API 官方