API protocol
GET · Task status
Direct answerGET /v1/tasks/{task_id}. Authentication, parameters, examples in three languages, result validation and error handling.
Updated · Reviewed
OpenFox · Task status
GET https://api.openfox.vip/v1/tasks/{task_id}
Model ID: YOUR_MODEL_ID
Authentication
Authorization: Bearer $OPENFOX_API_KEY
Create a model API key in API Keys. Dashboard sessions and personal access tokens are not model API credentials.
Keep credentials in environment variables on your server. Do not paste real keys, cookies or account records into this guide.
Request parameters
- task_id (path, string, Required): Task ID returned by a real task creation request owned by this user.
Example values are not server defaults. Model-specific parameter support must be confirmed for the selected channel.
Model and channel limitations
SUCCESS is a task state, not proof of a downloadable result. Fetch artifacts and validate the actual output. Other protocols use different status names.
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_API_KEY:?Set OPENFOX_API_KEY}"
: "${OPENFOX_TASK_ID:?Set a real task ID}"
TASK_ID=$(printf %s "$OPENFOX_TASK_ID" | jq -sRr @uri)
curl --silent --show-error --fail-with-body --max-time 180 "https://api.openfox.vip/v1/tasks/$TASK_ID" \
-H "Authorization: Bearer $OPENFOX_API_KEY" \
--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:
# Poll NOT_START, SUBMITTED, QUEUED or IN_PROGRESS. Stop on FAILURE or unknown state. After SUCCESS, fetch non-empty artifacts; artifact references still require download and format-specific verification.
# 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/v1/tasks/{task_id}"
url = url.replace('{task_id}', quote(os.environ['OPENFOX_TASK_ID'], safe=''))
headers = {}
headers["Authorization"] = "Bearer " + os.environ["OPENFOX_API_KEY"]
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")
for attempt in range(60):
if data.get('status') not in ['NOT_START', 'SUBMITTED', 'QUEUED', 'IN_PROGRESS']:
break
await asyncio.sleep(3)
data = await read(url)
if data.get('status') != 'SUCCESS':
raise RuntimeError('Result not successful: ' + str(data.get('status')))
data = await read(url + '/artifacts')
if not (bool(data.get('artifacts')) and all(x.get('content_url') for x in data['artifacts'])):
raise RuntimeError('Unexpected result')
print('Artifact references received; download and validate outputs before declaring success.')
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/v1/tasks/{task_id}");
if (!process.env.OPENFOX_TASK_ID) throw Error('Set OPENFOX_TASK_ID from a real task response');
url.pathname = url.pathname.replace('%7Btask_id%7D', encodeURIComponent(process.env.OPENFOX_TASK_ID)).replace('{task_id}', encodeURIComponent(process.env.OPENFOX_TASK_ID));
const headers = {};
if (!process.env.OPENFOX_API_KEY) throw Error('Set OPENFOX_API_KEY');
headers["Authorization"] = "Bearer " + process.env.OPENFOX_API_KEY;
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");
for (let attempt = 0; ['NOT_START', 'SUBMITTED', 'QUEUED', 'IN_PROGRESS'].includes(data.status); attempt++) {
if (attempt >= 59) throw Error('Polling limit reached');
await new Promise(resolve => setTimeout(resolve, 3000));
data = await read(url);
}
if (data.status !== 'SUCCESS') throw Error('Result not successful: ' + data.status);
data = await read(new URL(url.href + '/artifacts'));
if (!(Array.isArray(data.artifacts) && data.artifacts.length > 0 && data.artifacts.every(x => typeof x.content_url === 'string' && x.content_url.length > 0))) throw Error('Unexpected result');
console.log('Artifact references received; download and validate each output before declaring success.');
} finally { clearTimeout(timer); }
Results and success criteria
Poll NOT_START, SUBMITTED, QUEUED or IN_PROGRESS. Stop on FAILURE or unknown state. After SUCCESS, fetch non-empty artifacts; artifact references still require download and format-specific verification.
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.
Uploads, downloads and related endpoints
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.
- https://api.openfox.vip/docs?operation=artifacts
Full request schema
{
"parameters": [
{
"name": "task_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "Task ID returned by a real task creation request owned by this user."
}
],
"requestBody": null
}
Sources and verification
docs/openapi/relay.json · controller/task.go · 2026-11-03
SHA-256: aeee6c35a35b2eaced964401f3826f369ad7ac8985c17989dcbbe08337d9fa01
source-reviewed; upstream-not-tested; source-reviewed
Source review is not upstream business verification. Availability and billing depend on your account, group and channel.
Use cases
- getting-started
- troubleshooting
API protocols
/v1/tasks/{task_id}
FAQ
Does this guarantee model availability?
No. Check the exact model, group and endpoint permissions in the marketplace.
Do examples include live credentials?
No. Set environment variables on your server and replace YOUR_MODEL_ID with an available exact model ID.
Should I retry immediately after a timeout?
Do not automatically retry creation requests. Check the request ID, task status and usage to avoid duplicate charges.
Related guides
Official sources
- OpenFox API Official