Get vision images

POST

/v2/project/content/vision/getImages

Fetch the analysis state of submitted images by image ID, with the enriched image object for every image that is complete.

Analysis 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.

1 to 100 image IDs per request.

One entry per requested ID, in request order, so entries can be matched positionally.

Status is pending, completed, failed or not_found; only completed carries Image.

An ID this project never submitted reports not_found, never an error.

404 means Vision AI is not enabled for your project.

429 means the rate limit was hit; wait Retry-After seconds.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

One entry per requested image ID, in request order.

Headers

Bodyapplication/json

🟠400getVisionImages_BadRequest

🟠401getVisionImages_Unauthorized

🟠403getVisionImages_Forbidden

🟠404getVisionImages_NotFound

🟠429getVisionImages_TooManyRequests

🔴500getVisionImages_InternalServerError

Request Example

Shell

JavaScript

Java

Swift

cURL

Poll four image IDs from an in-flight batchPoll two image IDs whose analysis has finished

curl --location 'https://api.ygo.ai/v2/project/content/vision/getImages' \
--header 'X-Project-ID: ' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "ImageIDs": [
        "0192fb20-1aa2-7def-9abc-1122334455aa",
        "0192fb21-2bb3-7def-9abc-2233445566bb",
        "0192fb22-3cc4-7def-9abc-3344556677cc",
        "0192fb99-9ff9-7def-9abc-999999999999"
    ]
}'

Response Example

200 - One completed image, one still being analyzed, one unreachable URL and one unknown ID

{
    "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,
                    "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"
            }
        ]
    }
}

Modified at 2026-09-14 07:24:05

Ingest vision images

List vision images