fal-ai/json-schema/fal-queue-request-schema.json at main · api-evangelist/fal-ai · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/fal-ai/main/json-schema/fal-queue-request-schema.json",
  "title": "fal Queue Inference Request",
  "description": "Common envelope for a request submitted to https://queue.fal.run/{model_owner}/{model_name}. The body is model-specific (additionalProperties true), but the following fields appear across most fal models.",
  "type": "object",
  "additionalProperties": true,
  "properties": {
    "prompt": {
      "type": "string",
      "description": "Natural-language prompt describing the desired output."
    },
    "negative_prompt": {
      "type": "string",
      "description": "Concepts the model should avoid."
    },
    "image_url": {
      "type": "string",
      "format": "uri",
      "description": "Reference image URL (often https://v3.fal.media/...)."
    },
    "image_size": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "square_hd",
            "square",
            "portrait_4_3",
            "portrait_16_9",
            "landscape_4_3",
            "landscape_16_9"
          ]
        },
        {
          "type": "object",
          "properties": {
            "width": { "type": "integer", "minimum": 256, "maximum": 8192 },
            "height": { "type": "integer", "minimum": 256, "maximum": 8192 }
          }
        }
      ]
    },
    "num_inference_steps": {
      "type": "integer",
      "minimum": 1,
      "maximum": 200,
      "description": "Number of diffusion steps."
    },
    "guidance_scale": {
      "type": "number",
      "minimum": 0,
      "maximum": 20,
      "description": "Classifier-free guidance strength."
    },
    "seed": {
      "type": "integer",
      "description": "Deterministic seed."
    },
    "num_images": {
      "type": "integer",
      "minimum": 1,
      "maximum": 8
    },
    "enable_safety_checker": {
      "type": "boolean",
      "default": true
    },
    "sync_mode": {
      "type": "boolean",
      "description": "When true, request blocks until completion instead of queueing."
    }
  }
}