find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/keysavvy:keysavvy-deal-documents-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: KeySavvy Partner Deal Documents API
  version: 1.0.0
  description: API for KeySavvy Partner integration
  contact:
    name: KeySavvy API Support Team
    email: api-support@keysavvy.com
servers:
- url: https://api.keysavvy.com/v1
  description: KeySavvy Production API
- url: https://api.keysavvy.dev/v1
  description: KeySavvy Non-Production API
security:
- apiKey: []
tags:
- name: Deal Documents
paths:
  /deal/{referenceId}/bill-of-lading-link:
    post:
      tags:
      - Deal Documents
      summary: Submit bill of lading URL
      description: Upload a bill of lading URL from an online shipping platform (e.g. Super Dispatch). If mileage at pickup is known, you can also provide vehicle mileage.
      operationId: uploadBillOfLadingLink
      parameters:
      - name: referenceId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BillOfLadingLinkRequestBody'
      responses:
        '201':
          $ref: '#/components/responses/CreatedResponse'
        '400':
          $ref: '#/components/responses/ErrorResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedResponse'
        '404':
          $ref: '#/components/responses/ErrorResponse'
  /deal/{referenceId}/bill-of-lading-upload:
    post:
      tags:
      - Deal Documents
      summary: Upload bill of lading document
      description: Upload a bill of lading file (image or PDF). If a file has already been uploaded, the existing one will be archived and will be replaced by the new file. The maximum file size is 20 MB.
      operationId: uploadBillOfLading
      parameters:
      - name: referenceId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/BillOfLadingUploadRequestBody'
      responses:
        '201':
          $ref: '#/components/responses/CreatedResponse'
        '400':
          $ref: '#/components/responses/ErrorResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedResponse'
        '404':
          $ref: '#/components/responses/ErrorResponse'
        '413':
          $ref: '#/components/responses/ErrorResponse'
components:
  schemas:
    ErrorResponseBody:
      type: object
      properties:
        error:
          type: string
        message:
          type: string
    BillOfLadingUploadRequestBody:
      type: object
      properties:
        transferMileage:
          type: integer
          minimum: 1
          maximum: 999999
          description: Mileage at transfer. If specified, must be specified before file.
        file:
          type: string
          description: BOL document file (image/* or application/pdf mime-type)
          format: binary
      required:
      - file
    CreatedResponseBody:
      type: object
      properties:
        message:
          type: string
    BillOfLadingLinkRequestBody:
      type: object
      properties:
        onlineBillOfLadingUrl:
          type: string
          format: uri
          description: URL to the online bill of lading document
        transferMileage:
          type: integer
          minimum: 1
          maximum: 999999
          description: Mileage at transfer, if known.
      required:
      - onlineBillOfLadingUrl
  responses:
    ErrorResponse:
      description: The request failed. `error` and `message` describe why.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponseBody'
    CreatedResponse:
      description: Resource created successfully
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CreatedResponseBody'
    UnauthorizedResponse:
      description: Authentication failed
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponseBody'
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: keysavvy-api