Base URL: https://agent.crowdlisten.com. Read the authentication guide before calling an endpoint. This inventory includes product, connector, callback and administrative routes; availability depends on the route’s authorization and your account. It does not imply personal-key support for every operation.
151 operations
get/agent/v1/healthGet Health
Check the health of the Api
Group: Health
Request parameters, bodies, response codes and schema references:
{
"parameters": [],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/agent/v1/connectionCheck Connection
Group: agent-connection
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "entity_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Entity Id"
}
},
{
"name": "project_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Project Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/agent/v1/analysis/runRun Analysis
Queue a durable research input, then observe its saved state over NDJSON.
Group: analysis
Request parameters, bodies, response codes and schema references:
{
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnalysisRunRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/agent/v1/analysis/{analysis_id}/continueContinue Analysis
Queue one continuation against the same analysis and immutable prior input.
Group: analysis
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "analysis_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Analysis Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnalysisContinueRequest"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/agent/v1/analysis/{analysis_id}/streamStream Analysis Progress
Reconnect to a saved state snapshot; disconnecting never cancels research.
Group: analysis
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "analysis_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Analysis Id"
}
},
{
"name": "session_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Session Id"
}
},
{
"name": "job_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Job Id"
}
},
{
"name": "Last-Event-ID",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Last-Event-Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/agent/v1/analysis/inboxList Inbox Early
List inbox items for the current user. Registered before /{analysis_id} catch-all.
Group: analysis
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "status_filter",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status Filter"
}
},
{
"name": "entity_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Entity Id"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 50,
"title": "Limit"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/agent/v1/analysis/inboxSubmit To Inbox
Submit content to the processing inbox. Items are queued as 'pending' and processed by the background cron through the full enhancement pipeline (extract → enhance → classify → dedup → store to content_store). Auth: JWT or API key. Body: { items: [{ url, raw_text, source_platform, entity_id, metadata }] } Returns: { queued: N, inbox_ids: [...] }
Group: analysis
Request parameters, bodies, response codes and schema references:
{
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InboxRequest"
}
}
}
},
"responses": {
"202": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/agent/v1/analysis/{analysis_id}Get Analysis
Fetch analysis by ID. Returns complete analysis data including sentiment, themes, opinions, sources, and related topics. **Authentication:** - Optional (public analyses accessible to all) **Access Control:** - Current project/entity scope, legacy ownership, or explicit public access **Path Parameters:** - analysis_id: UUID of the analysis **Response:** - Complete analysis object with all fields
Group: analysis
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "analysis_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Analysis Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnalysisResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/agent/v1/analysis/{analysis_id}/generate-cardsGenerate Analysis Cards
Generate an LLM-orchestrated card layout for an analysis. The LLM selects which reusable card components to display, fills their data from the analysis, and optionally generates dynamic HTML cards for novel insights. Returns: { "cards": [{ "type": "...", "data": {...} }, ...] }
Group: analysis
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "analysis_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Analysis Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/agent/v1/analysis/synthesizeSynthesize Content
Synthesize supplied originals through the shared durable record pipeline.
Group: analysis
Request parameters, bodies, response codes and schema references:
{
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SynthesizeRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/agent/v1/analysis/batch-importBatch Import Urls
Import URL originals through the shared capture, job and finding contract.
Group: analysis
Request parameters, bodies, response codes and schema references:
{
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchImportRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/agent/v1/analysis/curate/analyzeAnalyze Curated Content
Group: analysis
Request parameters, bodies, response codes and schema references:
{
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CurateAnalyzeRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/agent/v1/analysis/curateSubmit Curated Content
Group: analysis
Request parameters, bodies, response codes and schema references:
{
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CurateRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/agent/v1/analysis/curate/{entity_id}List Curated Content
List all curated content for an entity.
Group: analysis
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "entity_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Entity Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/agent/v1/research/workflowsCreate Workflow
Group: research
Request parameters, bodies, response codes and schema references:
{
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchWorkflowCreate"
}
}
}
},
"responses": {
"202": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/agent/v1/research/workflowsList Workflows
Group: research
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "entity_id",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Entity Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/agent/v1/research/workflows/{workflow_id}Get Workflow
Group: research
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "workflow_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Workflow Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/agent/v1/research/workflows/{workflow_id}/resumeResume Workflow
Group: research
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "workflow_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Workflow Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/agent/v1/projects/{project_id}/analysesList Project Analyses
List all analyses for a specific project with pagination and filtering. **Access Control:** - Returns analyses if user owns the project OR project is public - Returns only user's analyses OR public analyses **Pagination:** - page: Page number (1-indexed, default: 1) - limit: Results per page (default: 20, max: 100) **Sorting:** - sort: Field and direction (e.g., "created_at:desc") - Allowed fields: created_at, updated_at, question, status, total_comments - Default: created_at:desc (newest first) **Filtering:** - status: Filter by analysis status (pending, running, completed, failed) - public: Filter by public visibility (true/false) **Response:** - List of analysis summaries (lightweight, no full content) - Pagination metadata (page, limit, total, pages)
Group: analysis
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "project_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Project Id"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 1,
"description": "Page number (1-indexed)",
"default": 1,
"title": "Page"
},
"description": "Page number (1-indexed)"
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Results per page (max 100)",
"default": 20,
"title": "Limit"
},
"description": "Results per page (max 100)"
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string",
"description": "Sort field:direction",
"default": "created_at:desc",
"title": "Sort"
},
"description": "Sort field:direction"
},
{
"name": "status",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Filter by status",
"title": "Status"
},
"description": "Filter by status"
},
{
"name": "public",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Filter by public flag",
"title": "Public"
},
"description": "Filter by public flag"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnalysesListResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/agent/v1/hosted/chatHosted Chat
Stream a chat response from the hosted agent via SSE. The agent uses direct Python tools after explicit project/entity authorization.
Group: hosted
Request parameters, bodies, response codes and schema references:
{
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HostedChatRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/agent/v1/hosted/healthHosted Health
Check if the hosted agent is available.
Group: hosted
Request parameters, bodies, response codes and schema references:
{
"parameters": [],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/agent/v1/context/recallRecall Context
Semantic search over the knowledge base with keyword fallback.
Group: context
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "query",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 1000,
"title": "Query"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 20,
"minimum": 1,
"default": 5,
"title": "Limit"
}
},
{
"name": "project_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Project Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/agent/v1/context/saveSave Context
Save a context page through the acknowledged caller/project-scoped writer.
Group: context
Request parameters, bodies, response codes and schema references:
{
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SaveRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/agent/v1/context/uploadUpload Context File
Extract and save a document through the canonical pages boundary.
Group: context
Request parameters, bodies, response codes and schema references:
{
"parameters": [],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Body_upload_context_file_agent_v1_context_upload_post"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/agent/v1/context/extractExtract Context File
Extract bounded document text for an authenticated one-off analysis.
Group: context
Request parameters, bodies, response codes and schema references:
{
"parameters": [],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Body_extract_context_file_agent_v1_context_extract_post"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/agent/v1/context/queryQuery Research
Query synthesized research documentation for an entity or topic. Returns structured findings with source counts, platform coverage, sentiment, and freshness metadata. Use this to answer questions about what the crowd is saying about a brand, product, or topic.
Group: context
Request parameters, bodies, response codes and schema references:
{
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QueryResearchRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/agent/v1/searchSearch Content
Discover source-backed evidence without synthesis.
Group: search
Request parameters, bodies, response codes and schema references:
{
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/agent/v1/ingest/collection-planGet Collection Plan
Read saved product/competitor scope without starting providers or granting access.
Group: ingest
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "entity_id",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Entity Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/agent/v1/ingest/contentCapture complete sources and comments with acknowledged IDs
Capture all originals and parent links atomically; analysis is a separate step.
Group: ingest
Request parameters, bodies, response codes and schema references:
{
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IngestContentRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IngestContentResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/agent/v1/ingest/coverageRecord collector coverage for an entity/platform scope
Record what a collector attempted and whether coverage is proven. This is intentionally separate from row insertion: a collector can prove a target is blocked or fully exhausted even when zero new rows were stored because all posts were already deduplicated.
Group: ingest
Request parameters, bodies, response codes and schema references:
{
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CoverageRecordRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CoverageRecordResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/agent/v1/ingest/trigger-pipelineTrigger the content processing pipeline for an entity
Acknowledge a durable job; its status/result reader owns completion.
Group: ingest
Request parameters, bodies, response codes and schema references:
{
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TriggerPipelineRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/agent/v1/ingest/filterFilter discovered content for relevance before deep extraction
Filter discovered content for relevance before deep extraction. Runs the LLM relevance classifier on a list of lightweight source items and returns per-item verdicts plus a recommended-for-extraction URL list. Designed to be called between discovery (search) and expensive extraction (transcript / full-text fetch) so that only relevant or marginal sources are extracted.
Group: ingest
Request parameters, bodies, response codes and schema references:
{
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FilterRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FilterResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/agent/v1/ingest/deep-extractExtract and capture complete comments with their source references
Preserve all retrieved originals; each item has its own atomic capture receipt.
Group: ingest
Request parameters, bodies, response codes and schema references:
{
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeepExtractRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeepExtractResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/agent/v1/ingest/research/jobsCreate Research Job
Queue entity research on the shared capture/findings ledger.
Group: ingest
Request parameters, bodies, response codes and schema references:
{
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchJobRequest"
}
}
}
},
"responses": {
"202": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchJobAccepted"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/agent/v1/ingest/research/jobsList Research Jobs
Read bounded saved job history for a currently accessible entity.
Group: ingest
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "entity_id",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Entity Id"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"default": 50,
"title": "Limit"
}
},
{
"name": "offset",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"default": 0,
"title": "Offset"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/agent/v1/ingest/collection/jobsCreate Collection Job
A distinct route fails closed on older servers instead of starting synthesis.
Group: ingest
Request parameters, bodies, response codes and schema references:
{
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchJobRequest"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchJobAccepted"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/agent/v1/ingest/research/jobs/{job_id}Get Research Job
Return a research job only when the caller can view its analysis or entity.
Group: ingest
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "job_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Job Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/agent/v1/ingest/researchResearch Entity
Run all entity questions through durable capture and cited findings.
Group: ingest
Request parameters, bodies, response codes and schema references:
{
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResearchResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/agent/v1/export/manifestList exportable datasets and entities
Group: export
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "workspace_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Workspace Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/agent/v1/export/completenessAudit raw export coverage and completeness
Return conservative coverage metrics for agent triage. This endpoint distinguishes export completeness from collection completeness: every table export is pageable, but source collection is only exhaustive when the stored rows carry explicit coverage metadata from a platform/account crawl.
Group: export
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "workspace_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Workspace Id"
}
},
{
"name": "entity_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Entity Id"
}
},
{
"name": "platform",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Platform"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/agent/v1/export/table/{table_name}Export raw rows from an allowed table
Group: export
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "table_name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Table Name"
}
},
{
"name": "workspace_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Workspace Id"
}
},
{
"name": "entity_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Entity Id"
}
},
{
"name": "platform",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Platform"
}
},
{
"name": "project_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Project Id"
}
},
{
"name": "path_prefix",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Path Prefix"
}
},
{
"name": "parent_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Parent Id"
}
},
{
"name": "parents_only",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": false,
"title": "Parents Only"
}
},
{
"name": "since",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "ISO timestamp lower bound on created_at",
"title": "Since"
},
"description": "ISO timestamp lower bound on created_at"
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 5000,
"minimum": 1,
"default": 1000,
"title": "Limit"
}
},
{
"name": "offset",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"default": 0,
"title": "Offset"
}
},
{
"name": "include_embeddings",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": false,
"title": "Include Embeddings"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/agent/v1/content/embedEmbed Text
Generate an embedding vector for the given text.
Group: embed
Request parameters, bodies, response codes and schema references:
{
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmbedRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/agent/v1/intelligence/summaryGet Intelligence Summary
Return an evidence-backed cross-channel intelligence readout.
Group: intelligence
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "entity_id",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"title": "Entity Id"
}
},
{
"name": "window_days",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 365,
"minimum": 7,
"default": 30,
"title": "Window Days"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/agent/v1/intelligence/refreshRefresh Intelligence
Accept durable per-entity research; inspect returned jobs for actual results.
Group: intelligence
Request parameters, bodies, response codes and schema references:
{
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntelligenceRefreshRequest"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/agent/v1/knowledge/insights/{insight_id}/curationCurate Knowledge Insight
Group: agent-knowledge
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "insight_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Insight Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InsightCuration"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/agent/v1/knowledge/insightsCreate Knowledge Insight
Save a grounded synthesis under the caller's explicit entity/project scope.
Group: agent-knowledge
Request parameters, bodies, response codes and schema references:
{
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InsightWrite"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/agent/v1/knowledge/insightsList Knowledge Insights
Group: agent-knowledge
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "entity_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Entity Id"
}
},
{
"name": "project_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Project Id"
}
},
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"maxLength": 300
},
{
"type": "null"
}
],
"title": "Query"
}
},
{
"name": "tag",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"type": "null"
}
],
"title": "Tag"
}
},
{
"name": "include_archived",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": false,
"title": "Include Archived"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"enum": [
"updated_at",
"title",
"created_at"
],
"type": "string",
"default": "updated_at",
"title": "Sort"
}
},
{
"name": "order",
"in": "query",
"required": false,
"schema": {
"enum": [
"asc",
"desc"
],
"type": "string",
"default": "desc",
"title": "Order"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"default": 20,
"title": "Limit"
}
},
{
"name": "offset",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 2147483547,
"minimum": 0,
"default": 0,
"title": "Offset"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
put/agent/v1/knowledge/insights/{insight_id}Update Knowledge Insight
Replace a synthesis at its expected revision; _save authorizes the actor.
Group: agent-knowledge
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "insight_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Insight Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InsightWrite"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
patch/agent/v1/knowledge/insights/{insight_id}Edit Knowledge Insight Text
Version a text correction without replacing any stored evidence references.
Group: agent-knowledge
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "insight_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Insight Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InsightTextEdit"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/agent/v1/knowledge/insights/{insight_id}Get Knowledge Insight
Group: agent-knowledge
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "insight_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Insight Id"
}
},
{
"name": "entity_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Entity Id"
}
},
{
"name": "project_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Project Id"
}
},
{
"name": "revision",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
],
"title": "Revision"
}
},
{
"name": "include_evidence",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": true,
"title": "Include Evidence"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/agent/v1/knowledge/contextGet Knowledge Context
A bounded view of current canonical records; never a second generated store.
Group: agent-knowledge
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "entity_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Entity Id"
}
},
{
"name": "project_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Project Id"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"default": 20,
"title": "Limit"
}
},
{
"name": "offset",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 2147483547,
"minimum": 0,
"default": 0,
"title": "Offset"
}
},
{
"name": "max_chars",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 50000,
"minimum": 500,
"default": 16000,
"title": "Max Chars"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/agent/v1/knowledge/contentList Knowledge Content
Discover source IDs across an authorized entity, including shared entities.
Group: agent-knowledge
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "entity_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Entity Id"
}
},
{
"name": "project_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Project Id"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"default": 20,
"title": "Limit"
}
},
{
"name": "offset",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 2147483547,
"minimum": 0,
"default": 0,
"title": "Offset"
}
},
{
"name": "platform",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 60
},
{
"type": "null"
}
],
"title": "Platform"
}
},
{
"name": "personal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": false,
"title": "Personal"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/agent/v1/knowledge/content/{content_id}Get Knowledge Content
Read original uncited source text so agents can form exact citations.
Group: agent-knowledge
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "content_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Content Id"
}
},
{
"name": "entity_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Entity Id"
}
},
{
"name": "project_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Project Id"
}
},
{
"name": "personal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": false,
"title": "Personal"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/agent/v1/knowledge/content/{content_id}/acquisitionsGet Content Acquisitions
Read provider history in stable ID order, under the current source scope.
Group: agent-knowledge
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "content_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Content Id"
}
},
{
"name": "entity_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Entity Id"
}
},
{
"name": "project_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Project Id"
}
},
{
"name": "after",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 9223372036854776000,
"minimum": 0,
"default": 0,
"title": "After"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"default": 20,
"title": "Limit"
}
},
{
"name": "personal",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": false,
"title": "Personal"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/agent/v1/knowledge/sources/{source_revision_id}Get Knowledge Source
Group: agent-knowledge
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "source_revision_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Source Revision Id"
}
},
{
"name": "entity_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Entity Id"
}
},
{
"name": "project_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Project Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/agent/v1/knowledge/changesGet Knowledge Changes
Group: agent-knowledge
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "entity_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Entity Id"
}
},
{
"name": "project_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Project Id"
}
},
{
"name": "after",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 9223372036854776000,
"minimum": 0,
"default": 0,
"title": "After"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"default": 50,
"title": "Limit"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/agent/v1/metrics/provider-usageGet Provider Usage
Get LLM provider usage statistics. Returns provider usage counts, percentages, costs, and overall metrics. Returns: dict: Provider usage statistics including: - total_requests: Total number of LLM requests - providers: Dictionary of provider stats (uses, percentage, cost) - timestamp: When stats were generated
Group: metrics
Request parameters, bodies, response codes and schema references:
{
"parameters": [],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/agent/v1/metrics/healthGet Metrics Health
Get metrics system health status. Returns: dict: Health status including available providers
Group: metrics
Request parameters, bodies, response codes and schema references:
{
"parameters": [],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/api/discord/resolve-inviteResolve Discord Invite
Resolve a Discord invite link to get server information. Returns guild info, whether our bot is in the server, and available channels.
Group: source-management
Request parameters, bodies, response codes and schema references:
{
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResolveInviteRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResolveInviteResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/api/channels/reddit-collectCollect Reddit For Ingestion
Collect citation-backed Reddit sources for the private ingestion worker.
Group: source-management
Request parameters, bodies, response codes and schema references:
{
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CollectRedditRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/api/reddit/validate-subredditValidate Subreddit
Validate that a subreddit exists and is accessible.
Group: source-management
Request parameters, bodies, response codes and schema references:
{
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidateSubredditRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidateSubredditResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/api/slack/oauth/startSlack Oauth Start
Return an authorize URL bound to the verified user with signed state.
Group: source-management
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "return_to",
"in": "query",
"required": false,
"schema": {
"type": "string",
"default": "",
"title": "Return To"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/api/slack/oauth/callbackSlack Oauth Callback
Handle Slack OAuth callback — exchange code for token, store installation.
Group: source-management
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "code",
"in": "query",
"required": false,
"schema": {
"type": "string",
"default": "",
"title": "Code"
}
},
{
"name": "state",
"in": "query",
"required": false,
"schema": {
"type": "string",
"default": "",
"title": "State"
}
},
{
"name": "error",
"in": "query",
"required": false,
"schema": {
"type": "string",
"default": "",
"title": "Error"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/api/slack/channelsList Slack Channels
List Slack channels for a user's connected workspace.
Group: source-management
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "team_id",
"in": "query",
"required": true,
"schema": {
"type": "string",
"title": "Team Id"
}
},
{
"name": "cursor",
"in": "query",
"required": false,
"schema": {
"type": "string",
"default": "",
"title": "Cursor"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/api/slack/installationsGet Slack Installations
Get all Slack workspaces connected by a user.
Group: source-management
Request parameters, bodies, response codes and schema references:
{
"parameters": [],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/api/slack/syncSync Slack Channel
Import one explicitly selected Slack channel page into entity evidence.
Group: source-management
Request parameters, bodies, response codes and schema references:
{
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SlackSyncRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/api/slack/messagesSend Slack Message
Post one user-reviewed message through the customer's installation.
Group: source-management
Request parameters, bodies, response codes and schema references:
{
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SlackMessageRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/api/granola/validate-keyValidate Granola Key
Validate a Granola API key against the official public Notes API.
Group: source-management
Request parameters, bodies, response codes and schema references:
{
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GranolaKeyRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/api/granola/syncSync Granola Notes
Import one bounded note page; summaries never become transcript quotations.
Group: source-management
Request parameters, bodies, response codes and schema references:
{
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GranolaSyncRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/api/user/keysCreate API key
Create a new API key. The raw key is returned once and never stored.
Group: API Key Management
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "authorization",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateKeyRequest"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/api/user/keysList API keys
List all API keys for the authenticated user. Keys are masked.
Group: API Key Management
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "authorization",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
delete/api/user/keys/{key_id}Revoke API key
Soft-delete an API key by setting is_active=false.
Group: API Key Management
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "key_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Key Id"
}
},
{
"name": "authorization",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/api/user/keys/{key_id}/usageGet key usage stats
Get usage stats for a specific API key, grouped by scope and month.
Group: API Key Management
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "key_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Key Id"
}
},
{
"name": "authorization",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/api/observations/submitSubmit Observations
Submit 1-50 observations. Auth (two modes): 1. Connector API key via X-Api-Key header or Authorization: Bearer cl_obs_* — scopes to connector's project. 2. User JWT via Authorization: Bearer <jwt> — requires project_id in request body. Atomically accepts immutable source snapshots and acknowledges each stored ID. Exact retries return the same IDs. Redis is an optional cron wakeup.
Group: observations
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "X-Api-Key",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"name": "authorization",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubmitObservationsRequest"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/api/observations/feedGet Observation Feed
Get observation feed for a project. Auth: User JWT (via middleware setting request.state.user_id). Returns observations ordered by created_at DESC with optional filters.
Group: observations
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"schema": {
"type": "string",
"description": "Project ID to get observations for",
"title": "Project Id"
},
"description": "Project ID to get observations for"
},
{
"name": "type",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Filter by observation_type",
"title": "Type"
},
"description": "Filter by observation_type"
},
{
"name": "status",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Filter by processing_status",
"title": "Status"
},
"description": "Filter by processing_status"
},
{
"name": "days",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 90,
"minimum": 1,
"description": "Number of days to look back",
"default": 7,
"title": "Days"
},
"description": "Number of days to look back"
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 200,
"minimum": 1,
"description": "Maximum observations to return",
"default": 50,
"title": "Limit"
},
"description": "Maximum observations to return"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/api/observations/themesGet Observation Themes
Get observation themes with stats for a project. Auth: User JWT. Returns themes ordered by observation_count DESC.
Group: observations
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"schema": {
"type": "string",
"description": "Project ID to get themes for",
"title": "Project Id"
},
"description": "Project ID to get themes for"
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Maximum themes to return",
"default": 20,
"title": "Limit"
},
"description": "Maximum themes to return"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/api/observations/themes/{theme_id}Get Theme Detail
Get a single theme with its linked observations. Auth: User JWT. Returns the theme record and all observations linked via observation_theme_links.
Group: observations
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "theme_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Theme Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/api/observations/processTrigger Observation Processing
Trigger observation processing pipeline for a project. Auth: User JWT or cron key (via X-Cron-Key header matching CRON_SECRET env var). Calls the observation_processor.process_observations() function.
Group: observations
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "X-Cron-Key",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Cron-Key"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessRequest"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/api/observations/resolvedGet Resolved Observations Endpoint
Get recently resolved observations for a project. Auth: User JWT. Returns observations that have been resolved (via kanban card status changes) within the specified time window.
Group: observations
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"schema": {
"type": "string",
"description": "Project ID",
"title": "Project Id"
},
"description": "Project ID"
},
{
"name": "since_days",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 90,
"minimum": 1,
"description": "Days to look back",
"default": 7,
"title": "Since Days"
},
"description": "Days to look back"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/api/observations/{observation_id}/resolveResolve Observation Endpoint
Manually resolve a single observation. Auth: User JWT. Sets the resolution status and optional note on an observation.
Group: observations
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "observation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Observation Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResolveObservationRequest"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/api/connectorsCreate connector
Create a new agent connector with a unique observation API key. Returns the full API key (shown once only on creation).
Group: connectors
Request parameters, bodies, response codes and schema references:
{
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateConnectorRequest"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/api/connectorsList connectors
List all connectors for the authenticated user. Optionally filter by project_id. API keys are masked in the response.
Group: connectors
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "project_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Project Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
delete/api/connectors/{connector_id}Deactivate connector
Soft-deactivate a connector by setting is_active=False.
Group: connectors
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "connector_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Connector Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/api/entities/discovery/x-affiliatesX Organization Affiliates
Group: entities
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "organization",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 500,
"title": "Organization"
}
},
{
"name": "cursor",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"maxLength": 20
},
{
"type": "null"
}
],
"title": "Cursor"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/api/entitiesCreate Entity
Create a new entity (named thing to track).
Group: entities
Request parameters, bodies, response codes and schema references:
{
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateEntityRequest"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/api/entitiesList Entities
List current personal/shared entities and their saved source configuration.
Group: entities
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "workspace_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Workspace Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/api/entities/onboardingComplete Onboarding
Create the complete onboarding workspace in one database transaction.
Group: entities
Request parameters, bodies, response codes and schema references:
{
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CompleteOnboardingRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/api/entities/workspace-contextGet Workspace Context
Returns structured overview of all tracked entities with key findings. Provides a single-call snapshot of every entity the user tracks, including recent KB pages, observation counts, and active theme counts. Designed for agents that need cross-entity awareness without N+1 queries.
Group: entities
Request parameters, bodies, response codes and schema references:
{
"parameters": [],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/api/entities/{entity_id}Get Entity
Get entity with its child products.
Group: entities
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "entity_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Entity Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
put/api/entities/{entity_id}Update Entity
Update an entity's properties.
Group: entities
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "entity_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Entity Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateEntityRequest"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
delete/api/entities/{entity_id}Delete Entity
Delete an entity and its child products (CASCADE).
Group: entities
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "entity_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Entity Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/api/entities/{entity_id}/contentGet Entity Content
List stored content for an entity or all user content. Returns paginated content_store items: posts, videos with engagement and comment counts. The persistent content layer that analyses build on. Pass entity_id="all" to get all user content (not filtered by entity). Query params: platform: Filter by platform (tiktok, youtube, reddit, instagram) limit: Max results (default 50) offset: Pagination offset (default 0)
Group: entities
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "entity_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Entity Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/api/entities/{entity_id}/analyticsGet Entity Analytics
Temporal + comparative analytics from existing content data. Computes mention timelines, sentiment trajectories, platform breakdowns, and per-insight velocity metrics via in-Python aggregation over content_store, opinion_units, entity_insights, and insight_evidence.
Group: entities
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "entity_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Entity Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/api/entities/{entity_id}/pipeline-summaryGet Pipeline Summary
Return processing stage counts for an entity's content_store rows.
Group: entities
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "entity_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Entity Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/api/entities/{entity_id}/linkLink Entity To Project
Link an entity to a project.
Group: entities
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "entity_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Entity Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LinkEntityRequest"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
delete/api/entities/{entity_id}/link/{project_id}Unlink Entity From Project
Unlink an entity from a project.
Group: entities
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "entity_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Entity Id"
}
},
{
"name": "project_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Project Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/api/entities/project/{project_id}List Project Entities
List all entities linked to a project.
Group: entities
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "project_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Project Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/api/entities/public/{project_id}List Public Project Entities
List entities for a public project (no auth required).
Group: entities
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "project_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Project Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
patch/api/entities/{entity_id}/config/compareCompare Entity Config
Reject stale edits without replacing another writer's saved configuration.
Group: entities
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "entity_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Entity Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CompareConfigRequest"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
patch/api/entities/{entity_id}/configPatch Entity Config
Merge top-level keys atomically; null deletes only that key.
Group: entities
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "entity_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Entity Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchConfigRequest"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/api/entities/trigger-researchTrigger Entity Research
Find entities due for research. Returns list of due entities for the calling agent to process. Filtering logic: - research_enabled is not explicitly false - no queued or running research job in the durable ledger - last_research_at older than research_interval_hours (default 24) - entity has at least one linked project - max 5 concurrent entity jobs in the workspace (or personal owner scope)
Group: entities
Request parameters, bodies, response codes and schema references:
{
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TriggerResearchRequest",
"default": {}
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/api/entities/{entity_id}/enrichEnrich Entity
Manual fallback: trigger server-side enrichment via LLM + web search. Primary enrichment is agent-driven via entity-research SKILL.md. This endpoint exists for users without a connected agent.
Group: entities
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "entity_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Entity Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/api/entities/{entity_id}/enrich-syncEnrich Entity Sync
Synchronous enrichment: waits for result and returns extracted fields. Used during onboarding verification step. Returns description, industry, keywords, and suggested_tags for user to review before proceeding.
Group: entities
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "entity_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Entity Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/api/entities/discover-competitorsDiscover Competitors
Find competitors using the supported discovery service + LLM extraction.
Group: entities
Request parameters, bodies, response codes and schema references:
{
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DiscoverCompetitorsRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/api/entities/scheduler/healthScheduler Health
Scheduler status + per-entity team status for the authenticated user.
Group: entities
Request parameters, bodies, response codes and schema references:
{
"parameters": [],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/api/entities/{entity_id}/insightsGet Entity Insights
Get pre-computed insights for an entity.
Group: entities
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "entity_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Entity Id"
}
},
{
"name": "category",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Category"
}
},
{
"name": "status",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/api/entities/{entity_id}/skillsGet Entity Skills
Group: entities
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "entity_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Entity Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
put/api/entities/{entity_id}/skillsSave Entity Skills
Group: entities
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "entity_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Entity Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SkillSettings"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/api/entities/{entity_id}/skill-routinesGet Skill Routines
Group: entities
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "entity_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Entity Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
put/api/entities/{entity_id}/skills/{skill_id}/routineConfigure Skill Routine
Group: entities
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "entity_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Entity Id"
}
},
{
"name": "skill_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Skill Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SkillRoutineSettings"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/api/entities/{entity_id}/skill-runsList Skill Runs
Group: entities
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "entity_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Entity Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/api/entities/{entity_id}/skills/{skill_id}/runsRun Saved Skill
Group: entities
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "entity_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Entity Id"
}
},
{
"name": "skill_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Skill Id"
}
},
{
"name": "source_mode",
"in": "query",
"required": false,
"schema": {
"type": "string",
"default": "saved",
"title": "Source Mode"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/api/entities/{entity_id}/insights/generateGenerate Entity Insights
Queue the same stored-source job used by collectors and sweeps.
Group: entities
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "entity_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Entity Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
patch/api/entities/{entity_id}/insights/{insight_id}Update Insight Status
Update insight status (investigating, actioned, resolved) or urgency.
Group: entities
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "entity_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Entity Id"
}
},
{
"name": "insight_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Insight Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/api/entities/{entity_id}/insights/{insight_id}/generate-artifactGenerate Insight Artifact
Generate an artifact (PRD, battlecard, etc.) from an insight.
Group: entities
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "entity_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Entity Id"
}
},
{
"name": "insight_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Insight Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/api/entities/{entity_id}/topic-glossaryGet Topic Glossary
Generate a topic glossary from the entity's knowledge base. Parses the entity's compounding KB document (research/{slug}) and extracts a structured topic tree for the left sidebar navigation.
Group: entities
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "entity_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Entity Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/api/entities/{entity_id}/generate-reportGenerate Research Report
Generate a comprehensive research report from all crowd signals for an entity.
Group: entities
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "entity_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Entity Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/api/entities/{entity_id}/relationshipsGet Entity Relationships
Returns related entities with relationship types and evidence counts.
Group: entities
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "entity_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Entity Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/api/entities/{entity_id}/activityGet Entity Activity
Returns recent agent activity log entries for an entity.
Group: entities
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "entity_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Entity Id"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 20,
"title": "Limit"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/api/entities/{entity_id}/aliasesGet Entity Aliases
List all aliases for an entity.
Group: entities
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "entity_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Entity Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/api/entities/{entity_id}/aliasesAdd Entity Alias
Add an alias for an entity. Body: { "alias": "string", "source": "manual"|"enrichment"|"inferred"|"social_handle" }
Group: entities
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "entity_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Entity Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": true,
"title": "Body"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
delete/api/entities/{entity_id}/aliases/{alias_id}Delete Entity Alias
Delete an alias.
Group: entities
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "entity_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Entity Id"
}
},
{
"name": "alias_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Alias Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/api/entities/{entity_id}/usage-accountConnect Workspace Usage
Connect from the owner's CrowdListen session; no external personal key.
Group: AWB integration
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "entity_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Entity Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkspaceUsageRequest"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/api/entities/{entity_id}/usage-accountBalance
Group: AWB integration
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "entity_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Entity Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/api/v1/integrations/awb/connectionConnection
Group: AWB integration
Request parameters, bodies, response codes and schema references:
{
"parameters": [],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/api/entities/{entity_id}/usage-account/switch-to-productionProduction Billing Proposal
Group: AWB integration
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "entity_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Entity Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/api/entities/{entity_id}/usage-account/switch-to-productionSwitch Production Billing
Group: AWB integration
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "entity_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Entity Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BillingTransitionRequest"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
delete/api/entities/{entity_id}/usage-account/switch-to-productionCancel Production Billing
Group: AWB integration
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "entity_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Entity Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BillingTransitionCancel"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/api/entities/{entity_id}/integrations/awbConnect
Group: AWB integration
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "entity_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Entity Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectRequest"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/api/entities/{entity_id}/integrations/awbBalance
Group: AWB integration
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "entity_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Entity Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/api/entities/{entity_id}/usage-account/checkoutWorkspace Checkout
Group: AWB integration
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "entity_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Entity Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkspaceCheckoutRequest"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/api/entities/{entity_id}/usage-account/activate-creditsActivate Prepaid
Owner-approved, retry-safe migration; no checkout or provider work.
Group: AWB integration
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "entity_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Entity Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PrepaidActivationRequest"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/api/v1/integrations/awb/analysisAnalyze
Group: AWB integration
Request parameters, bodies, response codes and schema references:
{
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FeedbackRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/agent/v1/models/routerModel Router Status
Group: Models
Request parameters, bodies, response codes and schema references:
{
"parameters": [],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/api/sweeps/focusGet Sweep Focus
Read the shared Product/Marketing focus and scheduler settings.
Group: sweeps
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "entity_id",
"in": "query",
"required": true,
"schema": {
"type": "string",
"title": "Entity Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
patch/api/sweeps/focusUpdate Sweep Focus
Update shared focus as an editor/owner; viewers remain read-only.
Group: sweeps
Request parameters, bodies, response codes and schema references:
{
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FocusUpdate"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/api/sweeps/runRun Sweeps
Run a bounded cron sweep or one editor-authorized manual sweep.
Group: sweeps
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "X-Cron-Key",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Cron-Key"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SweepRunRequest"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/api/sweeps/objectsCreate Workflow Object
Create an open, user-authored workflow Action for an entity.
Group: sweeps
Request parameters, bodies, response codes and schema references:
{
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkflowObjectCreate"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/api/sweeps/objectsList Enrichment Objects
Return general workflows and legacy generated Actions for an entity.
Group: sweeps
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "entity_id",
"in": "query",
"required": true,
"schema": {
"type": "string",
"title": "Entity Id"
}
},
{
"name": "status",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"open",
"acting",
"done",
"dismissed"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Status"
}
},
{
"name": "object_type",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Object Type"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 200,
"minimum": 1,
"default": 50,
"title": "Limit"
}
},
{
"name": "offset",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 2147483447,
"minimum": 0,
"default": 0,
"title": "Offset"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
patch/api/sweeps/objects/{object_id}Update Enrichment Object
Advance/dismiss an action object as a workspace editor or owner.
Group: sweeps
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "object_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Object Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnrichmentObjectUpdate"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/api/sweeps/healthSweeps Health
Return recent activity only for an entity the caller can read.
Group: sweeps
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "entity_id",
"in": "query",
"required": true,
"schema": {
"type": "string",
"title": "Entity Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/api/sweeps/objects/{action_id}/executionsCreate Execution Run
Create an explicitly approved handoff for a host agent to execute.
Group: action-executions
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "action_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Action Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExecutionRunCreate"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/api/sweeps/objects/{action_id}/executionsList Execution Runs
List execution handoffs and reviewed outcomes for an Action.
Group: action-executions
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "action_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Action Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
patch/api/sweeps/executions/{execution_id}Update Execution Run
Persist a host-agent outcome; owners alone approve portable training use.
Group: action-executions
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "execution_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Execution Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExecutionRunUpdate"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/api/highlightsSave Highlight
Save a single highlight to the knowledge table.
Group: highlights
Request parameters, bodies, response codes and schema references:
{
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HighlightRequest"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
get/api/highlightsGet Highlights
Get highlights for a URL or entity.
Group: highlights
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "url",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
}
},
{
"name": "entity_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Entity Id"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 50,
"title": "Limit"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/api/highlights/batchSave Highlights Batch
Save multiple highlights at once.
Group: highlights
Request parameters, bodies, response codes and schema references:
{
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchHighlightRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
delete/api/highlights/{highlight_id}Delete Highlight
Delete a highlight.
Group: highlights
Request parameters, bodies, response codes and schema references:
{
"parameters": [
{
"name": "highlight_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Highlight Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/api/tools/analyze-urlAnalyze Url
Analyze a single video URL — transcript, comments, engagement-weighted themes. Public endpoint, no auth required. Rate limited to 3 per day per IP. Supports: TikTok, YouTube, Instagram, Reddit, X/Twitter, Hacker News. Uses unified source_processing layer: 1. process_source() → extract metadata + transcript + comments, enhance source + comments 2. _cluster_opinions() → cluster enhanced comments into themes (single-URL operation)
Group: tools-public
Request parameters, bodies, response codes and schema references:
{
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnalyzeUrlRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/api/tools/transcribeTranscribe Audio
Transcribe uploaded audio file. Free (no auth): raw transcript, rate-limited 3/day. Authenticated (user_id): unlimited + stores in content_store. Authenticated + entity_slug: also enhances with KB context.
Group: tools-audio
Request parameters, bodies, response codes and schema references:
{
"parameters": [],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Body_transcribe_audio_api_tools_transcribe_post"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.
post/api/tools/transcribe/enhanceEnhance Existing Transcript
Enhance an existing transcript with entity KB context. Requires auth.
Group: tools-audio
Request parameters, bodies, response codes and schema references:
{
"parameters": [],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/Body_enhance_existing_transcript_api_tools_transcribe_enhance_post"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}Schema references resolve under components.schemas in the complete snapshot.