Skip to content
Changelog

Report a bug

Aryn integration: operations for AI agents

Aryn connects to Type.com as an integration. This page lists the 28 operations documented for Claude and Codex in Type.com: 10 read, 13 write, 5 destructive.

About Aryn

Aryn is an AI-powered platform for document parsing, data extraction, and analytics, enabling users to process and query unstructured documents at scale.

Categories: Analytics & Data, Documents & Forms

How to connect Aryn to Type.com

Access
Organization connection: one shared account for the workspace.

To add the connection, follow the steps in Space connections.

Documented operations

28 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

28 operations listed.

Partition

  • Read

    Get Async Task Status

    GET /v1/async/result/{task_id}

  • Read

    List Async Tasks

    GET /v1/async/list

  • Write

    Partition Document

    POST /v1/document/partition

  • Write

    Submit Document for Async Partitioning

    POST /v1/async/submit/document/partition

  • Destructive

    Cancel Async Task

    POST /v1/async/cancel/{task_id}

Document

  • Read

    List Docs

    List documents in a DocSet with pagination. Args: docsetid: The ID of the DocSet nexttoken: Token for the next page of results pagesize: Number of items per page (default 100) filterdict: JSON string containing filter parameters Returns: List[DocumentMetadata]: Paginated list of…

  • Read

    Get Async Task Status

    GET /v1/async/result/{task_id}

  • Read

    List Async Tasks for Add Doc

    GET /v1/async/list

  • Read

    Get Doc

    Get a document from a DocSet. Args: docsetid: The ID of the DocSet docid: The ID of the document Returns: Document: Document data including elements, embeddings, metadata, and binary data

  • Read

    Get Doc Binary

    Get binary original source file with range request support. Args: docsetid: The ID of the DocSet docid: The ID of the document Returns: the content

  • Write

    Add Doc

    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. This method can take some time, so callers should consider invoking it via the async endpoint.

  • Write

    Submit Document for Async Add Doc

    POST /v1/async/submit/storage/docsets/{docset_id}/docs

  • Write

    Update Doc Properties

    Updates the properties of an individual document in place. This call can be used to replace one or more properties with a new value. The update syntax is based on JSON Patch, though we currently support only the replace operation.

  • Destructive

    Cancel Async Task for Add Doc

    POST /v1/async/cancel/{task_id}

  • Destructive

    Delete Doc

    Remove a document from a DocSet and delete the file. Args: docsetid: The ID of the DocSet docid: The ID of the document to remove

Doc Set

  • Read

    List Docsets

    List all DocSets in the system. Returns: list[DocSetMetadata]: A list of DocSet metadata objects Note: Will be paginated in v2

  • Read

    Get Docset

    Get metadata for a specific DocSet. Args: docsetid (str): The unique identifier of the DocSet Returns: DocSetMetadata: Metadata object containing DocSet information

  • Write

    Create Docset

    Create a new DocSet. Args: name (str): The name for the new DocSet Returns: DocSetMetadata: Metadata of the newly created DocSet

  • Write

    Update Docset

    Updates the metadata associated with a docset. Currently, this will replace any field that is set (non-None) in the update. In v2 we will add support for proper update masks a la AIP-134.

  • Write

    Clone Docset

    POST /v1/storage/docsets/{docset_id}/clone

  • Write

    Set Readonly Docset

    Sets the read-only status of the DocSet.

  • Destructive

    Delete Docset

    Delete a specific DocSet. Args: docsetid (str): The unique identifier of the DocSet Returns: DocSetMetadata: Metadata object containing DocSet information

Query

  • Read

    Search

    Run a search query.

  • Write

    Generate Plan

    Generate a query plan for the given query, but do not run it.

  • Write

    Edit Plan

    Take an existing plan and user feedback to rewrite it.

  • Write

    Run Query

    Run the given query. If the stream parameter is set to true, the result will be streamed back to the client as a series of SSE events. Otherwise, the result will be returned as a QueryResult object.

Transform

  • Write

    Extract Properties

    Extract properties given in the schema from the DocSet.

  • Destructive

    Delete Properties

    Delete properties given in the schema from the DocSet.

See How connections work for access and permissions, or browse all integrations.