How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Canoe Intelligence Documents API

The Documents API from Canoe Intelligence — 10 operation(s) for documents.

Canoe Intelligence Documents API is one of 10 APIs that Canoe Intelligence publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Documents. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 24 operations across 22 paths, and defines 5 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://api.canoesoftware.com.

24 operations 22 paths 5 schemas 2 DELETE12 GET1 PATCH6 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.canoesoftware.com
Authentication
HTTP Bearer, OAuth 2.0
Resource Areas
1

Authentication & Security 2

Canoe Intelligence Documents API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). It supports OAuth 2.0 (oauth2) using the authorizationCode and clientCredentials flows.

  • bearerAuth — Enter your Bearer token in the format: Bearer {token}
  • oauth2 — OAuth 2.0 authentication

Paths & Operations 24

Across 22 paths, the API surfaces 24 operations — 2 DELETE, 12 GET, 1 PATCH, 6 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Documents 24
GET
Get Document Data
/v1/documents/data Fetch documents' extracted data and metadata. By default, Canoe's server sends back the full representation of each document object after processing requests. For faster performanc…
GetDocuments 36 params body → 200403
GET
Get Document Types
/v1/documents/types Fetch all available document types. Document types are dynamically managed and organized by category. The response includes document type information including ID, key, level ('cl…
GetDocumentsType body → 200
GET
Get Document Tags
/v1/documents/tags Fetch all available document tags.
GetDocumentTags 2 params body → 200
GET
Get Document Allocation Tags
/v1/documents/allocation-tags Fetch all available document allocation tags.
GetDocumentAllocationTags 2 params body → 200
POST
Delete Multiple Documents
/v1/documents/delete-documents Delete up to 100 documents by filtering with the current parameters. At least one parameter is required in the request.
DeleteMultipleDocuments 21 params body → 200
GET
Get A Single Document
/v1/documents/{id} Download a specific document by the document's ID. A successful call to this endpoint will only contain the binary file, not the JSON data.
GetASingleDocument 1 param body → 200403
DELETE
Delete A Single Document
/v1/documents/{id} Delete a specific document by using the document's Canoe ID.
DeleteDocument 1 param body → 200403
POST
Bulk Set Document Metadata
/v1/documents/metadata Update metadata fields for up to 100 documents in a single request. Processing continues even if individual documents fail. Returns a summary of successful and failed updates.
BulkSetDocumentMetadata 5 params body → 200422
PUT
Set Document Metadata
/v1/documents/{id}/metadata Set document metadata.
SetDocumentMetadata 7 params body → 200401403422
GET
Download Documents
/v1/documents Download documents in a ZIP file. Each fetch will download up to 100 documents. By default, this will fetch the first 100 documents in the Intelligent Document Center. A successful call…
DownloadDocuments 32 params body → 200
POST
Upload A Single Document
/v1/documents Upload a Single Document
UploadDocuments 8 params body → 200422
PUT
Edit Document Attributes
/v1/documents/edit-attributes Update categorization attributes for up to 100 documents in a single request. At least one of the following fields must be provided: allocationid , entityid , termid , d…
EditDocumentAttributes 6 params body → 200422
GET
/v1/documents/data
Get Document Data
GetDocuments 33 params → 200403
GET
/v1/documents/types
Get Document Types
GetDocumentsType → 200
GET
/v1/documents/tags
Get Document Tags
GetDocumentTags 2 params → 200
GET
/v1/documents/allocation-tags
Get Document Allocation Tags
GetDocumentAllocationTags 2 params → 200
POST
/v1/documents/delete-documents
Delete Multiple Documents
DeleteMultipleDocuments body → 200
GET
/v1/documents/{id}
Get A Single Document
GetASingleDocument 1 param → 200403
DELETE
/v1/documents/{id}
Delete A Single Document
DeleteDocument 1 param → 200403
POST
/v1/documents/metadata
Bulk Set Document Metadata
BulkSetDocumentMetadata 5 params → 200422
PUT
/v1/documents/{id}/metadata
Set Document Metadata
SetDocumentMetadata 1 param body → 200401403422
GET
/v1/documents
Download Documents
DownloadDocuments 31 params → 200
POST
/v1/documents
Upload A Single Document
UploadDocuments body → 200422
PATCH
/v1/documents/{allocationId}/allocation-tags
Update Allocation Tags
updateAllocationTags 1 param body → 200400403404422

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Document_3 (25 properties), Document_2 (25 properties), Document (25 properties), DocumentMetaData (6 properties). Each schema is shown below with its type and property counts.

UploadSingleDocument
object
3 properties
Document
object
25 properties
DocumentMetaData
object
6 properties
Document_2
object
25 properties
Document_3
object
25 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

canoe-intelligence-documents-api-openapi.yml Raw ↑

Other APIs Canoe Intelligence publishes across the network.

Canoe Intelligence Allocations API
Canoe Intelligence Authentication API
Canoe Intelligence Custom Fields API
Canoe Intelligence Funds API
Canoe Intelligence Organizations API
Canoe Intelligence Password Grant Tokens API
Canoe Intelligence Terms API
Canoe Intelligence User API
Canoe Intelligence Introduction API
Where this information came from

This is an independent, third-party profile of Canoe Intelligence Documents API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.