Storage - Aryn Documentation

Please find the documentation for how to call the Storage APIs using the Aryn SDK below. All parameters are optional unless specified otherwise.

DocSet Functions

Functions for managing document sets (DocSets) which are collections of documents.

Create DocSet

Create a new DocSet to store documents.

Parameters

name

string

required

String name for the DocSet

properties

object

Optional dictionary of additional properties

schema

Schema

Optional Schema object defining document properties

prompts

object

Optional dictionary of prompts for the DocSet

Example

from aryn_sdk.client.client import Client

docset = client.create_docset(name="My DocSet")
docset_id = docset.docset_id

Return Value

A DocSetMetadata object containing:

docset_id

string

Unique identifier for the DocSet

name

string

Name of the DocSet

created

timestamp

Creation timestamp

readonly

boolean

Boolean indicating if DocSet is read-only

properties

object

Dictionary of custom properties

size

number

Size of DocSet in bytes

schema

Schema

Schema object defining document properties

prompts

object

Dictionary of prompts for the DocSet

Get DocSet

Retrieve metadata for a DocSet.

Parameters

docset_id

string

required

The unique identifier of the DocSet to retrieve

Example

docset = client.get_docset(docset_id="your-docset-id")

Return Value

A DocSetMetadata object containing:

docset_id

string

Unique identifier for the DocSet

name

string

Name of the DocSet

created

timestamp

Creation timestamp

readonly

boolean

Boolean indicating if DocSet is read-only

properties

object

Dictionary of custom properties

size

number

Size of DocSet in bytes

schema

Schema

Schema object defining document properties

prompts

object

Dictionary of prompts for the DocSet

Exceptions

HTTPError 403: “No Aryn API Key provided”
HTTPError 403: “Invalid Aryn API key”
HTTPError 403: “Expired Aryn API key”
HTTPError 404: “DocSet not found”
HTTPError 5xx: Internal Server Error

List DocSets

List all DocSets in the account.

Parameters

page_size

integer

default:"100"

Number of items per page

page_token

string

Token for pagination

name_eq

string

Filter DocSets by exact name match

Example

docsets = client.list_docsets().get_all()
for docset in docsets:
    print(f"DocSet: {docset.name}")

Return Value

A paginated list of DocSetMetadata objects, each containing:

docset_id

string

Unique identifier for the DocSet

name

string

Name of the DocSet

created

timestamp

Creation timestamp

readonly

boolean

Boolean indicating if DocSet is read-only

properties

object

Dictionary of custom properties

size

number

Size of DocSet in bytes

schema

Schema

Schema object defining document properties

prompts

object

Dictionary of prompts for the DocSet

Exceptions

HTTPError 403: “No Aryn API Key provided”
HTTPError 403: “Invalid Aryn API key”
HTTPError 403: “Expired Aryn API key”
HTTPError 5xx: Internal Server Error

Delete DocSet

Delete a DocSet and all its documents.

Parameters

docset_id

string

required

The unique identifier of the DocSet to delete

Example

client.delete_docset(docset_id="your-docset-id")

Return Value

The metadata of the deleted DocSet

Exceptions

HTTPError 403: “No Aryn API Key provided”
HTTPError 403: “Invalid Aryn API key”
HTTPError 403: “Expired Aryn API key”
HTTPError 404: “DocSet not found”
HTTPError 5xx: Internal Server Error

Document Functions

Functions for managing individual documents within DocSets.

Add Document

Add a single document to the Aryn platform. This API calls DocParse to partition the document, and automatically extracts any properties registered as part of the DocSet schema.

Parameters

file

BinaryIO | str | PathLike

required

A file opened in binary mode or a path specified as either a str or PathLike instance, or an HTTP URL indicating the document to add. The path can either be a local path or an Amazon S3 url starting with s3://. The URL can start with either https:// or http://. In the latter case, you must have boto3 installed and AWS credentials set up in your environment.

docset_id

str

required

The id of the DocSet into which to add the document.

options

str

DocParse options to use for partitioning the specified document. You can find more about specific options here

Example

doc = client.add_doc(file="/path/to/myfile.pdf", docset_id="your-docset-id")

Return Value

A DocumentMetadata object containing

account_id

string

Account identifier

doc_id

string

Document identifier

docset_id

string

Document set identifier

name

string

Document name

created_at

timestamp

Creation timestamp

size

number

Document size in bytes

content_type

string

MIME type of document

properties

object

Custom document properties

Exceptions

HTTPError 403: “No Aryn API Key provided”
HTTPError 403: “Invalid Aryn API key”
HTTPError 403: “Expired Aryn API key”
HTTPError 404: “DocSet not found”
HTTPError 5xx: Internal Server Error

List Documents

List all documents in a DocSet.

Parameters

docset_id

string

required

ID of the DocSet containing the documents

page_size

integer

default:"100"

Number of items per page

page_token

string

Token for pagination

Example

docs = client.list_docs(docset_id="your-docset-id")
for doc in docs:
    print(f"Document: {doc.name}")

Return Value

A paginated list of DocumentMetadata objects, each containing:

account_id

string

Account identifier

doc_id

string

Document identifier

docset_id

string

Document set identifier

name

string

Document name

created_at

timestamp

Creation timestamp

size

number

Document size in bytes

content_type

string

MIME type of document

properties

object

Custom document properties

Exceptions

