Add Document
Add a new document to Skribble.skribble.document.add(document_data: DocumentRequest) -> DocumentResponse
skribble.document.add(documentData: Types.DocumentRequest): Promise<Types.DocumentResponse>
Request Object
Response Object
Show DocumentResponse properties
Show DocumentResponse properties
string
required
ID of the Document object
string
ID of the previous version of the Document object
string
required
Given title of the document
string
required
Content type of the document (always application/pdf)
number
required
Size in bytes of the document
number
Number of pages of the document
number
Width of the document in pixel
number
Height of the document in pixel
{ name?: string; status?: string; position?: Position }[]
PDF AcroForm signature fields found in the document
string[]
required
Array of users with read access
string[]
required
Array of users with write access
string
required
Timestamp at which the document was created
string
Timestamp at which the document was last updated
Get Document
Retrieve document metadata by ID.skribble.document.get(document_id: str) -> DocumentResponse
skribble.document.get(documentId: string): Promise<Types.DocumentResponse>
Response Object
Show DocumentResponse properties
Show DocumentResponse properties
string
required
ID of the Document object
string
ID of the previous version of the Document object
string
required
Given title of the document
string
required
Content type of the document (always application/pdf)
number
required
Size in bytes of the document
number
Number of pages of the document
number
Width of the document in pixel
number
Height of the document in pixel
{ name?: string; status?: string; position?: Position }[]
PDF AcroForm signature fields found in the document
string[]
required
Array of users with read access
string[]
required
Array of users with write access
string
required
Timestamp at which the document was created
string
Timestamp at which the document was last updated
Download Document
Download document content by ID.skribble.document.download(document_id: str, content_type: str = "blob") -> Union[bytes, str]
skribble.document.download(documentId: string, contentType?: 'blob' | 'base64'): Promise<Blob | string>
Preview Document
Get a preview image of a document page.skribble.document.preview(document_id: str, page_id: int, scale: int = 20, max_retries: int = 10, retry_delay: int = 2) -> bytes
skribble.document.preview(documentId: string, pageId: number, scale?: number, maxRetries?: number, retryDelay?: number): Promise<Blob>
List Documents
List all documents with optional pagination.skribble.document.list(limit: int = None) -> List[DocumentResponse]
skribble.document.list(limit?: number): Promise<Types.DocumentResponse[]>
Response Object
Show DocumentResponse properties
Show DocumentResponse properties
string
required
ID of the Document object
string
ID of the previous version of the Document object
string
required
Given title of the document
string
required
Content type of the document (always application/pdf)
number
required
Size in bytes of the document
number
Number of pages of the document
number
Width of the document in pixel
number
Height of the document in pixel
{ name?: string; status?: string; position?: Position }[]
PDF AcroForm signature fields found in the document
string[]
required
Array of users with read access
string[]
required
Array of users with write access
string
required
Timestamp at which the document was created
string
Timestamp at which the document was last updated
Delete Document
Delete a document by ID.skribble.document.delete(document_id: str) -> None
skribble.document.delete(documentId: string): Promise<void>