Skip to main content

API Reference

This section contains the complete REST API documentation for Korala, auto-generated from our OpenAPI specification.

Base URL

https://api.korala.ai/api/v1

Authentication

All API requests require HMAC-SHA256 authentication. See the Authentication Guide for details.

Required headers:

HeaderDescription
X-API-KeyYour API key ID
X-TimestampUnix timestamp (seconds)
X-SignatureHMAC-SHA256 signature

Response Format

All responses are JSON. Successful responses return the requested data directly:

{
"id": "doc_abc123",
"name": "contract.pdf",
"status": "draft"
}

Error responses include an error code and message:

{
"statusCode": 400,
"error": "Bad Request",
"message": "Validation failed"
}

Rate Limits

TierRequests/minute
Free60
Pro600
EnterpriseUnlimited

Endpoints

Browse the API endpoints in the sidebar, organized by resource:

  • Documents - Create, manage, and track documents
  • Signers - Add and manage document signers
  • Fields - Place signature fields on documents
  • Webhooks - Subscribe to document events
  • API Keys - Manage API credentials