Base URL & Versioning

All API requests are made to a single base URL. Endpoints are versioned with a path prefix.

Base URL

text
https://smsgateway-api.onrender.com

All API endpoints (except /health) are prefixed with /v1/. A full endpoint URL looks like:

text
https://smsgateway-api.onrender.com/v1/sms/send

Content type

All request and response bodies use JSON. Set the Content-Type header on requests that include a body:

text
Content-Type: application/json

Request body limit

The maximum request body size is 100 KB. Larger payloads are rejected with a 413 response.

413 Payload Too Large
json
{
"error": "Payload too large"
}

HTTPS requirement

In production, the gateway enforces HTTPS. Requests over plain HTTP receive a 403 response:

403 HTTPS Required
json
{
"error": "HTTPS required"
}
HTTPS enforcement checks the X-Forwarded-Proto header. This applies only in production when the header is present.

Request ID

Every response includes an X-Request-Id header containing a UUID. Include this value when reporting issues — it correlates to the server-side logs for that request.

Health check

The health endpoint is the only route without the /v1/ prefix. It requires no authentication.

Request
curl https://smsgateway-api.onrender.com/health
200
json
{
"status": "ok"
}

Related docs