Endpoint Examples

/status

Service status (health)

`GET` /status

Get the health of the service. Be sure to check the healthy attribute of the response, not just the status code.

Code Examples

curl --request GET \
     --url https://api.lightcast.io/classification/status \
     --header 'accept: application/json' \
     --header 'authorization: Bearer <Access Token>'

Response Examples

{
  "data": {
    "healthy": true,
    "message": "Service is healthy"
  }
}

{
  "message": "Verification failed"
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "insufficient scope"
}

{
  "title": "Method Not Allowed",
  "status": 405,
  "detail": "unsupported method"
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "classification failed while executing request"
}