Ingest vision images

POST

/v2/project/content/vision/ingestImages

Submit image URLs for analysis and receive an image ID for each immediately.

Processing is asynchronous: nothing is analyzed before the response is written. Poll the returned IDs with getVisionImages until each reports completed or failed.

1 to 100 images per request; each URL must be absolute https.

Select the hotel with at most one of HotelID, GlobalHotelID or ExternalHotelID, or none at all. HotelName is required with a selector, refused without one.

Only giata alone can create a hotel; any other selector resolving to nothing returns 404, as does a project without Vision AI enabled.

429 means a daily cap was reached, 25,000 images or 1,000 new hotels per rolling 24 hours; 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

Images accepted. Every submitted URL has an image ID; analysis runs asynchronously, so poll the returned IDs with getVisionImages.

Headers

Bodyapplication/json

🟠400ingestVisionImages_BadRequest

🟠401ingestVisionImages_Unauthorized

🟠403ingestVisionImages_Forbidden

🟠404ingestVisionImages_NotFound

🟠409ingestVisionImages_Conflict

🟠429ingestVisionImages_TooManyRequests

🔴500ingestVisionImages_InternalServerError

Request Example

Shell

JavaScript

Java

Swift

cURL

Two images submitted without a hotelOne image for a hotel identified by your own product codeThree images for a known hotel selected by its UUID, two carrying the client's room codesRe-submitting two already known URLs alongside a new oneCreating a hotel record: giata alone, not yet known

curl --location 'https://api.ygo.ai/v2/project/content/vision/ingestImages' \
--header 'X-Project-ID: ' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "Images": [
        {
            "URL": "https://ucarecdn.com/9c1b7e42-5a6d-4f38-9a11-2b7c8d5e6f01/"
        },
        {
            "URL": "https://ucarecdn.com/3f0a1d55-8b2c-4e79-9d64-7a1c2b3d4e5f/"
        }
    ]
}'

Response Example

200 - Both images are queued for analysis on the project's placeholder hotel

{
    "Data": {
        "HotelID": "01a086e1-ffaf-7040-b032-76677278f0ae",
        "Images": [
            {
                "ImageID": "0199b2d0-11a5-7c5e-8f21-6d0e4f88b521",
                "URL": "https://ucarecdn.com/9c1b7e42-5a6d-4f38-9a11-2b7c8d5e6f01/",
                "Status": "pending"
            },
            {
                "ImageID": "0199b2c4-8e31-77aa-9c02-3f5b71a2d9e4",
                "URL": "https://ucarecdn.com/3f0a1d55-8b2c-4e79-9d64-7a1c2b3d4e5f/",
                "Status": "pending"
            }
        ]
    }
}

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

Vision AI

Get vision images