Documents

API reference for document operations

Add Document

Add a new document to Skribble.

Python

skribble.document.add(document_data: DocumentRequest) -> DocumentResponse

request · Request Object

Show DocumentRequest properties

title · string · required

Title of the document

content_type · string

Content type of bytes sent in content

content · string

Base64 encoded bytes of document

file_url · string

Publicly accessible URL for document download

write_access · string[]

E-mail addresses with write access to the object

response · Response Object

Show DocumentResponse properties

id · string · required

ID of the Document object

parent_id · string

ID of the previous version of the Document object

title · string · required

Given title of the document

content_type · string · required

Content type of the document (always application/pdf)

size · number · required

Size in bytes of the document

page_count · number

Number of pages of the document

page_width · number

Width of the document in pixel

page_height · number

Height of the document in pixel

signature_fields · { name?: string; status?: string; position?: Position }[]

PDF AcroForm signature fields found in the document

read_access · string[] · required

Array of users with read access

write_access · string[] · required

Array of users with write access

created_at · string · required

Timestamp at which the document was created

updated_at · string

Timestamp at which the document was last updated

Get Document

Retrieve document metadata by ID.

Python

skribble.document.get(document_id: str) -> DocumentResponse

response · Response Object

Show DocumentResponse properties

id · string · required

ID of the Document object

parent_id · string

ID of the previous version of the Document object

title · string · required

Given title of the document

content_type · string · required

Content type of the document (always application/pdf)

size · number · required

Size in bytes of the document

page_count · number

Number of pages of the document

page_width · number

Width of the document in pixel

page_height · number

Height of the document in pixel

signature_fields · { name?: string; status?: string; position?: Position }[]

PDF AcroForm signature fields found in the document

read_access · string[] · required

Array of users with read access

write_access · string[] · required

Array of users with write access

created_at · string · required

Timestamp at which the document was created

updated_at · string

Timestamp at which the document was last updated

Download Document

Download document content by ID.

Python

skribble.document.download(document_id: str, content_type: str = "blob") -> Union[bytes, str]

Preview Document

Get a preview image of a document page.

Python

skribble.document.preview(document_id: str, page_id: int, scale: int = 20, max_retries: int = 10, retry_delay: int = 2) -> bytes

List Documents

List all documents with optional pagination.

Python

skribble.document.list(limit: int = None) -> List[DocumentResponse]

response · Response Object

Show DocumentResponse properties

id · string · required

ID of the Document object

parent_id · string

ID of the previous version of the Document object

title · string · required

Given title of the document

content_type · string · required

Content type of the document (always application/pdf)

size · number · required

Size in bytes of the document

page_count · number

Number of pages of the document

page_width · number

Width of the document in pixel

page_height · number

Height of the document in pixel

signature_fields · { name?: string; status?: string; position?: Position }[]

PDF AcroForm signature fields found in the document

read_access · string[] · required

Array of users with read access

write_access · string[] · required

Array of users with write access

created_at · string · required

Timestamp at which the document was created

updated_at · string

Timestamp at which the document was last updated

Delete Document

Delete a document by ID.

Python

skribble.document.delete(document_id: str) -> None