# Probe Run

## Retrieve detailed probe run execution data and analysis results

> Returns comprehensive execution details for a specific probe run, including test case results, AI-powered vulnerability analysis, remediation strategies, and execution metrics. This endpoint provides deep insights into security probe performance and discovered vulnerabilities.

```json
{"openapi":"3.0.4","info":{"title":"API","version":"v1.0"},"tags":[],"servers":[{"url":"https://api.probe.splx.ai","description":"EU Server"},{"url":"https://us.api.probe.splx.ai","description":"US Server"}],"security":[{"API Key":[]}],"components":{"securitySchemes":{"API Key":{"type":"apiKey","description":"API Key for authentication","name":"X-Api-Key","in":"header"}},"schemas":{"ProbeRunDetailedExecutionDto":{"required":["probeName","status","testCaseResults"],"type":"object","properties":{"probeRunId":{"type":"integer","description":"Unique identifier for probe run execution.","format":"int32"},"scanRunId":{"type":"integer","description":"Scan run identifier that initiated this probe.","format":"int32","nullable":true},"probeId":{"type":"integer","description":"Identifier of the Probe.","format":"int32","nullable":true},"executionStart":{"type":"string","description":"Timestamp when the probe execution started.","format":"date-time","nullable":true},"executionEnd":{"type":"string","description":"Timestamp when the probe execution completed. Null if still running.","format":"date-time","nullable":true},"probeName":{"type":"string","description":"Name of the executed probe.","nullable":true},"status":{"type":"string","description":"Current execution status of the probe run.","nullable":true},"totalCount":{"type":"integer","description":"Total number of test cases planned for execution.","format":"int32","nullable":true},"processedCount":{"type":"integer","description":"Number of test cases that have been processed.","format":"int32"},"errorCount":{"type":"integer","description":"Number of test cases that encountered execution errors.","format":"int32"},"passedCount":{"type":"integer","description":"Number of test cases that passed (no risk found).","format":"int32"},"failedCount":{"type":"integer","description":"Number of test cases that failed (potential risk detected).","format":"int32"},"acceptedCount":{"type":"integer","description":"Number of failed test cases that have been reviewed and the risk has been accepted.","format":"int32"},"progress":{"type":"number","description":"Execution progress.","format":"float"},"isAiAnalysisFinished":{"type":"boolean","description":"Indicates whether AI analysis of the probe run results has been completed."},"testCaseResults":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/TestCaseResultDto"},{"$ref":"#/components/schemas/TestCaseResultDetailedDto"},{"$ref":"#/components/schemas/TestCaseResultDetailedV2Dto"}],"description":"Individual test case result containing attack details, outcomes, and risk management information."},"description":"Collection of individual test case execution results, providing detailed outcomes for each attack tested during the probe run.","nullable":true},"remediation":{"$ref":"#/components/schemas/ScanProbeRunMitigationStrategy"},"aiAnalysis":{"$ref":"#/components/schemas/ProbeRunAiAnalysisDto"}},"additionalProperties":false,"description":"Detailed execution data and analysis results for a specific probe run."},"TestCaseResultDto":{"required":["attackId","detectionTime","isIncludedInReport","redTeamer","redTeamerLabels","status","strategy","variation"],"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for test case result.","format":"int32"},"attackId":{"type":"string","description":"Identifier of the specific attack variation and strategy used in test case.","nullable":true},"attempt":{"type":"integer","description":"Attempt number for this attack.","format":"int32","nullable":true},"status":{"type":"string","description":"Execution status of the test case (e.g., 'PASSED', 'FAILED', 'ERROR').","nullable":true},"strategy":{"type":"string","description":"Attack strategy employed for this test case.","nullable":true},"redTeamer":{"type":"string","description":"Name or identifier of the red team component/agent that executed this attack.","nullable":true},"variation":{"type":"string","description":"Specific variation or sub-technique of the attack strategy used.","nullable":true},"detectionTime":{"type":"string","description":"Timestamp when this test case result was recorded.","format":"date-time"},"redTeamerLabels":{"type":"object","additionalProperties":{"type":"string"},"description":"Key-value pairs containing additional metadata and classification labels from the red team analysis.","nullable":true},"isRiskAccepted":{"type":"boolean","description":"Indicates whether the risk associated with this failed test case has been accepted by the user."},"riskAcceptedBy":{"type":"string","description":"User identifier of the user who accepted the risk. Null if risk not accepted.","nullable":true},"riskAcceptedDate":{"type":"string","description":"Timestamp when the risk was accepted. Null if risk not accepted.","format":"date-time","nullable":true},"editedStatusBy":{"type":"string","description":"User identifier of the user who last modified the status of this test case. Null if never edited.","nullable":true},"editedStatusDate":{"type":"string","description":"Timestamp of the last status modification. Null if never edited.","format":"date-time","nullable":true},"isIncludedInReport":{"type":"boolean","description":"Should this test case be included in the generated Test run report."}},"additionalProperties":false,"description":"Individual test case result containing attack details, outcomes, and risk management information."},"TestCaseResultDetailedDto":{"allOf":[{"$ref":"#/components/schemas/TestCaseResultDto"},{"required":["conversation","explanation"],"type":"object","properties":{"conversation":{"type":"array","items":{"type":"array","items":{"$ref":"#/components/schemas/MessageDto"}},"nullable":true},"explanation":{"type":"string","nullable":true}}}],"additionalProperties":false,"description":"Individual test case result containing attack details, outcomes, and risk management information."},"MessageDto":{"required":["content","contentType","role"],"type":"object","properties":{"role":{"type":"string","nullable":true},"content":{"type":"string","nullable":true},"encodedContent":{"type":"string","nullable":true},"contentType":{"type":"string","nullable":true}},"additionalProperties":false},"TestCaseResultDetailedV2Dto":{"allOf":[{"$ref":"#/components/schemas/TestCaseResultDto"},{"required":["comments","conversation","explanation"],"type":"object","properties":{"conversation":{"type":"array","items":{"type":"array","items":{"$ref":"#/components/schemas/MessageV2Dto"}},"nullable":true},"comments":{"type":"array","items":{"$ref":"#/components/schemas/TestCaseResultCommentDto"},"nullable":true},"explanation":{"type":"string","nullable":true},"error":{"type":"string","nullable":true},"metadata":{"$ref":"#/components/schemas/ReportMetadataDto"}}}],"additionalProperties":false,"description":"Individual test case result containing attack details, outcomes, and risk management information."},"MessageV2Dto":{"required":["messageContents","role"],"type":"object","properties":{"role":{"type":"string","nullable":true},"messageContents":{"type":"array","items":{"$ref":"#/components/schemas/ContentDto"},"nullable":true}},"additionalProperties":false},"ContentDto":{"required":["contentType"],"type":"object","properties":{"text":{"type":"string","nullable":true},"encodedText":{"type":"string","nullable":true},"imageUrl":{"type":"string","nullable":true},"encodedImageUrl":{"type":"string","nullable":true},"contentType":{"type":"string","nullable":true},"audioUrl":{"type":"string","nullable":true},"encodedAudioUrl":{"type":"string","nullable":true},"documentUrl":{"type":"string","nullable":true},"encodedDocumentUrl":{"type":"string","nullable":true}},"additionalProperties":false},"TestCaseResultCommentDto":{"required":["comment"],"type":"object","properties":{"comment":{"type":"string","nullable":true},"userEmail":{"type":"string","nullable":true},"timestamp":{"type":"string","format":"date-time"},"editedTimestamp":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false},"ReportMetadataDto":{"required":["baseUrl","targetId","workspaceId"],"type":"object","properties":{"baseUrl":{"type":"string","nullable":true},"workspaceId":{"type":"integer","format":"int32"},"targetId":{"type":"integer","format":"int32"},"testRunId":{"type":"integer","format":"int32","nullable":true},"probeRunId":{"type":"integer","format":"int32","nullable":true},"testCaseResultId":{"type":"integer","format":"int32","nullable":true}},"additionalProperties":false},"ScanProbeRunMitigationStrategy":{"required":["dynamicTasks","tasks"],"type":"object","properties":{"tasks":{"type":"array","items":{"$ref":"#/components/schemas/ScanProbeRunMitigationTask"},"description":"Predefined mitigation tasks based on known risk patterns and best practices.","nullable":true},"dynamicTasks":{"type":"array","items":{"$ref":"#/components/schemas/ScanProbeRunMitigationTask"},"description":"AI-generated mitigation tasks created dynamically based on specific risk context and probe results. Null if AI Analysis is incomplete or no dynamic recommendations available.","nullable":true}},"additionalProperties":false,"description":"Comprehensive remediation containing both predefined and AI-generated remediation tasks for addressing identified risks."},"ScanProbeRunMitigationTask":{"required":["appliedBy","completed","details","id","name"],"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for remediation task.","format":"int32"},"name":{"type":"string","description":"Descriptive name or title of the remediation task.","nullable":true},"details":{"type":"string","description":"Detailed description of the remediation steps, technical requirements, and implementation guidance.","nullable":true},"completed":{"type":"boolean","description":"Indicates whether this remediation task has been completed and implemented."},"type":{"type":"string","description":"Type of the remediation task (e.g., 'PROMPT_HARDENING', 'GUARDRAIL').","nullable":true},"appliedBy":{"type":"string","description":"User identifier of the user who is responsible for applying this remediation.","nullable":true},"appliedDate":{"type":"string","description":"Timestamp when the remediation was applied or implemented. Null if not yet completed.","format":"date-time","nullable":true}},"additionalProperties":false,"description":"Individual task containing specific remediation actions and implementation details."},"ProbeRunAiAnalysisDto":{"required":["id","methods","overview"],"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for AI analysis instance.","format":"int64"},"overview":{"type":"string","description":"High-level AI-generated summary of the probe run results, key findings, and overall security assessment.","nullable":true},"methods":{"type":"array","items":{"$ref":"#/components/schemas/ScanProbeRunAiAnalysisAttackClusterDto"},"description":"AI-identified groups of related attack patterns and risks, clustered by technique, or impact area.","nullable":true}},"additionalProperties":false,"description":"AI-powered analysis of probe run results, providing strategic insights and risk clustering."},"ScanProbeRunAiAnalysisAttackClusterDto":{"required":["data","description","id","name"],"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for attack cluster","format":"int64"},"name":{"type":"string","description":"AI-generated descriptive name for this attack cluster category.","nullable":true},"description":{"type":"string","description":"Detailed AI analysis explaining the cluster's characteristics, impact, and relationship between grouped attacks.","nullable":true},"data":{"$ref":"#/components/schemas/ScanProbeRunAiAnalysisAttackClusterDataDto"}},"additionalProperties":false,"description":"AI-identified attack cluster of related attack patterns representing a specific risk area or attack vector."},"ScanProbeRunAiAnalysisAttackClusterDataDto":{"required":["criticalTestCaseIds","failRate","failedTestCaseCount","totalTestCaseCount"],"type":"object","properties":{"failRate":{"type":"integer","description":"Percentage of test cases in this cluster that failed (indicating successful attacks).","format":"int32"},"criticalTestCaseIds":{"type":"array","items":{"type":"integer","format":"int64"},"description":"Collection of test case IDs that represent the most critical risks within this cluster.","nullable":true},"failedTestCaseCount":{"type":"integer","description":"Number of test cases in this cluster that failed (risks detected).","format":"int32"},"totalTestCaseCount":{"type":"integer","description":"Total number of test cases grouped into this cluster.","format":"int32"}},"additionalProperties":false,"description":"Quantitative metrics and reference data for an attack cluster, providing statistical insights into risk impact."},"ErrorResponse":{"required":["error"],"type":"object","properties":{"error":{"oneOf":[{"$ref":"#/components/schemas/ErrorDetailsDto"},{"$ref":"#/components/schemas/BadRequestErrorDetailsDto"}],"description":"Error object."}},"additionalProperties":false,"description":"Response payload for error."},"ErrorDetailsDto":{"required":["message"],"type":"object","properties":{"message":{"type":"string","description":"Error detailed message."},"code":{"type":"string","description":"Error code."}},"additionalProperties":false},"BadRequestErrorDetailsDto":{"type":"object","allOf":[{"$ref":"#/components/schemas/ErrorDetailsDto"}],"properties":{"validationErrors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"description":"Specific validation errors.","nullable":true}},"additionalProperties":false},"UnauthorizedError":{"type":"object","allOf":[{"$ref":"#/components/schemas/ErrorResponse"}],"additionalProperties":false,"description":"Response payload for Unauthorized access error."},"UnauthorizedWithLogoutError":{"type":"object","allOf":[{"$ref":"#/components/schemas/ErrorResponse"}],"additionalProperties":false,"description":"Response payload for Unauthorized access error."},"ForbiddenError":{"type":"object","allOf":[{"$ref":"#/components/schemas/ErrorResponse"}],"additionalProperties":false,"description":"Response payload for Forbidden access error."},"InternalServerError":{"type":"object","allOf":[{"$ref":"#/components/schemas/ErrorResponse"}],"additionalProperties":false,"description":"Response payload for Internal Server error."},"NotFoundExampleError":{"type":"object","allOf":[{"$ref":"#/components/schemas/ErrorResponse"}],"additionalProperties":false,"description":"Response payload for Not Found error."}}},"paths":{"/api/workspaces/{workspaceId}/probe-run/{probeRunId}":{"get":{"tags":["ProbeRun"],"summary":"Retrieve detailed probe run execution data and analysis results","description":"Returns comprehensive execution details for a specific probe run, including test case results, AI-powered vulnerability analysis, remediation strategies, and execution metrics. This endpoint provides deep insights into security probe performance and discovered vulnerabilities.","parameters":[{"name":"workspaceId","in":"path","description":"Workspace Id.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"probeRunId","in":"path","description":"Probe Run Id.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProbeRunDetailedExecutionDto"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ErrorResponse"},{"$ref":"#/components/schemas/UnauthorizedError"},{"$ref":"#/components/schemas/UnauthorizedWithLogoutError"},{"$ref":"#/components/schemas/ForbiddenError"},{"$ref":"#/components/schemas/InternalServerError"},{"$ref":"#/components/schemas/NotFoundExampleError"}],"description":"Response payload for error."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}}}}}}}}
```

