{ "openapi": "3.1.1", "info": { "title": "RscHub.Api | v1", "version": "1.0.0" }, "servers": [ { "url": "https://www.researchprotocol.io/" } ], "paths": { "/health": { "get": { "tags": [ "Health" ], "operationId": "Liveness", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/auth/act-as/consume": { "get": { "tags": [ "Auth" ], "operationId": "AdminActAsConsume", "parameters": [ { "name": "token", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/tickers/search": { "get": { "tags": [ "Search" ], "operationId": "SearchTickers", "parameters": [ { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 10 } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "safe" } }, "/api/v1/ingest": { "post": { "tags": [ "Ingest" ], "operationId": "IngestNotes", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IngestRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "partial" } }, "/api/v1/ingest/prices": { "post": { "tags": [ "Ingest" ], "operationId": "IngestPrices", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PriceIngestRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/ingest/prices/tickers": { "get": { "tags": [ "Ingest" ], "operationId": "ListPriceTickers", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/ingest/readership/research-tree": { "post": { "tags": [ "Ingest" ], "operationId": "IngestResearchTreeReadership", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResearchTreeReadershipIngestRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/upload": { "post": { "tags": [ "Ingest" ], "operationId": "UploadHostedContent", "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "file" ], "type": "object", "properties": { "file": { "$ref": "#/components/schemas/IFormFile" } } } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "partial" } }, "/api/v1/companies/{exchange}/{ticker}": { "get": { "tags": [ "Company Forecasts" ], "operationId": "GetCompanyConsensus", "parameters": [ { "name": "exchange", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ticker", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "safe" } }, "/api/v1/companies/{exchange}/{ticker}/forecasts": { "get": { "tags": [ "Company Forecasts" ], "operationId": "GetCompanyForecasts", "parameters": [ { "name": "exchange", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ticker", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "safe" } }, "/api/v1/companies/{exchange}/{ticker}/history": { "get": { "tags": [ "Company Forecasts" ], "operationId": "GetCompanyHistory", "parameters": [ { "name": "exchange", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ticker", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "safe" } }, "/api/v1/companies/{exchange}/{ticker}/providers/{providerId}/model": { "get": { "tags": [ "Company Forecasts" ], "operationId": "GetCompanyProviderModel", "parameters": [ { "name": "exchange", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ticker", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "providerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "safe" } }, "/api/v1/portal/companies/{exchange}/{ticker}/forecasts": { "get": { "tags": [ "Branded Portal" ], "operationId": "GetPortalCompanyForecasts", "parameters": [ { "name": "exchange", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ticker", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "safe" } }, "/api/v1/me/key-research": { "get": { "tags": [ "Content" ], "operationId": "GetKeyResearch", "parameters": [ { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "safe" } }, "/api/v1/portal/analysts/departed": { "get": { "tags": [ "Branded Portal" ], "operationId": "PortalDepartedAnalysts", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "safe" } }, "/api/v1/feed": { "get": { "tags": [ "Research" ], "operationId": "GetResearchFeed", "parameters": [ { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } }, { "name": "offset", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 0 } }, { "name": "sectors", "in": "query", "schema": { "type": "string" } }, { "name": "analysts", "in": "query", "schema": { "type": "string" } }, { "name": "tickers", "in": "query", "schema": { "type": "string" } }, { "name": "provider_id", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "note_type", "in": "query", "schema": { "type": "string" } }, { "name": "since", "in": "query", "schema": { "type": "string" } }, { "name": "rating_changes", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "language", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "safe" } }, "/api/v1/feed/facets": { "get": { "tags": [ "Research" ], "operationId": "GetResearchFeedFacets", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/org-users": { "get": { "tags": [ "Organisation" ], "operationId": "ListOrgUsers", "parameters": [ { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 100 } }, { "name": "offset", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 0 } }, { "name": "include_archived", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/org-users/invite": { "post": { "tags": [ "Organisation" ], "operationId": "InviteOrgUser", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/InviteRequest" } ] } } } }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/org-users/{userId}:archive": { "post": { "tags": [ "Organisation" ], "operationId": "ArchiveOrgUser", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/org-users:archive-bulk": { "post": { "tags": [ "Organisation" ], "operationId": "ArchiveOrgUsersBulk", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/BulkArchiveRequest" } ] } } } }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/org-users/{userId}:unarchive": { "post": { "tags": [ "Organisation" ], "operationId": "UnarchiveOrgUser", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/org-users/{userId}/role": { "patch": { "tags": [ "Organisation" ], "operationId": "ChangeOrgUserRole", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ChangeOrgUserRoleRequest" } ] } } } }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/org-users/{userId}:adopt": { "post": { "tags": [ "Organisation" ], "operationId": "AdoptOrgUser", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/orgs/{orgId}/erasure": { "delete": { "tags": [ "GDPR" ], "operationId": "ProcessOrgErasure", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/orgs/{orgId}/data-export": { "get": { "tags": [ "GDPR" ], "operationId": "GetOrgDataExport", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/portal/config": { "get": { "tags": [ "Portal" ], "operationId": "GetPortalConfig", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "safe" } }, "/api/v1/portal/register": { "post": { "tags": [ "Branded Portal" ], "operationId": "PortalRegister", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortalRegisterRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/portal/feed": { "get": { "tags": [ "Branded Portal" ], "operationId": "PortalFeed", "parameters": [ { "name": "offset", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "language", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "safe" } }, "/api/v1/portal/hero": { "get": { "tags": [ "Branded Portal" ], "operationId": "PortalHero", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "safe" } }, "/robots.txt": { "get": { "tags": [ "Public" ], "operationId": "RobotsTxt", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "safe" } }, "/sitemap.xml": { "get": { "tags": [ "Public" ], "operationId": "Sitemap", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "safe" } }, "/llms.txt": { "get": { "tags": [ "Public" ], "operationId": "LlmsTxt", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "safe" } }, "/.well-known/mcp.json": { "get": { "tags": [ "Public" ], "operationId": "WellKnownMcpJson", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "safe" } }, "/.well-known/agent.json": { "get": { "tags": [ "Public" ], "operationId": "WellKnownAgentJson", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "safe" } }, "/api/v1/agents/signup": { "post": { "tags": [ "Agents" ], "operationId": "AgentSignup", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSignupRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "partial" } }, "/api/v1/agents/me": { "get": { "tags": [ "Agents" ], "operationId": "AgentSelf", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "safe" } }, "/api/v1/providers/me/analytics/agent-consumption": { "get": { "tags": [ "Provider Portal" ], "operationId": "GetProviderAgentConsumption", "parameters": [ { "name": "days", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 30 } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "safe" } }, "/api/v1/providers/me/analytics/readership": { "get": { "tags": [ "Provider Portal" ], "operationId": "GetProviderReadership", "parameters": [ { "name": "from", "in": "query", "schema": { "type": "string" } }, { "name": "to", "in": "query", "schema": { "type": "string" } }, { "name": "days", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/analytics/readership/events": { "get": { "tags": [ "Provider Portal" ], "operationId": "GetProviderReadershipEvents", "parameters": [ { "name": "from", "in": "query", "schema": { "type": "string" } }, { "name": "to", "in": "query", "schema": { "type": "string" } }, { "name": "days", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "page", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "page_size", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/users/me/preferences": { "get": { "tags": [ "Localisation" ], "operationId": "GetUserLocalePreferences", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" }, "patch": { "tags": [ "Localisation" ], "operationId": "PatchUserLocalePreferences", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocalePreferencesPatch" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/me/locale": { "put": { "tags": [ "Localisation" ], "operationId": "SetUserLocale", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetLocaleRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/notes/{noteId}/readership": { "get": { "tags": [ "Provider Portal" ], "operationId": "GetMyProviderNoteReadership", "parameters": [ { "name": "noteId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/notes/extract-metadata": { "post": { "tags": [ "Provider Portal" ], "operationId": "ExtractNoteMetadataMultipart", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "$ref": "#/components/schemas/IFormFile" } } } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "partial" } }, "/api/v1/providers/me/notes/extract-metadata:url": { "post": { "tags": [ "Provider Portal" ], "operationId": "ExtractNoteMetadataFromUrl", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtractMetadataRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "partial" } }, "/api/v1/providers/me/metadata/options": { "get": { "tags": [ "Provider Portal" ], "operationId": "GetProviderMetadataOptions", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "safe" } }, "/api/v1/providers/me/buy-side-orgs/search": { "get": { "tags": [ "Provider Portal" ], "operationId": "SearchBuySideOrgsForProvider", "parameters": [ { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 20 } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/analyst-scope": { "get": { "tags": [ "Provider Portal" ], "operationId": "ProviderAnalystScope", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/contacts:bulk-upsert": { "post": { "tags": [ "Provider Portal" ], "operationId": "BulkUpsertProviderContacts", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkContactInviteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/contacts:bulk-archive": { "post": { "tags": [ "Provider Portal" ], "operationId": "BulkArchiveProviderContacts", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkContactRemovalRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/contacts:bulk-unarchive": { "post": { "tags": [ "Provider Portal" ], "operationId": "BulkUnarchiveProviderContacts", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkContactRemovalRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/contacts:bulk-categorise": { "post": { "tags": [ "Provider Portal" ], "operationId": "BulkCategoriseProviderContacts", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkContactCategoriseRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/imports/{kind}:preview": { "post": { "tags": [ "Provider Portal" ], "operationId": "PreviewProviderImport", "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportUploadRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/imports/{kind}:apply": { "post": { "tags": [ "Provider Portal" ], "operationId": "ApplyProviderImport", "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportUploadRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/email-activity": { "get": { "tags": [ "Provider Portal" ], "operationId": "ListProviderEmailActivity", "parameters": [ { "name": "page", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "page_size", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } }, { "name": "email_type", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "q", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/coverage": { "get": { "tags": [ "Provider Portal" ], "operationId": "ListProviderCoverage", "parameters": [ { "name": "classification", "in": "query", "schema": { "type": "string" } }, { "name": "sector_id", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "unassigned", "in": "query", "schema": { "type": "boolean" } }, { "name": "archived", "in": "query", "schema": { "type": "boolean" } }, { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "analyst", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "offset", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" }, "post": { "tags": [ "Provider Portal" ], "operationId": "CreateProviderCoverageCompany", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoverageCreateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/coverage:backfill-preview": { "get": { "tags": [ "Provider Portal" ], "operationId": "PreviewBackfillProviderCoverage", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/coverage:backfill": { "post": { "tags": [ "Provider Portal" ], "operationId": "BackfillProviderCoverage", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/coverage:backfill-undo": { "post": { "tags": [ "Provider Portal" ], "operationId": "UndoBackfillProviderCoverage", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoverageBulkArchiveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/coverage:bulk-classify": { "post": { "tags": [ "Provider Portal" ], "operationId": "BulkClassifyCoverage", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoverageBulkClassifyRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/coverage:bulk-assign-sectors": { "post": { "tags": [ "Provider Portal" ], "operationId": "BulkAssignCoverageSectors", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoverageBulkAssignSectorsRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/coverage:bulk-assign-template": { "post": { "tags": [ "Provider Portal" ], "operationId": "BulkAssignCoverageTemplate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoverageBulkAssignTemplateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/coverage:bulk-archive": { "post": { "tags": [ "Provider Portal" ], "operationId": "BulkArchiveCoverage", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoverageBulkArchiveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/coverage:bulk-unarchive": { "post": { "tags": [ "Provider Portal" ], "operationId": "BulkUnarchiveCoverage", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoverageBulkArchiveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/coverage:bulk-assign-analysts": { "post": { "tags": [ "Provider Portal" ], "operationId": "BulkAssignCoverageAnalysts", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoverageBulkAssignAnalystsRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/coverage:bulk-unassign-analysts": { "post": { "tags": [ "Provider Portal" ], "operationId": "BulkUnassignCoverageAnalysts", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoverageBulkUnassignAnalystsRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/data-checks": { "get": { "tags": [ "Provider Portal" ], "operationId": "ListProviderDataChecks", "parameters": [ { "name": "dismissed", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/data-checks/dismissals": { "post": { "tags": [ "Provider Portal" ], "operationId": "DismissProviderDataCheck", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataCheckDismissRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/data-checks/dismissals/{item_type}/{item_id}": { "delete": { "tags": [ "Provider Portal" ], "operationId": "RestoreProviderDataCheck", "parameters": [ { "name": "item_type", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "item_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/access-requests": { "get": { "tags": [ "Provider Portal" ], "operationId": "ListProviderAccessRequests", "parameters": [ { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "days", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 30 } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/access-requests/availability": { "get": { "tags": [ "Provider Portal" ], "operationId": "GetProviderAccessRequestAvailability", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/access-explain": { "get": { "tags": [ "Provider Portal" ], "operationId": "ExplainReaderAccess", "parameters": [ { "name": "email", "in": "query", "schema": { "type": "string" } }, { "name": "note_id", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/line-items/{id}:archive": { "post": { "tags": [ "Provider Portal" ], "operationId": "ArchiveProviderLineItem", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "partial" } }, "/api/v1/providers/me/views/{id}:archive": { "post": { "tags": [ "Provider Portal" ], "operationId": "ArchiveProviderView", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "partial" } }, "/api/v1/providers/me/views/{viewId}/line-items:reorder": { "post": { "tags": [ "Provider Portal" ], "operationId": "BulkReorderProviderViewMemberships", "parameters": [ { "name": "viewId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkReorderRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "partial" } }, "/api/v1/providers/me/forecast-templates/{id}:archive": { "post": { "tags": [ "Provider Portal" ], "operationId": "ArchiveProviderForecastTemplate", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "partial" } }, "/api/v1/providers/me/forecast-templates/{templateId}/views:reorder": { "post": { "tags": [ "Provider Portal" ], "operationId": "ReorderProviderTemplateViews", "parameters": [ { "name": "templateId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateViewReorderRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "partial" } }, "/api/v1/providers/me/forecast-templates/starters": { "get": { "tags": [ "Provider Portal" ], "operationId": "ListProviderForecastTemplateStarters", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "safe" } }, "/api/v1/providers/me/forecast-templates/starters/{starterCode}:fork": { "post": { "tags": [ "Provider Portal" ], "operationId": "ForkProviderForecastTemplateStarter", "parameters": [ { "name": "starterCode", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ForkStarterTemplateRequest" } ] } } } }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "partial" } }, "/api/v1/providers/me/forecast-templates/{templateId}/versions": { "get": { "tags": [ "Provider Portal" ], "operationId": "ListProviderForecastTemplateVersions", "parameters": [ { "name": "templateId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } }, { "name": "offset", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "safe" } }, "/api/v1/providers/me/forecast-templates/{templateId}/assigned-companies": { "get": { "tags": [ "Provider Portal" ], "operationId": "ListProviderForecastTemplateAssignedCompanies", "parameters": [ { "name": "templateId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "safe" } }, "/api/v1/providers/me/default-template": { "get": { "tags": [ "Provider Portal" ], "operationId": "GetProviderDefaultTemplate", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "safe" }, "patch": { "tags": [ "Provider Portal" ], "operationId": "PatchProviderDefaultTemplate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetProviderDefaultTemplateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "partial" } }, "/api/v1/providers/me/forecasts/dashboard": { "get": { "tags": [ "Provider Portal" ], "operationId": "GetProviderForecastsDashboard", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "safe" } }, "/api/v1/providers/me/forecasts/dashboard:assign-default-bulk": { "post": { "tags": [ "Provider Portal" ], "operationId": "AssignDefaultBulk", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "partial" } }, "/api/v1/providers/me/forecasts": { "post": { "tags": [ "Provider Portal" ], "operationId": "PushProviderForecasts", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForecastIngestRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "partial" } }, "/api/v1/providers/me/forecasts/rixml-rules": { "get": { "tags": [ "Provider Portal" ], "operationId": "GetProviderRixmlRules", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" }, "put": { "tags": [ "Provider Portal" ], "operationId": "PutProviderRixmlRules", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetRixmlRulesRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/forecasts:rixml": { "post": { "tags": [ "Provider Portal" ], "operationId": "PushProviderForecastsRixml", "requestBody": { "content": { "application/xml": { "schema": { "type": "string" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/forecasts:csv": { "post": { "tags": [ "Provider Portal" ], "operationId": "PushProviderForecastsCsv", "requestBody": { "content": { "text/csv": { "schema": { "type": "string" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "partial" } }, "/api/v1/admin/monitoring": { "get": { "tags": [ "Admin" ], "operationId": "AdminMonitoring", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/admin/encrypt-pii": { "post": { "tags": [ "Admin" ], "operationId": "AdminEncryptKycPii", "parameters": [ { "name": "dryRun", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/auth/act-as/exit": { "post": { "tags": [ "Auth" ], "operationId": "ActAsExit", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/auth/magic-link": { "post": { "tags": [ "Auth" ], "operationId": "RequestMagicLink", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MagicLinkRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/auth/verify": { "post": { "tags": [ "Auth" ], "operationId": "VerifyToken", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MagicLinkVerifyRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/auth/logout": { "post": { "tags": [ "Auth" ], "operationId": "Logout", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/auth/logout-all": { "post": { "tags": [ "Auth" ], "operationId": "LogoutAll", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/auth/me": { "get": { "tags": [ "Auth" ], "operationId": "GetCurrentUser", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/auth/csrf": { "get": { "tags": [ "Auth" ], "operationId": "GetCsrfToken", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/auth/oidc/status": { "get": { "tags": [ "Auth" ], "operationId": "OidcStatus", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/auth/oidc/start": { "get": { "tags": [ "Auth" ], "operationId": "OidcStart", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/auth/oidc/callback": { "get": { "tags": [ "Auth" ], "operationId": "OidcCallback", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/search": { "get": { "tags": [ "Search" ], "operationId": "SearchResearch", "parameters": [ { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "sectors", "in": "query", "schema": { "type": "string" } }, { "name": "tickers", "in": "query", "schema": { "type": "string" } }, { "name": "provider_ids", "in": "query", "schema": { "type": "string" } }, { "name": "rating", "in": "query", "schema": { "type": "string" } }, { "name": "note_types", "in": "query", "schema": { "type": "string" } }, { "name": "analysts", "in": "query", "schema": { "type": "string" } }, { "name": "published_since", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 20 } }, { "name": "offset", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "safe" } }, "/api/v1/providers": { "get": { "tags": [ "Providers" ], "operationId": "ListProviders", "parameters": [ { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 100 } }, { "name": "offset", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "safe" } }, "/api/v1/entitlements": { "get": { "tags": [ "Entitlements" ], "operationId": "ListEntitlements", "parameters": [ { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 100 } }, { "name": "offset", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 0 } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/entitlements/check": { "get": { "tags": [ "Entitlements" ], "operationId": "CheckEntitlement", "parameters": [ { "name": "provider_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/entitlements/grant": { "post": { "tags": [ "Entitlements" ], "operationId": "GrantEntitlement", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GrantRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/entitlements/revoke": { "post": { "tags": [ "Entitlements" ], "operationId": "RevokeEntitlement", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevokeRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/entitlements/platform/grant": { "post": { "tags": [ "Entitlements" ], "operationId": "PlatformGrantEntitlement", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformGrantRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/entitlements/platform/revoke": { "post": { "tags": [ "Entitlements" ], "operationId": "PlatformRevokeEntitlement", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformRevokeRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/entitlement-rules/entitlement/{entitlementId}": { "get": { "tags": [ "Entitlement Rules" ], "operationId": "ListEntitlementRules", "parameters": [ { "name": "entitlementId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/entitlement-rules": { "post": { "tags": [ "Entitlement Rules" ], "operationId": "CreateEntitlementRule", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateEntitlementRuleRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/entitlement-rules/{ruleId}": { "delete": { "tags": [ "Entitlement Rules" ], "operationId": "DeleteEntitlementRule", "parameters": [ { "name": "ruleId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/orgs/me/access": { "get": { "tags": [ "Org Access" ], "operationId": "ListOwnOrgAccess", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/orgs/me/access/{id}/rules": { "get": { "tags": [ "Org Access" ], "operationId": "ListOwnEntitlementRules", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/notes/{id}/content": { "get": { "tags": [ "Content" ], "operationId": "RequestContent", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "safe" } }, "/api/v1/notes/{id}/content/stream": { "get": { "tags": [ "Content" ], "operationId": "StreamContent", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "safe" } }, "/api/v1/notes/{id}/disclaimer": { "get": { "tags": [ "Content" ], "operationId": "NoteDisclaimerCurrent", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/notes/{id}/disclaimer/accept": { "post": { "tags": [ "Content" ], "operationId": "NoteDisclaimerAccept", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NoteDisclaimerAcceptRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/notes/{noteId}/attachments": { "get": { "tags": [ "Attachments" ], "operationId": "ListNoteAttachments", "parameters": [ { "name": "noteId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/notes/{noteId}/attachments/{attachmentId}/download": { "get": { "tags": [ "Attachments" ], "operationId": "DownloadNoteAttachment", "parameters": [ { "name": "noteId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "attachmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/analysts": { "get": { "tags": [ "Analysts" ], "operationId": "ListAnalysts", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "safe" } }, "/api/v1/analysts/{name}": { "get": { "tags": [ "Analysts" ], "operationId": "GetAnalyst", "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 100 } }, { "name": "offset", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "safe" } }, "/api/v1/analysts/photo/{profileId}": { "get": { "tags": [ "Analysts" ], "operationId": "GetAnalystPhoto", "parameters": [ { "name": "profileId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/coverage": { "get": { "tags": [ "Coverage" ], "operationId": "ListCoverage", "parameters": [ { "name": "analyst", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "safe" } }, "/api/v1/coverage/{ticker}": { "get": { "tags": [ "Coverage" ], "operationId": "GetCoverage", "parameters": [ { "name": "ticker", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "exchange", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 100 } }, { "name": "offset", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "safe" } }, "/api/v1/api-keys": { "get": { "tags": [ "ApiKeys" ], "operationId": "ListApiKeys", "parameters": [ { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } }, { "name": "offset", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" }, "post": { "tags": [ "ApiKeys" ], "operationId": "CreateApiKey", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateApiKeyRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/api-keys/{id}": { "delete": { "tags": [ "ApiKeys" ], "operationId": "DeleteApiKey", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/onboarding/progress": { "get": { "tags": [ "Onboarding" ], "operationId": "GetOnboardingProgress", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "safe" }, "patch": { "tags": [ "Onboarding" ], "operationId": "UpdateOnboardingStep", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboardingStepUpdate" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "partial" } }, "/api/v1/onboarding/complete": { "post": { "tags": [ "Onboarding" ], "operationId": "CompleteOnboarding", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "partial" } }, "/api/v1/onboarding/reset": { "post": { "tags": [ "Onboarding" ], "operationId": "ResetOnboarding", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "partial" } }, "/api/v1/onboarding/enrich": { "get": { "tags": [ "Onboarding" ], "operationId": "EnrichDomain", "parameters": [ { "name": "domain", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "safe" } }, "/api/v1/buy-side/briefing": { "get": { "tags": [ "BuySide" ], "operationId": "GetBriefing", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/buy-side/analytics/providers": { "get": { "tags": [ "BuySide" ], "operationId": "GetProviderAnalytics", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/buy-side/analytics/my": { "get": { "tags": [ "BuySide" ], "operationId": "GetMyAnalytics", "parameters": [ { "name": "days", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 30 } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/buy-side/analytics/team": { "get": { "tags": [ "BuySide" ], "operationId": "GetTeamAnalytics", "parameters": [ { "name": "days", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 30 } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/org/settings": { "get": { "tags": [ "Organisation" ], "operationId": "GetOrgSettings", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" }, "patch": { "tags": [ "Organisation" ], "operationId": "UpdateOrgSettings", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UpdateOrgSettingsRequest" } ] } } } }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/kyc/profiles": { "post": { "tags": [ "KYC" ], "operationId": "CreateKycProfile", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateKycProfileRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" }, "get": { "tags": [ "KYC" ], "operationId": "ListKycProfiles", "parameters": [ { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } }, { "name": "offset", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/kyc/profiles/me": { "get": { "tags": [ "KYC" ], "operationId": "GetOwnKycProfile", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/kyc/profiles/{id}": { "get": { "tags": [ "KYC" ], "operationId": "GetKycProfileById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" }, "patch": { "tags": [ "KYC" ], "operationId": "UpdateKycProfile", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateKycProfileRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/kyc/profiles/{id}/submit": { "post": { "tags": [ "KYC" ], "operationId": "SubmitKycProfile", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/kyc/profiles/{id}/review": { "post": { "tags": [ "KYC" ], "operationId": "ReviewKycProfile", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReviewKycProfileRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/kyc/attestations": { "post": { "tags": [ "KYC Attestations" ], "operationId": "IssueKycAttestation", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssueAttestationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/kyc/attestations/verify": { "post": { "tags": [ "KYC Attestations" ], "operationId": "VerifyKycAttestation", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerifyAttestationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/kyc/attestations/{id}/revoke": { "post": { "tags": [ "KYC Attestations" ], "operationId": "RevokeKycAttestation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevokeAttestationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/kyc/attestations/active/{profileId}": { "get": { "tags": [ "KYC Attestations" ], "operationId": "GetActiveAttestation", "parameters": [ { "name": "profileId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/kyc/attestations/profile/{profileId}": { "get": { "tags": [ "KYC Attestations" ], "operationId": "ListAttestationsForProfile", "parameters": [ { "name": "profileId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/kyc/attestations/reminders": { "get": { "tags": [ "KYC Attestations" ], "operationId": "ListExpiringAttestations", "parameters": [ { "name": "days_ahead", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 30 } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/kyc/attestations/reminders/urgent": { "get": { "tags": [ "KYC Attestations" ], "operationId": "ListUrgentExpiringAttestations", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/kyc/permissions/{profileId}": { "post": { "tags": [ "KYC Permissions" ], "operationId": "GrantKycPermission", "parameters": [ { "name": "profileId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GrantPermissionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/kyc/permissions/profile/{profileId}": { "get": { "tags": [ "KYC Permissions" ], "operationId": "ListKycPermissionsForProfile", "parameters": [ { "name": "profileId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/kyc/permissions/{id}": { "patch": { "tags": [ "KYC Permissions" ], "operationId": "UpdateKycPermissionLevel", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePermissionLevelRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/kyc/permissions/{id}/revoke": { "post": { "tags": [ "KYC Permissions" ], "operationId": "RevokeKycPermission", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/kyc/permissions/provider/{providerId}": { "get": { "tags": [ "KYC Permissions" ], "operationId": "ListKycPermissionsForProvider", "parameters": [ { "name": "providerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/kyc/permissions/check": { "get": { "tags": [ "KYC Permissions" ], "operationId": "CheckKycPermission", "parameters": [ { "name": "profile_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "provider_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/kyc/views/provider/{providerId}": { "get": { "tags": [ "KYC Views" ], "operationId": "ListKycViewsForProvider", "parameters": [ { "name": "providerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/billing/purchase": { "post": { "tags": [ "Billing" ], "operationId": "InitiatePurchase", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InitiatePurchaseRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/billing/purchases": { "get": { "tags": [ "Billing" ], "operationId": "ListPurchases", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/billing/pricing/{providerId}": { "get": { "tags": [ "Billing" ], "operationId": "ListPricingTiers", "parameters": [ { "name": "providerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/billing/pricing": { "post": { "tags": [ "Billing" ], "operationId": "CreatePricingTier", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePricingTierRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/webhooks/stripe": { "post": { "tags": [ "Webhooks" ], "operationId": "StripeWebhook", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/webhooks/ses-events": { "post": { "tags": [ "Webhooks" ], "operationId": "SesEventsWebhook", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/portal/subscribe": { "post": { "tags": [ "Branded Portal" ], "operationId": "PortalSubscribe", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortalSubscribeRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/portal/subscribe/confirm": { "get": { "tags": [ "Branded Portal" ], "operationId": "PortalSubscribeConfirm", "parameters": [ { "name": "token", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/portal/subscribe/unsubscribe": { "get": { "tags": [ "Branded Portal" ], "operationId": "PortalSubscribeUnsubscribe", "parameters": [ { "name": "token", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/portal/disclaimer": { "get": { "tags": [ "Branded Portal" ], "operationId": "PortalDisclaimerCurrent", "parameters": [ { "name": "provider_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/portal/disclaimer/accept": { "post": { "tags": [ "Branded Portal" ], "operationId": "PortalDisclaimerAccept", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortalDisclaimerAcceptRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/portal/notes/{id}/access": { "get": { "tags": [ "Branded Portal" ], "operationId": "PortalNoteAccessEntry", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/portal/notes/{id}/access-request": { "post": { "tags": [ "Branded Portal" ], "operationId": "PortalNoteAccessRequest", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NoteAccessRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/portal/notes/{id}": { "get": { "tags": [ "Branded Portal" ], "operationId": "PortalPublicNote", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "safe" } }, "/api/v1/portal/notes/{id}/content": { "get": { "tags": [ "Branded Portal" ], "operationId": "PortalPublicNoteContent", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "safe" } }, "/api/v1/portal/sectors": { "get": { "tags": [ "Branded Portal" ], "operationId": "PortalSectorList", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "safe" } }, "/api/v1/portal/sectors/{slug}": { "get": { "tags": [ "Branded Portal" ], "operationId": "PortalSectorDetail", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "safe" } }, "/api/v1/portal/subscriptions": { "get": { "tags": [ "Branded Portal" ], "operationId": "PortalSubscriptionList", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "safe" }, "post": { "tags": [ "Branded Portal" ], "operationId": "PortalSubscriptionAdd", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PortalSubscriptionRequest" } ] } } } }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "partial" } }, "/api/v1/portal/subscriptions/feed": { "get": { "tags": [ "Branded Portal" ], "operationId": "PortalSubscriptionFeed", "parameters": [ { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 12 } }, { "name": "offset", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "safe" } }, "/api/v1/portal/subscriptions/{subjectType}/{subjectKey}": { "delete": { "tags": [ "Branded Portal" ], "operationId": "PortalSubscriptionRemove", "parameters": [ { "name": "subjectType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subjectKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "partial" } }, "/api/v1/support/reports": { "post": { "tags": [ "Support" ], "operationId": "SubmitSupportReport", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupportReportRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/support/cases": { "get": { "tags": [ "Support" ], "operationId": "ListSupportCases", "parameters": [ { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/support/cases/{reference}": { "get": { "tags": [ "Support" ], "operationId": "GetSupportCase", "parameters": [ { "name": "reference", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/support/cases/{reference}/diagnosis": { "post": { "tags": [ "Support" ], "operationId": "RecordSupportDiagnosis", "parameters": [ { "name": "reference", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupportDiagnosisRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/watchlist": { "get": { "tags": [ "Watchlist" ], "operationId": "ListWatchlists", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "safe" }, "post": { "tags": [ "Watchlist" ], "operationId": "CreateWatchlist", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CreateWatchlistRequest" } ] } } } }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "partial" } }, "/api/v1/watchlist/{name}": { "get": { "tags": [ "Watchlist" ], "operationId": "GetWatchlist", "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "safe" }, "delete": { "tags": [ "Watchlist" ], "operationId": "DeleteWatchlist", "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "partial" } }, "/api/v1/watchlist/{name}/tickers": { "post": { "tags": [ "Watchlist" ], "operationId": "AddTicker", "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/AddTickerRequest" } ] } } } }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "partial" } }, "/api/v1/watchlist/{name}/tickers/{ticker}": { "delete": { "tags": [ "Watchlist" ], "operationId": "RemoveTicker", "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ticker", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "partial" } }, "/api/v1/watchlist/{name}/monitor": { "get": { "tags": [ "Watchlist" ], "operationId": "MonitorWatchlist", "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "days", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 7 } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "safe" } }, "/api/v1/analytics/network": { "get": { "tags": [ "Analytics" ], "operationId": "NetworkStats", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/analytics/coverage": { "get": { "tags": [ "Analytics" ], "operationId": "CoverageMap", "parameters": [ { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } }, { "name": "offset", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/analytics/velocity": { "get": { "tags": [ "Analytics" ], "operationId": "Velocity", "parameters": [ { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } }, { "name": "offset", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/analytics/analysts": { "get": { "tags": [ "Analytics" ], "operationId": "AnalystDiscovery", "parameters": [ { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } }, { "name": "offset", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me": { "get": { "tags": [ "Provider Portal" ], "operationId": "GetMyProvider", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" }, "patch": { "tags": [ "Provider Portal" ], "operationId": "UpdateMyProvider", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/portal": { "get": { "tags": [ "Provider Portal" ], "operationId": "GetMyPortal", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" }, "patch": { "tags": [ "Provider Portal" ], "operationId": "UpdateMyPortal", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/default-content-language": { "put": { "tags": [ "Provider Portal" ], "operationId": "SetMyProviderDefaultContentLanguage", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetProviderDefaultContentLanguageRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/notes/{noteId}": { "get": { "tags": [ "Provider Portal" ], "operationId": "GetMyProviderNote", "parameters": [ { "name": "noteId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" }, "delete": { "tags": [ "Provider Portal" ], "operationId": "WithdrawMyProviderNote", "parameters": [ { "name": "noteId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/notes/bulk-metadata": { "post": { "tags": [ "Provider Portal" ], "operationId": "BulkEditMyProviderNoteMetadata", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkNoteMetadataRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/notes/bulk-metadata/values": { "post": { "tags": [ "Provider Portal" ], "operationId": "BulkNoteMetadataValues", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkNoteMetadataValuesRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/entitlements": { "get": { "tags": [ "Provider Portal" ], "operationId": "ListProviderEntitlements", "parameters": [ { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 100 } }, { "name": "offset", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/entitlements/grant": { "post": { "tags": [ "Provider Portal" ], "operationId": "GrantProviderEntitlement", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/entitlements/{id}/revoke": { "post": { "tags": [ "Provider Portal" ], "operationId": "RevokeProviderEntitlement", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/entitlements/{id}/rules": { "get": { "tags": [ "Provider Portal" ], "operationId": "ListProviderEntitlementRules", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/entitlements/{id}/effective": { "get": { "tags": [ "Provider Portal" ], "operationId": "GetProviderEntitlementEffectiveAccess", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/orgs": { "get": { "tags": [ "Provider Portal" ], "operationId": "ListManagedOrgs", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" }, "post": { "tags": [ "Provider Portal" ], "operationId": "CreateManagedOrg", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateManagedOrgRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/orgs/cohorts": { "get": { "tags": [ "Provider Portal" ], "operationId": "ListManagedOrgCohorts", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/orgs/{id}": { "get": { "tags": [ "Provider Portal" ], "operationId": "GetManagedOrg", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" }, "patch": { "tags": [ "Provider Portal" ], "operationId": "EditManagedOrg", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateManagedOrgRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/orgs/{id}:archive": { "post": { "tags": [ "Provider Portal" ], "operationId": "ArchiveManagedOrg", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/orgs/{id}:unarchive": { "post": { "tags": [ "Provider Portal" ], "operationId": "UnarchiveManagedOrg", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/orgs/resolve-by-email": { "get": { "tags": [ "Provider Portal" ], "operationId": "ResolveOrgByEmail", "parameters": [ { "name": "email", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/orgs/{id}/domain-matches": { "get": { "tags": [ "Provider Portal" ], "operationId": "ListOrgDomainMatches", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/analytics": { "get": { "tags": [ "Provider Portal" ], "operationId": "ProviderAnalyticsSummary", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/analytics/usage": { "get": { "tags": [ "Provider Portal" ], "operationId": "ProviderUsageDashboard", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/analytics/clients": { "get": { "tags": [ "Provider Portal" ], "operationId": "ProviderClientMetrics", "parameters": [ { "name": "from", "in": "query", "schema": { "type": "string" } }, { "name": "to", "in": "query", "schema": { "type": "string" } }, { "name": "days", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/analytics/trends": { "get": { "tags": [ "Provider Portal" ], "operationId": "ProviderTrendMetrics", "parameters": [ { "name": "from", "in": "query", "schema": { "type": "string" } }, { "name": "to", "in": "query", "schema": { "type": "string" } }, { "name": "days", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "months", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/analytics/payouts": { "get": { "tags": [ "Provider Portal" ], "operationId": "ProviderPayoutSummary", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/analytics/analysts": { "get": { "tags": [ "Provider Portal" ], "operationId": "ProviderAnalystMetrics", "parameters": [ { "name": "from", "in": "query", "schema": { "type": "string" } }, { "name": "to", "in": "query", "schema": { "type": "string" } }, { "name": "days", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/analytics/notes": { "get": { "tags": [ "Provider Portal" ], "operationId": "ProviderNoteMetrics", "parameters": [ { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } }, { "name": "offset", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 0 } }, { "name": "authors", "in": "query", "schema": { "type": "string" } }, { "name": "sectors", "in": "query", "schema": { "type": "string" } }, { "name": "codes", "in": "query", "schema": { "type": "string" } }, { "name": "languages", "in": "query", "schema": { "type": "string" } }, { "name": "note_types", "in": "query", "schema": { "type": "string" } }, { "name": "ratings", "in": "query", "schema": { "type": "string" } }, { "name": "q", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/analytics/notes/facets": { "get": { "tags": [ "Provider Portal" ], "operationId": "ProviderNoteFacets", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/analytics/notes/readership": { "get": { "tags": [ "Provider Portal" ], "operationId": "ProviderNoteReadership", "parameters": [ { "name": "from", "in": "query", "schema": { "type": "string" } }, { "name": "to", "in": "query", "schema": { "type": "string" } }, { "name": "days", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } }, { "name": "offset", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/rate-limits": { "get": { "tags": [ "Provider Portal" ], "operationId": "ListProviderRateLimits", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" }, "post": { "tags": [ "Provider Portal" ], "operationId": "CreateProviderRateLimit", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProviderRateLimitRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/pricing": { "get": { "tags": [ "Provider Portal" ], "operationId": "ListProviderPricing", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" }, "post": { "tags": [ "Provider Portal" ], "operationId": "CreateProviderPricing", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProviderPricingRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/pricing/{tierId}": { "delete": { "tags": [ "Provider Portal" ], "operationId": "DeleteProviderPricing", "parameters": [ { "name": "tierId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/rate-limits/{ruleId}": { "delete": { "tags": [ "Provider Portal" ], "operationId": "DeleteProviderRateLimit", "parameters": [ { "name": "ruleId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/entitlements/{id}/user-access": { "get": { "tags": [ "Provider Portal" ], "operationId": "ListEntitlementUserAccess", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/entitlements/{id}/scope-mode": { "patch": { "tags": [ "Provider Portal" ], "operationId": "UpdateEntitlementScopeMode", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/entitlements/{id}/user-access/bulk": { "post": { "tags": [ "Provider Portal" ], "operationId": "BulkSetUserAccess", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/templates": { "get": { "tags": [ "Provider Portal" ], "operationId": "ListProviderTemplates", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" }, "post": { "tags": [ "Provider Portal" ], "operationId": "CreateProviderTemplate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTemplateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/templates/{id}": { "get": { "tags": [ "Provider Portal" ], "operationId": "GetProviderTemplate", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" }, "patch": { "tags": [ "Provider Portal" ], "operationId": "UpdateProviderTemplate", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTemplateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" }, "delete": { "tags": [ "Provider Portal" ], "operationId": "DeleteProviderTemplate", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/templates/{id}/rules": { "post": { "tags": [ "Provider Portal" ], "operationId": "AddProviderTemplateRule", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddTemplateRuleRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/templates/{id}/rules/{ruleId}": { "patch": { "tags": [ "Provider Portal" ], "operationId": "UpdateProviderTemplateRule", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "ruleId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTemplateRuleRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" }, "delete": { "tags": [ "Provider Portal" ], "operationId": "DeleteProviderTemplateRule", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "ruleId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/templates/{id}/sync": { "post": { "tags": [ "Provider Portal" ], "operationId": "SyncProviderTemplate", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "force", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/templates/{id}/make-default": { "post": { "tags": [ "Provider Portal" ], "operationId": "MakeProviderTemplateDefault", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/entitlements/{id}/apply-template": { "post": { "tags": [ "Provider Portal" ], "operationId": "ApplyTemplateToEntitlement", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplyTemplateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/entitlements/{id}/detach-template": { "post": { "tags": [ "Provider Portal" ], "operationId": "DetachTemplateFromEntitlement", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/contacts": { "get": { "tags": [ "Provider Portal" ], "operationId": "ListProviderContacts", "parameters": [ { "name": "entitlementId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "orgId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "include_archived", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "scope", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 100 } }, { "name": "offset", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/contacts/{userId}": { "get": { "tags": [ "Provider Portal" ], "operationId": "GetProviderContact", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" }, "patch": { "tags": [ "Provider Portal" ], "operationId": "PatchProviderContact", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactProfilePatch" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/contacts/{userId}:archive": { "post": { "tags": [ "Provider Portal" ], "operationId": "ArchiveProviderContact", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/contacts/{userId}:unarchive": { "post": { "tags": [ "Provider Portal" ], "operationId": "UnarchiveProviderContact", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/analyst-profiles": { "get": { "tags": [ "Provider Portal" ], "operationId": "ListProviderAnalystProfiles", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/analyst-profiles/{name}": { "put": { "tags": [ "Provider Portal" ], "operationId": "UpsertProviderAnalystProfile", "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalystProfileUpsertRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" }, "delete": { "tags": [ "Provider Portal" ], "operationId": "DeleteProviderAnalystProfile", "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/analyst-profiles/{name}/photo": { "post": { "tags": [ "Provider Portal" ], "operationId": "UploadProviderAnalystProfilePhoto", "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "file" ], "type": "object", "properties": { "file": { "$ref": "#/components/schemas/IFormFile" } } } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" }, "delete": { "tags": [ "Provider Portal" ], "operationId": "DeleteProviderAnalystProfilePhoto", "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/analyst-profiles/{name}:archive": { "post": { "tags": [ "Provider Portal" ], "operationId": "ArchiveProviderAnalyst", "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/AnalystArchiveRequest" } ] } } } }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/analyst-profiles/{name}:unarchive": { "post": { "tags": [ "Provider Portal" ], "operationId": "UnarchiveProviderAnalyst", "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/analyst-profiles/{name}/coverage": { "get": { "tags": [ "Provider Portal" ], "operationId": "ListProviderAnalystCoverage", "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" }, "put": { "tags": [ "Provider Portal" ], "operationId": "ReplaceProviderAnalystCoverage", "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalystCoverageReplaceRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/analyst-profiles/{name}/linked-user": { "put": { "tags": [ "Provider Portal" ], "operationId": "LinkProviderAnalystUser", "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalystLinkedUserRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" }, "delete": { "tags": [ "Provider Portal" ], "operationId": "UnlinkProviderAnalystUser", "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/analyst-profiles/{name}/team-byline": { "put": { "tags": [ "Provider Portal" ], "operationId": "MarkProviderAnalystTeamByline", "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" }, "delete": { "tags": [ "Provider Portal" ], "operationId": "UnmarkProviderAnalystTeamByline", "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/entitlement-codes": { "get": { "tags": [ "Provider Portal" ], "operationId": "ListProviderEntitlementCodes", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" }, "post": { "tags": [ "Provider Portal" ], "operationId": "CreateProviderEntitlementCode", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateEntitlementCodeRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/entitlement-codes/{id}": { "patch": { "tags": [ "Provider Portal" ], "operationId": "UpdateProviderEntitlementCode", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateEntitlementCodeRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/entitlement-codes/{code}/recipients": { "get": { "tags": [ "Provider Portal" ], "operationId": "ListProviderCodeRecipients", "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "include_revoked", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "format", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" }, "post": { "tags": [ "Provider Portal" ], "operationId": "UploadProviderCodeRecipients", "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecipientUploadRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/entitlement-codes/{code}/recipients/{id}": { "delete": { "tags": [ "Provider Portal" ], "operationId": "RevokeProviderCodeRecipient", "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/sectors": { "get": { "tags": [ "Provider Portal" ], "operationId": "ListProviderSectors", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" }, "post": { "tags": [ "Provider Portal" ], "operationId": "CreateProviderSector", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProviderSectorRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/sectors/{id}": { "patch": { "tags": [ "Provider Portal" ], "operationId": "UpdateProviderSector", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateProviderSectorRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" }, "delete": { "tags": [ "Provider Portal" ], "operationId": "DeleteProviderSector", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/sectors/order": { "put": { "tags": [ "Provider Portal" ], "operationId": "ReorderProviderSectors", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReorderProviderSectorsRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/webhooks": { "get": { "tags": [ "Provider Portal" ], "operationId": "ListProviderWebhooks", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" }, "post": { "tags": [ "Provider Portal" ], "operationId": "CreateProviderWebhook", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateWebhookSubscriptionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/webhooks/{id}": { "patch": { "tags": [ "Provider Portal" ], "operationId": "UpdateProviderWebhook", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateWebhookSubscriptionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" }, "delete": { "tags": [ "Provider Portal" ], "operationId": "DeleteProviderWebhook", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/distribution/presets": { "get": { "tags": [ "Provider Portal" ], "operationId": "ListDistributionPresets", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/distribution/dashboard": { "get": { "tags": [ "Provider Portal" ], "operationId": "GetDistributionDashboard", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/distribution": { "get": { "tags": [ "Provider Portal" ], "operationId": "ListDistributionChannels", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" }, "post": { "tags": [ "Provider Portal" ], "operationId": "CreateDistributionChannel", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDistributionChannelRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/distribution/{id}": { "get": { "tags": [ "Provider Portal" ], "operationId": "GetDistributionChannel", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" }, "patch": { "tags": [ "Provider Portal" ], "operationId": "UpdateDistributionChannel", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDistributionChannelRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" }, "delete": { "tags": [ "Provider Portal" ], "operationId": "DeleteDistributionChannel", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/distribution/{id}/deliveries": { "get": { "tags": [ "Provider Portal" ], "operationId": "ListDistributionDeliveries", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/distribution/{id}/test-send": { "post": { "tags": [ "Provider Portal" ], "operationId": "TestSendDistribution", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DistributionTestSendRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/notes/{noteId}/attachments": { "post": { "tags": [ "Provider Portal" ], "operationId": "UploadProviderAttachment", "parameters": [ { "name": "noteId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "file" ], "type": "object", "properties": { "file": { "$ref": "#/components/schemas/IFormFile" } } } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" }, "get": { "tags": [ "Provider Portal" ], "operationId": "ListProviderAttachments", "parameters": [ { "name": "noteId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "includeHistory", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/notes/{noteId}/attachments/{attachmentId}": { "delete": { "tags": [ "Provider Portal" ], "operationId": "DeleteProviderAttachment", "parameters": [ { "name": "noteId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "attachmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/line-items": { "get": { "tags": [ "Provider Portal" ], "operationId": "ListProviderLineItems", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "safe" }, "post": { "tags": [ "Provider Portal" ], "operationId": "CreateProviderLineItem", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateLineItemRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "partial" } }, "/api/v1/providers/me/line-items/{id}": { "get": { "tags": [ "Provider Portal" ], "operationId": "GetProviderLineItem", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "safe" }, "patch": { "tags": [ "Provider Portal" ], "operationId": "PatchProviderLineItem", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateLineItemRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "partial" } }, "/api/v1/providers/me/views": { "get": { "tags": [ "Provider Portal" ], "operationId": "ListProviderViews", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "safe" }, "post": { "tags": [ "Provider Portal" ], "operationId": "CreateProviderView", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateForecastViewRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "partial" } }, "/api/v1/providers/me/views/{id}": { "get": { "tags": [ "Provider Portal" ], "operationId": "GetProviderView", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "safe" }, "patch": { "tags": [ "Provider Portal" ], "operationId": "PatchProviderView", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateForecastViewRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "partial" } }, "/api/v1/providers/me/views/{viewId}/line-items": { "get": { "tags": [ "Provider Portal" ], "operationId": "ListProviderViewMemberships", "parameters": [ { "name": "viewId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "safe" }, "post": { "tags": [ "Provider Portal" ], "operationId": "AddProviderViewMembership", "parameters": [ { "name": "viewId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateMembershipRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "partial" } }, "/api/v1/providers/me/views/{viewId}/line-items/{membershipId}": { "patch": { "tags": [ "Provider Portal" ], "operationId": "PatchProviderViewMembership", "parameters": [ { "name": "viewId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "membershipId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMembershipRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "partial" }, "delete": { "tags": [ "Provider Portal" ], "operationId": "RemoveProviderViewMembership", "parameters": [ { "name": "viewId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "membershipId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "partial" } }, "/api/v1/providers/me/forecast-templates": { "get": { "tags": [ "Provider Portal" ], "operationId": "ListProviderForecastTemplates", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "safe" }, "post": { "tags": [ "Provider Portal" ], "operationId": "CreateProviderForecastTemplate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateForecastTemplateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "partial" } }, "/api/v1/providers/me/forecast-templates/{id}": { "get": { "tags": [ "Provider Portal" ], "operationId": "GetProviderForecastTemplate", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "safe" }, "patch": { "tags": [ "Provider Portal" ], "operationId": "PatchProviderForecastTemplate", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateForecastTemplateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "partial" } }, "/api/v1/providers/me/forecast-templates/{templateId}/views": { "get": { "tags": [ "Provider Portal" ], "operationId": "ListProviderTemplateViews", "parameters": [ { "name": "templateId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "safe" }, "post": { "tags": [ "Provider Portal" ], "operationId": "AddProviderTemplateView", "parameters": [ { "name": "templateId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddTemplateViewRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "partial" } }, "/api/v1/providers/me/forecast-templates/{templateId}/views/{membershipId}": { "patch": { "tags": [ "Provider Portal" ], "operationId": "PatchProviderTemplateView", "parameters": [ { "name": "templateId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "membershipId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTemplateViewRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "partial" }, "delete": { "tags": [ "Provider Portal" ], "operationId": "RemoveProviderTemplateView", "parameters": [ { "name": "templateId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "membershipId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "partial" } }, "/api/v1/providers/me/forecast-templates/{templateId}/mappings": { "get": { "tags": [ "Provider Portal" ], "operationId": "ListProviderRptMappings", "parameters": [ { "name": "templateId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "safe" }, "post": { "tags": [ "Provider Portal" ], "operationId": "AddProviderRptMapping", "parameters": [ { "name": "templateId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddLineItemRptMappingRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "partial" } }, "/api/v1/providers/me/forecast-templates/{templateId}/mappings/{mappingId}": { "patch": { "tags": [ "Provider Portal" ], "operationId": "PatchProviderRptMapping", "parameters": [ { "name": "templateId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "mappingId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateLineItemRptMappingRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "partial" }, "delete": { "tags": [ "Provider Portal" ], "operationId": "RemoveProviderRptMapping", "parameters": [ { "name": "templateId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "mappingId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "partial" } }, "/api/v1/providers/me/companies/{exchange}/{ticker}/template": { "get": { "tags": [ "Provider Portal" ], "operationId": "GetCompanyTemplate", "parameters": [ { "name": "exchange", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ticker", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "safe" }, "post": { "tags": [ "Provider Portal" ], "operationId": "SetCompanyTemplate", "parameters": [ { "name": "exchange", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ticker", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetCompanyTemplateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "partial" }, "delete": { "tags": [ "Provider Portal" ], "operationId": "UnassignCompanyTemplate", "parameters": [ { "name": "exchange", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ticker", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "partial" } }, "/api/v1/providers/me/team": { "get": { "tags": [ "Provider Portal" ], "operationId": "ListProviderTeam", "parameters": [ { "name": "include_archived", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/team/{userId}/coverage": { "get": { "tags": [ "Provider Portal" ], "operationId": "ListProviderCoverageGrants", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "safe" }, "post": { "tags": [ "Provider Portal" ], "operationId": "GrantProviderCoverage", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GrantCoverageRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/team/{userId}/coverage/{coverageId}": { "delete": { "tags": [ "Provider Portal" ], "operationId": "RevokeProviderCoverage", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "coverageId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/team/{userId}/template-grants": { "get": { "tags": [ "Provider Portal" ], "operationId": "ListProviderTemplateGrants", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "safe" }, "post": { "tags": [ "Provider Portal" ], "operationId": "GrantProviderTemplateEditor", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GrantTemplateEditorRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/providers/me/team/{userId}/template-grants/{grantId}": { "delete": { "tags": [ "Provider Portal" ], "operationId": "RevokeProviderTemplateEditor", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "grantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/portal/view-as": { "post": { "tags": [ "Portal" ], "operationId": "PortalEnterViewAs", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ViewAsEnterRequest" } ] } } } }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/portal/view-as/exit": { "post": { "tags": [ "Portal" ], "operationId": "PortalExitViewAs", "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/admin/providers/{providerId}/home-org": { "put": { "tags": [ "Admin" ], "operationId": "AdminSetProviderHomeOrg", "parameters": [ { "name": "providerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetProviderHomeOrgRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/admin/providers/{providerId}/default-content-language": { "put": { "tags": [ "Admin" ], "operationId": "AdminSetProviderDefaultContentLanguage", "parameters": [ { "name": "providerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetProviderDefaultContentLanguageRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/admin/entitlements": { "get": { "tags": [ "Admin" ], "operationId": "AdminListEntitlements", "parameters": [ { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } }, { "name": "offset", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/admin/entitlements/grant": { "post": { "tags": [ "Admin" ], "operationId": "AdminGrantEntitlement", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GrantEntitlementRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/admin/orgs/{orgId}/onboarding:reset": { "post": { "tags": [ "Admin" ], "operationId": "AdminResetOnboarding", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/admin/providers": { "post": { "tags": [ "AdminProviderManagement" ], "operationId": "AdminRegisterProvider", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegisterProviderRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/admin/providers/{providerId}": { "patch": { "tags": [ "AdminProviderManagement" ], "operationId": "AdminUpdateProvider", "parameters": [ { "name": "providerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateProviderRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" }, "delete": { "tags": [ "AdminProviderManagement" ], "operationId": "AdminSoftDeleteProvider", "parameters": [ { "name": "providerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/audit-logs": { "get": { "tags": [ "Audit Logs" ], "operationId": "ListAuditLogs", "parameters": [ { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } }, { "name": "offset", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 0 } }, { "name": "acting_as_provider_id", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "org_id", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "method", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/audit-logs/me": { "get": { "tags": [ "Audit Logs" ], "operationId": "ListMyAuditLogs", "parameters": [ { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } }, { "name": "offset", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/sync/pull": { "post": { "tags": [ "Sync" ], "operationId": "TriggerPullSync", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PullSyncRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/adapters/validate": { "post": { "tags": [ "Adapters" ], "operationId": "ValidateAdapterConfig", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdapterValidationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } }, "/api/v1/admin/providers/{providerId}/act-as": { "post": { "tags": [ "Admin" ], "operationId": "AdminEnterActAs", "parameters": [ { "name": "providerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ActAsEnterRequest" } ] } } } }, "responses": { "200": { "description": "OK" } }, "x-agent-friendly": "human-in-loop" } } }, "components": { "schemas": { "ActAsEnterRequest": { "required": [ "ttl_seconds" ], "type": "object", "properties": { "ttl_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" } } }, "AdapterValidationRequest": { "required": [ "adapter_type", "config" ], "type": "object", "properties": { "adapter_type": { "type": "string" }, "config": { "type": [ "null", "object" ] } } }, "AddLineItemRptMappingRequest": { "required": [ "line_item_id", "rpt_canonical_metric" ], "type": "object", "properties": { "line_item_id": { "type": "string", "format": "uuid" }, "rpt_canonical_metric": { "type": "string" }, "scale_factor": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "sign_flip": { "type": [ "null", "boolean" ] } } }, "AddTemplateRuleRequest": { "required": [ "rule_type" ], "type": "object", "properties": { "rule_type": { "type": "string" }, "config": { "type": [ "null", "object" ] } } }, "AddTemplateViewRequest": { "required": [ "view_id", "position" ], "type": "object", "properties": { "view_id": { "type": "string", "format": "uuid" }, "position": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "title_override": { "type": [ "null", "string" ] } } }, "AddTickerRequest": { "required": [ "ticker", "exchange" ], "type": "object", "properties": { "ticker": { "type": "string" }, "exchange": { "type": [ "null", "string" ] } } }, "AgentSignupRequest": { "required": [ "email" ], "type": "object", "properties": { "email": { "type": "string" }, "owner_org": { "type": [ "null", "string" ] }, "intended_use": { "type": [ "null", "string" ] } } }, "AnalystArchiveRequest": { "type": "object", "properties": { "research_discoverable": { "type": [ "null", "boolean" ] } } }, "AnalystCoverageAssignmentDto": { "required": [ "ticker" ], "type": "object", "properties": { "exchange": { "type": [ "null", "string" ] }, "ticker": { "type": "string" }, "role": { "type": [ "null", "string" ] } } }, "AnalystCoverageReplaceRequest": { "required": [ "companies" ], "type": "object", "properties": { "companies": { "type": "array", "items": { "$ref": "#/components/schemas/AnalystCoverageAssignmentDto" } } } }, "AnalystLinkedUserRequest": { "type": "object", "properties": { "org_user_id": { "type": [ "null", "string" ], "format": "uuid" } } }, "AnalystProfileUpsertRequest": { "required": [ "title", "bio", "email", "phone", "linkedin_url" ], "type": "object", "properties": { "title": { "type": [ "null", "string" ] }, "bio": { "type": [ "null", "string" ] }, "email": { "type": [ "null", "string" ] }, "phone": { "type": [ "null", "string" ] }, "linkedin_url": { "type": [ "null", "string" ] } } }, "ApplyTemplateRequest": { "required": [ "template_id" ], "type": "object", "properties": { "template_id": { "type": "string", "format": "uuid" } } }, "BulkArchiveRequest": { "required": [ "user_ids" ], "type": "object", "properties": { "user_ids": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "BulkContactCategoriseRequest": { "required": [ "user_ids", "categories", "mode" ], "type": "object", "properties": { "user_ids": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "categories": { "type": "array", "items": { "type": "string" } }, "mode": { "type": "string" } } }, "BulkContactInviteRequest": { "required": [ "contacts" ], "type": "object", "properties": { "contacts": { "type": "array", "items": { "$ref": "#/components/schemas/ContactInviteRow" } }, "preview": { "type": "boolean", "default": false } } }, "BulkContactRemovalRequest": { "required": [ "user_ids" ], "type": "object", "properties": { "user_ids": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "BulkNoteMetadataCompany": { "required": [ "ticker" ], "type": "object", "properties": { "ticker": { "type": "string" }, "exchange": { "type": [ "null", "string" ] }, "company_name": { "type": [ "null", "string" ] } } }, "BulkNoteMetadataOperation": { "required": [ "field", "op" ], "type": "object", "properties": { "field": { "type": "string" }, "op": { "type": "string" }, "values": { "type": [ "null", "array" ], "items": { "type": "string" } }, "from": { "type": [ "null", "array" ], "items": { "type": "string" } }, "to": { "type": [ "null", "string" ] }, "companies": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/BulkNoteMetadataCompany" } }, "tickers": { "type": [ "null", "array" ], "items": { "type": "string" } } } }, "BulkNoteMetadataRequest": { "required": [ "note_ids", "operations" ], "type": "object", "properties": { "note_ids": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "dry_run": { "type": "boolean" }, "operations": { "type": "array", "items": { "$ref": "#/components/schemas/BulkNoteMetadataOperation" } } } }, "BulkNoteMetadataValuesRequest": { "required": [ "note_ids", "field" ], "type": "object", "properties": { "note_ids": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "field": { "type": "string" } } }, "BulkReorderEntry": { "required": [ "membership_id", "sort_order" ], "type": "object", "properties": { "membership_id": { "type": "string", "format": "uuid" }, "sort_order": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "BulkReorderRequest": { "required": [ "entries" ], "type": "object", "properties": { "entries": { "type": "array", "items": { "$ref": "#/components/schemas/BulkReorderEntry" } } } }, "ChangeOrgUserRoleRequest": { "required": [ "role" ], "type": "object", "properties": { "role": { "type": [ "null", "string" ] } } }, "ContactInviteRow": { "required": [ "buy_side_org_id", "email", "display_name", "role" ], "type": "object", "properties": { "buy_side_org_id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "display_name": { "type": [ "null", "string" ] }, "role": { "type": [ "null", "string" ] } } }, "ContactProfilePatch": { "required": [ "display_name", "role" ], "type": "object", "properties": { "display_name": { "type": [ "null", "string" ] }, "role": { "type": [ "null", "string" ] }, "categories": { "type": [ "null", "array" ], "items": { "type": "string" } } } }, "CoverageBulkArchiveRequest": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CoverageCompanyKeyDto" } } } }, "CoverageBulkAssignAnalystsRequest": { "required": [ "items", "analyst_names" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CoverageCompanyKeyDto" } }, "analyst_names": { "type": "array", "items": { "type": "string" } }, "role": { "type": [ "null", "string" ] } } }, "CoverageBulkAssignSectorsRequest": { "required": [ "items", "sector_ids" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CoverageCompanyKeyDto" } }, "sector_ids": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "mode": { "type": [ "null", "string" ] } } }, "CoverageBulkAssignTemplateRequest": { "required": [ "items", "template_id" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CoverageCompanyKeyDto" } }, "template_id": { "type": "string", "format": "uuid" } } }, "CoverageBulkClassifyRequest": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CoverageCompanyKeyDto" } }, "classification": { "type": [ "null", "string" ] } } }, "CoverageBulkUnassignAnalystsRequest": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CoverageCompanyKeyDto" } }, "analyst_names": { "type": "array", "items": { "type": "string" } } } }, "CoverageCompanyKeyDto": { "required": [ "ticker" ], "type": "object", "properties": { "exchange": { "type": [ "null", "string" ] }, "ticker": { "type": "string" } } }, "CoverageCreateRequest": { "required": [ "exchange", "ticker", "company_name" ], "type": "object", "properties": { "exchange": { "type": "string" }, "ticker": { "type": "string" }, "company_name": { "type": "string" }, "classification": { "type": [ "null", "string" ] }, "sector_ids": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } } } }, "CreateApiKeyRequest": { "required": [ "label" ], "type": "object", "properties": { "label": { "type": "string" }, "scopes": { "type": [ "null", "array" ], "items": { "type": "string" } }, "expires_at": { "type": [ "null", "string" ], "format": "date-time" }, "description": { "type": [ "null", "string" ] } } }, "CreateDistributionChannelRequest": { "required": [ "name", "transport", "package_format" ], "type": "object", "properties": { "name": { "type": "string" }, "transport": { "type": "string" }, "package_format": { "type": "string" }, "endpoint": { "type": [ "null", "string" ] }, "credentials_ref": { "type": [ "null", "string" ] }, "filter": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/DistributionFilterDto" } ] }, "rixml_version": { "type": [ "null", "string" ] }, "watermark_mode": { "type": [ "null", "string" ] } } }, "CreateEntitlementCodeRequest": { "required": [ "code", "title" ], "type": "object", "properties": { "code": { "type": "string" }, "title": { "type": "string" } } }, "CreateEntitlementRuleRequest": { "required": [ "entitlement_id", "rule_type", "config" ], "type": "object", "properties": { "entitlement_id": { "type": "string", "format": "uuid" }, "rule_type": { "type": "string" }, "config": { "type": "object" } } }, "CreateForecastTemplateRequest": { "required": [ "code", "display_name" ], "type": "object", "properties": { "code": { "type": "string" }, "display_name": { "type": "string" }, "description": { "type": [ "null", "string" ] } } }, "CreateForecastViewRequest": { "required": [ "code", "display_name", "view_type" ], "type": "object", "properties": { "code": { "type": "string" }, "display_name": { "type": "string" }, "view_type": { "type": "string" }, "description": { "type": [ "null", "string" ] } } }, "CreateKycProfileRequest": { "required": [ "legal_name", "jurisdiction", "regulatory_status" ], "type": "object", "properties": { "legal_name": { "type": "string" }, "jurisdiction": { "type": "string" }, "regulatory_status": { "type": "string" }, "lei": { "type": [ "null", "string" ] }, "regulator": { "type": [ "null", "string" ] }, "registration_number": { "type": [ "null", "string" ] }, "contact_email": { "type": [ "null", "string" ] }, "contact_name": { "type": [ "null", "string" ] } } }, "CreateLineItemRequest": { "required": [ "code", "display_name", "unit_type" ], "type": "object", "properties": { "code": { "type": "string" }, "display_name": { "type": "string" }, "description": { "type": [ "null", "string" ] }, "unit_type": { "type": "string" }, "currency_code": { "type": [ "null", "string" ] }, "magnitude": { "type": [ "null", "string" ] }, "display_suffix": { "type": [ "null", "string" ] } } }, "CreateManagedOrgRequest": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" }, "domain": { "type": [ "null", "string" ] }, "org_type": { "type": [ "null", "string" ] }, "institution_type": { "type": [ "null", "string" ] }, "regions": { "type": [ "null", "array" ], "items": { "type": "string" } }, "asset_classes": { "type": [ "null", "array" ], "items": { "type": "string" } } } }, "CreateMembershipRequest": { "required": [ "line_item_id", "sort_order" ], "type": "object", "properties": { "line_item_id": { "type": "string", "format": "uuid" }, "sort_order": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "group_label": { "type": [ "null", "string" ] }, "row_style": { "type": [ "null", "string" ] }, "style_config": { "type": [ "null", "object" ] } } }, "CreatePricingTierRequest": { "required": [ "provider_id", "price" ], "type": "object", "properties": { "provider_id": { "type": "string", "format": "uuid" }, "price": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "note_type": { "type": [ "null", "string" ] }, "currency": { "type": [ "null", "string" ] }, "bundle_size": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "bundle_price": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" } } }, "CreateProviderPricingRequest": { "required": [ "price" ], "type": "object", "properties": { "price": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "note_type": { "type": [ "null", "string" ] }, "currency": { "type": [ "null", "string" ] }, "bundle_size": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "bundle_price": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" } } }, "CreateProviderRateLimitRequest": { "required": [ "max_requests" ], "type": "object", "properties": { "max_requests": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "period": { "type": [ "null", "string" ] }, "org_id": { "type": [ "null", "string" ], "format": "uuid" }, "user_id": { "type": [ "null", "string" ], "format": "uuid" } } }, "CreateProviderSectorRequest": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" }, "slug": { "type": [ "null", "string" ] }, "icon": { "type": [ "null", "string" ] }, "sort_order": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" } } }, "CreateTemplateRequest": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": [ "null", "string" ] }, "full_access": { "type": [ "null", "boolean" ] } } }, "CreateWatchlistRequest": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": [ "null", "string" ] } } }, "CreateWebhookSubscriptionRequest": { "required": [ "url", "secret", "events" ], "type": "object", "properties": { "url": { "type": "string" }, "secret": { "type": "string" }, "events": { "type": "string" } } }, "DataCheckDismissRequest": { "required": [ "item_type" ], "type": "object", "properties": { "item_type": { "type": "string" }, "item_id": { "type": "string", "format": "uuid" } } }, "DistributionFilterDto": { "type": "object", "properties": { "sectors": { "type": [ "null", "array" ], "items": { "type": "string" } }, "product_categories": { "type": [ "null", "array" ], "items": { "type": "string" } }, "entitlement_codes": { "type": [ "null", "array" ], "items": { "type": "string" } }, "languages": { "type": [ "null", "array" ], "items": { "type": "string" } }, "access_levels": { "type": [ "null", "array" ], "items": { "type": "string" } }, "tickers": { "type": [ "null", "array" ], "items": { "type": "string" } } } }, "DistributionTestSendRequest": { "required": [ "note_id" ], "type": "object", "properties": { "note_id": { "type": "string", "format": "uuid" } } }, "ExtractMetadataRequest": { "required": [ "html_url" ], "type": "object", "properties": { "html_url": { "type": "string" } } }, "ForecastIngestRequest": { "required": [ "rows" ], "type": "object", "properties": { "rows": { "type": "array", "items": { "$ref": "#/components/schemas/ForecastIngestRow" } }, "analyst_user_id": { "type": [ "null", "string" ], "format": "uuid" } } }, "ForecastIngestRow": { "required": [ "exchange", "ticker", "fiscal_year", "period_type", "as_of_date" ], "type": "object", "properties": { "line_item_id": { "type": [ "null", "string" ], "format": "uuid" }, "line_item_code": { "type": [ "null", "string" ] }, "exchange": { "type": "string" }, "ticker": { "type": "string" }, "fiscal_year": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "period_type": { "type": "string" }, "period_index": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "period_end_date": { "type": [ "null", "string" ], "format": "date" }, "period_kind": { "type": "string" }, "value_numeric": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "value_text": { "type": [ "null", "string" ] }, "currency": { "type": [ "null", "string" ] }, "note_id": { "type": [ "null", "string" ], "format": "uuid" }, "as_of_date": { "type": "string", "format": "date" } } }, "ForkStarterTemplateRequest": { "type": "object", "properties": { "code_override": { "type": [ "null", "string" ] }, "display_name_override": { "type": [ "null", "string" ] } } }, "GrantCoverageRequest": { "required": [ "exchange", "ticker" ], "type": "object", "properties": { "exchange": { "type": "string" }, "ticker": { "type": "string" }, "role": { "type": [ "null", "string" ] } } }, "GrantEntitlementRequest": { "required": [ "org_id", "provider_id", "access_type" ], "type": "object", "properties": { "org_id": { "type": "string", "format": "uuid" }, "provider_id": { "type": "string", "format": "uuid" }, "access_type": { "type": [ "null", "string" ] } } }, "GrantPermissionRequest": { "required": [ "provider_id", "permission_level" ], "type": "object", "properties": { "provider_id": { "type": "string", "format": "uuid" }, "permission_level": { "type": [ "null", "string" ] } } }, "GrantRequest": { "required": [ "provider_id" ], "type": "object", "properties": { "provider_id": { "type": "string", "format": "uuid" }, "access_type": { "type": [ "null", "string" ] }, "expires_at": { "type": [ "null", "string" ], "format": "date-time" } } }, "GrantTemplateEditorRequest": { "required": [ "template_id" ], "type": "object", "properties": { "template_id": { "type": "string", "format": "uuid" } } }, "IFormFile": { "type": "string", "format": "binary" }, "ImportUploadRequest": { "type": "object", "properties": { "csv": { "type": [ "null", "string" ] }, "file_name": { "type": [ "null", "string" ] }, "default_code": { "type": [ "null", "string" ] }, "default_template_id": { "type": [ "null", "string" ], "format": "uuid" }, "mode": { "type": [ "null", "string" ] }, "category": { "type": [ "null", "string" ] } } }, "IngestCompany": { "type": "object", "properties": { "exchange": { "type": [ "null", "string" ] }, "ticker": { "type": "string" }, "company_name": { "type": [ "null", "string" ] }, "is_primary": { "type": "boolean" } } }, "IngestNote": { "required": [ "external_id", "title", "published_at" ], "type": "object", "properties": { "external_id": { "type": "string" }, "title": { "type": "string" }, "authors": { "type": "array", "items": { "type": "string" } }, "published_at": { "type": "string", "format": "date-time" }, "note_type": { "$ref": "#/components/schemas/OptionalOfstring" }, "abstract": { "type": [ "null", "string" ] }, "sectors": { "type": [ "null", "array" ], "items": { "type": "string" } }, "geographies": { "type": [ "null", "array" ], "items": { "type": "string" } }, "entitlement_codes": { "type": [ "null", "array" ], "items": { "type": "string" } }, "product_category": { "type": [ "null", "string" ] }, "rating": { "$ref": "#/components/schemas/OptionalOfstring" }, "price_target": { "$ref": "#/components/schemas/OptionalOfdecimal" }, "price_currency": { "$ref": "#/components/schemas/OptionalOfstring" }, "previous_rating": { "$ref": "#/components/schemas/OptionalOfstring" }, "content_url": { "type": [ "null", "string" ] }, "content_format": { "type": "string" }, "blob_path": { "type": [ "null", "string" ] }, "page_count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "word_count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "embargo_until": { "type": [ "null", "string" ], "format": "date-time" }, "status": { "type": [ "null", "string" ] }, "access_level": { "type": [ "null", "string" ] }, "language": { "type": [ "null", "string" ] }, "companies": { "type": "array", "items": { "$ref": "#/components/schemas/IngestCompany" } }, "is_ipo": { "type": [ "null", "boolean" ] }, "ipo_disclaimer_text": { "$ref": "#/components/schemas/OptionalOfstring" }, "ipo_disclaimer_mode": { "$ref": "#/components/schemas/OptionalOfstring" }, "download_disabled": { "type": [ "null", "boolean" ] } } }, "IngestRequest": { "required": [ "provider_id", "notes" ], "type": "object", "properties": { "provider_id": { "type": "string", "format": "uuid" }, "notes": { "type": "array", "items": { "$ref": "#/components/schemas/IngestNote" } } } }, "InitiatePurchaseRequest": { "required": [ "provider_id", "note_id" ], "type": "object", "properties": { "provider_id": { "type": "string", "format": "uuid" }, "note_id": { "type": "string", "format": "uuid" }, "note_type": { "type": [ "null", "string" ] } } }, "InviteRequest": { "required": [ "email", "role" ], "type": "object", "properties": { "email": { "type": "string" }, "role": { "type": [ "null", "string" ] } } }, "IssueAttestationRequest": { "required": [ "profile_id", "attestation_type" ], "type": "object", "properties": { "profile_id": { "type": "string", "format": "uuid" }, "attestation_type": { "type": [ "null", "string" ] } } }, "LocalePreferencesPatch": { "required": [ "preferred_locale", "content_languages" ], "type": "object", "properties": { "preferred_locale": { "type": [ "null", "string" ] }, "content_languages": { "type": [ "null", "array" ], "items": { "type": "string" } } } }, "MagicLinkRequest": { "required": [ "email" ], "type": "object", "properties": { "email": { "type": "string" }, "return_path": { "type": [ "null", "string" ] } } }, "MagicLinkVerifyRequest": { "required": [ "token" ], "type": "object", "properties": { "token": { "type": "string" } } }, "NoteAccessRequest": { "required": [ "email" ], "type": "object", "properties": { "email": { "type": "string" } } }, "NoteDisclaimerAcceptRequest": { "required": [ "disclaimer_version" ], "type": "object", "properties": { "disclaimer_version": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "OnboardingStepUpdate": { "required": [ "step_key", "data" ], "type": "object", "properties": { "step_key": { "type": "string" }, "data": { "type": [ "null", "object" ] } } }, "OptionalOfdecimal": { "type": [ "null", "number" ], "format": "double" }, "OptionalOfstring": { "type": [ "null", "string" ] }, "PlatformGrantRequest": { "required": [ "org_id", "provider_id" ], "type": "object", "properties": { "org_id": { "type": "string", "format": "uuid" }, "provider_id": { "type": "string", "format": "uuid" }, "access_type": { "type": [ "null", "string" ] }, "expires_at": { "type": [ "null", "string" ], "format": "date-time" } } }, "PlatformRevokeRequest": { "required": [ "org_id", "provider_id" ], "type": "object", "properties": { "org_id": { "type": "string", "format": "uuid" }, "provider_id": { "type": "string", "format": "uuid" } } }, "PortalDisclaimerAcceptRequest": { "required": [ "provider_id" ], "type": "object", "properties": { "provider_id": { "type": "string", "format": "uuid" }, "disclaimer_version": { "type": [ "null", "string" ] } } }, "PortalRegisterRequest": { "required": [ "email" ], "type": "object", "properties": { "email": { "type": "string" }, "country_of_domicile": { "type": [ "null", "string" ] }, "investor_type": { "type": [ "null", "string" ] }, "disclaimer_version": { "type": [ "null", "string" ] }, "disclaimer_agreed": { "type": "boolean", "default": false }, "full_name": { "type": [ "null", "string" ] } } }, "PortalSubscribeRequest": { "required": [ "email" ], "type": "object", "properties": { "email": { "type": "string" }, "locale": { "type": [ "null", "string" ] }, "source": { "type": [ "null", "string" ] } } }, "PortalSubscriptionRequest": { "type": "object", "properties": { "subject_type": { "type": [ "null", "string" ] }, "subject_key": { "type": [ "null", "string" ] }, "exchange": { "type": [ "null", "string" ] } } }, "PriceIngestRequest": { "required": [ "prices" ], "type": "object", "properties": { "prices": { "type": "array", "items": { "$ref": "#/components/schemas/PriceIngestRow" } } } }, "PriceIngestRow": { "required": [ "ticker", "price", "currency" ], "type": "object", "properties": { "ticker": { "type": "string" }, "price": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "currency": { "type": "string" }, "exchange": { "type": [ "null", "string" ] }, "as_of": { "type": [ "null", "string" ], "format": "date-time" }, "change": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "change_percent": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" } } }, "PullSyncRequest": { "required": [ "provider_id" ], "type": "object", "properties": { "provider_id": { "type": "string", "format": "uuid" } } }, "RecipientRow": { "required": [ "email", "display_name", "provider_user_ref" ], "type": "object", "properties": { "email": { "type": "string" }, "display_name": { "type": [ "null", "string" ] }, "provider_user_ref": { "type": [ "null", "string" ] } } }, "RecipientUploadRequest": { "required": [ "mode", "recipients" ], "type": "object", "properties": { "mode": { "type": [ "null", "string" ] }, "recipients": { "type": "array", "items": { "$ref": "#/components/schemas/RecipientRow" } } } }, "RegisterProviderRequest": { "required": [ "display_name", "org_type", "adapter_type", "portal_slug", "portal_primary_colour" ], "type": "object", "properties": { "display_name": { "type": "string" }, "org_type": { "type": [ "null", "string" ] }, "adapter_type": { "type": [ "null", "string" ] }, "portal_slug": { "type": [ "null", "string" ] }, "portal_primary_colour": { "type": [ "null", "string" ] } } }, "ReorderProviderSectorsRequest": { "required": [ "sector_ids" ], "type": "object", "properties": { "sector_ids": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "ResearchTreeReadershipIngestRequest": { "required": [ "events" ], "type": "object", "properties": { "events": { "type": [ "null", "array" ] } } }, "ReviewKycProfileRequest": { "required": [ "decision" ], "type": "object", "properties": { "decision": { "type": "string" } } }, "RevokeAttestationRequest": { "required": [ "reason" ], "type": "object", "properties": { "reason": { "type": [ "null", "string" ] } } }, "RevokeRequest": { "required": [ "provider_id" ], "type": "object", "properties": { "provider_id": { "type": "string", "format": "uuid" } } }, "SetCompanyTemplateRequest": { "required": [ "template_id" ], "type": "object", "properties": { "template_id": { "type": "string", "format": "uuid" } } }, "SetLocaleRequest": { "required": [ "locale" ], "type": "object", "properties": { "locale": { "type": "string" } } }, "SetProviderDefaultContentLanguageRequest": { "required": [ "language" ], "type": "object", "properties": { "language": { "type": "string" } } }, "SetProviderDefaultTemplateRequest": { "type": "object", "properties": { "default_template_id": { "type": [ "null", "string" ], "format": "uuid" } } }, "SetProviderHomeOrgRequest": { "required": [ "home_org_id" ], "type": "object", "properties": { "home_org_id": { "type": [ "null", "string" ], "format": "uuid" } } }, "SetRixmlRulesRequest": { "required": [ "rules" ], "type": "object", "properties": { "rules": { "type": "object", "additionalProperties": { "type": "string" } } } }, "SupportDiagnosisRequest": { "type": "object", "properties": { "bucket": { "type": "string" }, "affected_count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "confidence": { "type": [ "null", "string" ] }, "summary": { "type": "string" }, "evidence": { "type": [ "null", "string" ] }, "proposed_next_step": { "type": [ "null", "string" ] }, "risk": { "type": [ "null", "string" ] }, "undo": { "type": [ "null", "string" ] } } }, "SupportFailedRequest": { "type": "object", "properties": { "request_id": { "type": [ "null", "string" ] }, "path": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" } } }, "SupportReportContext": { "type": "object", "properties": { "page_url": { "type": [ "null", "string" ] }, "note_id": { "type": [ "null", "string" ] }, "failed_requests": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/SupportFailedRequest" } }, "user_agent": { "type": [ "null", "string" ] }, "locale": { "type": [ "null", "string" ] }, "client_time": { "type": [ "null", "string" ] } } }, "SupportReportRequest": { "type": "object", "properties": { "message": { "type": "string" }, "email": { "type": [ "null", "string" ] }, "context": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/SupportReportContext" } ] } } }, "TemplateViewReorderEntry": { "required": [ "template_view_id", "position" ], "type": "object", "properties": { "template_view_id": { "type": "string", "format": "uuid" }, "position": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "TemplateViewReorderRequest": { "required": [ "entries" ], "type": "object", "properties": { "entries": { "type": "array", "items": { "$ref": "#/components/schemas/TemplateViewReorderEntry" } } } }, "UpdateDistributionChannelRequest": { "type": "object", "properties": { "name": { "type": [ "null", "string" ] }, "transport": { "type": [ "null", "string" ] }, "package_format": { "type": [ "null", "string" ] }, "endpoint": { "type": [ "null", "string" ] }, "credentials_ref": { "type": [ "null", "string" ] }, "filter": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/DistributionFilterDto" } ] }, "rixml_version": { "type": [ "null", "string" ] }, "watermark_mode": { "type": [ "null", "string" ] }, "enabled": { "type": [ "null", "boolean" ] } } }, "UpdateEntitlementCodeRequest": { "required": [ "title" ], "type": "object", "properties": { "title": { "type": "string" } } }, "UpdateForecastTemplateRequest": { "type": "object", "properties": { "display_name": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] } } }, "UpdateForecastViewRequest": { "type": "object", "properties": { "display_name": { "type": [ "null", "string" ] }, "view_type": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] } } }, "UpdateKycProfileRequest": { "type": "object", "properties": { "legal_name": { "type": [ "null", "string" ] }, "jurisdiction": { "type": [ "null", "string" ] }, "regulatory_status": { "type": [ "null", "string" ] }, "lei": { "type": [ "null", "string" ] }, "regulator": { "type": [ "null", "string" ] }, "registration_number": { "type": [ "null", "string" ] }, "contact_email": { "type": [ "null", "string" ] }, "contact_name": { "type": [ "null", "string" ] } } }, "UpdateLineItemRequest": { "type": "object", "properties": { "display_name": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] }, "unit_type": { "type": [ "null", "string" ] }, "currency_code": { "type": [ "null", "string" ] }, "magnitude": { "type": [ "null", "string" ] }, "display_suffix": { "type": [ "null", "string" ] } } }, "UpdateLineItemRptMappingRequest": { "type": "object", "properties": { "scale_factor": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "sign_flip": { "type": [ "null", "boolean" ] } } }, "UpdateManagedOrgRequest": { "type": "object", "properties": { "display_name": { "type": [ "null", "string" ] }, "org_type": { "type": [ "null", "string" ] }, "institution_type": { "type": [ "null", "string" ] }, "regions": { "type": [ "null", "array" ], "items": { "type": "string" } }, "asset_classes": { "type": [ "null", "array" ], "items": { "type": "string" } } } }, "UpdateMembershipRequest": { "type": "object", "properties": { "sort_order": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "group_label": { "type": [ "null", "string" ] }, "row_style": { "type": [ "null", "string" ] }, "style_config": { "type": [ "null", "object" ] } } }, "UpdateOrgSettingsRequest": { "type": "object", "properties": { "name": { "type": [ "null", "string" ] }, "institution_type": { "type": [ "null", "string" ] }, "regions": { "type": [ "null", "array" ], "items": { "type": "string" } }, "asset_classes": { "type": [ "null", "array" ], "items": { "type": "string" } }, "sub_sectors": { "type": [ "null", "array" ], "items": { "type": "string" } } } }, "UpdatePermissionLevelRequest": { "required": [ "permission_level" ], "type": "object", "properties": { "permission_level": { "type": "string" } } }, "UpdateProviderRequest": { "required": [ "display_name", "adapter_type", "org_type" ], "type": "object", "properties": { "display_name": { "type": [ "null", "string" ] }, "adapter_type": { "type": [ "null", "string" ] }, "org_type": { "type": [ "null", "string" ] } } }, "UpdateProviderSectorRequest": { "type": "object", "properties": { "name": { "type": [ "null", "string" ] }, "slug": { "type": [ "null", "string" ] }, "icon": { "type": [ "null", "string" ] }, "sort_order": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" } } }, "UpdateTemplateRequest": { "type": "object", "properties": { "name": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] }, "includes_attachments": { "type": [ "null", "boolean" ] }, "full_access": { "type": [ "null", "boolean" ] } } }, "UpdateTemplateRuleRequest": { "type": "object", "properties": { "rule_type": { "type": [ "null", "string" ] }, "config": { "type": [ "null", "object" ] } } }, "UpdateTemplateViewRequest": { "type": "object", "properties": { "position": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "title_override": { "type": [ "null", "string" ] } } }, "UpdateWebhookSubscriptionRequest": { "required": [ "url", "secret", "events", "is_active" ], "type": "object", "properties": { "url": { "type": [ "null", "string" ] }, "secret": { "type": [ "null", "string" ] }, "events": { "type": [ "null", "string" ] }, "is_active": { "type": [ "null", "boolean" ] } } }, "VerifyAttestationRequest": { "required": [ "hash" ], "type": "object", "properties": { "hash": { "type": "string" } } }, "ViewAsEnterRequest": { "required": [ "mode", "ttl_seconds" ], "type": "object", "properties": { "mode": { "type": [ "null", "string" ] }, "ttl_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" } } } } }, "tags": [ { "name": "Health" }, { "name": "Auth" }, { "name": "Search" }, { "name": "Ingest" }, { "name": "Company Forecasts" }, { "name": "Branded Portal" }, { "name": "Content" }, { "name": "Research" }, { "name": "Organisation" }, { "name": "GDPR" }, { "name": "Portal" }, { "name": "Public" }, { "name": "Agents" }, { "name": "Provider Portal" }, { "name": "Localisation" }, { "name": "Admin" }, { "name": "Providers" }, { "name": "Entitlements" }, { "name": "Entitlement Rules" }, { "name": "Org Access" }, { "name": "Attachments" }, { "name": "Analysts" }, { "name": "Coverage" }, { "name": "ApiKeys" }, { "name": "Onboarding" }, { "name": "BuySide" }, { "name": "KYC" }, { "name": "KYC Attestations" }, { "name": "KYC Permissions" }, { "name": "KYC Views" }, { "name": "Billing" }, { "name": "Webhooks" }, { "name": "Support" }, { "name": "Watchlist" }, { "name": "Analytics" }, { "name": "AdminProviderManagement" }, { "name": "Audit Logs" }, { "name": "Sync" }, { "name": "Adapters" } ] }