API Reference

Complete reference documentation for the PDF-Sign REST API.

Base URL

All API requests should be made to this base URL:

https://api.pdf-sign.com/functions/v1

Authentication

All API requests require authentication using an API key. Include your key in the x-api-key header:

curl -H "x-api-key: pdfsign_your_api_key" \
     -H "Content-Type: application/json" \
     https://api.pdf-sign.com/functions/v1/generate-pdf-preview

Learn more about Authentication.

Available Endpoints

PDF Generation

See the full Generate PDF documentation.

Response Format

All API responses are returned in JSON format.

Success Response

{
  "success": true,
  "pdf_url": "https://api.pdf-sign.com/storage/v1/object/public/pdfs/...",
  "generation_id": "uuid",
  "file_size": 12345
}

Error Response

{
  "error": "Error message",
  "code": "ERROR_CODE",
  "status": 400
}

See all Error Codes.

Rate Limits

API usage is limited based on your subscription plan:

Learn more about Rate Limits.

Best Practices

1. Cache template IDs - Store template IDs in your application to avoid repeated lookups
2. Validate data before sending - Ensure all required variables are present and valid
3. Handle errors gracefully - Implement proper error handling and retry logic
4. Monitor your usage - Keep track of your API usage to avoid hitting rate limits
5. Use HTTPS only - All API requests must use HTTPS for security