Begin LLM analysis

post

https://{sandfly-api-host}/v4/llmanalysis

Begin a new LLM analysis for a host, or for results and/or artifacts.

Body Params

Request to begin a new LLM analysis of a host or results.

mode

string

enum

required

The analysis mode. Determines which other fields are required.

Allowed:

host_sequence_id

integer

The host sequence ID. Required if mode is 'host', ignored otherwise.

result_ids

array of int64s

deprecated

Deprecated in favor of artifact_ids. A list of result IDs. At least one result ID or artifact ID is required if mode is 'results', ignored otherwise. Each result is analyzed as the artifact it is about, together with the verdicts of every other sandfly currently reporting on that artifact. Results about the same artifact are analyzed together.

result_ids

artifact_ids

array of int64s

A list of artifact IDs, as the artifact API reports them. At least one result ID or artifact ID is required if mode is 'results', ignored otherwise. Each artifact is analyzed together with the verdicts of every sandfly currently reporting on it. An artifact is analyzed once even if it is also named through one of the result_ids. For each artifact named here but not through a result, the analysis lists one of the artifact's results among its results.

artifact_ids

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201LLM analysis created.

400Invalid request body.

403LLM integration is not enabled in the server configuration.

404The host ID, a result ID, or an artifact ID was not found, or an artifact has no results to analyze.

defaultUnexpected error