Sign in
Page Figures

List File Pages Figures

Changed on

List metadata for all figures from all pages of a file.

get/api/v1/files/{id}/page-figures

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Query parameters

project_idstring uuid nullable
organization_idstring uuid nullable

Cookies

sessionstring nullable

Response

Successful Response

figure_namestring required

The name of the figure

file_idstring uuid required

The ID of the file that the figure was taken from

page_indexinteger required

The index of the page for which the figure is taken (0-indexed)

figure_sizeinteger required

The size of the figure in bytes

is_likely_noiseboolean

Whether the figure is likely to be noise

confidencenumber required

The confidence of the figure

metadataobject nullable

Metadata for the figure

Changes