SmartDocumentor
  • Overview
    • SmartDocumentor
  • GETTING STARTED
    • About SmartDocumentor
    • How SmartDocumentor Works
    • Main concepts
      • Workspaces
      • Organization
    • Quickstart 101
    • Licenses
      • How to Buy?
      • Support
    • Privacy
    • Security
  • Technical
    • Initial Setup
    • Mappings
    • API Reference
      • [POST] Client Credentials Access Token
      • [GET] Task Status
      • [GET] Task Status List
      • [GET] Task Status List Paginated
      • [GET] Get Workspaces
      • [PATCH] Reprocess Task
      • [POST] Create Task
      • [POST] Create Batch
      • [GET] Get Batch
      • [GET] Get Batch Paginated
      • Transcripts
        • Speakers
          • Workspaces
            • [GET] Workspace Speakers
            • [PUT] Workspace Speakers
          • Tasks
            • [GET] Task Speakers
            • [POST] Task Speaker
            • [PUT] Task Speaker
            • [DELETE] Task Speaker
      • Invite Users
        • [GET] List Available Roles
        • Tenants
          • [GET] List All Tenant Users
          • [POST] Invite Users
        • Workspaces
          • [GET] List All Workspace Users
          • [POST] Invite Users
    • Folder Worker
    • Export
      • Webhooks
        • Webhook (Text Documents)
        • Webhook (Transcripts)
        • Webhook Url To File (Transcripts)
        • Webhook Url to File (Anonymization)
    • Changelog
  • FAQs
    • FAQs
Powered by GitBook
On this page
  1. Technical

API Reference

PreviousMappingsNext[POST] Client Credentials Access Token

Last updated 6 months ago

This section documents how your organization can use the provided client credentials to directly integrate with SmartDocumentor.

Before you start, please make sure that you have read and set up all the configurations described at the page.

Important Concepts:

  • Task/Document: a file that you imported into our system to be recognized and reviewed. We use the term Task and Document interchangeably during this documentation. The term "Task" is usually used in technical descriptions, as "Task" is how we describe imported files in our system. "Document" is used in the frontend for ease of use.

  • Workspace: a way to organize multiple related tasks together, which must be processed in the same way, with the same recognized fields and export method.

  • Tenant/Organization: A logical way to organize multiple users and their assigned workspaces. When you create a new account, a new Organization is automatically assigned to you. The terms "Organization" and "Tenant" may be used interchangeably during this documentation. The term "Tenant" is usually used in technical descriptions, as "Tenant" is how we describe organizations in our system. "Organization" is used in the frontend for ease of use.

  • Batch: a way to organize similar tasks together within a workspace. Tasks in Batches are reviewed together, in the context of the Batch they belong to.

You can set up the exportation/integration flow also. SmartDocumentor also has the documentation for this at the page.

Initial Setup
Integration