Sign in
Page Figures

List File Pages Figures

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

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

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

Changed in 1 of the 33 revisions of this API.2

  • b17341164de92See the full diff
    • ○

      added the optional property detail/items/ctx to the response with the 422 status

      response-optional-property-added

    • ○

      added the optional property detail/items/input to the response with the 422 status

      response-optional-property-added

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog