Docupilot

Docupilot general API

The general API from Docupilot — 5 operation(s) for general.

GitHub OpenAPI

Operations 5

GET /dashboard/banner_notifications/ #
GET /dashboard/feature_flags/ #
GET /dashboard/meta/ #
GET /dashboard/plans/ #
GET /dashboard/tz/ #

Documentation

📖
Documentation
https://help.docupilot.app/developers/api-overview

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/docupilot/refs/heads/main/openapi/docupilot-general-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/docupilot/refs/heads/main/json-schema/

Other Resources

🔗
SwaggerUI
https://{subdomain}.docupilot.app/~/dashboard/api-docs/swagger-ui/
🔗
Webhooks
https://help.docupilot.app/create-document/api-and-webhook-integration
🔗
JSONExamples
https://raw.githubusercontent.com/api-evangelist/docupilot/refs/heads/main/examples/
🔗
Vocabulary
https://raw.githubusercontent.com/api-evangelist/docupilot/refs/heads/main/vocabulary/docupilot-vocabulary.json
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/docupilot/refs/heads/main/json-ld/docupilot.jsonld

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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/docupilot-general-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

docupilot-general-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Docupilot accounts APIs ai General API
  version: '1.0'
  description: Docupilot accounts APIs
  termsOfService: https://docupilot.app/terms-and-conditions/
  contact:
    name: Team Docupilot
    email: support@docupilot.app
servers:
- url: https://api-us1.docupilot.app
  description: Base URL declared by the provider in apis.yml (roadmap#122).
tags:
- name: general
paths:
  /dashboard/banner_notifications/:
    get:
      operationId: list_banner_notifications
      tags:
      - general
      security:
      - SessionAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/BannerNotification'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
  /dashboard/feature_flags/:
    get:
      operationId: get_feature_flags
      parameters:
      - in: header
        name: X-Workspace
        schema:
          type: string
        description: Workspace unique_key
        required: true
      tags:
      - general
      security:
      - SessionAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeatureFlags'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
  /dashboard/meta/:
    get:
      operationId: get_app_meta
      tags:
      - general
      security:
      - SessionAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Meta'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
  /dashboard/plans/:
    get:
      operationId: list_subscription_plans
      tags:
      - general
      security:
      - SessionAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Plan'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
  /dashboard/tz/:
    get:
      operationId: list_timezones
      tags:
      - general
      security:
      - SessionAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Timezone'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
components:
  schemas:
    UnauthenticatedError:
      type: object
      properties:
        detail:
          type: string
      required:
      - detail
      description: ''
    Plan:
      type: object
      properties:
        plan_id:
          type: string
          readOnly: true
        documents_allowed:
          type: integer
          readOnly: true
        price:
          type: integer
          readOnly: true
        billing_period_unit:
          enum:
          - year
          - month
          type: string
          readOnly: true
      required:
      - billing_period_unit
      - documents_allowed
      - plan_id
      - price
      description: ''
    BannerNotification:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type: string
        action:
          $ref: '#/components/schemas/BannerNotificationAction'
      required:
      - action
      - description
      - id
      - name
      description: ''
    FeatureFlags:
      type: object
      properties:
        template_versioning_enabled:
          type: boolean
      required:
      - template_versioning_enabled
      description: ''
    Timezone:
      type: object
      properties:
        name:
          type: string
          readOnly: true
        tz:
          type: string
          readOnly: true
      required:
      - name
      - tz
      description: ''
    FileUploadMeta:
      type: object
      properties:
        email_attachments:
          $ref: '#/components/schemas/AttachmentsConfig'
      required:
      - email_attachments
      description: ''
    BannerNotificationAction:
      type: object
      properties:
        text:
          type: string
        attributes:
          type: object
          additionalProperties: {}
      required:
      - attributes
      - text
      description: ''
    BulkGenerateMeta:
      type: object
      properties:
        max_test_rows:
          type: integer
      required:
      - max_test_rows
      description: ''
    Meta:
      type: object
      properties:
        file_uploads:
          $ref: '#/components/schemas/FileUploadMeta'
        batch_process_max_allowed_test_rows:
          $ref: '#/components/schemas/BulkGenerateMeta'
        iam:
          type: string
        esign_reminder_defaults:
          $ref: '#/components/schemas/ESignReminderConfig'
      required:
      - batch_process_max_allowed_test_rows
      - esign_reminder_defaults
      - file_uploads
      - iam
      description: ''
    ESignReminderConfig:
      type: object
      properties:
        expiry:
          type: integer
        first_reminder:
          type: integer
        reminder_frequency:
          type: integer
        warn_before:
          type: integer
      required:
      - expiry
      - first_reminder
      - reminder_frequency
      - warn_before
      description: ''
    ForbiddenError:
      type: object
      properties:
        detail:
          type: string
      required:
      - detail
      description: ''
    AttachmentsConfig:
      type: object
      properties:
        allowed_types:
          type: string
        max_files:
          type: integer
        max_total_size:
          type: integer
      required:
      - allowed_types
      - max_files
      - max_total_size
      description: ''
  securitySchemes:
    OAuthAuthentication:
      type: http
      scheme: bearer
      description: OAuth2 Bearer Token Authentication
    SessionAuthentication:
      type: apiKey
      in: cookie
      name: sessionid
      description: browser based login takes care of this
externalDocs:
  description: Help docs on how to use API
  url: https://help.docupilot.app/developers/api-overview