Skip to main content
GET
Status and metrics
curl --request GET \
  --url http://localhost:8080/
{
  "name": "ScreenJSON CLI API",
  "version": "1.0.0",
  "status": "running",
  "queue": {
    "pending": 0,
    "workers": 8
  },
  "endpoints": [
    {
      "method": "GET",
      "path": "/",
      "description": "Queue status and metrics"
    },
    {
      "method": "GET",
      "path": "/health",
      "description": "Health check"
    },
    {
      "method": "GET",
      "path": "/formats",
      "description": "List supported formats"
    },
    {
      "method": "POST",
      "path": "/convert",
      "description": "Upload file -> ScreenJSON response"
    },
    {
      "method": "POST",
      "path": "/export",
      "description": "Upload ScreenJSON -> format response"
    },
    {
      "method": "POST",
      "path": "/validate",
      "description": "Validate ScreenJSON document"
    }
  ]
}

Response

200 - application/json

Service descriptor

name
string
version
string
status
enum<string>
Available options:
running
queue
object
endpoints
object[]