Base URL: /api/v1

Creates a new temporary payload.

POST /payloads
Content-Type: application/json

{
  "content": "string",
  "mime_type": "string",
  "expiry_time": "2025-03-28T00:00:00Z"  // Optional, ISO 8601 format
}

{
  "hash_id": "string",
  "expiry_time": "2025-03-28T00:00:00Z"
}

• 400 Bad Request: Invalid request body or MIME type
• 413 Payload Too Large: Content exceeds size limit
• 429 Too Many Requests: Rate limit exceeded
• 500 Internal Server Error: Server error

Retrieves a payload by its hash ID.

GET /payloads/{hash_id}

{
  "content": "string",
  "mime_type": "string",
  "expiry_time": "2025-03-28T00:00:00Z"
}

• 404 Not Found: Payload not found or expired
• 429 Too Many Requests: Rate limit exceeded
• 500 Internal Server Error: Server error

Deletes a payload by its hash ID.

DELETE /payloads/{hash_id}

No response body

• 404 Not Found: Payload not found
• 429 Too Many Requests: Rate limit exceeded
• 500 Internal Server Error: Server error

The API implements rate limiting based on client IP address:

• Default limit: 100 requests per 60 seconds
• Rate limit headers:
  • X-RateLimit-Limit: Maximum requests per window
  • X-RateLimit-Remaining: Remaining requests in current window
  • X-RateLimit-Reset: Time when the rate limit resets (Unix timestamp)

All error responses follow this format:

{
  "error": "string"  // Human-readable error message
}

Request:

curl -X POST http://localhost:8080/api/v1/payloads \
  -H "Content-Type: application/json" \
  -d '{
    "content": "Hello, World!",
    "mime_type": "text/plain",
    "expiry_time": "2025-03-28T00:00:00Z"
  }'

Response:

{
  "hash_id": "feb61cd1b3d34efebab6d6a8490071b2",
  "expiry_time": "2025-03-28T00:00:00Z"
}

Request:

curl http://localhost:8080/api/v1/payloads/feb61cd1b3d34efebab6d6a8490071b2

Response:

{
  "content": "Hello, World!",
  "mime_type": "text/plain",
  "expiry_time": "2025-03-28T00:00:00Z"
}

Request:

curl -X DELETE http://localhost:8080/api/v1/payloads/feb61cd1b3d34efebab6d6a8490071b2

Response:

204 No Content