> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://hiddenlayer.ferndocs.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://hiddenlayer.ferndocs.com/_mcp/server.

# Get scan detection remediation guidance

GET https://api.hiddenlayer.ai/supply-chain/v3/scans/{scan_id}/guidance

[BETA] This endpoint is not GA or Production ready and is subject to changes at any time. Breaking changes may occur.

Remediation guidance is generated on-demand with AI assistance and may not be
immediately available.


Reference: https://hiddenlayer.ferndocs.com/api-reference/llm-proxy-api/supply-chain/get-guidance

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Servers

- `https://api.hiddenlayer.ai` (ProdUs, default)
- `https://api.eu.hiddenlayer.ai` (ProdEu)

## Request

### Path parameters

- `scan_id` (string, required)

## Response

### 200

Remediation guidance has been generated and is returned.

- `legal_disclosure` (string, optional)
- `general_recommendations` (string, optional)
- `detection_guidance` (list of SupplyChainV3ScansScanIdGuidanceGetResponsesContentApplicationJsonSchemaDetectionGuidanceItems, optional)

### 202

Request is accepted, but remediation guidance is still being generated. Retry the request in a few moments.

## Errors

### 400 Bad Request Error

The request failed due to a client error, with one or more of the following possible causes: 1. The request required a tenant_id field, which was missing. 2. The request was malformed syntactically or semantically.

- `any`

### 403 Forbidden Error

The `is_ai_assistance_guidance_enabled` preference is not enabled.

- `any`

### 404 Not Found Error

Scan ID not found, or scan is missing an AIBOM.

- `any`

## Types

### SupplyChainV3ScansScanIdGuidanceGetResponsesContentApplicationJsonSchemaDetectionGuidanceItems

- `detection_id` (string, optional)
- `detection_category` (string, optional)
- `severity` (string, optional)
- `summary` (string, optional)
- `remediation_actions` (list of SupplyChainV3ScansScanIdGuidanceGetResponsesContentApplicationJsonSchemaDetectionGuidanceItemsRemediationActionsItems, optional)
- `false_positive_considerations` (string, optional)
- `references` (list of string, optional)

### SupplyChainV3ScansScanIdGuidanceGetResponsesContentApplicationJsonSchemaDetectionGuidanceItemsRemediationActionsItems

- `priority` (string, optional)
- `action` (string, optional)
- `description` (string, optional)

## Examples

### Example 1

**Response**

```json
{
  "legal_disclosure": "string",
  "general_recommendations": "string",
  "detection_guidance": [
    {
      "detection_id": "string",
      "detection_category": "string",
      "severity": "string",
      "summary": "string",
      "remediation_actions": [
        {
          "priority": "string",
          "action": "string",
          "description": "string"
        }
      ],
      "false_positive_considerations": "string",
      "references": [
        "string"
      ]
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://api.hiddenlayer.ai/supply-chain/v3/scans/scan_id/guidance"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.hiddenlayer.ai/supply-chain/v3/scans/scan_id/guidance';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hiddenlayer.ai/supply-chain/v3/scans/scan_id/guidance"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.hiddenlayer.ai/supply-chain/v3/scans/scan_id/guidance")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.hiddenlayer.ai/supply-chain/v3/scans/scan_id/guidance")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.hiddenlayer.ai/supply-chain/v3/scans/scan_id/guidance', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.hiddenlayer.ai/supply-chain/v3/scans/scan_id/guidance");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.hiddenlayer.ai/supply-chain/v3/scans/scan_id/guidance")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### Example 2

**Response**

```json
{}
```

**SDK Code**

```python
import requests

url = "https://api.hiddenlayer.ai/supply-chain/v3/scans/scan_id/guidance"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.hiddenlayer.ai/supply-chain/v3/scans/scan_id/guidance';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hiddenlayer.ai/supply-chain/v3/scans/scan_id/guidance"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.hiddenlayer.ai/supply-chain/v3/scans/scan_id/guidance")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.hiddenlayer.ai/supply-chain/v3/scans/scan_id/guidance")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.hiddenlayer.ai/supply-chain/v3/scans/scan_id/guidance', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.hiddenlayer.ai/supply-chain/v3/scans/scan_id/guidance");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.hiddenlayer.ai/supply-chain/v3/scans/scan_id/guidance")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```