Skip to main content

🌐 REST API Overview

Fuyu provides a full-featured REST API so you can interact with your scripts, jobs, datasets, accounts, and more — all programmatically.

📦 Base URL​

The public API is available at:

https://fuyu.gg/api/

All requests must include your API key using the x-api-key header:

x-api-key: YOUR_API_KEY

Example:

curl https://fuyu.gg/api/scripts   -H "x-api-key: api_abc123.xyz456"

❗ Do not use https://api.fuyu.gg — it is reserved for internal services.

🔐 Authentication​

Refer to API Keys to create and manage secure tokens.

🧰 What You Can Do​

With the REST API, you can:

  • Create, run, and monitor scripts
  • View job results and logs
  • Upload and access datasets
  • Manage proxies and accounts
  • Retrieve per-script output programmatically

📄 Response Format​

All responses are in JSON. Errors are returned with appropriate HTTP status codes and a message field in the body.

Example success:

{
  "data": [...],
}

Example error:

{
  "error": true,
  "url": "http://fuyu.gg/api/scripts",
  "statusCode": 401,
  "statusMessage": "Server Error",
  "message": "Unauthorized"
}

📚 Endpoint Reference​

A complete endpoint listing will be published soon.

🧪 Test and Explore​

You can use tools like:

🔗 Related Topics​