Connector API

REST API. JWT secured.

Connect any application to SyteLine through the Connector Service. Fastify-powered, RBAC-protected, WebSocket-capable.

JWT Auth
RBAC
Fastify
Air-gapped

Interactive Demo

Explore the API — live.

Pick an endpoint, customize the request, and see the response in real time.

Authorization

Three RBAC roles

Viewer

  • •Read queries
  • •View reports
  • •Browse IDOs
  • •View agent status

Operator

  • •All Viewer permissions
  • •Run queries
  • •Invoke agents
  • •Generate reports

Admin

  • •All Operator permissions
  • •Deploy agents
  • •Manage extensions
  • •Configure policies

Endpoints

Key API routes

POST/api/v1/query
GET/api/v1/agents
POST/api/v1/agents/:id/invoke
GET/api/v1/reports
POST/api/v1/reports/generate
GET/api/v1/extensions
POST/api/v1/extensions/deploy
GET/api/v1/ido/:name

Example

Query in one request

Request
curl -X POST https://your-server:8091/api/v1/query \
  -H "Authorization: Bearer ${JWT_TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "Show overdue purchase orders over $10K",
    "format": "json",
    "limit": 50
  }'
Response
{
  "success": true,
  "data": [
    {
      "po_number": "PO-2024-1847",
      "vendor": "Acme Steel Corp",
      "amount": 24500.00,
      "days_overdue": 12
    }
  ],
  "meta": {
    "count": 3,
    "elapsed": "0.12s",
    "confidence": 0.98
  }
}

Start integrating

Connect your dashboards, internal tools, or custom apps to SyteLine through a secure, documented REST API.

Get Started FreeAgent SDK