> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bizyair.vip/llms.txt
> Use this file to discover all available pages before exploring further.

# API Quickstart

> BizyAir API three-minute quickstart: configure API Key, call the sync task endpoint, and get results with complete curl examples.

BizyAir exposes every AI app as an HTTPS POST endpoint. All tasks are initiated through a unified **task creation interface**, and the call mode is determined by the request header.

## Core Concepts

| Concept        | Description                                                                               |
| -------------- | ----------------------------------------------------------------------------------------- |
| `web_app_id`   | Unique numeric ID of the AI app or workflow, obtained from the BizyAir website            |
| `input_values` | Workflow input parameters, key format: `NodeID:NodeName.FieldName`                        |
| `request_id`   | Unique ID assigned per task for querying / canceling / interrupting                       |
| `object_url`   | Temporary hosting URL for result files, with an expiration time                           |
| `status`       | Task status enum: `Queuing` / `Preparing` / `Running` / `Success` / `Failed` / `Canceled` |
| API Key        | Account authentication credential, generated from **API Keys**                            |
| Balance        | Prepaid credits, deducted by actual consumption                                           |

## Three-Minute Quickstart

```bash theme={null}
# 1. Set API Key (from My Profile → API Keys)
export BIZYAIR_API_KEY="your-api-key-here"

# 2. Call AI app synchronously and get results instantly
curl -X POST "https://api.bizyair.ai/v1/webapp/task/openapi/create" \
  -H "Authorization: Bearer $BIZYAIR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "web_app_id": 38214,
    "suppress_preview_output": false,
    "input_values": {
      "84:CLIPTextEncode.text": "a futuristic cityscape at sunset, ultra detailed",
      "88:KSampler.seed": 354884000907176,
      "81:EmptySD3LatentImage.width": 1280,
      "81:EmptySD3LatentImage.height": 1280
    }
  }'
```

In synchronous mode, the HTTP connection stays open until the task completes, and the response body directly contains the `object_url` of the generated result.