Ping API Documentation

A quick way to check that the service is reachable and that your token is accepted.

Endpoints

GET /api/v1/ping

Ping the server. Like every other endpoint it requires a valid bearer token, so a 200 confirms both that the service is up and that your credentials work. It is also the cheapest request on which to ask the server its API version: send X-Client-API-Version and read X-API-Version-Status from the response.

curl -i https://app.spondulix.ai/api/v1/ping \
  -H "Authorization: Bearer your-api-token-here" \
  -H "X-Client-API-Version: 1.1.1"

Response

No response body. The headers carry the version handshake:

HTTP/1.1 200 OK
X-API-Version: 1.1.1
X-API-Version-Status: current

HTTP Response Codes