GET
/
v1
/
slides
/
{slide_id}
curl --request GET \
  --url https://api.flashdocs.ai/v1/slides/{slide_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "document_id": "<string>",
  "organization_id": "<string>",
  "format_data": {
    "google_document_id": "<string>",
    "google_slide_id": "<string>"
  },
  "index": 123,
  "description": "<string>",
  "text_placeholders": [],
  "image_placeholders": [],
  "chart_placeholders": [
    {
      "id": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "spreadsheet_google_document_id": "<string>",
      "prompt": "<string>",
      "attributes": {}
    }
  ],
  "looker_image_placeholders": [
    {
      "id": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "alt_text": "<string>",
      "dashboard_id": "<string>",
      "component_index": 123,
      "width": 800,
      "height": 600,
      "dashboard_filters": "<string>",
      "dashboard_style": "<string>",
      "crop_data": {
        "left_crop": {
          "x": 123,
          "y": 123
        },
        "right_crop": {
          "x": 123,
          "y": 123
        },
        "size": {
          "width": 123,
          "height": 123
        }
      },
      "attributes": {}
    }
  ],
  "table_placeholders": [
    {
      "id": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "num_rows": 123,
      "num_columns": 123,
      "table_height": 123,
      "table_width": 123,
      "alt_text": "<string>"
    }
  ],
  "embedding": [
    123
  ],
  "format": "google",
  "tree_nodes": [
    {
      "id": 0,
      "paragraph_line_capacity": 5,
      "new_line_capacity": 3,
      "character_per_line_capacity": 53,
      "text": "[header]",
      "children_ids": [
        123
      ]
    }
  ],
  "tree_markdown_representation": "<string>",
  "placeholder_hierarchy_representation": "<string>",
  "preview_link": "<string>"
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
slide_id
string
required

Query Parameters

​
embedding
boolean
default:false
​
tree
boolean
default:false
​
tree_representation_type
enum<string> | null

Preference for how to represent the canonical markdown of the tree. If not specified and the tree is requested, paragraph type is chosen

Available options:
paragraph,
list,
mixed

Response

200
application/json
Successful Response
​
document_id
string
required

ID of the document this slide belongs to

​
organization_id
string
required

ID of the organization this document belongs to

​
index
integer
required

Position of the slide in the document

​
description
string
required

Detailed description of the slide

​
format
enum<string>
required

Format of the document google vs microsoft

Available options:
google,
microsoft
​
id
string

Unique identifier

​
created_at
string

Creation timestamp

​
updated_at
string

Last update timestamp

​
format_data
object

Format of the document google vs microsoft

​
text_placeholders
object[]

List of text placeholder customization items.

​
image_placeholders
object[]

List of image placeholder customization items.

​
chart_placeholders
object[] | null

List of chart placeholder customization items.

​
looker_image_placeholders
object[] | null

List of looker image placeholder customization items.

​
table_placeholders
object[] | null

List of table placeholder customization items.

​
embedding
number[] | null

Embedding of the slide description

​
tree_nodes
object[] | null

Tree nodes of the document

​
tree_markdown_representation
string | null

Markdown representation of the tree

​
placeholder_hierarchy_representation
string | null

Placeholder hierarchy representation of the slide

​
preview_link
string | null

URL link to the preview of the slide.