Beta environment - not production
You are viewing the DocButterfly beta at beta.docbutterfly.com. Endpoints, data and templates here are for evaluation only, and may be reset or changed without notice. The documentation shows https://docbutterfly.com as the base URL - point your calls at the beta host while you are testing here. Do not use production data or production API keys.

DocFlow API Reference

183 endpoints across 18 categories. Every operation available via a single POST request.

Authentication

All API requests require an API key. Include it in the X-API-Key header with every request.

HTTP Header
X-API-Key: df_your_api_key_here

You can also pass the key as a Bearer token or ?apiKey= query parameter, but the header method is recommended.

Token System

Each operation costs tokens. Tokens are deducted on successful completion only. Response headers include:

  • X-Tokens-Used — tokens consumed by this request
  • X-Tokens-Remaining — your remaining balance

Base URL

https://docbutterfly.com

All endpoint paths below are relative to this base URL.

Error Codes

StatusMeaningResolution
400Bad RequestCheck your request body and parameters
401UnauthorizedInvalid or missing API key
402Payment RequiredInsufficient tokens — top up your balance
403ForbiddenAccount deactivated
500Server ErrorInternal error — contact support
503Service UnavailableRequired service not configured (e.g. Graph API, DocuSign)

Rate Limits

Currently there are no hard rate limits. The Azure Functions Consumption plan handles auto-scaling. Heavy operations (browser-based) may take 3-10 seconds on cold start.


Endpoint Categories