docs(api): use mintlify for API specs

2026-07-24 04:51:51 +00:00 · 2025-10-30 18:58:05 +01:00
parent f831171a21
commit 77089eba57
136 changed files with 23969 additions and 0 deletions
@@ -0,0 +1,7 @@
+---
+title: "List Lighthouse Config (Legacy)"
+api: "GET /api/v1/lighthouse/configuration"
+description: "Legacy configuration endpoint."
+---
+
+Legacy endpoint for configuration.
@@ -0,0 +1,7 @@
+---
+title: "Update Lighthouse Config (Legacy)"
+api: "PATCH /api/v1/lighthouse/configuration"
+description: "Update legacy configuration."
+---
+
+Legacy endpoint for updating configuration.
@@ -0,0 +1,19 @@
+---
+title: "Get Lighthouse AI Tenant Config"
+api: "GET /api/v1/lighthouse/configuration"
+description: "Retrieve current tenant-level Lighthouse AI settings."
+---
+
+Get your tenant's Lighthouse AI configuration including business context and default models.
+
+## Example Request
+
+```bash
+curl -X GET "https://api.prowler.com/api/v1/lighthouse/configuration" \
+  -H "Authorization: Bearer YOUR_API_KEY" \
+  -H "Content-Type: application/vnd.api+json"
+```
+
+## Response
+
+Returns tenant Lighthouse AI configuration.
@@ -0,0 +1,37 @@
+---
+title: "Update Lighthouse AI Tenant Config"
+api: "PATCH /api/v1/lighthouse/configuration"
+description: "Update tenant-level Lighthouse AI settings."
+---
+
+Update your tenant's Lighthouse AI configuration including business context and default providers/models.
+
+## Request Body
+
+```json
+{
+  "data": {
+    "type": "lighthouse-config",
+    "attributes": {
+      "business_context": "Financial services company focusing on security and compliance",
+      "default_provider": "openai",
+      "default_models": {
+        "chat": "gpt-4",
+        "analysis": "gpt-4"
+      }
+    }
+  }
+}
+```
+
+## Example Request
+
+```bash
+curl -X PATCH "https://api.prowler.com/api/v1/lighthouse/configuration" \
+  -H "Authorization: Bearer YOUR_API_KEY" \
+  -H "Content-Type: application/vnd.api+json"
+```
+
+## Response
+
+Returns updated configuration.
@@ -0,0 +1,7 @@
+---
+title: "Create Lighthouse Configuration"
+api: "POST /api/v1/lighthouse/configurations"
+description: "Create AI configuration profile."
+---
+
+Configure Lighthouse AI settings.
@@ -0,0 +1,7 @@
+---
+title: "Delete Lighthouse Configuration"
+api: "DELETE /api/v1/lighthouse/configurations/{id}"
+description: "Remove configuration profile."
+---
+
+Delete Lighthouse configuration.
@@ -0,0 +1,7 @@
+---
+title: "List Lighthouse Configurations"
+api: "GET /api/v1/lighthouse/configurations"
+description: "Retrieve Lighthouse AI configurations."
+---
+
+Get Lighthouse configuration profiles.
@@ -0,0 +1,7 @@
+---
+title: "Retrieve Lighthouse Configuration"
+api: "GET /api/v1/lighthouse/configurations/{id}"
+description: "Get configuration details."
+---
+
+Fetch Lighthouse configuration profile.
@@ -0,0 +1,7 @@
+---
+title: "Test Lighthouse Configuration"
+api: "POST /api/v1/lighthouse/configurations/{id}/connection"
+description: "Test configuration."
+---
+
+Verify Lighthouse configuration works.
@@ -0,0 +1,7 @@
+---
+title: "Update Lighthouse Configuration"
+api: "PATCH /api/v1/lighthouse/configurations/{id}"
+description: "Update configuration profile."
+---
+
+Modify Lighthouse AI settings.
@@ -0,0 +1,25 @@
+---
+title: "List LLM Models"
+api: "GET /api/v1/lighthouse/models"
+description: "List available LLM models per configured provider."
+---
+
+Retrieve all available LLM models from your configured providers.
+
+## Query Parameters
+
+- `filter[provider_type]` - Filter by provider type
+- `filter[model_id]`, `filter[model_id__icontains]` - Filter by model ID
+- `page[number]`, `page[size]` - Pagination
+
+## Example Request
+
+```bash
+curl -X GET "https://api.prowler.com/api/v1/lighthouse/models?filter[provider_type]=openai" \
+  -H "Authorization: Bearer YOUR_API_KEY" \
+  -H "Content-Type: application/vnd.api+json"
+```
+
+## Response
+
+Returns list of available LLM models with their parameters.
@@ -0,0 +1,7 @@
+---
+title: "List Lighthouse Models"
+api: "GET /api/v1/lighthouse/models"
+description: "Retrieve available AI models."
+---
+
+Get list of available LLM models.
@@ -0,0 +1,7 @@
+---
+title: "Retrieve Lighthouse Model"
+api: "GET /api/v1/lighthouse/models/{id}"
+description: "Get AI model details."
+---
+
+Fetch information about a specific model.
@@ -0,0 +1,40 @@
+---
+title: "Create LLM Provider Config"
+api: "POST /api/v1/lighthouse/providers"
+description: "Create configuration for an LLM provider."
+---
+
+Configure an LLM provider for use with Lighthouse AI.
+
+## Request Body
+
+```json
+{
+  "data": {
+    "type": "lighthouse-providers",
+    "attributes": {
+      "provider_type": "openai",
+      "base_url": "https://api.openai.com/v1",
+      "credentials": {
+        "api_key": "sk-..."
+      }
+    }
+  }
+}
+```
+
+## Example Request
+
+```bash
+curl -X POST "https://api.prowler.com/api/v1/lighthouse/providers" \
+  -H "Authorization: Bearer YOUR_API_KEY" \
+  -H "Content-Type: application/vnd.api+json"
+```
+
+## Response
+
+Returns the created provider configuration.
+
+<Note>
+Only one configuration per provider type is allowed per tenant.
+</Note>
@@ -0,0 +1,25 @@
+---
+title: "List LLM Provider Configs"
+api: "GET /api/v1/lighthouse/providers"
+description: "Retrieve all LLM provider configurations for Lighthouse AI."
+---
+
+Retrieve all configured LLM provider configurations (OpenAI, etc.) for Lighthouse AI.
+
+## Query Parameters
+
+- `filter[provider_type]` - Filter by provider type: `openai`
+- `filter[is_active]` - Filter by active status (boolean)
+- `page[number]`, `page[size]` - Pagination
+
+## Example Request
+
+```bash
+curl -X GET "https://api.prowler.com/api/v1/lighthouse/providers" \
+  -H "Authorization: Bearer YOUR_API_KEY" \
+  -H "Content-Type: application/vnd.api+json"
+```
+
+## Response
+
+Returns list of LLM provider configurations.
@@ -0,0 +1,21 @@
+---
+title: "Create Lighthouse Provider"
+api: "POST /api/v1/lighthouse/providers"
+description: "Add AI provider for Lighthouse."
+---
+
+Configure an LLM provider.
+
+## Request Body
+\`\`\`json
+{
+  "data": {
+    "type": "lighthouse-providers",
+    "attributes": {
+      "provider_type": "openai",
+      "api_key": "sk-...",
+      "name": "OpenAI Production"
+    }
+  }
+}
+\`\`\`
@@ -0,0 +1,7 @@
+---
+title: "Delete Lighthouse Provider"
+api: "DELETE /api/v1/lighthouse/providers/{id}"
+description: "Remove AI provider."
+---
+
+Delete LLM provider configuration.
@@ -0,0 +1,7 @@
+---
+title: "List Lighthouse Providers"
+api: "GET /api/v1/lighthouse/providers"
+description: "Retrieve LLM providers for Lighthouse AI."
+---
+
+Get configured AI/LLM providers (OpenAI, Azure OpenAI, etc).
@@ -0,0 +1,7 @@
+---
+title: "Refresh Lighthouse Provider Models"
+api: "POST /api/v1/lighthouse/providers/{id}/refresh-models"
+description: "Refresh available models from provider."
+---
+
+Update the list of available AI models.
@@ -0,0 +1,7 @@
+---
+title: "Retrieve Lighthouse Provider"
+api: "GET /api/v1/lighthouse/providers/{id}"
+description: "Get AI provider details."
+---
+
+Fetch LLM provider configuration.
@@ -0,0 +1,7 @@
+---
+title: "Test Lighthouse Provider Connection"
+api: "POST /api/v1/lighthouse/providers/{id}/connection"
+description: "Test AI provider connectivity."
+---
+
+Verify LLM provider is properly configured.
@@ -0,0 +1,7 @@
+---
+title: "Update Lighthouse Provider"
+api: "PATCH /api/v1/lighthouse/providers/{id}"
+description: "Update AI provider settings."
+---
+
+Modify LLM provider configuration.