{
  "openapi": "3.0.0",
  "info": {
    "title": "YGO API: Get vision images",
    "version": "2.0.0"
  },
  "servers": [
    {
      "url": "https://api.ygo.ai",
      "description": "Production and Sandbox (determined by API key)"
    }
  ],
  "paths": {
    "/v2/project/content/vision/getImages": {
      "post": {
        "summary": "Get vision images",
        "description": "Fetch the analysis state of submitted images by image ID, with the enriched image object for every image that is complete.\n\nAnalysis runs asynchronously after `ingestVisionImages`, so an image reports `pending` until it finishes. Poll every 30 to 60 seconds until each ID reaches `completed`, `failed` or `not_found`.\n\n- 1 to 100 image IDs per request.\n- One entry per requested ID, in request order, so entries can be matched positionally.\n- `Status` is `pending`, `completed`, `failed` or `not_found`; only `completed` carries `Image`.\n- An ID this project never submitted reports `not_found`, never an error.\n- 404 means Vision AI is not enabled for your project.\n- 429 means the rate limit was hit; wait `Retry-After` seconds.",
        "operationId": "getVisionImages",
        "tags": [
          "Content Enrichment API/Vision AI"
        ],
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/X-Project-ID"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/GetVisionImagesRequest"
              },
              "examples": {
                "mixedStatuses": {
                  "summary": "Poll four image IDs from an in-flight batch",
                  "value": {
                    "ImageIDs": [
                      "0192fb20-1aa2-7def-9abc-1122334455aa",
                      "0192fb21-2bb3-7def-9abc-2233445566bb",
                      "0192fb22-3cc4-7def-9abc-3344556677cc",
                      "0192fb99-9ff9-7def-9abc-999999999999"
                    ]
                  }
                },
                "allCompleted": {
                  "summary": "Poll two image IDs whose analysis has finished",
                  "value": {
                    "ImageIDs": [
                      "0192fb21-2bb3-7def-9abc-2233445566bb",
                      "0192fb23-4dd5-7def-9abc-4455667788dd"
                    ]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "One entry per requested image ID, in request order.",
            "headers": {
              "X-Trace-ID": {
                "$ref": "#/components/headers/X-Trace-ID"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetVisionImagesResponse"
                },
                "examples": {
                  "mixedStatuses": {
                    "summary": "One completed image, one still being analyzed, one unreachable URL and one unknown ID",
                    "value": {
                      "Data": {
                        "Images": [
                          {
                            "ImageID": "0192fb20-1aa2-7def-9abc-1122334455aa",
                            "Status": "pending"
                          },
                          {
                            "ImageID": "0192fb21-2bb3-7def-9abc-2233445566bb",
                            "Status": "completed",
                            "RoomRef": "DBL-SEA",
                            "Image": {
                              "ID": "0192fb21-2bb3-7def-9abc-2233445566bb",
                              "URL": "https://images.example-client.com/1234567/room-dbl-sea-1.jpg",
                              "Source": "photo",
                              "Category": "room",
                              "Features": [
                                "sea_view",
                                "balcony",
                                "double_bed"
                              ],
                              "Mood": [
                                "bright",
                                "calm"
                              ],
                              "Tags": [
                                "sea_view"
                              ],
                              "AppealScore": 82,
                              "QualityScore": 77,
                              "AppealScoreVersion": "app-v4",
                              "QualityScoreVersion": "qs-v4",
                              "Width": 1600,
                              "Height": 1067,
                              "Format": "jpeg",
                              "FileSize": 412000,
                              "DominantColor": "#2E6F95",
                              "BlurHash": "LEHV6nWB2yk8pyo0adR*",
                              "Descriptions": {
                                "en-US": "Double room with a balcony overlooking the sea.",
                                "de-DE": "Doppelzimmer mit Balkon und Meerblick."
                              },
                              "Compliance": {
                                "AIGenerated": true
                              },
                              "FeatureDetections": [
                                {
                                  "Label": "sea_view",
                                  "Confidence": 0.94
                                },
                                {
                                  "Label": "balcony",
                                  "Confidence": 0.88
                                }
                              ]
                            }
                          },
                          {
                            "ImageID": "0192fb22-3cc4-7def-9abc-3344556677cc",
                            "Status": "failed",
                            "RoomRef": "SUITE-1"
                          },
                          {
                            "ImageID": "0192fb99-9ff9-7def-9abc-999999999999",
                            "Status": "not_found"
                          }
                        ]
                      }
                    }
                  },
                  "allCompleted": {
                    "summary": "Both images analyzed, one of them carrying the measured detection domains",
                    "value": {
                      "Data": {
                        "Images": [
                          {
                            "ImageID": "0192fb21-2bb3-7def-9abc-2233445566bb",
                            "Status": "completed",
                            "RoomRef": "DBL-SEA",
                            "Image": {
                              "ID": "0192fb21-2bb3-7def-9abc-2233445566bb",
                              "URL": "https://images.example-client.com/1234567/room-dbl-sea-1.jpg",
                              "Source": "photo",
                              "Category": "room",
                              "Features": [
                                "sea_view",
                                "balcony",
                                "double_bed"
                              ],
                              "Mood": [
                                "bright",
                                "calm"
                              ],
                              "Tags": [
                                "sea_view"
                              ],
                              "AppealScore": 82,
                              "QualityScore": 77,
                              "AppealScoreVersion": "app-v4",
                              "QualityScoreVersion": "qs-v4",
                              "Width": 1600,
                              "Height": 1067,
                              "Format": "jpeg",
                              "FileSize": 412000,
                              "DominantColor": "#2E6F95",
                              "BlurHash": "LEHV6nWB2yk8pyo0adR*",
                              "Descriptions": {
                                "en-US": "Double room with a balcony overlooking the sea.",
                                "de-DE": "Doppelzimmer mit Balkon und Meerblick."
                              },
                              "Compliance": {
                                "AIGenerated": true
                              },
                              "FeatureDetections": [
                                {
                                  "Label": "sea_view",
                                  "Confidence": 0.94
                                },
                                {
                                  "Label": "balcony",
                                  "Confidence": 0.88
                                }
                              ]
                            }
                          },
                          {
                            "ImageID": "0192fb23-4dd5-7def-9abc-4455667788dd",
                            "Status": "completed",
                            "Image": {
                              "ID": "0192fb23-4dd5-7def-9abc-4455667788dd",
                              "URL": "https://images.example-client.com/1234567/exterior-pool.jpg",
                              "Source": "photo",
                              "Category": "pool",
                              "Features": [
                                "outdoor_pool",
                                "sun_loungers"
                              ],
                              "Mood": [
                                "relaxing"
                              ],
                              "Tags": [
                                "sunset"
                              ],
                              "Flags": [
                                "people_present"
                              ],
                              "AppealScore": 91,
                              "QualityScore": 88,
                              "AppealScoreVersion": "app-v4",
                              "QualityScoreVersion": "qs-v4",
                              "Width": 2048,
                              "Height": 1365,
                              "Format": "jpeg",
                              "FileSize": 738000,
                              "DominantColor": "#1F5D7A",
                              "BlurHash": "LKO2?U%2Tw=w]~RBVZRi};RPxuwH",
                              "FileMetadata": {
                                "CaptureDate": "2012-06-14",
                                "Copyright": "© 2012 Hotel Sol S.A."
                              },
                              "Descriptions": {
                                "en-US": "Outdoor pool with sun loungers at dusk.",
                                "de-DE": "Außenpool mit Sonnenliegen in der Abenddämmerung."
                              },
                              "Compliance": {
                                "AIGenerated": true
                              },
                              "Presence": [
                                {
                                  "Label": "adult",
                                  "Confidence": 0.81
                                },
                                {
                                  "Label": "child",
                                  "Confidence": null
                                }
                              ],
                              "Safety": {
                                "Inappropriate": 0.02,
                                "OffTopic": null
                              },
                              "TextDetections": [
                                {
                                  "Content": "POOL BAR",
                                  "Label": "signage",
                                  "Confidence": 0.76
                                }
                              ],
                              "FeatureDetections": [
                                {
                                  "Label": "outdoor_pool",
                                  "Confidence": 0.97
                                },
                                {
                                  "Label": "sun_loungers",
                                  "Confidence": 0.83
                                }
                              ]
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "Compliance": {
        "type": "object",
        "properties": {
          "AIGenerated": {
            "type": "boolean",
            "description": "EU AI Act Art. 50(2) machine-readable marker: `true` when the text content of the enclosing object is AI-generated. Always stated explicitly when the envelope is present.",
            "example": true
          }
        }
      },
      "DetectionConfidence": {
        "type": "number",
        "format": "float",
        "nullable": true,
        "minimum": 0,
        "maximum": 1,
        "description": "Confidence between 0 and 1, or null when the entry was asserted without a measured confidence. An entry the analysis did not assert is absent from its list rather than scored zero.",
        "example": 0.94
      },
      "ErrorDetail": {
        "type": "object",
        "required": [
          "Code",
          "Message"
        ],
        "description": "Error detail containing a machine-readable code and human-readable message.",
        "properties": {
          "Code": {
            "type": "string",
            "description": "Machine-readable error code for programmatic handling.",
            "example": "VALIDATION_ERROR"
          },
          "Message": {
            "type": "string",
            "description": "Human-readable error message.",
            "example": "Validation failed"
          },
          "Fields": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/FieldError"
            },
            "description": "Field-level validation errors. Only present for VALIDATION_ERROR responses."
          }
        }
      },
      "ErrorResponse": {
        "type": "object",
        "required": [
          "Error"
        ],
        "description": "Standard v2 error response wrapper.",
        "properties": {
          "Error": {
            "$ref": "#/components/schemas/ErrorDetail"
          }
        }
      },
      "FeatureDetection": {
        "type": "object",
        "required": [
          "Label",
          "Confidence"
        ],
        "description": "One feature of the image with the confidence measured for it.",
        "properties": {
          "Label": {
            "type": "string",
            "description": "The feature label, from the same vocabulary as Features.",
            "example": "sea_view"
          },
          "Confidence": {
            "$ref": "#/components/schemas/DetectionConfidence"
          }
        }
      },
      "FieldError": {
        "type": "object",
        "required": [
          "Field",
          "Message"
        ],
        "description": "A single field-level validation error.",
        "properties": {
          "Field": {
            "type": "string",
            "description": "Name of the field that failed validation. Per-entry errors carry the entry's position, for example ImageIDs[2].",
            "example": "ImageIDs[2]"
          },
          "Message": {
            "type": "string",
            "description": "Human-readable validation error message for this field.",
            "example": "ImageID must be a valid UUID"
          },
          "Code": {
            "type": "string",
            "enum": [
              "REQUIRED",
              "TOO_LONG",
              "TOO_SHORT",
              "OUT_OF_RANGE",
              "TOO_MANY",
              "INVALID_FORMAT",
              "NOT_ALLOWED",
              "CONFLICT",
              "INVALID_ENCODING",
              "INSECURE_SCHEME",
              "UNSAFE_CONTENT",
              "REQUIRED_WHEN_ENABLED"
            ],
            "description": "Machine-readable reason the field failed validation. Optional; clients should fall back to Message when it is absent or unrecognized.",
            "example": "TOO_LONG"
          },
          "Params": {
            "type": "object",
            "additionalProperties": true,
            "description": "Machine-readable values the message is built from, such as limits or allowed values; keys are PascalCase and depend on Code. Optional.",
            "example": {
              "Max": 100
            }
          }
        }
      },
      "GetVisionImagesRequest": {
        "type": "object",
        "required": [
          "ImageIDs"
        ],
        "description": "Request body for polling submitted images by image ID.",
        "properties": {
          "ImageIDs": {
            "type": "array",
            "minItems": 1,
            "maxItems": 100,
            "items": {
              "type": "string",
              "format": "uuid"
            },
            "description": "Image UUIDs returned by ingestVisionImages, between 1 and 100 per request. The response returns one entry per ID, in this order.",
            "example": [
              "0192fb20-1aa2-7def-9abc-1122334455aa",
              "0192fb21-2bb3-7def-9abc-2233445566bb"
            ]
          }
        }
      },
      "GetVisionImagesResponse": {
        "type": "object",
        "required": [
          "Data"
        ],
        "description": "Single-object response envelope wrapping the polled image states.",
        "properties": {
          "Data": {
            "$ref": "#/components/schemas/GetVisionImagesResult"
          }
        }
      },
      "GetVisionImagesResult": {
        "type": "object",
        "required": [
          "Images"
        ],
        "description": "The state of every polled image.",
        "properties": {
          "Images": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/VisionImageState"
            },
            "description": "One entry per requested image ID, in request order."
          }
        }
      },
      "Image": {
        "type": "object",
        "required": [
          "ID",
          "URL"
        ],
        "properties": {
          "ID": {
            "type": "string",
            "format": "uuid",
            "description": "Unique image UUID.",
            "example": "0192fb21-2bb3-7def-9abc-2233445566bb"
          },
          "URL": {
            "type": "string",
            "format": "uri",
            "description": "Image URL.",
            "example": "https://images.example-client.com/1234567/room-dbl-sea-1.jpg"
          },
          "Source": {
            "type": "string",
            "description": "Detected provenance of the pixels: `photo`, `render`, `illustration` or `ai_generated`. Omitted when the image carries no provenance assessment.",
            "example": "photo"
          },
          "Category": {
            "type": "string",
            "description": "Vision-derived image category (e.g. exterior, room, pool, restaurant).",
            "example": "room"
          },
          "Features": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Vision-derived feature tags depicted in the image.",
            "example": [
              "sea_view",
              "balcony"
            ]
          },
          "Mood": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Vision-derived mood descriptors.",
            "example": [
              "bright",
              "calm"
            ]
          },
          "Tags": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Additional vision-derived tags.",
            "example": [
              "sea_view"
            ]
          },
          "Flags": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Quality / content flags raised by vision analysis. Omitted when empty."
          },
          "AppealScore": {
            "type": "integer",
            "description": "Appeal score from 0 to 100, or -1 when there is no scorer-stamped value and no value above 0, normally because nothing has scored the image yet. -1 is not a score and does not affect image order.",
            "example": 82
          },
          "QualityScore": {
            "type": "integer",
            "description": "Technical quality score from 0 to 100, or -1 when there is no scorer-stamped value and no value above 0, normally because nothing has scored the image yet. -1 is not a score and does not affect image order.",
            "example": 77
          },
          "AppealScoreVersion": {
            "type": "string",
            "description": "Version stamp of the scorer that produced AppealScore, for example `app-v4`; it may name an earlier version. Absent when AppealScore is -1 or a legacy score from before stamps existed.",
            "example": "app-v4"
          },
          "QualityScoreVersion": {
            "type": "string",
            "description": "Version stamp of the scorer that produced QualityScore, for example `qs-v4`; it may name an earlier version. Absent when QualityScore is -1, a legacy score, or a first-seen image's provisional score.",
            "example": "qs-v4"
          },
          "Width": {
            "type": "integer",
            "description": "Image width in pixels.",
            "example": 1600
          },
          "Height": {
            "type": "integer",
            "description": "Image height in pixels.",
            "example": 1067
          },
          "Format": {
            "type": "string",
            "description": "Image format (e.g. jpeg, png, webp).",
            "example": "jpeg"
          },
          "FileSize": {
            "type": "integer",
            "description": "File size in bytes.",
            "example": 412000
          },
          "DominantColor": {
            "type": "string",
            "description": "Dominant color as a hex string.",
            "example": "#2E6F95"
          },
          "BlurHash": {
            "type": "string",
            "description": "BlurHash placeholder string for progressive loading.",
            "example": "LEHV6nWB2yk8pyo0adR*"
          },
          "FileMetadata": {
            "type": "object",
            "description": "What the image file itself states in its embedded IPTC/EXIF/XMP metadata: capture date and copyright notice. Omitted when the file states neither; inside it, a value the file did not state has no key.",
            "properties": {
              "CaptureDate": {
                "type": "string",
                "pattern": "^\\d{4}(-\\d{2}(-\\d{2})?)?$",
                "description": "Date the photograph was taken, at the precision the file stated: `2012-06-14`, `2012-06` or `2012`. It carries no time of day and no timezone.",
                "example": "2012-06-14"
              },
              "Copyright": {
                "type": "string",
                "description": "The copyright notice the file carries, as the file wrote it. It names who to ask; it is not a machine-readable licence.",
                "example": "© 2012 Hotel Sol S.A."
              }
            },
            "example": {
              "CaptureDate": "2012-06-14",
              "Copyright": "© 2012 Hotel Sol S.A."
            }
          },
          "Descriptions": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            },
            "description": "Neutral alt text describing what the image shows, not marketing copy, keyed by BCP 47 language tag. More locales may be added after an image is first analyzed.",
            "example": {
              "en-US": "Double room with a balcony overlooking the sea.",
              "de-DE": "Doppelzimmer mit Balkon und Meerblick."
            }
          },
          "Compliance": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Compliance"
              }
            ],
            "description": "EU AI Act Article 50(2) marker for this image. Always present with `AIGenerated` true: the category, features, mood, tags, scores and descriptions are model output, `FileMetadata` is not."
          },
          "Presence": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PresenceDetection"
            },
            "description": "People and animals seen in the image, from the closed vocabulary person, adult, child, animal. Omitted when the image carries no presence measurement."
          },
          "Safety": {
            "type": "object",
            "additionalProperties": {
              "type": "number",
              "format": "float",
              "nullable": true,
              "minimum": 0,
              "maximum": 1
            },
            "description": "Safety confidences keyed by dimension, `Inappropriate` and `OffTopic`, each between 0 and 1 or null. Omitted when the image carries no safety measurement.",
            "example": {
              "Inappropriate": 0.02,
              "OffTopic": null
            }
          },
          "TextDetections": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TextDetection"
            },
            "description": "Texts read off the image, each with its kind. Omitted when the image carries no text measurement."
          },
          "FeatureDetections": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/FeatureDetection"
            },
            "description": "The image's features with the confidence measured for each, running parallel to `Features`. Omitted when the image carries no feature measurement."
          },
          "Nudity": {
            "type": "object",
            "description": "Nudity assessment: exposure score, reason and explicit flag, independent of `Safety.Inappropriate`. Omitted when the assessment did not run or the image's `Presence` shows no person.",
            "required": [
              "Score",
              "Reason",
              "Explicit"
            ],
            "properties": {
              "Score": {
                "type": "integer",
                "minimum": 0,
                "maximum": 100,
                "description": "Exposure score from 0 to 100. Anchors: 20 beach or casual wear, 40 standard swimwear, 60 revealing swimwear or lingerie, 80 partial nudity, 100 explicit.",
                "example": 60
              },
              "Reason": {
                "type": "string",
                "description": "One model-written sentence naming what drives the score, at most 240 characters. Not sanitized for markup, so escape it before rendering.",
                "example": "Adult in revealing swimwear by the pool."
              },
              "Explicit": {
                "type": "boolean",
                "description": "True from a score of 90 up. Whether a child is in the picture is answered by `Presence`, not here.",
                "example": false
              }
            }
          }
        }
      },
      "PresenceDetection": {
        "type": "object",
        "required": [
          "Label",
          "Confidence"
        ],
        "description": "One person or animal seen in the image.",
        "properties": {
          "Label": {
            "type": "string",
            "description": "What was seen: `person`, `adult`, `child` or `animal`.",
            "example": "adult"
          },
          "Confidence": {
            "$ref": "#/components/schemas/DetectionConfidence"
          }
        }
      },
      "TextDetection": {
        "type": "object",
        "required": [
          "Content",
          "Label",
          "Confidence"
        ],
        "description": "One text read off the image.",
        "properties": {
          "Content": {
            "type": "string",
            "description": "The text as it appears on the image. A password or access code printed after a password label is masked.",
            "example": "POOL BAR"
          },
          "Label": {
            "type": "string",
            "description": "Kind of text: `overlay`, `price`, `promotional`, `watermark`, `signage` or `document`.",
            "example": "signage"
          },
          "Confidence": {
            "$ref": "#/components/schemas/DetectionConfidence"
          }
        }
      },
      "VisionImageState": {
        "type": "object",
        "required": [
          "ImageID",
          "Status"
        ],
        "description": "The analysis state of one polled image, with the enriched image object once the analysis is complete.",
        "properties": {
          "ImageID": {
            "type": "string",
            "format": "uuid",
            "description": "The requested image UUID.",
            "example": "0192fb21-2bb3-7def-9abc-2233445566bb"
          },
          "Status": {
            "type": "string",
            "enum": [
              "pending",
              "completed",
              "failed",
              "not_found"
            ],
            "description": "Analysis state: `pending` keep polling, `completed` `Image` carries the result, `failed` stop polling and submit a working URL, `not_found` the ID is unknown for this project.",
            "example": "completed"
          },
          "RoomRef": {
            "type": "string",
            "description": "The room code or name submitted with this image. Omitted when the image was submitted without one.",
            "example": "DBL-SEA"
          },
          "Image": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Image"
              }
            ],
            "description": "The enriched image object. Present only when Status is `completed`."
          }
        }
      }
    },
    "parameters": {
      "X-Project-ID": {
        "name": "X-Project-ID",
        "in": "header",
        "required": true,
        "description": "Project UUID. Required for all project-scoped endpoints.",
        "example": "$YGO_PROJECT_ID",
        "schema": {
          "type": "string",
          "format": "uuid"
        }
      }
    },
    "headers": {
      "Retry-After": {
        "description": "Number of seconds to wait before retrying the request. Present on 429 responses.",
        "schema": {
          "type": "integer",
          "minimum": 1,
          "example": 30
        }
      },
      "X-Trace-ID": {
        "description": "Request trace ID for debugging (OpenTelemetry). Include this ID when contacting support about specific requests.",
        "schema": {
          "type": "string",
          "example": "abc123def456ghi789"
        }
      }
    },
    "responses": {
      "BadRequest": {
        "description": "Bad Request: the request body or an image ID is invalid.",
        "headers": {
          "X-Trace-ID": {
            "$ref": "#/components/headers/X-Trace-ID"
          }
        },
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            },
            "examples": {
              "emptyImageIDs": {
                "summary": "No image IDs provided",
                "value": {
                  "Error": {
                    "Code": "VALIDATION_ERROR",
                    "Message": "Validation failed",
                    "Fields": [
                      {
                        "Field": "ImageIDs",
                        "Message": "ImageIDs must contain at least one image id"
                      }
                    ]
                  }
                }
              },
              "tooManyImageIDs": {
                "summary": "More than 100 image IDs in one request",
                "value": {
                  "Error": {
                    "Code": "VALIDATION_ERROR",
                    "Message": "Validation failed",
                    "Fields": [
                      {
                        "Field": "ImageIDs",
                        "Message": "ImageIDs cannot exceed 100 entries"
                      }
                    ]
                  }
                }
              },
              "malformedImageID": {
                "summary": "An entry is not a valid UUID",
                "value": {
                  "Error": {
                    "Code": "VALIDATION_ERROR",
                    "Message": "Validation failed",
                    "Fields": [
                      {
                        "Field": "ImageIDs[2]",
                        "Message": "ImageID must be a valid UUID"
                      }
                    ]
                  }
                }
              }
            }
          }
        }
      },
      "Forbidden": {
        "description": "Forbidden: the API key may not act on this project, or does not carry the `content.catalog:read` permission this endpoint requires (`INSUFFICIENT_SCOPE`).",
        "headers": {
          "X-Trace-ID": {
            "$ref": "#/components/headers/X-Trace-ID"
          }
        },
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            },
            "examples": {
              "insufficientScope": {
                "summary": "Missing required scope",
                "value": {
                  "Error": {
                    "Code": "INSUFFICIENT_SCOPE",
                    "Message": "token lacks scope content.catalog:read"
                  }
                }
              },
              "noProjectAccess": {
                "summary": "Project access required",
                "value": {
                  "Error": {
                    "Code": "FORBIDDEN",
                    "Message": "Project access required"
                  }
                }
              }
            }
          }
        }
      },
      "InternalServerError": {
        "description": "Internal Server Error: unexpected server error. Quote the `X-Trace-ID` response header when contacting support.",
        "headers": {
          "X-Trace-ID": {
            "$ref": "#/components/headers/X-Trace-ID"
          }
        },
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            },
            "examples": {
              "internalError": {
                "summary": "Internal server error",
                "value": {
                  "Error": {
                    "Code": "INTERNAL_ERROR",
                    "Message": "Failed to load images"
                  }
                }
              }
            }
          }
        }
      },
      "NotFound": {
        "description": "Not Found: Vision AI is not enabled for your project, or the project does not exist. An unknown image ID is not a 404; it is reported per image as `not_found`.",
        "headers": {
          "X-Trace-ID": {
            "$ref": "#/components/headers/X-Trace-ID"
          }
        },
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            },
            "examples": {
              "notFound": {
                "summary": "Project or resource not found",
                "value": {
                  "Error": {
                    "Code": "NOT_FOUND",
                    "Message": "Not found"
                  }
                }
              }
            }
          }
        }
      },
      "TooManyRequests": {
        "description": "Too Many Requests: the rate limit was exceeded. `Retry-After` carries the number of seconds to wait before retrying.",
        "headers": {
          "X-Trace-ID": {
            "$ref": "#/components/headers/X-Trace-ID"
          },
          "Retry-After": {
            "$ref": "#/components/headers/Retry-After"
          }
        },
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            },
            "examples": {
              "rateLimited": {
                "summary": "Limit exceeded",
                "value": {
                  "Error": {
                    "Code": "RATE_LIMIT_EXCEEDED",
                    "Message": "Rate limit exceeded. Retry after the number of seconds in the Retry-After header."
                  }
                }
              }
            }
          }
        }
      },
      "Unauthorized": {
        "description": "Unauthorized: the API key is missing or invalid.",
        "headers": {
          "X-Trace-ID": {
            "$ref": "#/components/headers/X-Trace-ID"
          }
        },
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            },
            "examples": {
              "invalidKey": {
                "summary": "Invalid API key",
                "value": {
                  "Error": {
                    "Code": "UNAUTHORIZED",
                    "Message": "Invalid API key"
                  }
                }
              }
            }
          }
        }
      }
    },
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "description": "Project-scoped API key"
      }
    }
  }
}
