Skip to main content

Interface: RequestOptions

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

Properties​

allowUnauthenticated?​

optional allowUnauthenticated?: boolean

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

Allow unauthenticated request


body?​

optional body?: any

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

Request body


cacheKey?​

optional cacheKey?: string

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

Cache key


cacheTTL?​

optional cacheTTL?: number

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

Cache TTL in seconds


headers?​

optional headers?: Record<string, string>

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

Custom headers


idempotencyKey?​

optional idempotencyKey?: string

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

Idempotency key for safe retries


query?​

optional query?: Record<string, any>

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

Query parameters


requiresAuth?​

optional requiresAuth?: boolean

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

Requires authentication

Default​

true

retry?​

optional retry?: RetryConfig

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

Retry configuration


signal?​

optional signal?: AbortSignal

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

Abort signal for cancellation


timeout?​

optional timeout?: number

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

Request timeout override


useCache?​

optional useCache?: boolean

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

Use cache

Default​

true for GET requests