a13nDocs
API referenceFindings

Start Analysis

POST/api/v1/finding-analyses

Authorization

AuthorizationBearer <token>

A workspace API key (a13n_...)

In: header

Header Parameters

Idempotency-Key*Idempotency-Key
Match^[!-~]+$
Length1 <= length <= 512
X-Workspace-ID?|

The workspace ID a login session acts in; required with a login session. An API key acts in its own workspace and needs none; naming another is forbidden.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/finding-analyses" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'
{  "agent_id": "string",  "cited_trace_count": 0,  "created_at": "2019-08-24T14:15:22Z",  "finding_count": 0,  "id": "string",  "read_trace_ids": [    "string"  ],  "run_id": "string",  "run_status": "string",  "selected_traces": [    {      "run_id": "string",      "trace_id": "string"    }  ],  "selection": {    "agent_id": "string",    "max_traces": 10,    "presets": [      "execution"    ],    "started_after": "2019-08-24T14:15:22Z",    "started_before": "2019-08-24T14:15:22Z",    "trace_id": "string"  },  "selection_truncated": true,  "session_id": "string",  "thread_id": "string"}