API Documentation
FlashDocs Document Configuration
- GETList Document Configurations
- POSTCreate Google Slides FlashDocs Template/Library
- POSTCreate PowerPoint FlashDocs Template/Library
- GETGet Document Configuration Full Data
- PUTUpdate Document Configuration
- DELDelete Document Configuration
- GETGet Slide Configuration Metadata
- POSTCompute Markdown Mapping for Slide
- POSTValidate Text Placeholder Manual Insertion
FlashDocs Document Configuration
Get Slide Configuration Metadata
GET
/
v1
/
slides
/
{slide_id}
Copy
curl --request GET \
--url https://api.flashdocs.ai/v1/slides/{slide_id} \
--header 'Authorization: Bearer <token>'
Copy
{
"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
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
Query Parameters
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
The response is of type object
.
Copy
curl --request GET \
--url https://api.flashdocs.ai/v1/slides/{slide_id} \
--header 'Authorization: Bearer <token>'
Copy
{
"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>"
}
Assistant
Responses are generated using AI and may contain mistakes.