## APIError

An unsuccessful HTTP response from the API.

## Extends

- [`TypeSafeError`](https://docs.typesafe.ai/sdk/javascript/api/classes/TypeSafeError)

## Extended by

- [`AuthenticationError`](https://docs.typesafe.ai/sdk/javascript/api/classes/AuthenticationError)
- [`BadRequestError`](https://docs.typesafe.ai/sdk/javascript/api/classes/BadRequestError)
- [`InternalServerError`](https://docs.typesafe.ai/sdk.javascript/api/classes/InternalServerError)
- [`NotFoundError`](https://docs.typesafe.ai/sdk/javascript/api/classes/NotFoundError)
- [`PermissionDeniedError`](https://docs.typesafe.ai/sdk/javascript/api/classes/PermissionDeniedError)
- [`RateLimitError`](https://docs.typesafe.ai/sdk/javascript/api/classes/RateLimitError)
- [`UnprocessableEntityError`](https://docs.typesafe.ai/sdk/javascript/api/classes/UnprocessableEntityError)

## Constructors

### Constructor

```
new APIError(
   status,
   body,
   headers,
   message?
): APIError;
```

#### Parameters

##### status

`number`

##### body

`unknown`

##### headers

`Headers`

##### message?

`string`

#### Returns

`APIError`

#### Overrides

[`TypeSafeError`](https://docs.typesafe.ai/sdk/javascript/api/classes/TypeSafeError). [`constructor`](https://docs.typesafe.ai/sdk/javascript/api/classes/TypeSafeError#sdk-constructor)

## Properties

### body

```
readonly body: unknown;
```

Parsed JSON, response text, or `undefined` for an empty body.

### headers

```
readonly headers: Headers;
```

HTTP response headers.

### requestId

```
readonly requestId: string | undefined;
```

Request ID from `x-typesafe-request-id`, or `undefined` when absent.

### status

```
readonly status: number;
```

HTTP response status code.

## Methods

### fromResponse()

```
static fromResponse(
   status,
   body,
   headers
): APIError;
```

Create the error subclass for an HTTP status code.

#### Parameters

##### status

`number`

##### body

`unknown`

##### headers

`Headers`

#### Returns

`APIError`