Rossum API SDK Logo

Contents:

  • API Clients
    • Overview
    • Asynchronous Client
      • AsyncRossumAPIClient
        • AsyncRossumAPIClient.retrieve_queue()
        • AsyncRossumAPIClient.list_queues()
        • AsyncRossumAPIClient.create_new_queue()
        • AsyncRossumAPIClient.delete_queue()
        • AsyncRossumAPIClient.import_document()
        • AsyncRossumAPIClient.upload_document()
        • AsyncRossumAPIClient.retrieve_upload()
        • AsyncRossumAPIClient.export_annotations_to_json()
        • AsyncRossumAPIClient.export_annotations_to_file()
        • AsyncRossumAPIClient.list_organizations()
        • AsyncRossumAPIClient.retrieve_organization()
        • AsyncRossumAPIClient.retrieve_own_organization()
        • AsyncRossumAPIClient.list_schemas()
        • AsyncRossumAPIClient.retrieve_schema()
        • AsyncRossumAPIClient.create_new_schema()
        • AsyncRossumAPIClient.delete_schema()
        • AsyncRossumAPIClient.list_users()
        • AsyncRossumAPIClient.retrieve_user()
        • AsyncRossumAPIClient.create_new_user()
        • AsyncRossumAPIClient.list_annotations()
        • AsyncRossumAPIClient.search_for_annotations()
        • AsyncRossumAPIClient.retrieve_annotation()
        • AsyncRossumAPIClient.poll_annotation()
        • AsyncRossumAPIClient.poll_annotation_until_imported()
        • AsyncRossumAPIClient.poll_task()
        • AsyncRossumAPIClient.poll_task_until_succeeded()
        • AsyncRossumAPIClient.retrieve_task()
        • AsyncRossumAPIClient.upload_and_wait_until_imported()
        • AsyncRossumAPIClient.start_annotation()
        • AsyncRossumAPIClient.update_annotation()
        • AsyncRossumAPIClient.update_part_annotation()
        • AsyncRossumAPIClient.bulk_update_annotation_data()
        • AsyncRossumAPIClient.confirm_annotation()
        • AsyncRossumAPIClient.create_new_annotation()
        • AsyncRossumAPIClient.delete_annotation()
        • AsyncRossumAPIClient.cancel_annotation()
        • AsyncRossumAPIClient.retrieve_document()
        • AsyncRossumAPIClient.retrieve_document_content()
        • AsyncRossumAPIClient.create_new_document()
        • AsyncRossumAPIClient.list_document_relations()
        • AsyncRossumAPIClient.retrieve_document_relation()
        • AsyncRossumAPIClient.create_new_document_relation()
        • AsyncRossumAPIClient.update_document_relation()
        • AsyncRossumAPIClient.update_part_document_relation()
        • AsyncRossumAPIClient.delete_document_relation()
        • AsyncRossumAPIClient.list_relations()
        • AsyncRossumAPIClient.create_new_relation()
        • AsyncRossumAPIClient.list_workspaces()
        • AsyncRossumAPIClient.retrieve_workspace()
        • AsyncRossumAPIClient.create_new_workspace()
        • AsyncRossumAPIClient.delete_workspace()
        • AsyncRossumAPIClient.create_new_inbox()
        • AsyncRossumAPIClient.retrieve_email()
        • AsyncRossumAPIClient.import_email()
        • AsyncRossumAPIClient.list_email_templates()
        • AsyncRossumAPIClient.retrieve_email_template()
        • AsyncRossumAPIClient.create_new_email_template()
        • AsyncRossumAPIClient.list_connectors()
        • AsyncRossumAPIClient.retrieve_connector()
        • AsyncRossumAPIClient.create_new_connector()
        • AsyncRossumAPIClient.list_hooks()
        • AsyncRossumAPIClient.retrieve_hook()
        • AsyncRossumAPIClient.create_new_hook()
        • AsyncRossumAPIClient.update_part_hook()
        • AsyncRossumAPIClient.delete_hook()
        • AsyncRossumAPIClient.list_rules()
        • AsyncRossumAPIClient.retrieve_rule()
        • AsyncRossumAPIClient.create_new_rule()
        • AsyncRossumAPIClient.update_part_rule()
        • AsyncRossumAPIClient.delete_rule()
        • AsyncRossumAPIClient.list_user_roles()
        • AsyncRossumAPIClient.request_paginated()
        • AsyncRossumAPIClient.request_json()
        • AsyncRossumAPIClient.request()
        • AsyncRossumAPIClient.get_token()
        • AsyncRossumAPIClient.authenticate()
    • Synchronous Client
      • SyncRossumAPIClient
        • SyncRossumAPIClient.retrieve_queue()
        • SyncRossumAPIClient.list_queues()
        • SyncRossumAPIClient.create_new_queue()
        • SyncRossumAPIClient.delete_queue()
        • SyncRossumAPIClient.import_document()
        • SyncRossumAPIClient.upload_document()
        • SyncRossumAPIClient.retrieve_upload()
        • SyncRossumAPIClient.export_annotations_to_json()
        • SyncRossumAPIClient.export_annotations_to_file()
        • SyncRossumAPIClient.list_organizations()
        • SyncRossumAPIClient.retrieve_organization()
        • SyncRossumAPIClient.retrieve_own_organization()
        • SyncRossumAPIClient.retrieve_my_organization()
        • SyncRossumAPIClient.list_schemas()
        • SyncRossumAPIClient.retrieve_schema()
        • SyncRossumAPIClient.create_new_schema()
        • SyncRossumAPIClient.delete_schema()
        • SyncRossumAPIClient.list_users()
        • SyncRossumAPIClient.retrieve_user()
        • SyncRossumAPIClient.create_new_user()
        • SyncRossumAPIClient.retrieve_annotation()
        • SyncRossumAPIClient.list_annotations()
        • SyncRossumAPIClient.search_for_annotations()
        • SyncRossumAPIClient.poll_annotation()
        • SyncRossumAPIClient.poll_annotation_until_imported()
        • SyncRossumAPIClient.retrieve_task()
        • SyncRossumAPIClient.poll_task()
        • SyncRossumAPIClient.poll_task_until_succeeded()
        • SyncRossumAPIClient.upload_and_wait_until_imported()
        • SyncRossumAPIClient.start_annotation()
        • SyncRossumAPIClient.update_annotation()
        • SyncRossumAPIClient.update_part_annotation()
        • SyncRossumAPIClient.bulk_update_annotation_data()
        • SyncRossumAPIClient.confirm_annotation()
        • SyncRossumAPIClient.create_new_annotation()
        • SyncRossumAPIClient.delete_annotation()
        • SyncRossumAPIClient.cancel_annotation()
        • SyncRossumAPIClient.retrieve_document()
        • SyncRossumAPIClient.retrieve_document_content()
        • SyncRossumAPIClient.create_new_document()
        • SyncRossumAPIClient.list_document_relations()
        • SyncRossumAPIClient.retrieve_document_relation()
        • SyncRossumAPIClient.create_new_document_relation()
        • SyncRossumAPIClient.update_document_relation()
        • SyncRossumAPIClient.update_part_document_relation()
        • SyncRossumAPIClient.delete_document_relation()
        • SyncRossumAPIClient.list_relations()
        • SyncRossumAPIClient.create_new_relation()
        • SyncRossumAPIClient.list_workspaces()
        • SyncRossumAPIClient.retrieve_workspace()
        • SyncRossumAPIClient.create_new_workspace()
        • SyncRossumAPIClient.delete_workspace()
        • SyncRossumAPIClient.create_new_inbox()
        • SyncRossumAPIClient.retrieve_email()
        • SyncRossumAPIClient.import_email()
        • SyncRossumAPIClient.list_email_templates()
        • SyncRossumAPIClient.retrieve_email_template()
        • SyncRossumAPIClient.create_new_email_template()
        • SyncRossumAPIClient.list_connectors()
        • SyncRossumAPIClient.retrieve_connector()
        • SyncRossumAPIClient.create_new_connector()
        • SyncRossumAPIClient.list_hooks()
        • SyncRossumAPIClient.retrieve_hook()
        • SyncRossumAPIClient.create_new_hook()
        • SyncRossumAPIClient.update_part_hook()
        • SyncRossumAPIClient.delete_hook()
        • SyncRossumAPIClient.list_rules()
        • SyncRossumAPIClient.retrieve_rule()
        • SyncRossumAPIClient.create_new_rule()
        • SyncRossumAPIClient.update_part_rule()
        • SyncRossumAPIClient.delete_rule()
        • SyncRossumAPIClient.list_user_roles()
        • SyncRossumAPIClient.request_paginated()
        • SyncRossumAPIClient.request_json()
        • SyncRossumAPIClient.request()
        • SyncRossumAPIClient.authenticate()
    • Client Usage Examples
      • Authentication
      • Working with Annotations
      • Working with Documents
      • Working with Workspaces and Queues
      • Pagination
      • Export Operations
      • Working with Relations
      • Working with Additional Resources
      • Authentication and Token Management
      • Generic Request Methods
      • Error Handling
      • Client Configuration
    • See Also
  • Data Models
    • Overview
    • Models
      • Annotation
      • AutomationBlocker
      • AutomationBlockerContent
      • Connector
      • Document
      • DocumentRelation
      • Email
      • EmailTemplate
      • Hook
      • Inbox
      • Organization
      • Queue
      • Relation
      • RelationType
        • RelationType.EDIT
        • RelationType.ATTACHMENT
        • RelationType.DUPLICATE
      • Rule
      • RuleAction
      • Schema
      • Section
      • Datapoint
      • Multivalue
      • Tuple
      • Task
      • Upload
      • User
      • Workspace
    • Model Usage Examples
      • Creating Model Instances
      • Accessing Nested Objects
      • Working with Enums
      • Type Hints
    • See Also
Rossum API SDK
  • Overview: module code

All modules for which code is available

  • rossum_api.clients.external_async_client
  • rossum_api.clients.external_sync_client
  • rossum_api.models.annotation
  • rossum_api.models.automation_blocker
  • rossum_api.models.connector
  • rossum_api.models.document
  • rossum_api.models.document_relation
  • rossum_api.models.email
  • rossum_api.models.email_template
  • rossum_api.models.hook
  • rossum_api.models.inbox
  • rossum_api.models.organization
  • rossum_api.models.queue
  • rossum_api.models.relation
  • rossum_api.models.rule
  • rossum_api.models.schema
  • rossum_api.models.task
  • rossum_api.models.upload
  • rossum_api.models.user
  • rossum_api.models.workspace

© Copyright 2025, Rossum.

Built with Sphinx using a theme provided by Read the Docs.