{ "openapi": "3.1.0", "info": { "title": "Lightsage Public API", "description": "Public API for Lightsage CLI and external integrations.", "version": "1.0.0" }, "servers": [ { "url": "https://api.lightsage.com", "description": "Production" } ], "paths": { "/v1/status": { "get": { "tags": [ "Status" ], "summary": "Get Status", "operationId": "status_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/v1/auth/status": { "get": { "tags": [ "Status" ], "summary": "Get Auth Status", "operationId": "auth_status_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "LightsageApiKeyAuth": [] } ] } }, "/v1/prompts": { "get": { "tags": [ "Prompts" ], "summary": "List Prompts", "operationId": "prompts_list", "security": [ { "LightsageApiKeyAuth": [] } ], "parameters": [ { "name": "topic_id", "in": "query", "required": false, "schema": { "type": "string", "title": "Topic Id" } }, { "name": "status", "in": "query", "required": false, "schema": { "enum": [ "active", "inactive", "archived" ], "type": "string", "description": "Filter prompts by lifecycle status.", "title": "Status" }, "description": "Filter prompts by lifecycle status." }, { "name": "include_archived", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Include Archived" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPromptsResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-stainless-method": "prompts.list" }, "post": { "tags": [ "Prompts" ], "summary": "Create Prompts", "operationId": "prompts_create", "security": [ { "LightsageApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePublicPromptsBatchRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicPromptBatchResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-stainless-method": "prompts.create" } }, "/v1/prompts/config": { "get": { "tags": [ "Prompts" ], "summary": "Retrieve Prompt Config", "operationId": "prompts_config_retrieve", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicPromptConfigResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "LightsageApiKeyAuth": [] } ], "x-stainless-method": "prompts.config.retrieve" } }, "/v1/prompts/topics": { "post": { "tags": [ "Prompts" ], "summary": "Create Topic", "operationId": "prompts_topics_create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePromptTopicRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicPromptTopic" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "LightsageApiKeyAuth": [] } ], "x-stainless-method": "prompts.topics.create" } }, "/v1/prompts/topics/{topic_id}": { "patch": { "tags": [ "Prompts" ], "summary": "Update Topic", "operationId": "prompts_topics_update", "security": [ { "LightsageApiKeyAuth": [] } ], "parameters": [ { "name": "topic_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Topic Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePromptTopicRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicPromptTopic" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-stainless-method": "prompts.topics.update" }, "delete": { "tags": [ "Prompts" ], "summary": "Delete Topic", "operationId": "prompts_topics_delete", "security": [ { "LightsageApiKeyAuth": [] } ], "parameters": [ { "name": "topic_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Topic Id" } }, { "name": "archive_prompts", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Archive Prompts" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicOkResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-stainless-method": "prompts.topics.delete" } }, "/v1/prompts/{prompt_id}": { "get": { "tags": [ "Prompts" ], "summary": "Retrieve Prompt", "operationId": "prompts_retrieve", "security": [ { "LightsageApiKeyAuth": [] } ], "parameters": [ { "name": "prompt_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Prompt Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicPrompt" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-stainless-method": "prompts.retrieve" }, "patch": { "tags": [ "Prompts" ], "summary": "Update Prompt", "operationId": "prompts_update", "security": [ { "LightsageApiKeyAuth": [] } ], "parameters": [ { "name": "prompt_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Prompt Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePublicPromptRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicPrompt" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-stainless-method": "prompts.update" }, "delete": { "tags": [ "Prompts" ], "summary": "Delete Prompt", "operationId": "prompts_delete", "security": [ { "LightsageApiKeyAuth": [] } ], "parameters": [ { "name": "prompt_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Prompt Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicOkResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-stainless-method": "prompts.delete" } }, "/v1/opportunities": { "get": { "tags": [ "Opportunities" ], "summary": "List Opportunities", "description": "List prompt opportunities with execution prompts.\n\nReturns pre-computed opportunities from Lightsage's prompt visibility analysis.\nEach opportunity includes an `execution_prompt` with the context an AI agent\nneeds to address it. This endpoint reads existing analysis; it does not run\nprompts or generate new opportunities.", "operationId": "opportunities_list", "security": [ { "LightsageApiKeyAuth": [] } ], "parameters": [ { "name": "since", "in": "query", "required": false, "schema": { "type": "string", "description": "Relative or absolute start date for opportunity analysis, such as 30d, 72h, or 2026-06-01. Ignored when start_date is provided.", "title": "Since" }, "description": "Relative or absolute start date for opportunity analysis, such as 30d, 72h, or 2026-06-01. Ignored when start_date is provided." }, { "name": "start_date", "in": "query", "required": false, "schema": { "type": "string", "description": "Inclusive analysis start date (YYYY-MM-DD).", "title": "Start Date" }, "description": "Inclusive analysis start date (YYYY-MM-DD)." }, { "name": "end_date", "in": "query", "required": false, "schema": { "type": "string", "description": "Inclusive analysis end date (YYYY-MM-DD). Defaults to today.", "title": "End Date" }, "description": "Inclusive analysis end date (YYYY-MM-DD). Defaults to today." }, { "name": "category", "in": "query", "required": false, "schema": { "enum": [ "quick_wins", "growth", "refresh", "citations" ], "type": "string", "description": "Filter opportunities to a high-level category.", "title": "Category" }, "description": "Filter opportunities to a high-level category." }, { "name": "opportunity_type", "in": "query", "required": false, "schema": { "enum": [ "almost_winning", "negative_sentiment", "lost_wins", "competitor_gaps", "untapped_topics", "platform_blind_spots", "content_gaps", "declining_visibility", "volatile_visibility", "citation_gaps", "high_citation_sources", "listicle_targets" ], "type": "string", "description": "Filter opportunities to a specific opportunity type.", "title": "Opportunity Type" }, "description": "Filter opportunities to a specific opportunity type." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "description": "Maximum number of ranked opportunities to return.", "default": 50, "title": "Limit" }, "description": "Maximum number of ranked opportunities to return." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOpportunitiesResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-stainless-method": "opportunities.list" } }, "/v1/tasks": { "get": { "tags": [ "Tasks" ], "summary": "List Tasks", "description": "List the persisted daily tasks for the organization.\n\nReturns existing tasks filtered by workflow `status`, along with per-status\ncounts. Each task includes an `execution_prompt` with the context an AI\nagent needs to execute it. If `action_date` is omitted, the response spans\npersisted tasks across generation dates. This reads existing tasks; it does\nnot generate a new batch.", "operationId": "tasks_list", "security": [ { "LightsageApiKeyAuth": [] } ], "parameters": [ { "name": "action_date", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "description": "Action-queue date to read (YYYY-MM-DD). Omit to read persisted tasks across all generation dates.", "title": "Action Date" }, "description": "Action-queue date to read (YYYY-MM-DD). Omit to read persisted tasks across all generation dates." }, { "name": "status", "in": "query", "required": false, "schema": { "enum": [ "active", "todo", "new", "in_progress", "completed", "done", "dismissed", "all" ], "type": "string", "description": "Which slice of the queue to return. The default active view returns todo/new and in-progress tasks. Use todo/new, in_progress, done, dismissed, completed, or all for a narrower or broader slice.", "default": "active", "title": "Status" }, "description": "Which slice of the queue to return. The default active view returns todo/new and in-progress tasks. Use todo/new, in_progress, done, dismissed, completed, or all for a narrower or broader slice." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListTasksResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-stainless-method": "tasks.list" } }, "/v1/tasks/{task_id}": { "get": { "tags": [ "Tasks" ], "summary": "Retrieve Task", "description": "Retrieve a single daily task and its execution prompt.", "operationId": "tasks_retrieve", "security": [ { "LightsageApiKeyAuth": [] } ], "parameters": [ { "name": "task_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Task Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicTask" } } } }, "404": { "description": "The task does not exist or is not visible to this API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } }, "required": [ "detail" ] }, "example": { "detail": "Task not found" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-stainless-method": "tasks.retrieve" }, "patch": { "tags": [ "Tasks" ], "summary": "Update Task", "description": "Update the status and delegation of a single daily task.\n\nMove a task through its lifecycle (for example to `in_progress`,\n`done`, or `dismissed`), reprioritize it (`priority`), delegate it to a\nteammate (`assignee_user_id`), or change its `action_type`. Only the fields\nsent are changed; sending `null` clears an assignee or action type. Send at\nleast one field.", "operationId": "tasks_update", "security": [ { "LightsageApiKeyAuth": [] } ], "parameters": [ { "name": "task_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Task Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTaskRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicTask" } } } }, "404": { "description": "The task does not exist or is not visible to this API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } }, "required": [ "detail" ] }, "example": { "detail": "Task not found" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-stainless-method": "tasks.update" } }, "/v1/eval-runs": { "post": { "tags": [ "Eval Runs" ], "summary": "Create Eval Run", "description": "Start a durable eval run and return the parent job ID to poll.\n\nFor prompt evals, provide explicit `targets` to override the configured\nprompt targets, or omit `targets` to use the organization's configured\nscheduled prompt targets. For API Performance evals, explicit `targets` or\n`models` override the stored configuration; when omitted, Lightsage uses\nconfigured scheduled targets or legacy configured models. Custom eval runs\nuse `custom_eval_ids` when provided, otherwise the configured custom eval\nset for the organization.\n\nFor API Performance source types backed by a source (`rest_api`, `sdk`, or\n`cli`), provide `source_id` from `api-performance sources list`, or omit it\nwhen `operation_ids`, `eval_ids`, or the requested `source_type` identify a\nsingle source. `operation_ids` are Lightsage API Performance operation IDs,\nnot OpenAPI operationId strings.\n\nEvery run is queued through the durable job queue. The response `id` is the\n`eval_run_id` to pass to `GET /v1/eval-runs/{eval_run_id}`. When Lightsage can\ndetermine the runnable work, the response also includes `dispatch_id` and\ninitial queued progress for the child jobs.", "operationId": "eval_runs_create", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/PublicPromptEvalRunRequest" }, { "$ref": "#/components/schemas/PublicApiPerformanceEvalRunRequest" } ], "title": "Request", "discriminator": { "propertyName": "type", "mapping": { "prompts": "#/components/schemas/PublicPromptEvalRunRequest", "api_performance": "#/components/schemas/PublicApiPerformanceEvalRunRequest" } } } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicEvalRunResponse" } } } }, "400": { "description": "The request is valid, but Lightsage could not determine what to run from either the request payload or saved configuration.", "content": { "application/json": { "schema": { "properties": { "detail": { "type": "string" } }, "type": "object", "required": [ "detail" ] }, "examples": { "missing_prompt_targets": { "summary": "No configured prompt targets", "value": { "detail": "No configured prompt targets were found for this organization. Configure prompt targets first or include targets in the request." } }, "missing_api_performance_targets": { "summary": "No configured API Performance targets", "value": { "detail": "No configured API Performance targets or models were found for cli. Configure eval targets for this source or include targets/models in the request." } }, "ambiguous_api_performance_source": { "summary": "API Performance source is ambiguous", "value": { "detail": "source_id is required for source_type=cli unless operation_ids or eval_ids identify a single source. Get source IDs from api-performance sources list or api-performance evals list." } }, "missing_custom_eval_ids": { "summary": "No configured custom evals", "value": { "detail": "No custom eval IDs were provided and no configured custom evals were found for this organization. Configure custom evals or include custom_eval_ids in the request." } } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "LightsageApiKeyAuth": [] } ], "x-stainless-method": "eval_runs.create" } }, "/v1/eval-runs/{eval_run_id}": { "get": { "tags": [ "Eval Runs" ], "summary": "Retrieve Eval Run", "description": "Retrieve status and progress for a durable eval run.\n\nThe `eval_run_id` is the `id` returned by `POST /v1/eval-runs`. Progress is\ncomputed from the parent job, its dispatch, and child jobs.", "operationId": "eval_runs_retrieve", "security": [ { "LightsageApiKeyAuth": [] } ], "parameters": [ { "name": "eval_run_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Eval Run Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicEvalRunResponse" } } } }, "404": { "description": "The eval run does not exist or is not visible to this API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } }, "required": [ "detail" ] }, "example": { "detail": "Eval run not found" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-stainless-method": "eval_runs.retrieve" } }, "/v1/content/draft": { "post": { "tags": [ "Content" ], "summary": "Generate Content Draft", "description": "Generate a draft marketing/blog article and save it as draft content.\n\nWrites the AI-generated article (markdown) to a new content record and\nreturns its id, title, body, slug, and status. Costs credits. Use the\nreturned id to finalize the draft or to open it for editing.", "operationId": "content_generate_draft", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateContentDraftRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicContent" } } } }, "402": { "description": "The organization does not have enough credits to generate content.", "content": { "application/json": { "schema": { "properties": { "detail": { "type": "string" } }, "type": "object", "required": [ "detail" ] }, "examples": { "insufficient_credits": { "summary": "Not enough credits", "value": { "detail": "Insufficient credits: need 10, balance 3." } } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "LightsageApiKeyAuth": [] } ] } }, "/v1/content/final": { "post": { "tags": [ "Content" ], "summary": "Generate Content Final", "description": "Polish an existing draft into final, publish-ready content.\n\nRewrites the referenced draft into a finalized article, updates its status\nto `final`, and returns the updated content. Costs credits.", "operationId": "content_generate_final", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateContentFinalRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicContent" } } } }, "402": { "description": "The organization does not have enough credits to generate content.", "content": { "application/json": { "schema": { "properties": { "detail": { "type": "string" } }, "type": "object", "required": [ "detail" ] }, "examples": { "insufficient_credits": { "summary": "Not enough credits", "value": { "detail": "Insufficient credits: need 10, balance 3." } } } } } }, "404": { "description": "Content (or the organization) was not found for this API key.", "content": { "application/json": { "schema": { "properties": { "detail": { "type": "string" } }, "type": "object", "required": [ "detail" ] }, "examples": { "not_found": { "summary": "Content not found", "value": { "detail": "Content not found." } } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "LightsageApiKeyAuth": [] } ] } }, "/v1/content/{content_id}": { "get": { "tags": [ "Content" ], "summary": "Get Content Endpoint", "description": "Retrieve a content record (title, markdown body, slug, status).", "operationId": "content_get", "security": [ { "LightsageApiKeyAuth": [] } ], "parameters": [ { "name": "content_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Content Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicContent" } } } }, "404": { "description": "Content (or the organization) was not found for this API key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } }, "required": [ "detail" ] }, "examples": { "not_found": { "summary": "Content not found", "value": { "detail": "Content not found." } } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/visibility/current": { "get": { "tags": [ "Visibility" ], "summary": "Retrieve Current Visibility", "description": "Retrieve current visibility metrics for the organization.\n\nReturns visibility score, share of voice, ranks, and date-range metadata for\nthe configured primary company. Values are calculated from currently active\nprompts. When the selected range has no prompt-run data, metric values are\n`null` and `has_data` is `false`.", "operationId": "visibility_current_retrieve", "security": [ { "LightsageApiKeyAuth": [] } ], "parameters": [ { "name": "start_date", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "description": "Optional start date. Defaults to 30 days before the end date.", "title": "Start Date" }, "description": "Optional start date. Defaults to 30 days before the end date." }, { "name": "end_date", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "description": "Optional end date. Defaults to today.", "title": "End Date" }, "description": "Optional end date. Defaults to today." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicCurrentVisibilityResponse" } } } }, "400": { "description": "The requested date range is invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } }, "required": [ "detail" ] }, "examples": { "invalid_date_range": { "summary": "Invalid date range", "value": { "detail": "start_date must be on or before end_date" } } } } } }, "404": { "description": "No configured company was found for this organization.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } }, "required": [ "detail" ] }, "examples": { "missing_company": { "summary": "Missing company", "value": { "detail": "Configured API Performance scope not found for this organization" } } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-stainless-method": "visibility.current.retrieve" } }, "/v1/visibility/overview": { "get": { "tags": [ "Visibility" ], "summary": "Retrieve Visibility Overview", "description": "Retrieve the visibility overview for the organization.\n\nMirrors the dashboard overview: a point-in-time `snapshot` (visibility score,\nshare of voice, average position, ranks, and total citations aggregated over\nthe range), a daily `timeseries` of visibility score, per-platform visibility\nand citation series in `by_platform`, and a `competitors` comparison. Values\nare calculated from currently active prompts. When the selected range has no\nprompt-run data, snapshot values are `null` and `has_data` is `false`.", "operationId": "visibility_overview_retrieve", "security": [ { "LightsageApiKeyAuth": [] } ], "parameters": [ { "name": "start_date", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "description": "Optional start date. Defaults to 30 days before the end date.", "title": "Start Date" }, "description": "Optional start date. Defaults to 30 days before the end date." }, { "name": "end_date", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "description": "Optional end date. Defaults to today.", "title": "End Date" }, "description": "Optional end date. Defaults to today." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicVisibilityOverviewResponse" } } } }, "400": { "description": "The requested date range is invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } }, "required": [ "detail" ] }, "examples": { "invalid_date_range": { "summary": "Invalid date range", "value": { "detail": "start_date must be on or before end_date" } } } } } }, "404": { "description": "No configured company was found for this organization.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } }, "required": [ "detail" ] }, "examples": { "missing_company": { "summary": "Missing company", "value": { "detail": "Configured API Performance scope not found for this organization" } } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-stainless-method": "visibility.overview.retrieve" } }, "/v1/visibility/prompts": { "get": { "tags": [ "Visibility" ], "summary": "Retrieve Prompt Visibility Report", "description": "Retrieve the prompt visibility report for the organization.\n\nMirrors the dashboard Prompts tab with an overall summary, topic rows, and\nnested active prompt rows. Each row includes visibility score, visibility\nrank, share of voice, average position, owned-domain citations, and prompt\nruns for the selected date range. Active prompts without runs remain in the\nresponse with `null` visibility metrics and zero counts.", "operationId": "visibility_prompts_retrieve", "security": [ { "LightsageApiKeyAuth": [] } ], "parameters": [ { "name": "start_date", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "description": "Optional start date. Defaults to 30 days before the end date.", "title": "Start Date" }, "description": "Optional start date. Defaults to 30 days before the end date." }, { "name": "end_date", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "description": "Optional end date. Defaults to today.", "title": "End Date" }, "description": "Optional end date. Defaults to today." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicPromptVisibilityReportResponse" } } } }, "400": { "description": "The requested date range is invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } }, "required": [ "detail" ] }, "examples": { "invalid_date_range": { "summary": "Invalid date range", "value": { "detail": "start_date must be on or before end_date" } } } } } }, "404": { "description": "No configured company was found for this organization.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } }, "required": [ "detail" ] }, "examples": { "missing_company": { "summary": "Missing company", "value": { "detail": "Configured API Performance scope not found for this organization" } } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-stainless-method": "visibility.prompts.retrieve" } }, "/v1/api-performance/targets": { "get": { "tags": [ "API Performance" ], "summary": "List Targets", "operationId": "api_performance_targets_list", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiPerformanceTargetsResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "LightsageApiKeyAuth": [] } ], "x-stainless-method": "api_performance.targets.list" } }, "/v1/api-performance/runs": { "get": { "tags": [ "API Performance" ], "summary": "List Eval Runs", "operationId": "api_performance_runs_list", "security": [ { "LightsageApiKeyAuth": [] } ], "parameters": [ { "name": "since", "in": "query", "required": false, "schema": { "type": "string", "title": "Since" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 20, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EvalRunsListResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-stainless-method": "api_performance.runs.list" } }, "/v1/api-performance/runs/{run_id}": { "get": { "tags": [ "API Performance" ], "summary": "Retrieve Eval Run", "operationId": "api_performance_runs_retrieve", "security": [ { "LightsageApiKeyAuth": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Run Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EvalRunResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-stainless-method": "api_performance.runs.retrieve" } }, "/v1/api-performance/diagnose": { "post": { "tags": [ "API Performance" ], "summary": "Diagnose Eval Runs", "operationId": "api_performance_diagnose", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiagnoseEvalRunsRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiagnoseEvalRunsResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "LightsageApiKeyAuth": [] } ], "x-stainless-method": "api_performance.diagnose" } }, "/v1/api-performance/config": { "get": { "tags": [ "API Performance" ], "summary": "Retrieve Eval Config", "operationId": "api_performance_config_retrieve", "security": [ { "LightsageApiKeyAuth": [] } ], "parameters": [ { "name": "source_id", "in": "query", "required": false, "schema": { "type": "string", "title": "Source Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicEvalConfigResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-stainless-method": "api_performance.config.retrieve" }, "put": { "tags": [ "API Performance" ], "summary": "Update Eval Config", "operationId": "api_performance_config_update", "security": [ { "LightsageApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicEvalConfigUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicEvalConfigResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-stainless-method": "api_performance.config.update" } }, "/v1/api-performance/sources": { "get": { "tags": [ "API Performance" ], "summary": "List Sources", "operationId": "api_performance_sources_list", "security": [ { "LightsageApiKeyAuth": [] } ], "parameters": [ { "name": "include_system", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Include System" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiPerformanceSourcesResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-stainless-method": "api_performance.sources.list" } }, "/v1/api-performance/skills": { "get": { "tags": [ "API Performance" ], "summary": "List Skills", "operationId": "api_performance_skills_list", "security": [ { "LightsageApiKeyAuth": [] } ], "parameters": [ { "name": "source_id", "in": "query", "required": false, "schema": { "type": "string", "title": "Source Id" } }, { "name": "skill_source_id", "in": "query", "required": false, "schema": { "type": "string", "title": "Skill Source Id" } }, { "name": "enabled", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Enabled" } }, { "name": "stale", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Stale" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiPerformanceSkillsResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-stainless-method": "api_performance.skills.list" } }, "/v1/api-performance/evals": { "get": { "tags": [ "API Performance" ], "summary": "List Eval Definitions", "operationId": "api_performance_evals_list", "security": [ { "LightsageApiKeyAuth": [] } ], "parameters": [ { "name": "source_id", "in": "query", "required": false, "schema": { "type": "string", "title": "Source Id" } }, { "name": "enabled", "in": "query", "required": false, "schema": { "type": "boolean", "title": "Enabled" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicEvalDefinitionsResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-stainless-method": "api_performance.evals.list" } }, "/v1/api-performance/evals/{eval_id}": { "get": { "tags": [ "API Performance" ], "summary": "Retrieve Eval Definition", "operationId": "api_performance_evals_retrieve", "security": [ { "LightsageApiKeyAuth": [] } ], "parameters": [ { "name": "eval_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Eval Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicEvalDefinition" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-stainless-method": "api_performance.evals.retrieve" }, "patch": { "tags": [ "API Performance" ], "summary": "Update Eval Definition", "operationId": "api_performance_evals_update", "security": [ { "LightsageApiKeyAuth": [] } ], "parameters": [ { "name": "eval_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Eval Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicEvalDefinitionUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicEvalDefinition" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-stainless-method": "api_performance.evals.update" } }, "/v1/api-performance/custom-evals": { "get": { "tags": [ "API Performance" ], "summary": "List Custom Evals", "operationId": "api_performance_custom_evals_list", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicCustomEvalsResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "LightsageApiKeyAuth": [] } ], "x-stainless-method": "api_performance.custom_evals.list" }, "post": { "tags": [ "API Performance" ], "summary": "Create Custom Eval", "operationId": "api_performance_custom_evals_create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicCustomEvalRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicCustomEval" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "LightsageApiKeyAuth": [] } ], "x-stainless-method": "api_performance.custom_evals.create" } }, "/v1/api-performance/custom-evals/history": { "get": { "tags": [ "API Performance" ], "summary": "List Custom Eval History", "description": "List custom eval history rows for the organization.\n\nUse `custom_eval_id` to retrieve the evaluated run history for one custom\neval prompt. The public API hides infrastructure-error rows, matching the\nnon-admin dashboard behavior.", "operationId": "api_performance_custom_evals_history_list", "security": [ { "LightsageApiKeyAuth": [] } ], "parameters": [ { "name": "custom_eval_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Optional custom eval ID to filter history rows.", "title": "Custom Eval Id" }, "description": "Optional custom eval ID to filter history rows." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 25, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 200, "title": "Search" } }, { "name": "result_filter", "in": "query", "required": false, "schema": { "enum": [ "all", "passed", "failed" ], "type": "string", "default": "all", "title": "Result Filter" } }, { "name": "target_key", "in": "query", "required": false, "schema": { "type": "string", "title": "Target Key" } }, { "name": "category_id", "in": "query", "required": false, "schema": { "type": "string", "title": "Category Id" } }, { "name": "sort_by", "in": "query", "required": false, "schema": { "enum": [ "time", "use_case", "target", "result", "score", "tool_calls", "latency" ], "type": "string", "default": "time", "title": "Sort By" } }, { "name": "sort_dir", "in": "query", "required": false, "schema": { "enum": [ "asc", "desc" ], "type": "string", "default": "desc", "title": "Sort Dir" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicCustomEvalHistoryResponse" } } } }, "404": { "description": "The organization does not have a configured API Performance scope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } }, "required": [ "detail" ] }, "examples": { "organization_not_configured": { "summary": "Organization configuration not found", "value": { "detail": "Configured API Performance scope not found for this organization" } } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-stainless-method": "api_performance.custom_evals.history.list" } }, "/v1/api-performance/custom-evals/{custom_eval_id}": { "get": { "tags": [ "API Performance" ], "summary": "Retrieve Custom Eval", "operationId": "api_performance_custom_evals_retrieve", "security": [ { "LightsageApiKeyAuth": [] } ], "parameters": [ { "name": "custom_eval_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Custom Eval Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicCustomEval" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-stainless-method": "api_performance.custom_evals.retrieve" }, "patch": { "tags": [ "API Performance" ], "summary": "Update Custom Eval", "operationId": "api_performance_custom_evals_update", "security": [ { "LightsageApiKeyAuth": [] } ], "parameters": [ { "name": "custom_eval_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Custom Eval Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicCustomEvalUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicCustomEval" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-stainless-method": "api_performance.custom_evals.update" }, "delete": { "tags": [ "API Performance" ], "summary": "Delete Custom Eval", "operationId": "api_performance_custom_evals_delete", "security": [ { "LightsageApiKeyAuth": [] } ], "parameters": [ { "name": "custom_eval_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Custom Eval Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicCustomEval" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-stainless-method": "api_performance.custom_evals.delete" } }, "/v1/api-performance/starter-projects": { "get": { "tags": [ "API Performance" ], "summary": "List Starter Projects", "operationId": "api_performance_starter_projects_list", "security": [ { "LightsageApiKeyAuth": [] } ], "parameters": [ { "name": "source_id", "in": "query", "required": false, "schema": { "type": "string", "title": "Source Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicStartingProjectsResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-stainless-method": "api_performance.starter_projects.list" }, "post": { "tags": [ "API Performance" ], "summary": "Create Starter Project", "operationId": "api_performance_starter_projects_create", "security": [ { "LightsageApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicStartingProjectRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicStartingProject" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-stainless-method": "api_performance.starter_projects.create" } }, "/v1/api-performance/starter-projects/{starter_project_id}": { "get": { "tags": [ "API Performance" ], "summary": "Retrieve Starter Project", "operationId": "api_performance_starter_projects_retrieve", "security": [ { "LightsageApiKeyAuth": [] } ], "parameters": [ { "name": "starter_project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Starter Project Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicStartingProject" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-stainless-method": "api_performance.starter_projects.retrieve" }, "patch": { "tags": [ "API Performance" ], "summary": "Update Starter Project", "operationId": "api_performance_starter_projects_update", "security": [ { "LightsageApiKeyAuth": [] } ], "parameters": [ { "name": "starter_project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Starter Project Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicStartingProjectUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicStartingProject" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-stainless-method": "api_performance.starter_projects.update" }, "delete": { "tags": [ "API Performance" ], "summary": "Delete Starter Project", "operationId": "api_performance_starter_projects_delete", "security": [ { "LightsageApiKeyAuth": [] } ], "parameters": [ { "name": "starter_project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Starter Project Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicStartingProject" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-stainless-method": "api_performance.starter_projects.delete" } }, "/v1/api-performance/actions": { "get": { "tags": [ "API Performance" ], "summary": "List Actions", "operationId": "api_performance_actions_list", "security": [ { "LightsageApiKeyAuth": [] } ], "parameters": [ { "name": "source_id", "in": "query", "required": false, "schema": { "type": "string", "title": "Source Id" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "title": "Status" } }, { "name": "action_type", "in": "query", "required": false, "schema": { "type": "string", "title": "Action Type" } }, { "name": "priority", "in": "query", "required": false, "schema": { "type": "string", "title": "Priority" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "default": 100, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiPerformanceActionsResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-stainless-method": "api_performance.actions.list" } }, "/v1/api-performance/actions/refresh": { "post": { "tags": [ "API Performance" ], "summary": "Refresh Actions", "operationId": "api_performance_actions_refresh", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicRefreshActionsRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicRefreshActionsResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "LightsageApiKeyAuth": [] } ], "x-stainless-method": "api_performance.actions.refresh" } }, "/v1/api-performance/actions/{action_id}": { "get": { "tags": [ "API Performance" ], "summary": "Retrieve Action", "operationId": "api_performance_actions_retrieve", "security": [ { "LightsageApiKeyAuth": [] } ], "parameters": [ { "name": "action_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Action Id" } }, { "name": "include_prompt", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Include Prompt" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicActionDetailResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-stainless-method": "api_performance.actions.retrieve" }, "patch": { "tags": [ "API Performance" ], "summary": "Update Action", "operationId": "api_performance_actions_update", "security": [ { "LightsageApiKeyAuth": [] } ], "parameters": [ { "name": "action_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Action Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicUpdateActionRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicActionDetailResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-stainless-method": "api_performance.actions.update" } }, "/v1/api-performance/actions/{action_id}/verify": { "post": { "tags": [ "API Performance" ], "summary": "Verify Action", "operationId": "api_performance_actions_verify", "security": [ { "LightsageApiKeyAuth": [] } ], "parameters": [ { "name": "action_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Action Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicVerifyActionResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-stainless-method": "api_performance.actions.verify" } } }, "components": { "schemas": { "CreatePromptTopicRequest": { "properties": { "name": { "type": "string", "maxLength": 120, "minLength": 1, "title": "Name" } }, "type": "object", "required": [ "name" ], "title": "CreatePromptTopicRequest" }, "CreatePublicPromptRequest": { "properties": { "topic_id": { "type": "string", "title": "Topic Id" }, "text": { "type": "string", "minLength": 1, "title": "Text" }, "platform_ids": { "items": { "type": "string" }, "type": "array", "title": "Platform Ids" } }, "additionalProperties": false, "type": "object", "required": [ "topic_id", "text" ], "title": "CreatePublicPromptRequest" }, "CreatePublicPromptsBatchRequest": { "properties": { "prompts": { "items": { "$ref": "#/components/schemas/CreatePublicPromptRequest" }, "type": "array", "maxItems": 100, "minItems": 1, "title": "Prompts" } }, "type": "object", "required": [ "prompts" ], "title": "CreatePublicPromptsBatchRequest" }, "DiagnoseEvalRunsRequest": { "properties": { "since": { "type": "string", "title": "Since", "description": "Lookback window, such as 20d, 72h, or an ISO timestamp.", "default": "20d" }, "format": { "type": "string", "enum": [ "json", "markdown", "md" ], "title": "Format", "description": "Report format to include in the response.", "default": "json" }, "include_examples": { "type": "boolean", "title": "Include Examples", "default": true }, "max_examples": { "type": "integer", "maximum": 50.0, "minimum": 1.0, "title": "Max Examples", "default": 10 } }, "type": "object", "title": "DiagnoseEvalRunsRequest" }, "DiagnoseEvalRunsResponse": { "properties": { "company": { "$ref": "#/components/schemas/PublicCompany" }, "since": { "type": "string", "title": "Since" }, "summary": { "$ref": "#/components/schemas/DiagnosisSummary" }, "failure_analysis": { "$ref": "#/components/schemas/FailureAnalysisSnapshot" }, "examples": { "items": { "$ref": "#/components/schemas/EvalRunDetail" }, "type": "array", "title": "Examples" }, "markdown": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Markdown" } }, "type": "object", "required": [ "company", "since", "summary", "failure_analysis" ], "title": "DiagnoseEvalRunsResponse" }, "DiagnosisSummary": { "properties": { "total_runs": { "type": "integer", "title": "Total Runs", "default": 0 }, "failed_runs": { "type": "integer", "title": "Failed Runs", "default": 0 }, "passed_runs": { "type": "integer", "title": "Passed Runs", "default": 0 }, "failure_rate": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Failure Rate" }, "top_failed_endpoints": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Top Failed Endpoints" }, "top_failed_models": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Top Failed Models" }, "top_failure_reasons": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Top Failure Reasons" } }, "type": "object", "title": "DiagnosisSummary" }, "EvalRunDetail": { "properties": { "id": { "type": "string", "title": "Id" }, "endpoint": { "anyOf": [ { "$ref": "#/components/schemas/PublicEndpoint" }, { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Endpoint" }, "source": { "anyOf": [ { "$ref": "#/components/schemas/EvalRunSource" }, { "type": "null" } ] }, "eval_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Eval Type" }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model" }, "model_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model Type" }, "platform": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Platform" }, "passed": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Passed" }, "score": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Score" }, "failure_reasons": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Failure Reasons" }, "latency_ms": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Latency Ms" }, "run_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Run At" }, "prompt_sent": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Prompt Sent" }, "response_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Response Text" }, "execution_stdout": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Execution Stdout" }, "execution_stderr": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Execution Stderr" }, "exit_code": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Exit Code" }, "tool_calls": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Tool Calls" }, "raw": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Raw" } }, "type": "object", "required": [ "id" ], "title": "EvalRunDetail" }, "EvalRunResponse": { "properties": { "data": { "$ref": "#/components/schemas/EvalRunDetail" } }, "type": "object", "required": [ "data" ], "title": "EvalRunResponse" }, "EvalRunSource": { "properties": { "id": { "type": "string", "title": "Id" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Type" }, "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Label" }, "metadata": { "additionalProperties": true, "type": "object", "title": "Metadata" } }, "type": "object", "required": [ "id" ], "title": "EvalRunSource" }, "EvalRunSummary": { "properties": { "id": { "type": "string", "title": "Id" }, "endpoint": { "anyOf": [ { "$ref": "#/components/schemas/PublicEndpoint" }, { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Endpoint" }, "source": { "anyOf": [ { "$ref": "#/components/schemas/EvalRunSource" }, { "type": "null" } ] }, "eval_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Eval Type" }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model" }, "model_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model Type" }, "platform": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Platform" }, "passed": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Passed" }, "score": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Score" }, "failure_reasons": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Failure Reasons" }, "latency_ms": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Latency Ms" }, "run_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Run At" } }, "type": "object", "required": [ "id" ], "title": "EvalRunSummary" }, "EvalRunsListResponse": { "properties": { "company": { "$ref": "#/components/schemas/PublicCompany" }, "data": { "items": { "$ref": "#/components/schemas/EvalRunSummary" }, "type": "array", "title": "Data" }, "meta": { "$ref": "#/components/schemas/PublicListMeta" } }, "type": "object", "required": [ "company", "data", "meta" ], "title": "EvalRunsListResponse" }, "FailureAnalysisSnapshot": { "properties": { "total_runs": { "type": "integer", "title": "Total Runs", "default": 0 }, "failed_runs": { "type": "integer", "title": "Failed Runs", "default": 0 }, "failure_rate": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Failure Rate" }, "patterns": { "items": { "$ref": "#/components/schemas/FailurePatternSnapshot" }, "type": "array", "title": "Patterns" }, "top_failure_reasons": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Top Failure Reasons" }, "endpoints_by_failure_count": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Endpoints By Failure Count" } }, "type": "object", "title": "FailureAnalysisSnapshot" }, "FailurePatternSnapshot": { "properties": { "pattern": { "type": "string", "title": "Pattern" }, "label": { "type": "string", "title": "Label" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "count": { "type": "integer", "title": "Count" }, "percentage": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Percentage" }, "severity": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Severity" }, "example_reasons": { "items": { "type": "string" }, "type": "array", "title": "Example Reasons" }, "affected_endpoints": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Affected Endpoints" }, "affected_models": { "items": { "type": "string" }, "type": "array", "title": "Affected Models" }, "run_ids": { "items": { "type": "string" }, "type": "array", "title": "Run Ids" } }, "type": "object", "required": [ "pattern", "label", "count" ], "title": "FailurePatternSnapshot" }, "GenerateContentDraftRequest": { "properties": { "title": { "type": "string", "title": "Title", "description": "Article title/headline." }, "topic_name": { "type": "string", "title": "Topic Name", "description": "Topic or theme; defaults to the title when omitted." }, "description": { "type": "string", "title": "Description", "description": "Optional brief describing angle, audience, or goals." }, "prompt_texts": { "items": { "type": "string" }, "type": "array", "title": "Prompt Texts", "description": "Optional related prompts/questions to ground the article." } }, "type": "object", "required": [ "title" ], "title": "GenerateContentDraftRequest", "description": "Generate a draft marketing/blog article and save it." }, "GenerateContentFinalRequest": { "properties": { "content_id": { "type": "string", "title": "Content Id", "description": "Id of the draft content to finalize." } }, "type": "object", "required": [ "content_id" ], "title": "GenerateContentFinalRequest", "description": "Polish an existing draft into final, publish-ready content." }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "ListOpportunitiesResponse": { "properties": { "start_date": { "type": "string", "title": "Start Date" }, "end_date": { "type": "string", "title": "End Date" }, "data": { "items": { "$ref": "#/components/schemas/PublicPromptOpportunity" }, "type": "array", "title": "Data" }, "count": { "type": "integer", "title": "Count" }, "summary": { "additionalProperties": true, "type": "object", "title": "Summary" } }, "type": "object", "required": [ "start_date", "end_date", "count" ], "title": "ListOpportunitiesResponse" }, "ListPromptsResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/PublicPrompt" }, "type": "array", "title": "Data" }, "count": { "type": "integer", "title": "Count" } }, "type": "object", "required": [ "data", "count" ], "title": "ListPromptsResponse" }, "ListTasksResponse": { "properties": { "action_date": { "type": "string", "title": "Action Date" }, "status": { "type": "string", "enum": [ "active", "todo", "new", "in_progress", "completed", "done", "dismissed", "all" ], "title": "Status" }, "batch_number": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Batch Number" }, "latest_batch_number": { "type": "integer", "title": "Latest Batch Number", "default": 0 }, "data": { "items": { "$ref": "#/components/schemas/PublicTask" }, "type": "array", "title": "Data" }, "count": { "type": "integer", "title": "Count" }, "active_count": { "type": "integer", "title": "Active Count", "default": 0 }, "in_progress_count": { "type": "integer", "title": "In Progress Count", "default": 0 }, "completed_count": { "type": "integer", "title": "Completed Count", "default": 0 }, "done_count": { "type": "integer", "title": "Done Count", "default": 0 }, "dismissed_count": { "type": "integer", "title": "Dismissed Count", "default": 0 }, "history_count": { "type": "integer", "title": "History Count", "default": 0 }, "has_history": { "type": "boolean", "title": "Has History", "default": false }, "can_fetch_next_batch": { "type": "boolean", "title": "Can Fetch Next Batch", "default": false }, "generated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Generated At" } }, "type": "object", "required": [ "action_date", "status", "count" ], "title": "ListTasksResponse", "description": "A batch of daily tasks plus the queue's status counts." }, "PromptBatchError": { "properties": { "index": { "type": "integer", "title": "Index" }, "text": { "type": "string", "title": "Text" }, "error": { "type": "string", "title": "Error" } }, "type": "object", "required": [ "index", "text", "error" ], "title": "PromptBatchError" }, "PublicActionDetailResponse": { "properties": { "data": { "$ref": "#/components/schemas/PublicApiPerformanceAction" }, "prompt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Prompt" } }, "type": "object", "required": [ "data" ], "title": "PublicActionDetailResponse" }, "PublicApiEvalTarget": { "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" }, "source_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Id" }, "target_type": { "type": "string", "enum": [ "text", "agent" ], "title": "Target Type" }, "execution_platform": { "type": "string", "title": "Execution Platform" }, "model_id": { "type": "string", "title": "Model Id" }, "frequency": { "type": "string", "enum": [ "daily", "every_other_day", "weekly", "manual" ], "title": "Frequency", "default": "daily" }, "enabled": { "type": "boolean", "title": "Enabled", "default": true }, "next_run_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Run At" }, "last_run_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Run At" }, "last_skipped_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Skipped At" }, "skip_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Skip Reason" }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" } }, "type": "object", "required": [ "target_type", "execution_platform", "model_id" ], "title": "PublicApiEvalTarget" }, "PublicApiPerformanceAction": { "properties": { "id": { "type": "string", "title": "Id" }, "source_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Id" }, "action_type": { "type": "string", "title": "Action Type" }, "status": { "type": "string", "title": "Status" }, "priority": { "type": "string", "title": "Priority" }, "confidence": { "type": "number", "title": "Confidence" }, "effort": { "type": "string", "title": "Effort" }, "title": { "type": "string", "title": "Title" }, "description": { "type": "string", "title": "Description" }, "primary_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Primary Url" }, "affected_urls": { "items": { "type": "string" }, "type": "array", "title": "Affected Urls" }, "evidence": { "additionalProperties": true, "type": "object", "title": "Evidence" }, "recommendation": { "additionalProperties": true, "type": "object", "title": "Recommendation" }, "impact": { "additionalProperties": true, "type": "object", "title": "Impact" }, "source": { "type": "string", "title": "Source" }, "fingerprint": { "type": "string", "title": "Fingerprint" }, "owner_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Owner User Id" }, "ignored_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ignored Reason" }, "first_seen_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "First Seen At" }, "last_seen_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Seen At" }, "resolved_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Resolved At" }, "verified_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Verified At" }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" } }, "type": "object", "required": [ "id", "action_type", "status", "priority", "confidence", "effort", "title", "description", "source", "fingerprint" ], "title": "PublicApiPerformanceAction" }, "PublicApiPerformanceActionsResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/PublicApiPerformanceAction" }, "type": "array", "title": "Data" }, "counts": { "additionalProperties": true, "type": "object", "title": "Counts" }, "summary": { "additionalProperties": true, "type": "object", "title": "Summary" } }, "type": "object", "required": [ "data" ], "title": "PublicApiPerformanceActionsResponse" }, "PublicApiPerformanceCodingAgent": { "properties": { "id": { "type": "string", "title": "Id" }, "label": { "type": "string", "title": "Label" }, "platform": { "type": "string", "title": "Platform" }, "cost_estimate_per_eval": { "type": "number", "title": "Cost Estimate Per Eval" }, "default_model_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Default Model Id" }, "target": { "anyOf": [ { "$ref": "#/components/schemas/PublicApiPerformanceTargetSpec" }, { "type": "null" } ] }, "models": { "items": { "$ref": "#/components/schemas/PublicApiPerformanceCodingAgentModel" }, "type": "array", "title": "Models" } }, "type": "object", "required": [ "id", "label", "platform", "cost_estimate_per_eval" ], "title": "PublicApiPerformanceCodingAgent" }, "PublicApiPerformanceCodingAgentModel": { "properties": { "id": { "type": "string", "title": "Id" }, "label": { "type": "string", "title": "Label" }, "target": { "$ref": "#/components/schemas/PublicApiPerformanceTargetSpec" } }, "type": "object", "required": [ "id", "label", "target" ], "title": "PublicApiPerformanceCodingAgentModel" }, "PublicApiPerformanceEvalRunRequest": { "properties": { "type": { "type": "string", "const": "api_performance", "title": "Type" }, "source_type": { "type": "string", "enum": [ "rest_api", "sdk", "cli", "custom_evals" ], "title": "Source Type" }, "source_id": { "type": "string", "title": "Source Id", "description": "API Performance source ID from api-performance sources list. Required unless operation_ids, eval_ids, or source_type identify one source." }, "models": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Models", "description": "Legacy flat model selection. Prefer targets." }, "targets": { "anyOf": [ { "items": { "$ref": "#/components/schemas/PublicApiPerformanceEvalRunTarget" }, "type": "array" }, { "type": "null" } ], "title": "Targets", "description": "Explicit text/agent targets to run." }, "categories": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Categories" }, "operation_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Operation Ids", "description": "API Performance operation IDs from api-performance evals list." }, "operation_paths": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Operation Paths", "description": "Optional METHOD:path filters, such as GET:/v1/items." }, "eval_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Eval Ids", "description": "API Performance eval definition IDs from api-performance evals list." }, "custom_eval_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Custom Eval Ids", "description": "Custom eval IDs. Used only when source_type is custom_evals." }, "eval_types": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Eval Types" }, "env_profile_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Env Profile Ids" }, "eval_overrides": { "anyOf": [ { "additionalProperties": { "additionalProperties": true, "type": "object" }, "type": "object" }, { "type": "null" } ], "title": "Eval Overrides" } }, "type": "object", "required": [ "type", "source_type" ], "title": "PublicApiPerformanceEvalRunRequest" }, "PublicApiPerformanceEvalRunTarget": { "properties": { "target_type": { "type": "string", "enum": [ "text", "agent" ], "title": "Target Type" }, "execution_platform": { "type": "string", "title": "Execution Platform" }, "model_id": { "type": "string", "title": "Model Id" }, "enabled": { "type": "boolean", "title": "Enabled", "default": true } }, "type": "object", "required": [ "target_type", "execution_platform", "model_id" ], "title": "PublicApiPerformanceEvalRunTarget" }, "PublicApiPerformanceSkill": { "properties": { "id": { "type": "string", "title": "Id" }, "skill_source_id": { "type": "string", "title": "Skill Source Id" }, "source_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Id" }, "slug": { "type": "string", "title": "Slug" }, "name": { "type": "string", "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "path": { "type": "string", "title": "Path" }, "entrypoint_path": { "type": "string", "title": "Entrypoint Path" }, "content_hash": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Content Hash" }, "enabled": { "type": "boolean", "title": "Enabled" }, "stale": { "type": "boolean", "title": "Stale" }, "metadata": { "additionalProperties": true, "type": "object", "title": "Metadata" }, "skill_source": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Skill Source" }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" } }, "type": "object", "required": [ "id", "skill_source_id", "slug", "name", "path", "entrypoint_path", "enabled", "stale" ], "title": "PublicApiPerformanceSkill" }, "PublicApiPerformanceSkillsResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/PublicApiPerformanceSkill" }, "type": "array", "title": "Data" }, "meta": { "additionalProperties": true, "type": "object", "title": "Meta" } }, "type": "object", "required": [ "data" ], "title": "PublicApiPerformanceSkillsResponse" }, "PublicApiPerformanceSource": { "properties": { "id": { "type": "string", "title": "Id" }, "type": { "type": "string", "title": "Type" }, "label": { "type": "string", "title": "Label" }, "metadata": { "$ref": "#/components/schemas/PublicApiPerformanceSourceMetadata" }, "targets": { "items": { "$ref": "#/components/schemas/PublicApiEvalTarget" }, "type": "array", "title": "Targets" }, "operation_count": { "type": "integer", "title": "Operation Count", "default": 0 }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At" } }, "type": "object", "required": [ "id", "type", "label" ], "title": "PublicApiPerformanceSource" }, "PublicApiPerformanceSourceMetadata": { "properties": { "api_base_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Base Url" }, "docs_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Docs Url" }, "default_env_profile_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Default Env Profile Id" }, "env_var_keys": { "items": { "type": "string" }, "type": "array", "title": "Env Var Keys" }, "env_profiles": { "items": { "$ref": "#/components/schemas/PublicEvalEnvProfileSummary" }, "type": "array", "title": "Env Profiles" }, "models": { "items": { "type": "string" }, "type": "array", "title": "Models" }, "eval_types": { "items": { "type": "string" }, "type": "array", "title": "Eval Types" } }, "type": "object", "title": "PublicApiPerformanceSourceMetadata" }, "PublicApiPerformanceSourceRef": { "properties": { "id": { "type": "string", "title": "Id" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Type" }, "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Label" } }, "type": "object", "required": [ "id" ], "title": "PublicApiPerformanceSourceRef" }, "PublicApiPerformanceSourcesResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/PublicApiPerformanceSource" }, "type": "array", "title": "Data" }, "meta": { "additionalProperties": true, "type": "object", "title": "Meta" } }, "type": "object", "required": [ "data" ], "title": "PublicApiPerformanceSourcesResponse" }, "PublicApiPerformanceTargetSpec": { "properties": { "target_type": { "type": "string", "enum": [ "text", "agent" ], "title": "Target Type" }, "execution_platform": { "type": "string", "title": "Execution Platform" }, "model_id": { "type": "string", "title": "Model Id" } }, "type": "object", "required": [ "target_type", "execution_platform", "model_id" ], "title": "PublicApiPerformanceTargetSpec" }, "PublicApiPerformanceTargetsResponse": { "properties": { "text_models": { "items": { "$ref": "#/components/schemas/PublicApiPerformanceTextModel" }, "type": "array", "title": "Text Models" }, "coding_agents": { "items": { "$ref": "#/components/schemas/PublicApiPerformanceCodingAgent" }, "type": "array", "title": "Coding Agents" }, "frequencies": { "items": { "type": "string", "enum": [ "daily", "every_other_day", "weekly", "manual" ] }, "type": "array", "title": "Frequencies" }, "meta": { "additionalProperties": true, "type": "object", "title": "Meta" } }, "type": "object", "required": [ "text_models", "coding_agents", "frequencies" ], "title": "PublicApiPerformanceTargetsResponse" }, "PublicApiPerformanceTextModel": { "properties": { "id": { "type": "string", "title": "Id" }, "label": { "type": "string", "title": "Label" }, "platform": { "type": "string", "title": "Platform" }, "cost_per_1m_input": { "type": "number", "title": "Cost Per 1M Input" }, "cost_per_1m_output": { "type": "number", "title": "Cost Per 1M Output" }, "target": { "$ref": "#/components/schemas/PublicApiPerformanceTargetSpec" } }, "type": "object", "required": [ "id", "label", "platform", "cost_per_1m_input", "cost_per_1m_output", "target" ], "title": "PublicApiPerformanceTextModel" }, "PublicCompany": { "properties": { "name": { "type": "string", "title": "Name" }, "domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Domain" }, "logo_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Logo Url" }, "relationship": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Relationship" } }, "type": "object", "required": [ "name" ], "title": "PublicCompany" }, "PublicCompetitorRow": { "properties": { "company": { "$ref": "#/components/schemas/PublicCompany" }, "visibility_score": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Visibility Score", "description": "Visibility score aggregated over the date range, from 0 to 1." }, "visibility_score_rank": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Visibility Score Rank", "description": "Rank by visibility score among tracked companies." }, "share_of_voice": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Share Of Voice", "description": "Share of voice aggregated over the date range, from 0 to 1." }, "share_of_voice_rank": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Share Of Voice Rank", "description": "Rank by share of voice among tracked companies." }, "average_position": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Average Position", "description": "Average mention position aggregated over the date range." }, "average_position_rank": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Average Position Rank", "description": "Rank by average mention position among tracked companies." } }, "type": "object", "required": [ "company" ], "title": "PublicCompetitorRow" }, "PublicContent": { "properties": { "id": { "type": "string", "title": "Id" }, "title": { "type": "string", "title": "Title" }, "text": { "type": "string", "title": "Text" }, "slug": { "type": "string", "title": "Slug" }, "status": { "type": "string", "title": "Status" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" } }, "type": "object", "required": [ "id", "title", "text", "slug", "status" ], "title": "PublicContent" }, "PublicCurrentVisibilityResponse": { "properties": { "company": { "$ref": "#/components/schemas/PublicCompany" }, "visibility_score": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Visibility Score", "description": "Current visibility score for the selected date range, from 0 to 1." }, "visibility_score_rank": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Visibility Score Rank", "description": "Rank by visibility score among tracked companies." }, "share_of_voice": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Share Of Voice", "description": "Current share of voice for the selected date range, from 0 to 1." }, "share_of_voice_rank": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Share Of Voice Rank", "description": "Rank by share of voice among tracked companies." }, "average_position": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Average Position", "description": "Average mention position for the selected date range." }, "average_position_rank": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Average Position Rank", "description": "Rank by average mention position among tracked companies." }, "date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Date", "description": "Latest prompt-run date included in the calculation." }, "start_date": { "type": "string", "title": "Start Date", "description": "Start date used for the calculation." }, "end_date": { "type": "string", "title": "End Date", "description": "End date used for the calculation." }, "active_prompts_only": { "type": "boolean", "title": "Active Prompts Only", "description": "Whether only currently active prompts were included.", "default": true }, "has_data": { "type": "boolean", "title": "Has Data", "description": "Whether the selected date range contains visibility data." } }, "type": "object", "required": [ "company", "start_date", "end_date", "has_data" ], "title": "PublicCurrentVisibilityResponse" }, "PublicCustomEval": { "properties": { "id": { "type": "string", "title": "Id" }, "prompt": { "type": "string", "title": "Prompt" }, "prompt_template": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Prompt Template", "description": "Template used to render prompt before storing. Available variables: Company name {{company_name}}; Company domain {{company_domain}}." }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "tag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tag" }, "competitor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Competitor" }, "prompt_competitor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Prompt Competitor" }, "prompt_competitor_group": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Prompt Competitor Group" }, "category": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Category" }, "eval": { "anyOf": [ { "$ref": "#/components/schemas/PublicEvalDefinition" }, { "type": "null" } ] }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" } }, "type": "object", "required": [ "id", "prompt" ], "title": "PublicCustomEval" }, "PublicCustomEvalHistoryCategory": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "slug": { "type": "string", "title": "Slug" }, "sort_order": { "type": "integer", "title": "Sort Order", "default": 0 } }, "type": "object", "required": [ "id", "name", "slug" ], "title": "PublicCustomEvalHistoryCategory" }, "PublicCustomEvalHistoryEndpoint": { "properties": { "id": { "type": "string", "title": "Id" }, "prompt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Prompt" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "category": { "anyOf": [ { "$ref": "#/components/schemas/PublicCustomEvalHistoryCategory" }, { "type": "null" } ] } }, "type": "object", "required": [ "id" ], "title": "PublicCustomEvalHistoryEndpoint" }, "PublicCustomEvalHistoryFacets": { "properties": { "targets": { "items": { "$ref": "#/components/schemas/PublicCustomEvalHistoryFilterOption" }, "type": "array", "title": "Targets" }, "categories": { "items": { "$ref": "#/components/schemas/PublicCustomEvalHistoryFilterOption" }, "type": "array", "title": "Categories" } }, "type": "object", "title": "PublicCustomEvalHistoryFacets" }, "PublicCustomEvalHistoryFilterOption": { "properties": { "value": { "type": "string", "title": "Value" }, "label": { "type": "string", "title": "Label" }, "count": { "type": "integer", "title": "Count" } }, "type": "object", "required": [ "value", "label", "count" ], "title": "PublicCustomEvalHistoryFilterOption" }, "PublicCustomEvalHistoryResponse": { "properties": { "runs": { "items": { "$ref": "#/components/schemas/PublicCustomEvalHistoryRun" }, "type": "array", "title": "Runs" }, "total": { "type": "integer", "title": "Total" }, "limit": { "type": "integer", "title": "Limit" }, "offset": { "type": "integer", "title": "Offset" }, "hide_infra_errors": { "type": "boolean", "title": "Hide Infra Errors", "default": true }, "facets": { "$ref": "#/components/schemas/PublicCustomEvalHistoryFacets" } }, "type": "object", "required": [ "runs", "total", "limit", "offset" ], "title": "PublicCustomEvalHistoryResponse" }, "PublicCustomEvalHistoryRun": { "properties": { "id": { "type": "string", "title": "Id" }, "endpoint": { "$ref": "#/components/schemas/PublicCustomEvalHistoryEndpoint" }, "target_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Key" }, "eval_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Eval Type" }, "prompt_sent": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Prompt Sent" }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model" }, "model_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model Type" }, "platform": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Platform" }, "passed": { "type": "boolean", "title": "Passed" }, "score": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Score" }, "latency_ms": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Latency Ms" }, "tool_call_count": { "type": "integer", "title": "Tool Call Count" }, "error_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error Message" }, "is_infra_error": { "type": "boolean", "title": "Is Infra Error", "default": false }, "run_at": { "type": "string", "title": "Run At" }, "harness_label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Harness Label" }, "model_label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model Label" }, "run_context_sent": { "additionalProperties": true, "type": "object", "title": "Run Context Sent" } }, "type": "object", "required": [ "id", "endpoint", "passed", "tool_call_count", "run_at" ], "title": "PublicCustomEvalHistoryRun" }, "PublicCustomEvalRequest": { "properties": { "prompt": { "type": "string", "title": "Prompt" }, "prompt_template": { "type": "string", "title": "Prompt Template", "description": "Optional template used to render prompt before storing. Available variables: Company name {{company_name}}; Company domain {{company_domain}}." }, "category_name": { "type": "string", "title": "Category Name" }, "description": { "type": "string", "title": "Description" }, "tag": { "type": "string", "title": "Tag", "description": "Optional display tag for this custom eval." }, "competitor": { "type": "string", "title": "Competitor", "description": "Competitor ID to render this custom eval against." }, "prompt_competitor_group": { "type": "string", "title": "Prompt Competitor Group", "description": "Base custom eval ID that this competitor variant belongs to." }, "eval": { "anyOf": [ { "$ref": "#/components/schemas/PublicEvalDefinitionUpdate" }, { "type": "null" } ] } }, "type": "object", "required": [ "prompt" ], "title": "PublicCustomEvalRequest" }, "PublicCustomEvalUpdateRequest": { "properties": { "prompt": { "type": "string", "title": "Prompt" }, "prompt_template": { "type": "string", "title": "Prompt Template", "description": "Optional template used to render prompt before storing. Available variables: Company name {{company_name}}; Company domain {{company_domain}}." }, "category_name": { "type": "string", "title": "Category Name" }, "description": { "type": "string", "title": "Description" }, "tag": { "type": "string", "title": "Tag", "description": "Optional display tag for this custom eval." }, "competitor": { "type": "string", "title": "Competitor" }, "prompt_competitor_group": { "type": "string", "title": "Prompt Competitor Group" }, "eval": { "anyOf": [ { "$ref": "#/components/schemas/PublicEvalDefinitionUpdate" }, { "type": "null" } ] } }, "type": "object", "title": "PublicCustomEvalUpdateRequest" }, "PublicCustomEvalsResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/PublicCustomEval" }, "type": "array", "title": "Data" }, "meta": { "additionalProperties": true, "type": "object", "title": "Meta" } }, "type": "object", "required": [ "data" ], "title": "PublicCustomEvalsResponse" }, "PublicEndpoint": { "properties": { "id": { "type": "string", "title": "Id" }, "method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Method" }, "path": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Path" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "category": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Category" } }, "type": "object", "required": [ "id" ], "title": "PublicEndpoint" }, "PublicEvalConfigResponse": { "properties": { "models": { "items": { "type": "string" }, "type": "array", "title": "Models" }, "targets": { "items": { "$ref": "#/components/schemas/PublicApiEvalTarget" }, "type": "array", "title": "Targets" }, "operation_ids": { "items": { "type": "string" }, "type": "array", "title": "Operation Ids" }, "custom_eval_ids": { "items": { "type": "string" }, "type": "array", "title": "Custom Eval Ids" }, "env_var_keys": { "items": { "type": "string" }, "type": "array", "title": "Env Var Keys" }, "env_profiles": { "items": { "$ref": "#/components/schemas/PublicEvalEnvProfileSummary" }, "type": "array", "title": "Env Profiles" }, "default_env_profile_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Default Env Profile Id" }, "source_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Id" }, "api_base_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Base Url" }, "can_configure_per_model_schedules": { "type": "boolean", "title": "Can Configure Per Model Schedules", "default": false } }, "type": "object", "required": [ "models", "operation_ids" ], "title": "PublicEvalConfigResponse" }, "PublicEvalConfigUpdateRequest": { "properties": { "models": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Models", "description": "Legacy flat model selection. Prefer targets for v0.3.0." }, "targets": { "anyOf": [ { "items": { "$ref": "#/components/schemas/PublicApiEvalTarget" }, "type": "array" }, { "type": "null" } ], "title": "Targets", "description": "Scheduled text/agent targets. Use frequency='manual' to keep a target available but unscheduled." }, "operation_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Operation Ids" }, "custom_eval_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Custom Eval Ids" }, "env_vars": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "title": "Env Vars" }, "env_profiles": { "anyOf": [ { "items": { "$ref": "#/components/schemas/PublicEvalEnvProfileRequest" }, "type": "array" }, { "type": "null" } ], "title": "Env Profiles" }, "default_env_profile_id": { "type": "string", "title": "Default Env Profile Id" }, "source_id": { "type": "string", "title": "Source Id" }, "api_base_url": { "type": "string", "title": "Api Base Url" } }, "type": "object", "title": "PublicEvalConfigUpdateRequest" }, "PublicEvalDefinition": { "properties": { "id": { "type": "string", "title": "Id" }, "operation_id": { "type": "string", "title": "Operation Id" }, "source_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Id" }, "source": { "anyOf": [ { "$ref": "#/components/schemas/PublicApiPerformanceSourceRef" }, { "type": "null" } ] }, "eval_type": { "type": "string", "title": "Eval Type" }, "prompt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Prompt" }, "custom_prompt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Custom Prompt" }, "expected_behavior": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Expected Behavior" }, "starting_project_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Starting Project Id" }, "docs_mode": { "type": "string", "enum": [ "default", "include", "exclude" ], "title": "Docs Mode", "default": "default" }, "include_env_vars": { "type": "boolean", "title": "Include Env Vars", "default": true }, "env_profile_ids": { "items": { "type": "string" }, "type": "array", "title": "Env Profile Ids" }, "model_ids": { "items": { "type": "string" }, "type": "array", "title": "Model Ids" }, "compare_skills": { "type": "boolean", "title": "Compare Skills", "default": false }, "skills_mode": { "type": "string", "enum": [ "none", "all", "selected" ], "title": "Skills Mode", "default": "none" }, "skills_enabled": { "type": "boolean", "title": "Skills Enabled", "default": false }, "skill_ids": { "items": { "type": "string" }, "type": "array", "title": "Skill Ids" }, "mcp_enabled": { "type": "boolean", "title": "Mcp Enabled", "default": false }, "run_context": { "additionalProperties": true, "type": "object", "title": "Run Context" }, "enabled": { "type": "boolean", "title": "Enabled", "default": true } }, "type": "object", "required": [ "id", "operation_id", "eval_type" ], "title": "PublicEvalDefinition" }, "PublicEvalDefinitionUpdate": { "properties": { "custom_prompt": { "type": "string", "title": "Custom Prompt" }, "expected_behavior": { "type": "string", "title": "Expected Behavior" }, "starting_project_id": { "type": "string", "title": "Starting Project Id", "description": "Starting project to clone before running the eval. Empty string clears it." }, "docs_mode": { "type": "string", "enum": [ "default", "include", "exclude" ], "title": "Docs Mode", "description": "Docs behavior for this eval: default, include, or exclude." }, "include_env_vars": { "type": "boolean", "title": "Include Env Vars", "description": "Include configured environment variable names in the eval prompt." }, "env_profile_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Env Profile Ids", "description": "Environment profile IDs to use for this eval. Empty list clears the selection." }, "model_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Model Ids", "description": "Model IDs to use for this eval. Empty list uses the config-level models." }, "compare_skills": { "type": "boolean", "title": "Compare Skills" }, "skills_mode": { "type": "string", "enum": [ "none", "all", "selected" ], "title": "Skills Mode" }, "skill_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Skill Ids", "description": "Selected skill IDs. Used when skills_mode is selected." }, "mcp_enabled": { "type": "boolean", "title": "Mcp Enabled" }, "run_context": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Run Context" }, "enabled": { "type": "boolean", "title": "Enabled" } }, "type": "object", "title": "PublicEvalDefinitionUpdate" }, "PublicEvalDefinitionsResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/PublicEvalDefinition" }, "type": "array", "title": "Data" }, "meta": { "additionalProperties": true, "type": "object", "title": "Meta" } }, "type": "object", "required": [ "data" ], "title": "PublicEvalDefinitionsResponse" }, "PublicEvalEnvProfileRequest": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "env_vars": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Env Vars" } }, "type": "object", "required": [ "id", "name" ], "title": "PublicEvalEnvProfileRequest" }, "PublicEvalEnvProfileSummary": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "env_var_keys": { "items": { "type": "string" }, "type": "array", "title": "Env Var Keys" } }, "type": "object", "required": [ "id", "name" ], "title": "PublicEvalEnvProfileSummary" }, "PublicEvalRunProgress": { "properties": { "total": { "type": "integer", "title": "Total", "default": 0 }, "queued": { "type": "integer", "title": "Queued", "default": 0 }, "running": { "type": "integer", "title": "Running", "default": 0 }, "completed": { "type": "integer", "title": "Completed", "default": 0 }, "failed": { "type": "integer", "title": "Failed", "default": 0 }, "cancelled": { "type": "integer", "title": "Cancelled", "default": 0 }, "interrupted": { "type": "integer", "title": "Interrupted", "default": 0 }, "percent": { "type": "number", "title": "Percent", "default": 0 } }, "type": "object", "title": "PublicEvalRunProgress" }, "PublicEvalRunResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "job_id": { "type": "string", "title": "Job Id" }, "type": { "type": "string", "enum": [ "prompts", "api_performance" ], "title": "Type" }, "source_type": { "type": "string", "enum": [ "prompts", "rest_api", "sdk", "cli", "custom_evals" ], "title": "Source Type" }, "status": { "anyOf": [ { "type": "string", "enum": [ "pending", "running", "summarizing", "completed", "failed", "cancelled", "interrupted" ] }, { "type": "string" } ], "title": "Status" }, "stage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Stage" }, "dispatch_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Dispatch Id" }, "progress": { "$ref": "#/components/schemas/PublicEvalRunProgress" }, "estimated_cost": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Estimated Cost" }, "eval_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Eval Count" }, "model_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Model Count" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error" }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At" }, "started_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Started At" }, "completed_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Completed At" } }, "type": "object", "required": [ "id", "job_id", "type", "source_type", "status" ], "title": "PublicEvalRunResponse" }, "PublicListMeta": { "properties": { "limit": { "type": "integer", "title": "Limit" }, "count": { "type": "integer", "title": "Count" } }, "type": "object", "required": [ "limit", "count" ], "title": "PublicListMeta" }, "PublicOkResponse": { "properties": { "ok": { "type": "boolean", "title": "Ok" } }, "type": "object", "required": [ "ok" ], "title": "PublicOkResponse" }, "PublicPlatformRef": { "properties": { "platform_id": { "type": "string", "title": "Platform Id", "description": "Stable platform identifier, e.g. chatgpt." }, "name": { "type": "string", "title": "Name", "description": "Human-readable platform name." }, "icon_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Icon Url", "description": "Platform icon URL, if available." } }, "type": "object", "required": [ "platform_id", "name" ], "title": "PublicPlatformRef" }, "PublicPrompt": { "properties": { "id": { "type": "string", "title": "Id" }, "topic_id": { "type": "string", "title": "Topic Id" }, "text": { "type": "string", "title": "Text" }, "language_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language Id" }, "region_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Region Id" }, "status": { "type": "string", "enum": [ "active", "inactive", "archived" ], "title": "Status" }, "topic": { "anyOf": [ { "$ref": "#/components/schemas/PublicPromptTopic" }, { "type": "null" } ] }, "platforms": { "items": { "$ref": "#/components/schemas/PublicPromptPlatform" }, "type": "array", "title": "Platforms" }, "tags": { "items": { "$ref": "#/components/schemas/PublicPromptTag" }, "type": "array", "title": "Tags" }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" } }, "type": "object", "required": [ "id", "topic_id", "text", "status" ], "title": "PublicPrompt" }, "PublicPromptBatchResponse": { "properties": { "created": { "items": { "$ref": "#/components/schemas/PublicPrompt" }, "type": "array", "title": "Created" }, "count": { "type": "integer", "title": "Count" }, "errors": { "items": { "$ref": "#/components/schemas/PromptBatchError" }, "type": "array", "title": "Errors" } }, "type": "object", "required": [ "created", "count" ], "title": "PublicPromptBatchResponse" }, "PublicPromptConfigResponse": { "properties": { "topics": { "items": { "$ref": "#/components/schemas/PublicPromptTopic" }, "type": "array", "title": "Topics" }, "platforms": { "items": { "$ref": "#/components/schemas/PublicPromptPlatformCatalogItem" }, "type": "array", "title": "Platforms" }, "languages": { "items": { "$ref": "#/components/schemas/PublicPromptLanguage" }, "type": "array", "title": "Languages" }, "regions": { "items": { "$ref": "#/components/schemas/PublicPromptRegion" }, "type": "array", "title": "Regions" }, "defaults": { "$ref": "#/components/schemas/PublicPromptDefaults" } }, "type": "object", "required": [ "topics", "platforms", "languages", "regions", "defaults" ], "title": "PublicPromptConfigResponse" }, "PublicPromptDefaults": { "properties": { "language_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language Id" }, "region_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Region Id" } }, "type": "object", "title": "PublicPromptDefaults" }, "PublicPromptEvalRunRequest": { "properties": { "type": { "type": "string", "const": "prompts", "title": "Type" }, "prompt_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Prompt Ids", "description": "Prompt IDs to run. Omit to run all active prompts." }, "targets": { "anyOf": [ { "items": { "$ref": "#/components/schemas/PublicPromptEvalRunTarget" }, "type": "array" }, { "type": "null" } ], "title": "Targets", "description": "Explicit prompt targets. Omit to use configured scheduled prompt targets." }, "force": { "type": "boolean", "title": "Force", "description": "If true, re-run even when the prompt/platform/model has already run today.", "default": false } }, "type": "object", "required": [ "type" ], "title": "PublicPromptEvalRunRequest" }, "PublicPromptEvalRunTarget": { "properties": { "target_kind": { "type": "string", "enum": [ "answer_engine", "coding_agent" ], "title": "Target Kind" }, "execution_platform": { "type": "string", "title": "Execution Platform" }, "prompt_platform_id": { "type": "string", "title": "Prompt Platform Id" }, "model_id": { "type": "string", "title": "Model Id" }, "prompt_topic_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Prompt Topic Id" }, "enabled": { "type": "boolean", "title": "Enabled", "default": true } }, "type": "object", "required": [ "target_kind", "execution_platform", "prompt_platform_id", "model_id" ], "title": "PublicPromptEvalRunTarget" }, "PublicPromptLanguage": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code" } }, "type": "object", "required": [ "id", "name" ], "title": "PublicPromptLanguage" }, "PublicPromptOpportunity": { "properties": { "id": { "type": "string", "title": "Id" }, "type": { "type": "string", "title": "Type" }, "category": { "type": "string", "title": "Category" }, "priority": { "type": "string", "title": "Priority" }, "title": { "type": "string", "title": "Title" }, "description": { "type": "string", "title": "Description" }, "action": { "type": "string", "title": "Action" }, "execution_prompt": { "type": "string", "title": "Execution Prompt", "description": "Paste-ready instructions for an AI agent to address this opportunity." }, "impact_score": { "type": "number", "title": "Impact Score" }, "created_at": { "type": "string", "title": "Created At" } }, "additionalProperties": true, "type": "object", "required": [ "id", "type", "category", "priority", "title", "description", "action", "execution_prompt", "impact_score", "created_at" ], "title": "PublicPromptOpportunity" }, "PublicPromptPlatform": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "type": "string", "title": "Name" } }, "type": "object", "required": [ "id", "name" ], "title": "PublicPromptPlatform" }, "PublicPromptPlatformCatalogItem": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model" }, "credits_per_prompt": { "type": "integer", "title": "Credits Per Prompt" } }, "type": "object", "required": [ "id", "name", "credits_per_prompt" ], "title": "PublicPromptPlatformCatalogItem" }, "PublicPromptRegion": { "properties": { "id": { "type": "string", "title": "Id" }, "country": { "type": "string", "title": "Country" }, "country_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country Code" } }, "type": "object", "required": [ "id", "country" ], "title": "PublicPromptRegion" }, "PublicPromptTag": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" } }, "type": "object", "required": [ "id", "name" ], "title": "PublicPromptTag" }, "PublicPromptTopic": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" } }, "type": "object", "required": [ "id", "name" ], "title": "PublicPromptTopic" }, "PublicPromptVisibilityDateRange": { "properties": { "start_date": { "type": "string", "title": "Start Date", "description": "Start date used for the calculation." }, "end_date": { "type": "string", "title": "End Date", "description": "End date used for the calculation." }, "latest_run_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Latest Run Date", "description": "Latest prompt-run date included in the calculation." }, "active_prompts_only": { "type": "boolean", "title": "Active Prompts Only", "description": "Whether only currently active prompts were included.", "default": true } }, "type": "object", "required": [ "start_date", "end_date" ], "title": "PublicPromptVisibilityDateRange" }, "PublicPromptVisibilityMetrics": { "properties": { "visibility_score": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Visibility Score", "description": "Visibility score aggregated over the date range, from 0 to 1." }, "visibility_score_rank": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Visibility Score Rank", "description": "Rank by visibility score among tracked companies." }, "share_of_voice": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Share Of Voice", "description": "Share of voice aggregated over the date range, from 0 to 1." }, "average_position": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Average Position", "description": "Average mention position aggregated over the date range." }, "citation_count": { "type": "integer", "title": "Citation Count", "description": "Owned-domain citations found in prompt runs for the date range.", "default": 0 }, "run_count": { "type": "integer", "title": "Run Count", "description": "Prompt runs included in the date-range calculation.", "default": 0 } }, "type": "object", "title": "PublicPromptVisibilityMetrics" }, "PublicPromptVisibilityReportResponse": { "properties": { "company": { "$ref": "#/components/schemas/PublicCompany" }, "date_range": { "$ref": "#/components/schemas/PublicPromptVisibilityDateRange" }, "has_data": { "type": "boolean", "title": "Has Data", "description": "Whether the selected date range contains prompt-run data." }, "summary": { "$ref": "#/components/schemas/PublicPromptVisibilitySummary" }, "topics": { "items": { "$ref": "#/components/schemas/PublicTopicVisibilityRow" }, "type": "array", "title": "Topics", "description": "Topic and prompt rows shown in the prompt visibility report." } }, "type": "object", "required": [ "company", "date_range", "has_data", "summary" ], "title": "PublicPromptVisibilityReportResponse" }, "PublicPromptVisibilityRow": { "properties": { "id": { "type": "string", "title": "Id", "description": "Stable prompt identifier." }, "text": { "type": "string", "title": "Text", "description": "Prompt text." }, "metrics": { "$ref": "#/components/schemas/PublicPromptVisibilityMetrics" } }, "type": "object", "required": [ "id", "text", "metrics" ], "title": "PublicPromptVisibilityRow" }, "PublicPromptVisibilitySummary": { "properties": { "prompt_count": { "type": "integer", "title": "Prompt Count", "description": "Active prompts included in the report." }, "topic_count": { "type": "integer", "title": "Topic Count", "description": "Topics containing active prompts." }, "metrics": { "$ref": "#/components/schemas/PublicPromptVisibilityMetrics" } }, "type": "object", "required": [ "prompt_count", "topic_count", "metrics" ], "title": "PublicPromptVisibilitySummary" }, "PublicRefreshActionsRequest": { "properties": { "source_id": { "type": "string", "title": "Source Id" }, "force": { "type": "boolean", "title": "Force", "default": false } }, "type": "object", "title": "PublicRefreshActionsRequest" }, "PublicRefreshActionsResponse": { "properties": { "generated": { "type": "integer", "title": "Generated" }, "updated": { "type": "integer", "title": "Updated" }, "unchanged": { "type": "integer", "title": "Unchanged" }, "total_candidates": { "type": "integer", "title": "Total Candidates" } }, "type": "object", "required": [ "generated", "updated", "unchanged", "total_candidates" ], "title": "PublicRefreshActionsResponse" }, "PublicSeriesPoint": { "properties": { "date": { "type": "string", "title": "Date", "description": "Prompt-run date for this data point." }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Value", "description": "Metric value on this date." } }, "type": "object", "required": [ "date" ], "title": "PublicSeriesPoint" }, "PublicStartingProject": { "properties": { "id": { "type": "string", "title": "Id" }, "source_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Id" }, "name": { "type": "string", "title": "Name" }, "repo_url": { "type": "string", "title": "Repo Url" }, "ref": { "type": "string", "title": "Ref" }, "subdir": { "type": "string", "title": "Subdir", "default": "" }, "install_steps": { "items": { "type": "string" }, "type": "array", "title": "Install Steps" }, "framework": { "type": "string", "enum": [ "fastify", "nuxt", "express", "spa-js", "angular", "react", "fastapi", "vite", "nextjs", "custom" ], "title": "Framework", "default": "custom" }, "enabled": { "type": "boolean", "title": "Enabled" }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" } }, "type": "object", "required": [ "id", "name", "repo_url", "ref", "enabled" ], "title": "PublicStartingProject" }, "PublicStartingProjectRequest": { "properties": { "name": { "type": "string", "title": "Name" }, "repo_url": { "type": "string", "title": "Repo Url" }, "ref": { "type": "string", "title": "Ref", "default": "main" }, "subdir": { "type": "string", "title": "Subdir", "default": "" }, "install_steps": { "items": { "type": "string" }, "type": "array", "title": "Install Steps" }, "source_id": { "type": "string", "title": "Source Id" }, "framework": { "type": "string", "enum": [ "fastify", "nuxt", "express", "spa-js", "angular", "react", "fastapi", "vite", "nextjs", "custom" ], "title": "Framework", "default": "custom" }, "enabled": { "type": "boolean", "title": "Enabled", "default": true } }, "type": "object", "required": [ "name", "repo_url" ], "title": "PublicStartingProjectRequest" }, "PublicStartingProjectUpdateRequest": { "properties": { "name": { "type": "string", "title": "Name" }, "repo_url": { "type": "string", "title": "Repo Url" }, "ref": { "type": "string", "title": "Ref" }, "subdir": { "type": "string", "title": "Subdir" }, "install_steps": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Install Steps" }, "source_id": { "type": "string", "title": "Source Id" }, "framework": { "type": "string", "enum": [ "fastify", "nuxt", "express", "spa-js", "angular", "react", "fastapi", "vite", "nextjs", "custom" ], "title": "Framework" }, "enabled": { "type": "boolean", "title": "Enabled" } }, "type": "object", "title": "PublicStartingProjectUpdateRequest" }, "PublicStartingProjectsResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/PublicStartingProject" }, "type": "array", "title": "Data" }, "meta": { "additionalProperties": true, "type": "object", "title": "Meta" } }, "type": "object", "required": [ "data" ], "title": "PublicStartingProjectsResponse" }, "PublicTask": { "properties": { "id": { "type": "string", "title": "Id" }, "action_date": { "type": "string", "title": "Action Date" }, "batch_number": { "type": "integer", "title": "Batch Number" }, "rank": { "type": "integer", "title": "Rank" }, "source_key": { "type": "string", "title": "Source Key" }, "task_type": { "type": "string", "title": "Task Type" }, "title": { "type": "string", "title": "Title" }, "why": { "type": "string", "title": "Why" }, "next_action": { "type": "string", "title": "Next Action" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "execution_prompt": { "type": "string", "title": "Execution Prompt", "description": "Paste-ready instructions for an AI agent to execute this task." }, "reasoning": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reasoning" }, "evidence": { "additionalProperties": true, "type": "object", "title": "Evidence" }, "score": { "type": "number", "title": "Score" }, "effort": { "type": "string", "title": "Effort" }, "priority": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Priority" }, "status": { "type": "string", "title": "Status" }, "assignee_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Assignee User Id" }, "function_area": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Function Area" }, "action_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Action Type" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source" }, "source_type": { "type": "string", "title": "Source Type" }, "source_refs": { "additionalProperties": true, "type": "object", "title": "Source Refs" }, "metadata": { "additionalProperties": true, "type": "object", "title": "Metadata" }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" } }, "additionalProperties": true, "type": "object", "required": [ "id", "action_date", "batch_number", "rank", "source_key", "task_type", "title", "why", "next_action", "execution_prompt", "score", "effort", "status", "source_type" ], "title": "PublicTask", "description": "A single persisted daily task in the public contract shape." }, "PublicTopicVisibilityRow": { "properties": { "id": { "type": "string", "title": "Id", "description": "Stable prompt topic identifier." }, "name": { "type": "string", "title": "Name", "description": "Prompt topic name." }, "prompt_count": { "type": "integer", "title": "Prompt Count", "description": "Active prompts in this topic." }, "metrics": { "$ref": "#/components/schemas/PublicPromptVisibilityMetrics" }, "prompts": { "items": { "$ref": "#/components/schemas/PublicPromptVisibilityRow" }, "type": "array", "title": "Prompts", "description": "Active prompts in the topic with date-range metrics." } }, "type": "object", "required": [ "id", "name", "prompt_count", "metrics" ], "title": "PublicTopicVisibilityRow" }, "PublicUpdateActionRequest": { "properties": { "status": { "type": "string", "title": "Status" }, "owner_user_id": { "type": "string", "title": "Owner User Id" }, "ignored_reason": { "type": "string", "title": "Ignored Reason" }, "note": { "type": "string", "title": "Note" } }, "type": "object", "title": "PublicUpdateActionRequest" }, "PublicVerifyActionResponse": { "properties": { "status": { "type": "string", "title": "Status" }, "action": { "anyOf": [ { "$ref": "#/components/schemas/PublicApiPerformanceAction" }, { "type": "null" } ] }, "url_check": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Url Check" } }, "type": "object", "required": [ "status" ], "title": "PublicVerifyActionResponse" }, "PublicVisibilityByPlatform": { "properties": { "platforms": { "items": { "$ref": "#/components/schemas/PublicPlatformRef" }, "type": "array", "title": "Platforms", "description": "Platforms present in the date range." }, "visibility_score": { "additionalProperties": { "items": { "$ref": "#/components/schemas/PublicSeriesPoint" }, "type": "array" }, "type": "object", "title": "Visibility Score", "description": "Visibility score timeseries keyed by platform_id." }, "citations": { "additionalProperties": { "items": { "$ref": "#/components/schemas/PublicSeriesPoint" }, "type": "array" }, "type": "object", "title": "Citations", "description": "Owned-domain citation-count timeseries keyed by platform_id." } }, "type": "object", "title": "PublicVisibilityByPlatform" }, "PublicVisibilityDateRange": { "properties": { "start_date": { "type": "string", "title": "Start Date", "description": "Start date used for the calculation." }, "end_date": { "type": "string", "title": "End Date", "description": "End date used for the calculation." }, "granularity": { "type": "string", "title": "Granularity", "description": "Spacing between timeseries data points.", "default": "day" }, "latest_run_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Latest Run Date", "description": "Latest prompt-run date included in the calculation." }, "active_prompts_only": { "type": "boolean", "title": "Active Prompts Only", "description": "Whether only currently active prompts were included.", "default": true } }, "type": "object", "required": [ "start_date", "end_date" ], "title": "PublicVisibilityDateRange" }, "PublicVisibilityOverviewResponse": { "properties": { "company": { "$ref": "#/components/schemas/PublicCompany" }, "date_range": { "$ref": "#/components/schemas/PublicVisibilityDateRange" }, "has_data": { "type": "boolean", "title": "Has Data", "description": "Whether the selected date range contains visibility data." }, "snapshot": { "$ref": "#/components/schemas/PublicVisibilitySnapshot" }, "timeseries": { "$ref": "#/components/schemas/PublicVisibilityTimeseries" }, "by_platform": { "$ref": "#/components/schemas/PublicVisibilityByPlatform" }, "competitors": { "items": { "$ref": "#/components/schemas/PublicCompetitorRow" }, "type": "array", "title": "Competitors", "description": "Competitor comparison rankings, including the primary company." } }, "type": "object", "required": [ "company", "date_range", "has_data", "snapshot", "timeseries", "by_platform" ], "title": "PublicVisibilityOverviewResponse" }, "PublicVisibilitySnapshot": { "properties": { "visibility_score": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Visibility Score", "description": "Visibility score aggregated over the date range, from 0 to 1." }, "visibility_score_rank": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Visibility Score Rank", "description": "Rank by visibility score among tracked companies." }, "share_of_voice": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Share Of Voice", "description": "Share of voice aggregated over the date range, from 0 to 1." }, "share_of_voice_rank": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Share Of Voice Rank", "description": "Rank by share of voice among tracked companies." }, "average_position": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Average Position", "description": "Average mention position aggregated over the date range." }, "average_position_rank": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Average Position Rank", "description": "Rank by average mention position among tracked companies." }, "total_citations": { "type": "integer", "title": "Total Citations", "description": "Total owned-domain citations across all platforms in the range.", "default": 0 } }, "type": "object", "title": "PublicVisibilitySnapshot" }, "PublicVisibilityTimeseries": { "properties": { "visibility_score": { "items": { "$ref": "#/components/schemas/PublicSeriesPoint" }, "type": "array", "title": "Visibility Score", "description": "Primary company visibility score over time." } }, "type": "object", "title": "PublicVisibilityTimeseries" }, "UpdatePromptTopicRequest": { "properties": { "name": { "type": "string", "maxLength": 120, "minLength": 1, "title": "Name" } }, "type": "object", "required": [ "name" ], "title": "UpdatePromptTopicRequest" }, "UpdatePublicPromptRequest": { "properties": { "text": { "type": "string", "minLength": 1, "title": "Text" }, "topic_id": { "type": "string", "title": "Topic Id" }, "platform_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Platform Ids" }, "status": { "type": "string", "enum": [ "active", "inactive" ], "title": "Status", "description": "Set whether the prompt participates in scheduled runs." } }, "additionalProperties": false, "type": "object", "title": "UpdatePublicPromptRequest" }, "UpdateTaskRequest": { "properties": { "status": { "type": "string", "enum": [ "new", "in_progress", "added_to_sheet", "done", "dismissed", "snoozed" ], "title": "Status" }, "priority": { "type": "string", "enum": [ "urgent", "high", "medium", "low" ], "title": "Priority" }, "assignee_user_id": { "type": "string", "title": "Assignee User Id" }, "action_type": { "type": "string", "enum": [ "agent_discovery", "agent_usability" ], "title": "Action Type" } }, "additionalProperties": false, "type": "object", "title": "UpdateTaskRequest", "description": "Update the status and delegation of a single task.\n\nAll fields are optional so status transitions and delegation can be changed\nindependently. Only the fields present in the request body are changed;\nomitted fields are left unchanged. Setting `assignee_user_id` or\n`action_type` to `null` clears it. Send at least one field." }, "ValidationError": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "type": "array", "title": "Location" }, "msg": { "type": "string", "title": "Message" }, "type": { "type": "string", "title": "Error Type" } }, "type": "object", "required": [ "loc", "msg", "type" ], "title": "ValidationError" } }, "securitySchemes": { "LightsageApiKeyAuth": { "type": "apiKey", "in": "header", "name": "X-Lightsage-Api-Key" } } } }