API Reference

Complete REST API documentation for programmatic access to OpenDocs.

Base URL
All API requests should use this base URL
https://docs.platphormnews.com/api/v1

Replace with your own domain if you have deployed your own instance.

Response Format
All responses follow this structure
{
  "success": true,
  "data": { ... },
  "meta": {
    "page": 1,
    "per_page": 20,
    "total": 100,
    "total_pages": 5,
    "request_id": "uuid"
  }
}
Error Response
{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Description of the error"
  },
  "meta": {
    "request_id": "uuid"
  }
}