List context image segments

get

https://api.lingohub.com/v2/context-images/{contextImageId}/segments

Lists the segments linked to the image, including SUGGESTION candidates that are not attachments. Highlight boxes use normalized fractions of image dimensions, not pixels. Change links with attachContextImage and detachContextImage. Missing or inconsistent parent images return 404; inconsistent links are excluded. Requires project-level context-image view permission.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

contextImageId

string

required

^ci_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a context image, a valid value would be : ci_0197c8f2-5a6b-7cde-8f12-3456789abcde

Query Params

filter

object

Filters and sorts the list: URL-encoded JSON of the schema ContextImageSegmentFilter. where holds exactly one _and or _or with an array of clauses; a clause is another _and/_or or a field with exactly one operator. sort lists fields with + (ascending) or - (descending). An unsupported field, operator or value answers 400 invalid_filter with a pointer into the filter.

Field	Type	Operators	Sort
`context_image_segment[context_image_id]`	id	`_eq` `_ne` `_in` `_nin`	–
`context_image_segment[created_at]`	timestamp	`_eq` `_lt` `_gt` `_lte` `_gte` `_within` `_null` `_nnull`	yes
`context_image_segment[is_highlighted]`	boolean	`_true` `_false`	–
`context_image_segment[language_code]`	language code	`_eq` `_ne` `_in` `_nin` `_like` `_nlike` `_ilike` `_nilike` `_contains` `_ncontains` `_icontains` `_nicontains` `_starts` `_ends` `_blank` `_nblank` `_gt`	–
`context_image_segment[link_type]`	KEY_BASED \| TEXT_BASED \| IMAGE_BASED \| MANUAL \| SUGGESTION	`_eq` `_ne` `_in` `_nin`	–
`context_image_segment[segment_id]`	id	`_eq` `_ne` `_in` `_nin`	–
`context_image_segment[updated_at]`	timestamp	`_eq` `_lt` `_gt` `_lte` `_gte` `_within` `_null` `_nnull`	yes

cursor

string

Opaque pagination cursor from the next_cursor field of a previous response. Omit for the first page.

limit

int32

1 to 100

Defaults to 20

Maximum number of items to return per page (1-100).

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200Context image segments retrieved.

400The request is malformed: an unknown or invalid query parameter, an invalid id in the path, or a body that is not valid JSON. code names the problem, errors the parameter or field.

401Invalid or missing API key.

403Insufficient permissions.

404The resource does not exist, or the API key cannot see it.

429The API rate limit was exceeded. Wait for the number of seconds given in the Retry-After header, then retry.

500An unexpected internal server error occurred.

503The service is temporarily unavailable. Retry after the number of seconds in the Retry-After header.