a13nDocs
API referenceFindings

Create Finding

POST/api/v1/findings

Authorization

AuthorizationBearer <token>

A workspace API key (a13n_...)

In: header

Header Parameters

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/findings" \  -H "Content-Type: application/json" \  -d '{    "agent_id": "string",    "agent_revision_id": "string",    "category": "unclear_request",    "evidence": [      {        "run_id": "string",        "trace_id": "string"      }    ],    "explanation": "string",    "source_key": "string",    "suggestion": "string",    "title": "string"  }'
{  "agent_id": "string",  "agent_revision_id": "string",  "analysis_id": "string",  "assessment": "unreviewed",  "assessment_note": "string",  "category": "unclear_request",  "closed": true,  "created_at": "2019-08-24T14:15:22Z",  "created_by_id": "string",  "evidence": [    {      "run_id": "string",      "span_ids": [        "string"      ],      "trace_id": "string"    }  ],  "explanation": "string",  "id": "string",  "limitations": "",  "severity": "critical",  "source_key": "string",  "source_run_id": "string",  "suggestion": "string",  "title": "string",  "updated_at": "2019-08-24T14:15:22Z",  "version": 0,  "workspace_id": "string"}