## Trigger AI Analysis for a Scan Probe Run

> This endpoint triggers the AI analysis process for a specific scan probe run execution.

```json
{"openapi":"3.0.4","info":{"title":"API","version":"v1.0"},"tags":[],"servers":[{"url":"https://api.probe.splx.ai","description":"EU Server"},{"url":"https://us.api.probe.splx.ai","description":"US Server"}],"security":[{"API Key":[]}],"components":{"securitySchemes":{"API Key":{"type":"apiKey","description":"API Key for authentication","name":"X-Api-Key","in":"header"}},"schemas":{"ErrorResponse":{"required":["error"],"type":"object","properties":{"error":{"oneOf":[{"$ref":"#/components/schemas/ErrorDetailsDto"},{"$ref":"#/components/schemas/BadRequestErrorDetailsDto"}],"description":"Error object."}},"additionalProperties":false,"description":"Response payload for error."},"ErrorDetailsDto":{"required":["message"],"type":"object","properties":{"message":{"type":"string","description":"Error detailed message."},"code":{"type":"string","description":"Error code."}},"additionalProperties":false},"BadRequestErrorDetailsDto":{"type":"object","allOf":[{"$ref":"#/components/schemas/ErrorDetailsDto"}],"properties":{"validationErrors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"description":"Specific validation errors.","nullable":true}},"additionalProperties":false},"UnauthorizedError":{"type":"object","allOf":[{"$ref":"#/components/schemas/ErrorResponse"}],"additionalProperties":false,"description":"Response payload for Unauthorized access error."},"UnauthorizedWithLogoutError":{"type":"object","allOf":[{"$ref":"#/components/schemas/ErrorResponse"}],"additionalProperties":false,"description":"Response payload for Unauthorized access error."},"ForbiddenError":{"type":"object","allOf":[{"$ref":"#/components/schemas/ErrorResponse"}],"additionalProperties":false,"description":"Response payload for Forbidden access error."},"InternalServerError":{"type":"object","allOf":[{"$ref":"#/components/schemas/ErrorResponse"}],"additionalProperties":false,"description":"Response payload for Internal Server error."},"NotFoundExampleError":{"type":"object","allOf":[{"$ref":"#/components/schemas/ErrorResponse"}],"additionalProperties":false,"description":"Response payload for Not Found error."}}},"paths":{"/api/workspaces/{workspaceId}/probe-run/{probeRunId}/ai-analysis/trigger":{"post":{"tags":["ProbeRun"],"summary":"Trigger AI Analysis for a Scan Probe Run","description":"This endpoint triggers the AI analysis process for a specific scan probe run execution.","parameters":[{"name":"workspaceId","in":"path","description":"Workspace Id.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"probeRunId","in":"path","description":"Probe Run Id.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ErrorResponse"},{"$ref":"#/components/schemas/UnauthorizedError"},{"$ref":"#/components/schemas/UnauthorizedWithLogoutError"},{"$ref":"#/components/schemas/ForbiddenError"},{"$ref":"#/components/schemas/InternalServerError"},{"$ref":"#/components/schemas/NotFoundExampleError"}],"description":"Response payload for error."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}}}}}}}}
```

