Interface: StreamOptions

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/types.ts:697

Streaming options for AI responses and large data

Extends

• Omit<RequestOptions, "body">

Properties

allowUnauthenticated?

optional allowUnauthenticated?: boolean

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/types.ts:162

Allow unauthenticated request

Inherited from

RequestOptions.allowUnauthenticated

---

body?

optional body?: any

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/types.ts:701

Request body

---

cacheKey?

optional cacheKey?: string

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/types.ts:173

Cache key

Inherited from

RequestOptions.cacheKey

---

cacheTTL?

optional cacheTTL?: number

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/types.ts:178

Cache TTL in seconds

Inherited from

RequestOptions.cacheTTL

---

headers?

optional headers?: Record<string, string>

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/types.ts:151

Custom headers

Inherited from

RequestOptions.headers

---

idempotencyKey?

optional idempotencyKey?: string

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/types.ts:188

Idempotency key for safe retries

Inherited from

RequestOptions.idempotencyKey

---

jsonLines?

optional jsonLines?: boolean

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/types.ts:722

Decode as JSON lines (NDJSON)

Default

false

---

onChunk?

optional onChunk?: (chunk) => void

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/types.ts:706

Callback for each streamed chunk

Parameters

chunk

string

Returns

void

---

onComplete?

optional onComplete?: (fullResponse) => void

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/types.ts:711

Callback for stream completion

Parameters

fullResponse

string

Returns

void

---

onError?

optional onError?: (error) => void

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/types.ts:716

Callback for stream errors

Parameters

error

Error

Returns

void

---

query?

optional query?: Record<string, any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/types.ts:146

Query parameters

Inherited from

RequestOptions.query

---

requiresAuth?

optional requiresAuth?: boolean

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/types.ts:157

Requires authentication

Default

true

Inherited from

RequestOptions.requiresAuth

---

retry?

optional retry?: RetryConfig

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/types.ts:183

Retry configuration

Inherited from

RequestOptions.retry

---

signal?

optional signal?: AbortSignal

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/types.ts:198

Abort signal for cancellation

Inherited from

RequestOptions.signal

---

timeout?

optional timeout?: number

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/types.ts:193

Request timeout override

Inherited from

RequestOptions.timeout

---

useCache?

optional useCache?: boolean

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/types.ts:168

Use cache

Default

true for GET requests

Inherited from

RequestOptions.useCache