List File Pages Figures

GET 
/api/v1/files/:id/page-figures

List File Pages Figures

Request

Path Parameters

id uuidrequired

Query Parameters

project_id any
organization_id any

Cookie Parameters

session any

Responses

200

Successful Response

application/json

Schema

Schema

• Array [

figure_name Figure Name (string)required

The name of the figure

file_id uuidrequired

The ID of the file that the figure was taken from

page_index Page Index (integer)required

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

figure_size Figure Size (integer)required

The size of the figure in bytes

is_likely_noise Is Likely Noise (boolean)
Whether the figure is likely to be noise
Default value: false
confidence Confidence (number)required

The confidence of the figure

Possible values: <= 1

• ]

Example (from schema)

[
  {
    "figure_name": "string",
    "file_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "page_index": 0,
    "figure_size": 0,
    "is_likely_noise": false,
    "confidence": 0
  }
]

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}