1. Vision AI
YGO Client API
v2
  • v2
  • v1
  • Project API
    • Overview
    • Core Concepts
    • Authentication
    • Error Handling & Limits
    • Content Enrichment API
      • Text Generation
        • Generate text
        • Get text generation status
        • Preview text
      • Enrichment
        • Get enriched hotel
        • List enriched hotels
        • List enriched hotel summaries
      • Templates
        • Save text template
        • List text templates
      • Tags
        • Save tag
        • List tags
        • Delete tag
        • Add tag to hotels (bulk)
        • Remove tag from hotels (bulk)
      • Image Pins
        • Delete hotel image pin
        • Save hotel image pin
      • Settings
        • Get content settings
      • Approval Links
        • Create approval links (bulk)
        • Export approved hotel text with image URLs
        • List approval links
        • Revoke approval link
        • Rotate approval link
      • Vision AI
        • Ingest vision images
          POST
        • Get vision images
          POST
        • List vision images
          POST
    • Schemas
      • GetEnrichedHotelRequest
      • GenerateTextRequest
      • GetTextGenerationStatusRequest
      • PreviewTextRequest
      • GetEnrichedHotelsByTagRequest
      • ListEnrichedHotelsRequest
      • GetContentSettingsRequest
      • ListTextTemplatesRequest
      • SaveTextTemplateRequest
      • generateText_GenerateTextRequest
      • createApprovalLinks_CreateApprovalLinksRequest
      • GetEnrichedHotelResponse
      • GenerateTextResponse
      • GetTextGenerationStatusResponse
      • PreviewTextResponse
      • GetEnrichedHotelsByTagResponse
      • ListEnrichedHotelsResponse
      • GetContentSettingsResponse
      • ListTextTemplatesResponse
      • SaveTextTemplateResponse
      • generateText_GenerateTextResponse
      • createApprovalLinks_CreateApprovalLinksResponse
      • TextGenerationRun
      • TextGenerationStatus
      • PreviewResult
      • EnrichedHotelsByTag
      • Pagination
      • ContentSettings
      • TextTemplate
      • generateText_TextGenerationRun
      • createApprovalLinks_ApprovalLink
      • ErrorResponse
      • RunProgress
      • PreviewHotel
      • TagSummary
      • EnrichedHotelListItem
      • generateText_RunProgress
      • createApprovalLinks_ApprovalApprover
      • EnrichedHotel
      • ErrorDetail
      • PreviewCell
      • TemplateUsageStats
      • generateText_ErrorResponse
      • createApprovalLinks_ErrorResponse
      • Location
      • FieldError
      • PreviewChange
      • generateText_ErrorDetail
      • createApprovalLinks_ErrorDetail
      • Address
      • createApprovalLinks_FieldError
      • FactualAttribute
      • getTextGenerationStatus_GetTextGenerationStatusRequest
      • exportApprovedHotelText_ExportApprovedHotelTextRequest
      • FactualInstance
      • getTextGenerationStatus_GetTextGenerationStatusResponse
      • exportApprovedHotelText_ApprovedHotelTextFile
      • POI
      • getTextGenerationStatus_TextGenerationStatus
      • exportApprovedHotelText_ErrorResponse
      • CheckIn
      • getTextGenerationStatus_RunProgress
      • exportApprovedHotelText_ErrorDetail
      • CheckOut
      • getTextGenerationStatus_ErrorResponse
      • exportApprovedHotelText_FieldError
      • GeneratedTexts
      • getTextGenerationStatus_ErrorDetail
      • listApprovals_ListApprovalsRequest
      • GeneratedTextDetail
      • listApprovals_ListApprovalsResponse
      • Image
      • previewText_PreviewTextRequest
      • listApprovals_Pagination
      • EnrichedRoom
      • previewText_PreviewTextResponse
      • listApprovals_ApprovalLink
      • Bedding
      • previewText_PreviewResult
      • listApprovals_ApprovalApprover
      • previewText_PreviewHotel
      • listApprovals_ErrorResponse
      • previewText_PreviewText
      • listApprovals_ErrorDetail
      • previewText_PreviewChange
      • listApprovals_FieldError
      • previewText_ErrorResponse
      • revokeApprovalLink_RevokeApprovalLinkRequest
      • previewText_ErrorDetail
      • revokeApprovalLink_RevokeApprovalLinkResponse
      • revokeApprovalLink_ApprovalLink
      • revokeApprovalLink_ApprovalApprover
      • getEnrichedHotel_GetEnrichedHotelResponse
      • revokeApprovalLink_ErrorResponse
      • revokeApprovalLink_ErrorDetail
      • getEnrichedHotel_ProjectTagSummary
      • revokeApprovalLink_FieldError
      • getEnrichedHotel_Location
      • rotateApprovalLink_RotateApprovalLinkRequest
      • rotateApprovalLink_RotateApprovalLinkResponse
      • rotateApprovalLink_ApprovalLink
      • rotateApprovalLink_ApprovalApprover
      • getEnrichedHotel_POI
      • rotateApprovalLink_ErrorResponse
      • getEnrichedHotel_CheckIn
      • rotateApprovalLink_ErrorDetail
      • getEnrichedHotel_CheckOut
      • rotateApprovalLink_FieldError
      • getEnrichedHotel_GeneratedTexts
      • getEnrichedHotel_GeneratedTextDetail
      • getEnrichedHotel_Compliance
      • getEnrichedHotel_ProviderVariant
      • generateText_FieldError
      • getEnrichedHotel_Bedding
      • getEnrichedHotel_ErrorResponse
      • getEnrichedHotel_ErrorDetail
      • listEnrichedHotelSummaries_ListEnrichedHotelSummariesRequest
      • listEnrichedHotels_EnrichedHotelListItem
      • listEnrichedHotelSummaries_ListEnrichedHotelSummariesResponse
      • listEnrichedHotelSummaries_Pagination
      • getTextGenerationStatus_FieldError
      • listEnrichedHotelSummaries_ErrorResponse
      • listEnrichedHotelSummaries_ErrorDetail
      • listEnrichedHotels_ListEnrichedHotelsResponse
      • listEnrichedHotels_Pagination
      • listEnrichedHotels_ProjectTagSummary
      • previewText_FieldError
      • listEnrichedHotels_Location
      • getEnrichedHotel_GetEnrichedHotelRequest
      • getEnrichedHotel_EnrichedHotel
      • listEnrichedHotels_POI
      • listEnrichedHotels_CheckIn
      • getEnrichedHotel_Address
      • listEnrichedHotels_CheckOut
      • listEnrichedHotels_GeneratedTexts
      • getEnrichedHotel_FactualAttribute
      • listEnrichedHotels_GeneratedTextDetail
      • getEnrichedHotel_FactualInstance
      • listEnrichedHotels_Compliance
      • listEnrichedHotels_ProviderVariant
      • listEnrichedHotels_Bedding
      • listEnrichedHotels_ErrorResponse
      • listEnrichedHotels_ErrorDetail
      • getEnrichedHotel_DetectionConfidence
      • getEnrichedHotel_PresenceDetection
      • deleteHotelImagePin_DeleteHotelImagePinRequest
      • getEnrichedHotel_TextDetection
      • deleteHotelImagePin_DeleteHotelImagePinResponse
      • getEnrichedHotel_FeatureDetection
      • getEnrichedHotel_Image
      • deleteHotelImagePin_ClearedHotelImagePin
      • getEnrichedHotel_EnrichedRoom
      • deleteHotelImagePin_ErrorResponse
      • deleteHotelImagePin_ErrorDetail
      • saveHotelImagePin_SaveHotelImagePinRequest
      • getEnrichedHotel_FieldError
      • saveHotelImagePin_SaveHotelImagePinResponse
      • saveHotelImagePin_HotelImagePin
      • saveHotelImagePin_ErrorResponse
      • saveHotelImagePin_ErrorDetail
      • listEnrichedHotelSummaries_EnrichedHotelSummary
      • getContentSettings_GetContentSettingsRequest
      • getContentSettings_GetContentSettingsResponse
      • getContentSettings_ContentSettings
      • listEnrichedHotelSummaries_FieldError
      • listEnrichedHotels_ListEnrichedHotelsRequest
      • getContentSettings_ErrorResponse
      • getContentSettings_ErrorDetail
      • listEnrichedHotels_EnrichedHotel
      • listImageProvidersProject_ListImageProvidersRequest
      • listImageProvidersProject_ListImageProvidersResponse
      • listImageProvidersProject_ImageProviderCatalog
      • listEnrichedHotels_Address
      • listImageProvidersProject_ImageProviderCatalogEntry
      • listEnrichedHotels_FactualAttribute
      • listImageProvidersProject_ErrorResponse
      • listEnrichedHotels_FactualInstance
      • listImageProvidersProject_ErrorDetail
      • addTagToHotels_AddTagToHotelsRequest
      • addTagToHotels_AddTagToHotelsResponse
      • addTagToHotels_BulkTagResult
      • addTagToHotels_BulkTagHotelResult
      • addTagToHotels_ErrorResponse
      • addTagToHotels_ErrorDetail
      • listEnrichedHotels_DetectionConfidence
      • listEnrichedHotels_PresenceDetection
      • deleteTag_DeleteTagRequest
      • listEnrichedHotels_TextDetection
      • deleteTag_DeleteTagResponse
      • listEnrichedHotels_FeatureDetection
      • listEnrichedHotels_Image
      • deleteTag_DeletedProjectTag
      • listEnrichedHotels_EnrichedRoom
      • deleteTag_ErrorResponse
      • deleteTag_ErrorDetail
      • listTags_ListTagsRequest
      • listEnrichedHotels_FieldError
      • listTags_ListTagsResponse
      • listTags_ProjectTag
      • listTags_ErrorResponse
      • listTags_ErrorDetail
      • removeTagFromHotels_RemoveTagFromHotelsRequest
      • removeTagFromHotels_RemoveTagFromHotelsResponse
      • deleteHotelImagePin_FieldError
      • removeTagFromHotels_BulkTagResult
      • removeTagFromHotels_BulkTagHotelResult
      • removeTagFromHotels_ErrorResponse
      • removeTagFromHotels_ErrorDetail
      • saveTag_SaveTagRequest
      • saveHotelImagePin_FieldError
      • saveTag_SaveTagResponse
      • saveTag_ProjectTag
      • saveTag_ErrorResponse
      • saveTag_ErrorDetail
      • getContentSettings_FieldError
      • listTextTemplates_ListTextTemplatesRequest
      • listTextTemplates_ListTextTemplatesResponse
      • listTextTemplates_Pagination
      • listTextTemplates_TextTemplate
      • listTextTemplates_TemplateUsageStats
      • listTextTemplates_ErrorResponse
      • listTextTemplates_ErrorDetail
      • listImageProvidersProject_FieldError
      • saveTextTemplate_SaveTextTemplateResponse
      • saveTextTemplate_TextTemplate
      • saveTextTemplate_ErrorResponse
      • saveTextTemplate_ErrorDetail
      • addTagToHotels_FieldError
      • deleteTag_FieldError
      • listTags_FieldError
      • removeTagFromHotels_FieldError
      • saveTag_FieldError
      • listTextTemplates_FieldError
      • saveTextTemplate_SaveTextTemplateRequest
      • saveTextTemplate_FieldError
      • getVisionImages_GetVisionImagesRequest
      • getVisionImages_GetVisionImagesResponse
      • getVisionImages_GetVisionImagesResult
      • getVisionImages_VisionImageState
      • getVisionImages_Image
      • getVisionImages_Compliance
      • getVisionImages_DetectionConfidence
      • getVisionImages_PresenceDetection
      • getVisionImages_TextDetection
      • getVisionImages_FeatureDetection
      • getVisionImages_ErrorResponse
      • getVisionImages_ErrorDetail
      • getVisionImages_FieldError
      • ingestVisionImages_IngestVisionImagesRequest
      • ingestVisionImages_VisionImageSubmission
      • ingestVisionImages_IngestVisionImagesResponse
      • ingestVisionImages_IngestVisionImagesResult
      • ingestVisionImages_IngestedImage
      • ingestVisionImages_ErrorResponse
      • ingestVisionImages_ErrorDetail
      • ingestVisionImages_FieldError
      • listVisionImages_ListVisionImagesRequest
      • listVisionImages_ListVisionImagesResponse
      • listVisionImages_Pagination
      • listVisionImages_ListVisionImage
      • listVisionImages_Image
      • listVisionImages_Compliance
      • listVisionImages_DetectionConfidence
      • listVisionImages_PresenceDetection
      • listVisionImages_TextDetection
      • listVisionImages_FeatureDetection
      • listVisionImages_ErrorResponse
      • listVisionImages_ErrorDetail
      • listVisionImages_FieldError
  1. Vision AI

