> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt
> Use this file to discover all available pages before exploring further.

# HttpRequestOptions

> HttpRequestOptions — Kinetica TypeScript API

HTTP Transport abstraction for cross-platform support.

interface HttpRequestOptions \{\
&#x20;[body](#body)?: string;\
&#x20;[bytes](#bytes)?: Uint8Array\<ArrayBufferLike>;\
&#x20;[headers](#headers): Record\<string, string>;\
&#x20;[maxResponseBytes](#maxresponsebytes)?: number;\
&#x20;[method](#method): "GET" | "POST";\
&#x20;[responseType](#responsetype)?: "text" | "binary";\
&#x20;[timeout](#timeout)?: number;\
&#x20;[url](#url): string;\
}

<ul>
  <li>Defined in [src/transport.ts:5](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/transport.ts#L5)</li>
</ul>

##### Index

### Properties

[body?](#body) [bytes?](#bytes) [headers](#headers) [maxResponseBytes?](#maxresponsebytes) [method](#method) [responseType?](#responsetype) [timeout?](#timeout) [url](#url)&#x20;

## Properties

### `Optional`body

body?: string

Request body, as text

<ul>
  <li>Defined in [src/transport.ts:10](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/transport.ts#L10)</li>
</ul>

### `Optional`bytes

bytes?: Uint8Array\<ArrayBufferLike>

Request body, as bytes: set in place of `body` by a client constructed with `encoding: 'binary'`. A custom transport serving such a client must send these unchanged.

<ul>
  <li>Defined in [src/transport.ts:16](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/transport.ts#L16)</li>
</ul>

### headers

headers: Record\<string, string>

<ul>
  <li>Defined in [src/transport.ts:8](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/transport.ts#L8)</li>
</ul>

### `Optional`maxResponseBytes

maxResponseBytes?: number

Abandon the response once it passes this many bytes, rejecting with a ResponseTooLargeError. 0 or omitted means no ceiling.

<ul>
  <li>Defined in [src/transport.ts:28](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/transport.ts#L28)</li>
</ul>

### method

method: "GET" | "POST"

<ul>
  <li>Defined in [src/transport.ts:6](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/transport.ts#L6)</li>
</ul>

### `Optional`responseType

responseType?: "text" | "binary"

'binary' also fills in `bytes` on the response, for responses that are not text -- WMS images, and the Avro a binary-encoding client receives. Decoding those as text would corrupt them.

<ul>
  <li>Defined in [src/transport.ts:23](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/transport.ts#L23)</li>
</ul>

### `Optional`timeout

timeout?: number

<ul>
  <li>Defined in [src/transport.ts:17](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/transport.ts#L17)</li>
</ul>

### url

url: string

<ul>
  <li>Defined in [src/transport.ts:7](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/transport.ts#L7)</li>
</ul>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.