API protocol

POST · /{mode}/mj/submit/describe · Route reference

Direct answerPOST /{mode}/mj/submit/describe. Source route reference only; the integration contract is not verified and no executable example is provided.

Updated · Reviewed

OpenFox · /{mode}/mj/submit/describe

POST https://api.openfox.vip/{mode}/mj/submit/describe

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

  • mode (path, string, Required): Use the real resource identifier required by this route. Contract verification pending.

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

Model and channel limitations

Route present in the source. The complete parameter and result contract has not been verified in this release. Native task routes depend on enabled plugins and channels. No runnable example is generated for this entry.

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.

This entry is a source reference, not a complete integration guide. Do not generate a request until the protocol contract has been verified.

Results and success criteria

Route existence was checked in source only. Response fields, business success, streaming and asynchronous behavior require protocol-specific verification before use.

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": [
    {
      "name": "mode",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string"
      },
      "description": "Use the real resource identifier required by this route. Contract verification pending."
    }
  ],
  "requestBody": null
}

Sources and verification

docs/openapi/relay.json · router/relay-router.go · 2026-11-03

SHA-256: aeee6c35a35b2eaced964401f3826f369ad7ac8985c17989dcbbe08337d9fa01

route-source-only; schema-and-business-not-tested; legacy-schema-needs-field-review

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

Use cases

  • getting-started
  • troubleshooting

API protocols

  • /{mode}/mj/submit/describe

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.

Official sources

  1. OpenFox API Official