List vision images

POST
/v2/project/content/vision/listImages
List this project's submitted images, newest first, with the enriched image object for every image that is complete.
Analysis runs asynchronously, so an image listed as pending is still being worked on. An empty body {} returns the first page of everything this project has submitted.
Limit defaults to 50, caps at 100; Offset defaults to 0.
Status filters to pending, completed or failed; any other value returns 400.
Ordered by SubmittedAt then ImageID, both descending.
Data is the array itself; Pagination.Total counts the match.
A Status filter covers your newest 10,000 submissions.
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 ********************
or
Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200
application/json
One page of this project's submitted images, newest first.
Headers

Bodyapplication/json

🟠400listVisionImages_BadRequest
🟠401listVisionImages_Unauthorized
🟠403listVisionImages_Forbidden
🟠404listVisionImages_NotFound
🟠429listVisionImages_TooManyRequests
🔴500listVisionImages_InternalServerError
Request Request Example
Shell
JavaScript
Java
Swift
cURL
curl --location 'https://api.ygo.ai/v2/project/content/vision/listImages' \
--header 'X-Project-ID: ' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{}'
Response Response Example
200 - Four images: one still being analyzed, two analyzed, one unreachable — three submitted without a hot
{
    "Data": [
        {
            "ImageID": "0199b2d0-11a5-7c5e-8f21-6d0e4f88b521",
            "URL": "https://ucarecdn.com/9c1b7e42-5a6d-4f38-9a11-2b7c8d5e6f01/",
            "Status": "pending",
            "SubmittedAt": "2026-09-09T16:04:51.812433Z",
            "BatchID": "0199b2d0-11a4-7c5e-8f21-5c9d3e77a410",
            "HotelID": "01a086e1-ffaf-7040-b032-76677278f0ae",
            "HotelName": "Vision AI API placeholder",
            "IsPlaceholderHotel": true
        },
        {
            "ImageID": "0199b2c4-8e31-77aa-9c02-3f5b71a2d9e4",
            "URL": "https://ucarecdn.com/3f0a1d55-8b2c-4e79-9d64-7a1c2b3d4e5f/",
            "Status": "completed",
            "SubmittedAt": "2026-09-09T16:04:12.550118Z",
            "BatchID": "0199b2c4-8e30-7b19-9a4d-2e7f6c1b8d33",
            "HotelID": "01a086e1-ffaf-7040-b032-76677278f0ae",
            "HotelName": "Vision AI API placeholder",
            "IsPlaceholderHotel": true,
            "Image": {
                "ID": "0199b2c4-8e31-77aa-9c02-3f5b71a2d9e4",
                "URL": "https://ucarecdn.com/3f0a1d55-8b2c-4e79-9d64-7a1c2b3d4e5f/",
                "Source": "photo",
                "Category": "restaurant",
                "Features": [
                    "indoor_seating",
                    "buffet"
                ],
                "Mood": [
                    "warm",
                    "inviting"
                ],
                "Tags": [
                    "breakfast"
                ],
                "AppealScore": 74,
                "QualityScore": 81,
                "Width": 2000,
                "Height": 1333,
                "Format": "jpeg",
                "FileSize": 611000,
                "DominantColor": "#8A6A48",
                "BlurHash": "L6PZfSjE.AyE_3t7t7R**0o#DgR4",
                "FileMetadata": {
                    "CaptureDate": "2012-06-14",
                    "Copyright": "© 2012 Hotel Sol S.A."
                },
                "Descriptions": {
                    "en-US": "Restaurant with buffet counters and set tables.",
                    "de-DE": "Restaurant mit Buffettheken und eingedeckten Tischen."
                },
                "Compliance": {
                    "AIGenerated": true
                },
                "FeatureDetections": [
                    {
                        "Label": "buffet",
                        "Confidence": 0.91
                    },
                    {
                        "Label": "indoor_seating",
                        "Confidence": 0.86
                    }
                ]
            }
        },
        {
            "ImageID": "0199b2c4-8e31-77aa-9c02-1a4c60b8c7f1",
            "URL": "https://ucarecdn.com/7d4e9b21-6c3a-4f52-8e10-9b8a7c6d5e4f/",
            "Status": "failed",
            "SubmittedAt": "2026-09-09T16:04:12.550118Z",
            "BatchID": "0199b2c4-8e30-7b19-9a4d-2e7f6c1b8d33",
            "HotelID": "01a086e1-ffaf-7040-b032-76677278f0ae",
            "HotelName": "Vision AI API placeholder",
            "IsPlaceholderHotel": true
        },
        {
            "ImageID": "0199a51f-4c23-7de8-b3a9-1122334455aa",
            "URL": "https://images.example-client.com/1234567/room-dbl-sea-1.jpg",
            "Status": "completed",
            "SubmittedAt": "2026-09-08T09:12:44.301882Z",
            "BatchID": "0199a51f-4c22-7de8-b3a9-0f1e2d3c4b5a",
            "HotelID": "0192fb17-5dc6-7abc-8def-123456789abc",
            "HotelName": "Hotel Bahia Azul",
            "RoomRef": "DBL-SEA",
            "Image": {
                "ID": "0199a51f-4c23-7de8-b3a9-1122334455aa",
                "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
                },
                "Presence": [
                    {
                        "Label": "adult",
                        "Confidence": 0.81
                    }
                ],
                "Safety": {
                    "Inappropriate": 0.02,
                    "OffTopic": null
                },
                "FeatureDetections": [
                    {
                        "Label": "sea_view",
                        "Confidence": 0.94
                    },
                    {
                        "Label": "balcony",
                        "Confidence": 0.88
                    }
                ]
            }
        }
    ],
    "Pagination": {
        "Total": 4,
        "Limit": 50,
        "Offset": 0
    }
}
Modified at 2026-09-14 07:24:05
Previous
Get vision images
Next
GetEnrichedHotelRequest
Built with