Canoe Intelligence Introduction API

openapi: 3.2.0
info:
  title: Canoe Intelligence Introduction API
  version: null
tags:
- name: Introduction
  description: ''
paths:
  Request:
    get:
      tags:
      - Introduction
      summary: Introduction request
      description: 'Canoe''s API provides methods for retrieving extracted data from documents and their metadata as well as data from downloaded PDFs. This documentation includes detailed explanations of API endpoints and examples. You may not have access to all of the listed endpoints depending on the services you''ve purchased from Canoe as well as your user permissions.


        By using Canoe’s API Documentation, you agree to the most recent version of Canoe’s Developer Portal Terms of Use.


        In addition to the curl, javascript, python, php and CSharp examples next to each endpoint, we''ve also included a Postman collection. The collection contains API calls for each available endpoint. Postman is a tool that helps generate and test API calls by providing a clean interface to build and save HTTP requests, and to check and test API responses.


        Note: Download Postman from their official website. Find out more about how to import Postman collections here.


        Your information security team may require whitelisting Canoe’s IP addresses before you can call the API. Whitelist the IP addresses found in this knowledge base page to allow all API addresses of Canoe. (Note: You must be logged into your Canoe account to access the knowledge base page)


        Your information technology team may require you to open ports to call the API. The API uses port numbers 443 and 9443.


        Additionally, your information security team may request that Canoe limit the IP address(es) from which you can make API calls as an extra layer of data protection. If so, please reach out to our support team.


        Request:


        The base URL for all Canoe API requests is https://api.canoesoftware.com


        The API is built on RESTful principles with resource-oriented URL endpoints. HTTP status codes are used to indicate any API errors and all responses are returned in JSON format. All requests must be made over an HTTPS connection to ensure a secure transmission of data. Following a RESTful structure, requests should hit API endpoints using the appropriate HTTP method, which will depend on the desired action:


        Method

        Description


        GET

        Use the GET method to retrieve information about your users, their organizations, and available associated data. This will always be a read-only request, so queried objects will never be modified by a GET request. When using filter parameters that include special characters, you should always encode those values to fit URI specifications.


        POST

        Use a POST method to create a new object, such as a new user or organization. Request parameters should be given in JSON format. The response body will typically return the newly created resource.


        PUT

        Use a PUT method to update an object, such as updating user credentials. As with a POST request, parameters should be given in JSON format. If successful, the response body will typically return the modified object.


        DELETE

        Use a DELETE method to delete an object, such as deleting one of your funds. Successful DELETE requests will typically return an empty response body.'
      operationId: IntroductionRequest
      x-summary-source: derived
  Response:
    get:
      tags:
      - Introduction
      summary: Introduction response
      description: 'Response:


        All non-empty response bodies, including errors, will be formatted as a JSON object. If you are fetching multiple entries, such as /v1/funds example, the data will be returned as a list. If you are fetching a single entry, such as GET /v1/funds/1, the data will be returned as a single object.


        Canoe''s APIs use standard HTTP status codes to indicate the status of a request.


        Below is a brief overview of the most common status codes:


        Code

        Text

        Definition


        200

        OK

        Success!


        400

        Bad Request

        The request was invalid or cannot be otherwise served. This could be due to an invalid or malformed parameter, etc.


        401

        Unauthorized

        The API authentication credentials or access token are missing or incorrect.


        403

        Forbidden

        The credentials or access token are authenticated, but you do not have access to the requested resource.


        404

        Not Found

        The requested resource is invalid or the resource requested, such as a Fund, does not exist. The 404 status code might indicates that the REST API can''t map the client''s URI to a resource but may be available in the future.


        405

        Method Not Allowed

        The request tried to use an HTTP method that the resource does not allow. For instance, a read-only resource could support only GET, but not PUT or DELETE or POST.


        429

        Too Many Requests

        You have exceeded the rate limit for this endpoint. Wait for the time specified in the retry_after response header before retrying. See Authentication Error Responses section for more details.


        500

        Internal Server Error

        There are internal or API-related errors on Canoe''s side. Additional requests will not resolve the issue.


        503

        Service Unavailable

        The Canoe servers are up, but overloaded with requests. Try again later.'
      operationId: IntroductionResponse
      x-summary-source: derived
externalDocs:
  description: Click to download docs in JSON format
  url: /api/docs.json
x-tagGroups:
- name: Getting Started
  tags:
  - Introduction
  - Authentication
  - Password Grant Tokens
- name: Core Resources
  tags:
  - Documents
  - Funds
  - Terms
  - Organizations
  - Allocations
  - Custom Fields
- name: User Management
  tags:
  - User