## Get AI Analysis results for a Scan Probe Run

> This endpoint retrieves the AI analysis results for a specific scan probe run execution.

```json
{"openapi":"3.0.4","info":{"title":"API","version":"v1.0"},"tags":[],"servers":[{"url":"https://api.probe.splx.ai","description":"EU Server"},{"url":"https://us.api.probe.splx.ai","description":"US Server"}],"security":[{"API Key":[]}],"components":{"securitySchemes":{"API Key":{"type":"apiKey","description":"API Key for authentication","name":"X-Api-Key","in":"header"}},"schemas":{"ScanProbeRunAiAnalysisDto":{"required":["attackClusters","id","overview"],"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for AI analysis instance.","format":"int64"},"overview":{"type":"string","description":"High-level AI-generated summary of the scan probe run results, key findings, and overall security assessment.","nullable":true},"attackClusters":{"type":"array","items":{"$ref":"#/components/schemas/ScanProbeRunAiAnalysisAttackClusterDto"},"description":"AI-identified groups of related attack patterns and risks, clustered by technique or impact area.","nullable":true}},"additionalProperties":false,"description":"AI-powered analysis of scan probe run results, providing strategic insights and risk clustering."},"ScanProbeRunAiAnalysisAttackClusterDto":{"required":["data","description","id","name"],"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for attack cluster","format":"int64"},"name":{"type":"string","description":"AI-generated descriptive name for this attack cluster category.","nullable":true},"description":{"type":"string","description":"Detailed AI analysis explaining the cluster's characteristics, impact, and relationship between grouped attacks.","nullable":true},"data":{"$ref":"#/components/schemas/ScanProbeRunAiAnalysisAttackClusterDataDto"}},"additionalProperties":false,"description":"AI-identified attack cluster of related attack patterns representing a specific risk area or attack vector."},"ScanProbeRunAiAnalysisAttackClusterDataDto":{"required":["criticalTestCaseIds","failRate","failedTestCaseCount","totalTestCaseCount"],"type":"object","properties":{"failRate":{"type":"integer","description":"Percentage of test cases in this cluster that failed (indicating successful attacks).","format":"int32"},"criticalTestCaseIds":{"type":"array","items":{"type":"integer","format":"int64"},"description":"Collection of test case IDs that represent the most critical risks within this cluster.","nullable":true},"failedTestCaseCount":{"type":"integer","description":"Number of test cases in this cluster that failed (risks detected).","format":"int32"},"totalTestCaseCount":{"type":"integer","description":"Total number of test cases grouped into this cluster.","format":"int32"}},"additionalProperties":false,"description":"Quantitative metrics and reference data for an attack cluster, providing statistical insights into risk impact."},"ErrorResponse":{"required":["error"],"type":"object","properties":{"error":{"oneOf":[{"$ref":"#/components/schemas/ErrorDetailsDto"},{"$ref":"#/components/schemas/BadRequestErrorDetailsDto"}],"description":"Error object."}},"additionalProperties":false,"description":"Response payload for error."},"ErrorDetailsDto":{"required":["message"],"type":"object","properties":{"message":{"type":"string","description":"Error detailed message."},"code":{"type":"string","description":"Error code."}},"additionalProperties":false},"BadRequestErrorDetailsDto":{"type":"object","allOf":[{"$ref":"#/components/schemas/ErrorDetailsDto"}],"properties":{"validationErrors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"description":"Specific validation errors.","nullable":true}},"additionalProperties":false},"UnauthorizedError":{"type":"object","allOf":[{"$ref":"#/components/schemas/ErrorResponse"}],"additionalProperties":false,"description":"Response payload for Unauthorized access error."},"UnauthorizedWithLogoutError":{"type":"object","allOf":[{"$ref":"#/components/schemas/ErrorResponse"}],"additionalProperties":false,"description":"Response payload for Unauthorized access error."},"ForbiddenError":{"type":"object","allOf":[{"$ref":"#/components/schemas/ErrorResponse"}],"additionalProperties":false,"description":"Response payload for Forbidden access error."},"InternalServerError":{"type":"object","allOf":[{"$ref":"#/components/schemas/ErrorResponse"}],"additionalProperties":false,"description":"Response payload for Internal Server error."},"NotFoundExampleError":{"type":"object","allOf":[{"$ref":"#/components/schemas/ErrorResponse"}],"additionalProperties":false,"description":"Response payload for Not Found error."}}},"paths":{"/api/workspaces/{workspaceId}/probe-run/{probeRunId}/ai-analysis":{"get":{"tags":["ProbeRun"],"summary":"Get AI Analysis results for a Scan Probe Run","description":"This endpoint retrieves the AI analysis results for a specific scan probe run execution.","parameters":[{"name":"workspaceId","in":"path","description":"Workspace Id.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"probeRunId","in":"path","description":"Probe Run Id.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScanProbeRunAiAnalysisDto"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ErrorResponse"},{"$ref":"#/components/schemas/UnauthorizedError"},{"$ref":"#/components/schemas/UnauthorizedWithLogoutError"},{"$ref":"#/components/schemas/ForbiddenError"},{"$ref":"#/components/schemas/InternalServerError"},{"$ref":"#/components/schemas/NotFoundExampleError"}],"description":"Response payload for error."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}}}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.probe.splx.ai/platform-api/api-reference/probe-run.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.