Get Document Configuration Full Data

GET

documents

{document_id}

full

curl --request GET \
  --url https://api.flashdocs.ai/v1/documents/{document_id}/full \
  --header 'Authorization: Bearer <token>'

{
  "id": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "organization_id": "<string>",
  "type": "template",
  "created_by": "",
  "name": "<string>",
  "description": "<string>",
  "status": "deployed",
  "google_document_id": "<string>",
  "knowledge_base_item_ids": [],
  "format": "google",
  "slides": [],
  "questions": [],
  "knowledge_base_items": []
}

Authorizations

Authorization

string

header

required

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

Path Parameters

document_id

string

required

Query Parameters

include_slides

boolean

default:false

include_questions

boolean

default:false

include_knowledge_base

boolean

default:false

include_embeddings

boolean

default:false

Response

200

application/json

Successful Response

organization_id

string

required

ID of the organization this document belongs to

type

enum<string>

required

Type of the document (template or library)

Available options:

template,

library

name

string

required

Name of the document

description

string

required

Detailed description of the document

string

Unique identifier

created_at

string

Creation timestamp

updated_at

string

Last update timestamp

created_by

string

default:

Email of user (non FlashDocs) who created the document

status

enum<string>

default:in_progress

Current status of the document

Available options:

deployed,

in_progress

google_document_id

string | null

ID of the corresponding Google Slides document

knowledge_base_item_ids

string[]

item_id for each knowledge base item associated with document.

format

enum<string>

default:google

Format of the document google vs microsoft

Available options:

google,

microsoft

slides

object[]

slides.document_id

string

required

ID of the document this slide belongs to

slides.organization_id

string

required

ID of the organization this document belongs to

slides.index

integer

required

Position of the slide in the document

slides.description

string

required

Detailed description of the slide

slides.format

enum<string>

required

Format of the document google vs microsoft

Available options:

google,

microsoft

slides.id

string

Unique identifier

slides.created_at

string

Creation timestamp

slides.updated_at

string

Last update timestamp

slides.format_data

object

Format of the document google vs microsoft

slides.text_placeholders

object[]

List of text placeholder customization items.

slides.image_placeholders

object[]

List of image placeholder customization items.

slides.chart_placeholders

object[] | null

List of chart placeholder customization items.

slides.looker_image_placeholders

object[] | null

List of looker image placeholder customization items.

slides.embedding

number[]

Embedding of the slide description

questions

object[]

knowledge_base_items

object[]

Create PowerPoint FlashDocs Template/Library Update Document Configuration

curl --request GET \
  --url https://api.flashdocs.ai/v1/documents/{document_id}/full \
  --header 'Authorization: Bearer <token>'

{
  "id": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "organization_id": "<string>",
  "type": "template",
  "created_by": "",
  "name": "<string>",
  "description": "<string>",
  "status": "deployed",
  "google_document_id": "<string>",
  "knowledge_base_item_ids": [],
  "format": "google",
  "slides": [],
  "questions": [],
  "knowledge_base_items": []
}

API Documentation

FlashDocs Document Configuration

Generate

Get Document Configuration Full Data

Authorizations

Path Parameters

Query Parameters

Response