Skip to main content

​
API overview

The Navi public API is versioned under a single public base path: 
/api/v1/navi

​
Base URL

Replace <your-base-url> with your Navi environment, for example: 
https://dev.meridian7.io/api/v1/navi

​
First request

Use the service metadata endpoint to confirm access: 
curl -s \
  -H "Cookie: sb-access-token=<your-session-cookie>" \
  https://dev.meridian7.io/api/v1/navi | jq
Example response: 
{
  "data": {
    "service": "navi-api",
    "version": "v1",
    "environment": "development",
    "org": {
      "id": "org_123",
      "name": "Acme Corporation"
    },
    "principal": {
      "type": "user",
      "authMode": "session",
      "userId": "user_123",
      "scopes": ["agents:read", "runs:read", "runs:write", "briefings:read", "deals:read"]
    },
    "capabilities": {
      "streaming": true,
      "runs": true,
      "briefings": true,
      "deals": true,
      "tokens": false,
      "usage": true
    }
  },
  "requestId": "req_123",
  "version": "v1"
}

​
Response envelope

All successful responses use the same top-level envelope: 
{
  "data": {},
  "requestId": "req_123",
  "version": "v1"
}

​
Error envelope

{
  "error": {
    "code": "unauthorized",
    "message": "Authentication required"
  },
  "requestId": "req_123",
  "version": "v1"
}

​
Current public resources

  • /api/v1/navi
  • /api/v1/navi/agents
  • /api/v1/navi/deals
  • /api/v1/navi/deals/{dealId}
  • /api/v1/navi/briefings/morning
  • /api/v1/navi/briefings/meeting
  • /api/v1/navi/runs
  • /api/v1/navi/runs/{runId}
  • /api/v1/navi/runs/{runId}/stream
  • /api/v1/navi/usage/summary

​
Next steps