Get frame UI elements

Get all elements for a specific frame (full element tree).

Get frame UI elements

cURL

curl --request GET \
  --url https://api.example.com/frames/{frame_id}/elements

200

{
  "data": [
    {
      "id": 123,
      "frame_id": 123,
      "source": "<string>",
      "role": "<string>",
      "text": "<string>",
      "parent_id": 123,
      "depth": 123,
      "bounds": {
        "left": 123,
        "top": 123,
        "width": 123,
        "height": 123
      },
      "confidence": 123,
      "sort_order": 123
    }
  ],
  "pagination": {
    "limit": 123,
    "offset": 123,
    "total": 123
  }
}

Path Parameters

frame_id · integer · required

Query Parameters

source · string | null

Response

200 - application/json

OK

data · object[] · required

Show child attributes

pagination · object · required

Show child attributes