Sitepaste API Documentation

The Sitepaste API enables Pro Plan users to programmatically manage their sites, create content, and trigger deployments. Build automated workflows, integrate with CI/CD pipelines, or publish content from your favorite tools.

Getting started

1. Introduction: Overview and quick start guide
2. Authentication: Create and manage API tokens
3. Pages API: Create and update content programmatically
4. Builds API: Trigger site deployments
5. Examples and use cases: iPhone shortcuts, VSCode extensions, and more
6. Rate limiting: Understanding API limits

Quick example

# Create a new page
curl -X POST https://sitepaste.com/api/v1/public/pages \
  -H "Authorization: Bearer sp_your_token_here" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "My First API Post",
    "content": "# Hello World\n\nThis was created via API!",
    "contentType": "blog"
  }'

# Trigger a deployment
curl -X POST https://sitepaste.com/api/v1/public/builds \
  -H "Authorization: Bearer sp_your_token_here"

API principles

• RESTful design with JSON request/response bodies
• Bearer token authentication using sp_ prefixed tokens
• Comprehensive error messages with clear status codes
• Rate limiting to ensure fair usage and platform stability
• Lightweight with versioning and minimal, communicated changes

Base URL

https://sitepaste.com/api/v1

All API requests must be made over HTTPS. Requests made over HTTP will fail.

Need help?

If you encounter issues or have questions:

• Review the documentation for detailed endpoint specifications
• Check your rate limits in the response headers
• Verify your Pro Plan is active
• Contact support if you need assistance

Ready to get started? Head to Authentication to create your first API token.