v1

latestOpenAPI 3.1.02026-08-06163531.4 KB
project

Retrieve segments of a specific project

Retrieve segments of a specific project, file and language by its UUID from the verify API

This endpoint retrieves segments of a specific project from the verify API using its UUID. File UUID and Language UUID are also required to retrieve the segments, and the response is paginated.

Headers:

  • Authorization (str): HTTP bearer - API token for user authentication.

Args:

  • project_id (UUID): The UUID of the project to retrieve.
  • file_id (UUID): The UUID of the file to retrieve.
  • language_id (UUID): The UUID of the language to retrieve.
  • page (int, optional): Page number for the list of segments. Defaults to 1.
  • page_size (int, optional): Number of segments per page. Defaults to 100.
  • api_key (str): API key for authentication.

Returns:

  • GetSegmentResponse: A dictionary containing the segments data.
get/project/{project_id}/segments/{file_id}/{language_id}

Path parameters

project_idstring uuid required
file_idstring uuid required
language_idstring uuid required

Query parameters

pageinteger
page_sizeinteger

Response

Successful Response

file_idstring uuid required
language_idstring uuid required