{ "openapi": "3.0.1", "info": { "title": "SEC Account Briefs", "description": "Turn a company's SEC filings into a decision-ready account brief: recent material events, leadership changes, financial signals, and risks — every sentence cited to an 8-K item with a sec.gov link. No-AI, bring-your-own-key, or managed modes.", "version": "0.1", "x-build-id": "9vlf0dvgk2ldqyTuH" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/gtm_solutions~sec-account-briefs/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-gtm_solutions-sec-account-briefs", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/gtm_solutions~sec-account-briefs/runs": { "post": { "operationId": "runs-sync-gtm_solutions-sec-account-briefs", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/gtm_solutions~sec-account-briefs/run-sync": { "post": { "operationId": "run-sync-gtm_solutions-sec-account-briefs", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "companies" ], "properties": { "companies": { "title": "Companies", "type": "array", "description": "One to ten companies by SEC CIK (1–10 digits, normalized to ten). Ticker and legal name are optional display hints.", "items": { "type": "object", "properties": { "cik": { "title": "CIK", "type": "string", "description": "SEC Central Index Key.", "editor": "textfield" }, "ticker": { "title": "Ticker", "type": "string", "description": "Optional exchange ticker, display only.", "editor": "textfield" }, "legalName": { "title": "Legal name", "type": "string", "description": "Optional legal name, display only.", "editor": "textfield" } }, "required": [ "cik" ] } }, "asOfDate": { "title": "As-of date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Inclusive end of the evidence window (YYYY-MM-DD). Defaults to today." }, "lookbackDays": { "title": "Lookback days", "minimum": 1, "maximum": 1095, "type": "integer", "description": "Length of the evidence window ending at the as-of date (1–1095).", "default": 365 }, "sections": { "title": "Sections", "type": "array", "description": "Synthesized sections to include. Coverage, citations and limitations are always included.", "items": { "type": "string", "enum": [ "material-events", "governance", "financial", "risks" ], "enumTitles": [ "Recent material events", "Management and governance", "Operating and financial signals", "Risks and watch items" ] }, "default": [ "material-events", "governance", "financial", "risks" ] }, "detail": { "title": "Detail", "enum": [ "brief", "standard" ], "type": "string", "description": "How many events each section may draw on: brief (5) or standard (12).", "default": "standard" }, "aiMode": { "title": "AI mode", "enum": [ "extractive", "byok", "managed" ], "type": "string", "description": "extractive: no model, every line cited. byok: your Anthropic key synthesizes each section. managed: the operator's model does, within the per-brief cost cap.", "default": "extractive" }, "anthropicApiKey": { "title": "Anthropic API key (BYOK)", "type": "string", "description": "Required for byok mode. Stored as a secret; never written to the dataset." }, "model": { "title": "Model (BYOK)", "enum": [ "claude-opus-5", "claude-sonnet-5", "claude-haiku-4-5" ], "type": "string", "description": "Optional model for byok mode." }, "maxModelCostCents": { "title": "Max model cost per brief (US cents)", "minimum": 1, "maximum": 20, "type": "integer", "description": "Managed mode: a brief whose model cost exceeds this is still delivered and flagged. 1–20 cents; the operator ceiling is 20.", "default": 20 } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }