# List context images

`GET https://api.lingohub.com/v1/{workspaceUrl}/projects/{projectUrl}/contextImages`

LingoHub API V1 · [Context Images](https://developers.lingohub.com/reference/v1/operations/tags/context-images.md) · operation `v1ContextImagesGetContextImages`

Retrieves a list of the context images.
This is a paginated endpoint; see the `page` and `size` query parameters to control pagination.

## Parameters

| Parameter | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| `workspaceUrl` | path | yes | string | workspaceUrl |
| `projectUrl` | path | yes | string | projectUrl |
| `urlFilter` | query | no | string | a filter based on UrlFilter |
| `page` | query | no | integer | Zero-based page index (0..N) |
| `sort` | query | no | string | Sorting criteria in the format: property,(asc\|desc). Default sort order is ascending. Multiple sort criteria are supported. |
| `size` | query | no | integer | The size of the page to be returned |

## Example request

```sh
curl --request GET \
  --url https://api.lingohub.com/v1/WORKSPACE_URL/projects/PROJECT_URL/contextImages \
  --header 'Authorization: Bearer YOUR_API_KEY'
```

## Responses

- `200`: OK: Returns a paginated list of the context images for the specified project.

## OpenAPI definition

The complete definition of this operation, with every schema it references:

````json
{
  "openapi": "3.1.0",
  "info": {
    "title": "LingoHub API V1",
    "version": "1"
  },
  "servers": [
    {
      "url": "https://api.lingohub.com",
      "description": "Generated server url"
    }
  ],
  "tags": [
    {
      "name": "Context Images",
      "description": "Endpoints for the operations that can be performed on the context images"
    }
  ],
  "paths": {
    "/v1/{workspaceUrl}/projects/{projectUrl}/contextImages": {
      "get": {
        "tags": [
          "Context Images"
        ],
        "summary": "List context images",
        "description": "Retrieves a list of the context images.\nThis is a paginated endpoint; see the `page` and `size` query parameters to control pagination.",
        "operationId": "v1ContextImagesGetContextImages",
        "parameters": [
          {
            "name": "workspaceUrl",
            "in": "path",
            "description": "workspaceUrl",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "projectUrl",
            "in": "path",
            "description": "projectUrl",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "urlFilter",
            "in": "query",
            "description": "a filter based on UrlFilter",
            "required": false,
            "schema": {
              "type": "string"
            },
            "example": "to fetch context images not bound to any segments: urlFilter={\"where\":{\"_and\":[{\"contextImage[segments]\":{\"_npresent\":true}}]}}"
          },
          {
            "name": "page",
            "in": "query",
            "description": "Zero-based page index (0..N)",
            "required": false,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "sort",
            "in": "query",
            "description": "Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "size",
            "in": "query",
            "description": "The size of the page to be returned",
            "required": false,
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK: Returns a paginated list of the context images for the specified project.",
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/PageResponseV1ContextImageResponse"
                }
              }
            }
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "PageResponseV1ContextImageResponse": {
        "type": "object",
        "properties": {
          "content": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/V1ContextImageResponse"
            }
          },
          "contentSize": {
            "type": "integer",
            "format": "int32"
          },
          "empty": {
            "type": "boolean"
          },
          "first": {
            "type": "boolean"
          },
          "last": {
            "type": "boolean"
          },
          "next": {
            "type": "boolean"
          },
          "pageNumber": {
            "type": "integer",
            "format": "int32"
          },
          "pageSize": {
            "type": "integer",
            "format": "int32"
          },
          "totalPages": {
            "type": [
              "integer",
              "null"
            ],
            "format": "int32"
          },
          "totalElements": {
            "type": [
              "integer",
              "null"
            ],
            "format": "int64"
          }
        },
        "required": [
          "content",
          "contentSize",
          "empty",
          "first",
          "last",
          "next",
          "pageNumber",
          "pageSize",
          "totalElements",
          "totalPages"
        ]
      },
      "V1ContextImageResponse": {
        "type": "object",
        "description": "Response object containing details of a context image including its connection status and metadata",
        "properties": {
          "id": {
            "type": "string",
            "description": "The unique identifier of the context image in the format 'ci_<encrypted_id>'",
            "example": "ci_18USq6822XIv-19847171"
          },
          "name": {
            "type": "string",
            "description": "The original filename of the uploaded context image"
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "description": "Optional user-provided description of the context image",
            "example": "Screenshot of the main dashboard showing the navigation menu"
          },
          "imageUrl": {
            "type": "string",
            "description": "The full URL to view the context image via Cloudflare Images CDN"
          },
          "projectTitle": {
            "type": "string",
            "description": "The title of the project this context image belongs to"
          },
          "languageCode": {
            "type": "string",
            "description": "The ISO 639-1 language code (with optional regional variant) this context image is associated with",
            "example": "en"
          },
          "connectedSegmentLanguagesCount": {
            "type": "integer",
            "format": "int64",
            "description": "The count of text segments that are definitively connected to this context image"
          },
          "segmentLanguagesSuggestionsCount": {
            "type": "integer",
            "format": "int64",
            "description": "The count of text segment connection suggestions pending review"
          },
          "source": {
            "$ref": "#/components/schemas/ContextSource",
            "description": "The source channel through which the context image was uploaded"
          },
          "uploadStatus": {
            "$ref": "#/components/schemas/UploadStatus",
            "description": "The current upload processing status of the image"
          },
          "textDetectionStatus": {
            "$ref": "#/components/schemas/TextDetectionStatus",
            "description": "The current status of the OCR text detection process"
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "description": "The timestamp when the context image was originally uploaded"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "description": "The timestamp when the context image was last updated"
          }
        },
        "required": [
          "connectedSegmentLanguagesCount",
          "createdAt",
          "description",
          "id",
          "imageUrl",
          "languageCode",
          "name",
          "projectTitle",
          "segmentLanguagesSuggestionsCount",
          "source",
          "textDetectionStatus",
          "updatedAt",
          "uploadStatus"
        ]
      },
      "ContextSource": {
        "type": "string",
        "enum": [
          "WEB",
          "API",
          "FIGMA",
          "SDK"
        ]
      },
      "UploadStatus": {
        "type": "string",
        "enum": [
          "PROCESSING",
          "DONE",
          "ERROR"
        ]
      },
      "TextDetectionStatus": {
        "type": "string",
        "enum": [
          "SCHEDULED",
          "PROCESSING",
          "DONE",
          "ERROR"
        ]
      }
    },
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "description": "API key authentication. Create API keys in your LingoHub workspace settings. Keys use the `lh-api_` prefix. Pass the full key as the Bearer token.",
        "scheme": "bearer"
      }
    }
  }
}
````
