Platform

Health, client bootstrap configuration, and environment information.

dev · https://api.dev.oprag.ai

None of the 3 endpoints on this page need a dashboard session. They are part of the Integration API, which lists them alongside everything else your key opens.

GET /health

Liveness check

Auth Public — no credential

Path parameters

None.

Query parameters

None.Serves a fixed document and takes no input at all.

Body parameters

None.GET requests carry no body.

Response

200 Success

JSON

{
  "status": "ok",
  "service": "oprag-api",
  "timestamp": "2026-06-09T12:00:00.000Z"
}

Status codes

Status	Meaning
200	Success.
429	Rate limited. See rate limits.

curl

Shell

curl -X GET 'https://api.dev.oprag.ai/health' \
  -H 'X-Oprag-Key: sk_live_...'

GET /config

Cognito pool/client IDs, API URL, Hosted UI domain prefix, SPA OAuth callback, and enabled socialProviders (Google, GitHub). Used by the dashboard and MCP clients to bootstrap auth.

Auth Public — no credential

Path parameters

None.

Query parameters

None.Serves a fixed document and takes no input at all.

Body parameters

None.GET requests carry no body.

Response

200 Success

JSON

{
  "cognitoUserPoolId": "us-east-1_example",
  "cognitoClientId": "exampleclientid",
  "apiUrl": "https://api.dev.oprag.ai",
  "cognitoRegion": "us-east-1",
  "cognitoDomain": "ashutech-dev-oprag",
  "oauthRedirectUri": "https://app.dev.oprag.ai/auth/callback",
  "socialProviders": ["Google", "GitHub"]
}

Status codes

Status	Meaning
200	Success.
429	Rate limited. See rate limits.

curl

Shell

curl -X GET 'https://api.dev.oprag.ai/config' \
  -H 'X-Oprag-Key: sk_live_...'

GET /dev/info

Dev testing credentials, MCP login steps, and the live API route catalog.

Auth Public — no credential

Before you call it

Returns 404 in staging and production — it exists to bootstrap local and dev testing only.
The response carries mcp.authModes, mcp.notes, mcp.testProject, the full loginSteps array, and apis.routes — the live catalog of every main-backend route.
The dev QA password is never returned.

Path parameters

None.

Query parameters

None.Serves a fixed document and takes no input at all.

Body parameters

None.GET requests carry no body.

Response

200 Success

JSON

{
  "environment": "dev",
  "apiUrl": "https://api.dev.oprag.ai",
  "docsUrl": "https://dev.oprag.ai/docs/",
  "dashboardUrl": "https://app.dev.oprag.ai",
  "mcp": {
    "credentials": {
      "apiUrl": "https://api.dev.oprag.ai",
      "cognitoUserPoolId": "us-east-1_example",
      "cognitoClientId": "exampleclientid",
      "email": "dev-qa@oprag.ai"
    },
    "testAccount": { "email": "dev-qa@oprag.ai", "companyName": "Dev QA" },
    "testProject": { "purposeId": "mcp-qa", "name": "Uolo Product Assistant" },
    "authModes": [
      { "mode": "credentials", "priority": 1, "env": ["OPRAG_API_URL", "OPRAG_COGNITO_EMAIL", "OPRAG_COGNITO_PASSWORD"] },
      { "mode": "jwt", "priority": 2, "env": ["OPRAG_API_URL", "OPRAG_JWT_TOKEN"] },
      { "mode": "api-key-only", "priority": 3, "env": ["OPRAG_API_URL", "OPRAG_API_KEY"], "description": "health_check and public_chat only" }
    ],
    "loginSteps": [
      { "step": 1, "title": "Install and build the MCP server", "commands": ["cd mcp", "npm install", "npm run build"] },
      { "step": 2, "title": "Configure credentials", "commands": ["cp mcp/.env.example mcp/.env"] }
    ],
    "notes": ["Password self-signup is disabled; use provisioned dev QA or invite."],
    "envExample": { "OPRAG_API_URL": "https://api.dev.oprag.ai", "OPRAG_COGNITO_EMAIL": "dev-qa@oprag.ai" }
  },
  "apis": {
    "count": 74,
    "routes": [{ "method": "GET", "path": "/health", "auth": "Public", "group": "health" }]
  }
}

Status codes

Status	Meaning
200	Success.
429	Rate limited. See rate limits.

curl

Shell

curl -X GET 'https://api.dev.oprag.ai/dev/info' \
  -H 'X-Oprag-Key: sk_live_...'

Ready to ship?

Get started free