HTTPError 403: “No Aryn API Key provided”
HTTPError 403: “Invalid Aryn API key”
HTTPError 403: “Expired Aryn API key”
HTTPError 404: “DocSet not found”
HTTPError 400: “Invalid filter parameters”
HTTPError 5xx: Internal Server Error

Get Document

Get a document by ID.

Parameters

docset_id

string

required

The unique identifier of the DocSet containing the document

doc_id

string

required

The unique identifier of the document to retrieve

include_elements

boolean

default:"true"

Boolean to include document elements

include_binary

boolean

default:"false"

Boolean to include binary data

Example

doc = client.get_doc(docset_id="your-docset-id", doc_id="your-doc-id")

Return Value

A Document object containing:

string

Document identifier

elements

array

List of document elements

properties

object

Document properties

binary_data

binary

Optional binary content of the document

Exceptions

HTTPError 403: “No Aryn API Key provided”
HTTPError 403: “Invalid Aryn API key”
HTTPError 403: “Expired Aryn API key”
HTTPError 404: “Document not found”
HTTPError 5xx: Internal Server Error

Delete Document

Delete a document by ID.

Parameters

docset_id

string

required

The unique identifier of the DocSet containing the document

doc_id

string

required

The unique identifier of the document to delete

Example

client.delete_doc(docset_id="your-docset-id", doc_id="your-doc-id")

Return Value

The metadata of the deleted document

Exceptions

HTTPError 403: “No Aryn API Key provided”
HTTPError 403: “Invalid Aryn API key”
HTTPError 403: “Expired Aryn API key”
HTTPError 404: “Document not found”
HTTPError 5xx: Internal Server Error

Get Document Binary

Get the binary content of a document.

Parameters

docset_id

string

required

The unique identifier of the DocSet containing the document

doc_id

string

required

The unique identifier of the document to retrieve

file

string

required

The file object to write the binary content to

Example

output = "output.pdf"
client.get_doc_binary(docset_id="your-docset-id", doc_id="your-doc-id", file=output)

Return Value

The binary content of the document

Exceptions

HTTPError 403: “No Aryn API Key provided”
HTTPError 403: “Invalid Aryn API key”
HTTPError 403: “Expired Aryn API key”
HTTPError 404: “Document not found”
HTTPError 5xx: Internal Server Error

Properties Functions

Functions for managing document properties.

Update Document Properties

Update properties of a document.

Parameters

docset_id

string

required

The unique identifier of the DocSet containing the document

doc_id

string

required

The unique identifier of the document to update

updates

array

required

List of ReplaceOperation objects defining property updates

Example

from aryn_sdk.types import ReplaceOperation

updates = [
    ReplaceOperation(
        path="/properties/status",
        value="reviewed"
    )
]
client.update_doc_properties(
    docset_id="your-docset-id",
    doc_id="your-doc-id",
    operations=updates
)

Return Value

The updated Document object containing:

string

Document identifier

elements

array

List of document elements

properties

object

Document properties

binary_data

binary

Optional binary content of the document

Exceptions

HTTPError 403: “No Aryn API Key provided”
HTTPError 403: “Invalid Aryn API key”
HTTPError 403: “Expired Aryn API key”
HTTPError 404: “Document not found”
HTTPError 5xx: Internal Server Error

Extract Properties

Extract properties from a document.

Parameters

docset_id

string

required

The unique identifier of the DocSet containing the documents

schema

object

required

Schema object defining properties to extract

Example

from aryn_sdk.types.schema import Schema, SchemaField

schema = Schema(fields=[
    SchemaField(name="category", field_type="string")
])
client.extract_properties(docset_id="your-docset-id", schema=schema)

Return Value

A job status object containing:

exit_status: The exit status of the job

Exceptions

HTTPError 403: “No Aryn API Key provided”
HTTPError 403: “Invalid Aryn API key”
HTTPError 403: “Expired Aryn API key”
HTTPError 404: “DocSet not found”
HTTPError 5xx: Internal Server Error

Delete Properties

Delete properties from a document.

Parameters

docset_id

string

required

The unique identifier of the DocSet containing the documents

schema

object

required

Schema object defining properties to delete

Example

client.delete_properties(docset_id="your-docset-id", schema=schema)

Return Value

A job status object

Exceptions

HTTPError 403: “No Aryn API Key provided”
HTTPError 403: “Invalid Aryn API key”
HTTPError 403: “Expired Aryn API key”
HTTPError 404: “DocSet not found”
HTTPError 5xx: Internal Server Error

Client Options

Parameters

region: A string that specifies the region to use for the DocParse server. Valid values are US, EU, and None. Default is None.
timeout: A float that specifies the timeout in seconds for the client. Default is 240.0.

Example

from aryn_sdk.client import Client
client = Client(region="EU", timeout=240.0)

Aryn SDK Reference

​DocSet Functions

​Create DocSet

​Get DocSet

​List DocSets

​Delete DocSet

​Document Functions

​Add Document

​List Documents

​Get Document

​Delete Document

​Get Document Binary

​Properties Functions

​Update Document Properties

​Extract Properties

​Delete Properties

​Client Options

DocSet Functions

Create DocSet

Get DocSet

List DocSets

Delete DocSet

Document Functions

Add Document

List Documents

Get Document

Delete Document

Get Document Binary

Properties Functions

Update Document Properties

Extract Properties

Delete Properties

Client Options