REST API

Shocking Energy provides a versioned REST API at /v1 for building custom integrations, dashboards, and automation workflows. The API uses JSON and standard HTTP conventions.

Base URL

https://api.jobway.ai/v1

For local development:

http://localhost:3003/v1

Authentication

All API requests require a Bearer token in the Authorization header:

curl https://api.jobway.ai/v1/jobs \
  -H "Authorization: Bearer YOUR_API_KEY"

Two token types are accepted:

API documentation

Interactive API documentation (Swagger UI) is available at:

https://api.jobway.ai/v1/docs

The documentation is auto-generated from the API's OpenAPI specification and includes request/response schemas, parameter descriptions, and example values.

Endpoints overview

Jobs

Flows

Assets

Projects

Invoices

Team

Search

Metrics

Request format

Query parameters

List endpoints support filtering via query parameters:

curl "https://api.jobway.ai/v1/jobs?status=PENDING&limit=10" \
  -H "Authorization: Bearer YOUR_API_KEY"

Request body

Write endpoints accept JSON request bodies:

curl -X POST https://api.jobway.ai/v1/jobs \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "jobTypeId": "123e4567-e89b-12d3-a456-426614174000",
    "scheduledDate": "2026-03-15",
    "notes": "Annual service visit"
  }'

Response format

Success responses

{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "status": "PENDING",
    "scheduledDate": "2026-03-15"
  }
}

List endpoints return an array:

{
  "data": [
    { "id": "...", "status": "PENDING" },
    { "id": "...", "status": "COMPLETED" }
  ]
}

Error responses

{
  "status": "error",
  "message": "Bad Request",
  "request_id": "req_abc123",
  "error": {
    "name": "BadRequestError",
    "issues": [
      {
        "message": "Invalid date format",
        "path": "scheduledDate"
      }
    ]
  }
}

HTTP status codes

Rate limiting

API requests are rate-limited to protect the service. When you exceed the limit, you receive a 429 response. Back off and retry after the time indicated in the Retry-After header.

MCP vs REST API

Both the MCP endpoint and REST API provide access to the same team data. Choose based on your use case:

Both use the same authentication and scope system. An API key works for both MCP and REST API access.