# Anuma Developer Platform — Full Documentation for LLMs

> Documentation for the Anuma Developer Platform. Build AI apps with multi-model chat, persistent memory, streaming, and tools — one SDK across OpenAI, Anthropic, Google, xAI, and open-source models.

Website: https://www.anuma.ai
Documentation: https://docs.anuma.ai
Developer Dashboard: https://dashboard.anuma.ai
GitHub: https://github.com/anuma-ai

---
Source: https://docs.anuma.ai/

# Anuma

Everything you need to build AI apps. One SDK across OpenAI, Anthropic, Google, xAI, and open-source models.

Switch providers without changing code. Add memory that persists across sessions. Give models tools to search the web, manage calendars, and call your own functions.

```tsx
import { useChat } from "@anuma/sdk/react";

const { sendMessage, isLoading } = useChat({
  getToken: async () => authToken,
  onData: (chunk) => setResponse((prev) => prev + chunk),
});

await sendMessage({
  messages: [{ role: "user", content: [{ type: "text", text: "Hello!" }] }],
  model: "gpt-4o-mini",
});
```

For persistent conversations with message history, use [`useChatStorage`](/sdk/react/Hooks/useChatStorage) which adds automatic storage on top of `useChat`.

## Getting Started

Create an app on [dashboard.anuma.ai](https://dashboard.anuma.ai), then follow the [quickstart tutorial](/tutorials/quickstart) or explore the [SDK reference](/sdk/react).

## What's Included

- [Chat completions](/conversations) — streaming, tool calling, multi-model support
- [Memory](/memory) — semantic search across past conversations
- [Tools](/tools/overview) — web search, calendars, custom functions
- [File processing](/files) — PDFs, Word, Excel, images with OCR

## Examples

## Portal API

For other languages or direct HTTP access. The API is OpenAI-compatible, so you can use existing tools and libraries.

[API Reference →](/api)

---
Source: https://docs.anuma.ai/authentication

# Authentication

Every API request requires authentication. Anuma supports two methods: API keys and user authentication with Privy. Both require an app on [dashboard.anuma.ai](https://dashboard.anuma.ai).

## API Key Authentication

Use API keys for server-side applications, backends, scripts, or when you as the developer pay for inference costs. This is the simplest way to get started.

### Setup

1. Create an app on [dashboard.anuma.ai](https://dashboard.anuma.ai)
2. Go to the Auth tab and add an API key
3. Copy the secret — it's only shown once

API keys use the `anuma_live_` prefix (or `anuma_test_` for test keys).

### Usage

API keys are sent via the `X-API-KEY` header:

```
X-API-KEY: <your-api-key>
```

### When to use

API keys are a good fit when your application runs on a server or in an environment where you control the credentials. You pay for all inference costs from your app's balance. Typical use cases include backends, internal tools, and prototyping.

## User Authentication with Privy

Use [Privy](https://www.privy.io/) for client-side applications where each user authenticates with their own wallet. Privy supports embedded wallets, so users don't need a browser extension.

### Setup

1. Create an app on [dashboard.anuma.ai](https://dashboard.anuma.ai)
2. Create a Privy app at [privy.io](https://www.privy.io/)
3. In the Privy dashboard, go to Configuration → App Settings → Basics. Copy your App ID and click "Verify with key instead" to get the verification key.
4. In the Privy dashboard, go to Authentication → Advanced and enable "Return user data in an identity token".
5. In the Anuma dashboard, go to your app's Auth tab, add Privy as an auth method, and paste the App ID and verification key.

### Usage

Privy tokens are sent via the `Authorization: Bearer` header. Use the `useIdentityToken` hook from Privy to get the token:

```typescript
import { useIdentityToken } from "@privy-io/react-auth";

function Chat() {
  const { identityToken } = useIdentityToken();

  const { sendMessage } = useChat({
    getToken: async () => identityToken,
  });
}
```

See the [Next.js Example](/tutorials/quickstart) for a complete Privy implementation.

### When to use

Privy is a good fit for user-facing applications where each user has their own identity and wallet. This works well for consumer apps, community tools, and any product where users need individual accounts.

---
Source: https://docs.anuma.ai/cli

# Anuma CLI

Command-line interface for the [Anuma](https://dashboard.anuma.ai) platform. Manage your apps, API keys, models, credits, and subscriptions from the terminal.

## Install

```bash
npm install -g anuma@next
```

Or run directly with npx:

```bash
npx anuma@next --help
```

## Create a New App

Scaffold a project from a starter template:

```bash
anuma new --starter mini
```

Available starters: `mini`, `next`, `telegram`. If you have a Privy app ID, pass it with `--privy <id>` to auto-configure the environment.

## Login

Authenticate with your API key:

```bash
anuma auth login --api-key <your-key>
```

You can get an API key from the [Anuma Developer Dashboard](https://dashboard.anuma.ai).

Once authenticated, explore available commands:

```bash
anuma --help
anuma <command> --help
```

## Configuration

The CLI stores configuration in `~/.anuma/config.json`. You can override the API base URL per invocation with `--api-url <url>`:

```bash
anuma api models list --api-url https://portal.anuma.ai
```

---
Source: https://docs.anuma.ai/cli/reference

## anuma new

```
Usage: anuma new [options]

Create a new project from a starter template

Options:
  --starter <name>  starter template (mini, next, telegram)
  --privy <id>      Privy app ID
  -h, --help        display help for command

```

## anuma auth

```
Usage: anuma auth [options] [command]

Log in to use the Anuma API

Options:
  -h, --help       display help for command

Commands:
  login [options]  Save your API key
  status           Show current authentication status
  logout           Remove saved API key
  help [command]   display help for command

```

## anuma auth login

```
Usage: anuma auth login [options]

Save your API key

Options:
  --api-key <key>  Anuma API key
  -h, --help       display help for command

```

## anuma auth status

```
Usage: anuma auth status [options]

Show current authentication status

Options:
  -h, --help  display help for command

```

## anuma auth logout

```
Usage: anuma auth logout [options]

Remove saved API key

Options:
  -h, --help  display help for command

```

## anuma chat

```
Usage: anuma chat [options]

Start an interactive chat session

Options:
  --api-url <url>    API base URL
  --model <name>     Model to use (default: "openai/gpt-4o")
  --system <prompt>  System prompt
  --no-tools         Disable client-side tools
  -h, --help         display help for command

```

## anuma docs

```
Usage: anuma docs [options]

Display help information for all available commands and their subcommands

Options:
  --json      Output documentation as JSON (tools schema)
  -h, --help  display help for command

```

## anuma api

```
Usage: anuma api [options] [command]

Anuma platform API

Options:
  --api-url <url>  API base URL (overrides ~/.anuma/config.json)
  -h, --help       display help for command

Commands:
  agents           Manage agents
  chat             Create chat completion
  config           Get configuration
  credits          Manage credits
  developer        Manage developer
  embeddings       Create embeddings
  models           List available models
  responses        Create response
  subscriptions    Manage subscriptions
  tasks            Get available tasks
  text             Manage text
  tools            List available tools
  usage            Get usage by model
  help [command]   display help for command

```

## anuma api agents

```
Usage: anuma api agents [options] [command]

Manage agents

Options:
  -h, --help      display help for command

Commands:
  get <id>        Get agent
  list            List agents
  help [command]  display help for command

```

## anuma api agents get

```
Usage: anuma api agents get [options] <id>

Get agent

Arguments:
  id          Agent ID

Options:
  -h, --help  display help for command

```

## anuma api agents list

```
Usage: anuma api agents list [options]

List agents

Options:
  -h, --help  display help for command

```

## anuma api chat

```
Usage: anuma api chat [options] [command]

Create chat completion

Options:
  -h, --help             display help for command

Commands:
  completions [options]  Create chat completion
  help [command]         display help for command

```

## anuma api chat completions

```
Usage: anuma api chat completions [options]

Create chat completion

Options:
  --image-model <value>  ImageModel is the user-selected image generation model.
                         When set, the portal overrides the model field in image
                         tool call arguments.
  --messages <value>     Messages is the conversation history
  --model <value>        Model is the model identifier
  --stream <value>       Stream indicates if response should be streamed
  --tool-choice <value>  tool_choice
  --tools <value>        Tools is an array of tool schemas describing which
                         tools the model can use
  --json <data>          Request body as JSON string
  -h, --help             display help for command

```

## anuma api config

```
Usage: anuma api config [options] [command]

Get configuration

Options:
  -h, --help      display help for command

Commands:
  list            Get configuration
  help [command]  display help for command

```

## anuma api config list

```
Usage: anuma api config list [options]

Get configuration

Options:
  -h, --help  display help for command

```

## anuma api credits

```
Usage: anuma api credits [options] [command]

Manage credits

Options:
  -h, --help            display help for command

Commands:
  balance               Get credit balance
  claim-daily           Claim daily credits
  claim-task [options]  Claim task reward
  packs                 List available credit packs
  purchase [options]    Create credit pack checkout session
  sync-snag             Sync Snag points
  help [command]        display help for command

```

## anuma api credits balance

```
Usage: anuma api credits balance [options]

Get credit balance

Options:
  -h, --help  display help for command

```

## anuma api credits claim-daily

```
Usage: anuma api credits claim-daily [options]

Claim daily credits

Options:
  -h, --help  display help for command

```

## anuma api credits claim-task

```
Usage: anuma api credits claim-task [options]

Claim task reward

Options:
  --memories <value>   memories
  --task-type <value>  task_type
  --json <data>        Request body as JSON string
  -h, --help           display help for command

```

## anuma api credits packs

```
Usage: anuma api credits packs [options]

List available credit packs

Options:
  -h, --help  display help for command

```

## anuma api credits purchase

```
Usage: anuma api credits purchase [options]

Create credit pack checkout session

Options:
  --cancel-url <value>   cancel_url
  --credits <value>      credits
  --referral <value>     Rewardful referral ID for affiliate tracking
  --success-url <value>  success_url
  --json <data>          Request body as JSON string
  -h, --help             display help for command

```

## anuma api credits sync-snag

```
Usage: anuma api credits sync-snag [options]

Sync Snag points

Options:
  -h, --help  display help for command

```

## anuma api developer

```
Usage: anuma api developer [options] [command]

Manage developer

Options:
  -h, --help         display help for command

Commands:
  billing [options]  Get billing history
  apps               Manage apps
  help [command]     display help for command

```

## anuma api developer billing

```
Usage: anuma api developer billing [options]

Get billing history

Options:
  --limit <value>   Maximum number of records to return (default 50, max 100)
  --offset <value>  Number of records to skip (default 0)
  -h, --help        display help for command

```

## anuma api developer apps

```
Usage: anuma api developer apps [options] [command]

Manage apps

Options:
  -h, --help                   display help for command

Commands:
  create [options]             Create app
  delete <app-uuid>            Delete app
  fund [options] <app-uuid>    Fund developer app balance
  get <app-uuid>               Get app
  list [options]               List apps
  update [options] <app-uuid>  Update app
  usage [options] <app-uuid>   Get app usage
  api-keys                     Manage api keys
  privy                        Manage privy
  users                        Manage users
  help [command]               display help for command

```

## anuma api developer apps create

```
Usage: anuma api developer apps create [options]

Create app

Options:
  --allowed-origins <value>       allowed CORS origins for API key requests
  --app-type <value>              "standard" (default) or "pooled_api"
  --default-user-credits <value>  credits per new user (1 credit = $0.01)
  --name <value>                  name
  --json <data>                   Request body as JSON string
  -h, --help                      display help for command

```

## anuma api developer apps delete

```
Usage: anuma api developer apps delete [options] <app-uuid>

Delete app

Arguments:
  app-uuid    App UUID

Options:
  -h, --help  display help for command

```

## anuma api developer apps fund

```
Usage: anuma api developer apps fund [options] <app-uuid>

Fund developer app balance

Arguments:
  app-uuid               App UUID

Options:
  --cancel-url <value>   URL to redirect if payment is cancelled
  --credits <value>      Number of credits to purchase (1 credit = $0.01)
  --referral <value>     Rewardful referral ID for affiliate tracking
  --success-url <value>  URL to redirect after successful payment
  --json <data>          Request body as JSON string
  -h, --help             display help for command

```

## anuma api developer apps get

```
Usage: anuma api developer apps get [options] <app-uuid>

Get app

Arguments:
  app-uuid    App UUID

Options:
  -h, --help  display help for command

```

## anuma api developer apps list

```
Usage: anuma api developer apps list [options]

List apps

Options:
  --limit <value>   Maximum number of apps to return (default 50, max 100)
  --offset <value>  Number of apps to skip (default 0)
  -h, --help        display help for command

```

## anuma api developer apps update

```
Usage: anuma api developer apps update [options] <app-uuid>

Update app

Arguments:
  app-uuid                        App UUID

Options:
  --allowed-origins <value>       nil=skip, []=clear, populated=set
  --default-user-credits <value>  credits per new user (1 credit = $0.01)
  --name <value>                  name
  --json <data>                   Request body as JSON string
  -h, --help                      display help for command

```

## anuma api developer apps usage

```
Usage: anuma api developer apps usage [options] [command] <app-uuid>

Get app usage

Arguments:
  app-uuid                    App UUID

Options:
  --start-time <value>        Start time (RFC3339). Defaults to 30 days ago.
  --end-time <value>          End time (RFC3339). Defaults to now.
  --granularity <value>       Timeseries granularity: 'day' (default) or 'hour'
  -h, --help                  display help for command

Commands:
  users [options] <app-uuid>  Get app user usage

```

## anuma api developer apps usage users

```
Usage: anuma api developer apps usage users [options] <app-uuid>

Get app user usage

Arguments:
  app-uuid              App UUID

Options:
  --start-time <value>  Start time (RFC3339). Defaults to 30 days ago.
  --end-time <value>    End time (RFC3339). Defaults to now.
  --limit <value>       Number of results (default 50, max 100)
  --offset <value>      Offset for pagination (default 0)
  -h, --help            display help for command

```

## anuma api developer apps api-keys

```
Usage: anuma api developer apps api-keys [options] [command]

Manage api keys

Options:
  -h, --help                   display help for command

Commands:
  create [options] <app-uuid>  Create API key
  delete <app-uuid> <key-id>   Delete API key
  list [options] <app-uuid>    List API keys
  help [command]               display help for command

```

## anuma api developer apps api-keys create

```
Usage: anuma api developer apps api-keys create [options] <app-uuid>

Create API key

Arguments:
  app-uuid           App UUID

Options:
  --is-test <value>  is_test
  --name <value>     name
  --json <data>      Request body as JSON string
  -h, --help         display help for command

```

## anuma api developer apps api-keys delete

```
Usage: anuma api developer apps api-keys delete [options] <app-uuid> <key-id>

Delete API key

Arguments:
  app-uuid    App UUID
  key-id      API Key ID

Options:
  -h, --help  display help for command

```

## anuma api developer apps api-keys list

```
Usage: anuma api developer apps api-keys list [options] <app-uuid>

List API keys

Arguments:
  app-uuid          App UUID

Options:
  --limit <value>   Maximum number of API keys to return (default 50, max 100)
  --offset <value>  Number of API keys to skip (default 0)
  -h, --help        display help for command

```

## anuma api developer apps privy

```
Usage: anuma api developer apps privy [options] [command]

Manage privy

Options:
  -h, --help                   display help for command

Commands:
  create [options] <app-uuid>  Configure Privy
  delete <app-uuid>            Remove Privy
  help [command]               display help for command

```

## anuma api developer apps privy create

```
Usage: anuma api developer apps privy create [options] <app-uuid>

Configure Privy

Arguments:
  app-uuid                          App UUID

Options:
  --privy-app-id <value>            privy_app_id
  --privy-verification-key <value>  privy_verification_key
  --json <data>                     Request body as JSON string
  -h, --help                        display help for command

```

## anuma api developer apps privy delete

```
Usage: anuma api developer apps privy delete [options] <app-uuid>

Remove Privy

Arguments:
  app-uuid    App UUID

Options:
  -h, --help  display help for command

```

## anuma api developer apps users

```
Usage: anuma api developer apps users [options] [command]

Manage users

Options:
  -h, --help                             display help for command

Commands:
  get <app-uuid> <address>               Get user
  list [options] <app-uuid>              List users
  top-up [options] <app-uuid> <address>  Top up user credits
  update [options] <app-uuid> <address>  Update user limit
  help [command]                         display help for command

```

## anuma api developer apps users get

```
Usage: anuma api developer apps users get [options] <app-uuid> <address>

Get user

Arguments:
  app-uuid    App UUID
  address     User wallet address

Options:
  -h, --help  display help for command

```

## anuma api developer apps users list

```
Usage: anuma api developer apps users list [options] <app-uuid>

List users

Arguments:
  app-uuid          App UUID

Options:
  --limit <value>   Maximum number of users to return (default 50, max 200)
  --offset <value>  Number of users to skip (default 0)
  -h, --help        display help for command

```

## anuma api developer apps users top-up

```
Usage: anuma api developer apps users top-up [options] <app-uuid> <address>

Top up user credits

Arguments:
  app-uuid           App UUID
  address            User wallet address

Options:
  --credits <value>  credits to add (1 credit = $0.01)
  --json <data>      Request body as JSON string
  -h, --help         display help for command

```

## anuma api developer apps users update

```
Usage: anuma api developer apps users update [options] <app-uuid> <address>

Update user limit

Arguments:
  app-uuid           App UUID
  address            User wallet address

Options:
  --credits <value>  credit limit (1 credit = $0.01)
  --json <data>      Request body as JSON string
  -h, --help         display help for command

```

## anuma api embeddings

```
Usage: anuma api embeddings [options] [command]

Create embeddings

Options:
  -h, --help        display help for command

Commands:
  create [options]  Create embeddings
  help [command]    display help for command

```

## anuma api embeddings create

```
Usage: anuma api embeddings create [options]

Create embeddings

Options:
  --dimensions <value>       Dimensions is the number of dimensions the
                             resulting output embeddings should have (optional)
  --encoding-format <value>  EncodingFormat is the format to return the
                             embeddings in (optional: "float" or "base64")
  --input <value>            Input text or tokens to embed (can be string,
                             []string, []int, or [][]int)
  --model <value>            Model identifier in 'provider/model' format
  --json <data>              Request body as JSON string
  -h, --help                 display help for command

```

## anuma api models

```
Usage: anuma api models [options] [command]

List available models

Options:
  -h, --help      display help for command

Commands:
  list [options]  List available models
  help [command]  display help for command

```

## anuma api models list

```
Usage: anuma api models list [options]

List available models

Options:
  --provider <value>    Filter by provider (e.g., openai, anthropic)
  --page-size <value>   Number of models to return per page
  --page-token <value>  Token to get next page of results
  -h, --help            display help for command

```

## anuma api responses

```
Usage: anuma api responses [options] [command]

Create response

Options:
  -h, --help        display help for command

Commands:
  create [options]  Create response
  help [command]    display help for command

```

## anuma api responses create

```
Usage: anuma api responses create [options]

Create response

Options:
  --background <value>         Background indicates if request should be
                               processed in background
  --image-model <value>        ImageModel is the user-selected image generation
                               model.
                               When set, the portal overrides the model field in
                               image tool call arguments.
  --input <value>              input
  --max-output-tokens <value>  MaxOutputTokens is the maximum number of tokens
                               to generate
  --model <value>              Model is the model identifier in 'provider/model'
                               format
  --reasoning <value>          reasoning
  --stream <value>             Stream indicates if response should be streamed
  --temperature <value>        Temperature controls randomness (0.0 to 2.0)
  --thinking <value>           thinking
  --tool-choice <value>        tool_choice
  --tools <value>              Tools is an array of tool schemas describing
                               which tools the model can use
  --json <data>                Request body as JSON string
  -h, --help                   display help for command

```

## anuma api subscriptions

```
Usage: anuma api subscriptions [options] [command]

Manage subscriptions

Options:
  -h, --help                         display help for command

Commands:
  cancel                             Cancel subscription
  cancel-scheduled-downgrade         Cancel scheduled downgrade
  create-checkout-session [options]  Create checkout session
  customer-portal [options]          Create customer portal session
  plans                              List available subscription plans
  renew                              Renew subscription
  schedule-downgrade [options]       Schedule subscription downgrade
  status                             Get subscription status
  upgrade [options]                  Upgrade subscription
  webhook                            Handle Stripe webhook
  help [command]                     display help for command

```

## anuma api subscriptions cancel

```
Usage: anuma api subscriptions cancel [options]

Cancel subscription

Options:
  -h, --help  display help for command

```

## anuma api subscriptions cancel-scheduled-downgrade

```
Usage: anuma api subscriptions cancel-scheduled-downgrade [options]

Cancel scheduled downgrade

Options:
  -h, --help  display help for command

```

## anuma api subscriptions create-checkout-session

```
Usage: anuma api subscriptions create-checkout-session [options]

Create checkout session

Options:
  --cancel-url <value>   cancel_url
  --interval <value>     "month" or "year"
  --price-id <value>     price_id
  --referral <value>     Rewardful referral ID for affiliate tracking
  --success-url <value>  success_url
  --tier <value>         "starter" or "pro"
  --json <data>          Request body as JSON string
  -h, --help             display help for command

```

## anuma api subscriptions customer-portal

```
Usage: anuma api subscriptions customer-portal [options]

Create customer portal session

Options:
  --return-url <value>  return_url
  --json <data>         Request body as JSON string
  -h, --help            display help for command

```

## anuma api subscriptions plans

```
Usage: anuma api subscriptions plans [options]

List available subscription plans

Options:
  -h, --help  display help for command

```

## anuma api subscriptions renew

```
Usage: anuma api subscriptions renew [options]

Renew subscription

Options:
  -h, --help  display help for command

```

## anuma api subscriptions schedule-downgrade

```
Usage: anuma api subscriptions schedule-downgrade [options]

Schedule subscription downgrade

Options:
  --interval <value>  "month" or "year"; defaults to current interval
  --tier <value>      target tier, e.g. "starter"
  --json <data>       Request body as JSON string
  -h, --help          display help for command

```

## anuma api subscriptions status

```
Usage: anuma api subscriptions status [options]

Get subscription status

Options:
  -h, --help  display help for command

```

## anuma api subscriptions upgrade

```
Usage: anuma api subscriptions upgrade [options]

Upgrade subscription

Options:
  --interval <value>  Optional: "month" or "year" (defaults to current)
  --tier <value>      Required: "starter" or "pro"
  --json <data>       Request body as JSON string
  -h, --help          display help for command

```

## anuma api subscriptions webhook

```
Usage: anuma api subscriptions webhook [options]

Handle Stripe webhook

Options:
  -h, --help  display help for command

```

## anuma api tasks

```
Usage: anuma api tasks [options] [command]

Get available tasks

Options:
  -h, --help      display help for command

Commands:
  list            Get available tasks
  help [command]  display help for command

```

## anuma api tasks list

```
Usage: anuma api tasks list [options]

Get available tasks

Options:
  -h, --help  display help for command

```

## anuma api text

```
Usage: anuma api text [options] [command]

Manage text

Options:
  -h, --help                    display help for command

Commands:
  lookup [options] <channel>    Lookup text channel registration by identifier
  register [options] <channel>  Register identifier for text channel
  status <channel>              Get text channel registration status
  unregister <channel>          Unregister text channel
  help [command]                display help for command

```

## anuma api text lookup

```
Usage: anuma api text lookup [options] <channel>

Lookup text channel registration by identifier

Arguments:
  channel               Text channel (sms, telegram)

Options:
  --identifier <value>  Channel identifier (e.g., E.164 phone number for SMS)
  -h, --help            display help for command

```

## anuma api text register

```
Usage: anuma api text register [options] <channel>

Register identifier for text channel

Arguments:
  channel                    Text channel (sms, telegram)

Options:
  --identifier <value>       identifier
  --preferred-model <value>  preferred_model
  --json <data>              Request body as JSON string
  -h, --help                 display help for command

```

## anuma api text status

```
Usage: anuma api text status [options] <channel>

Get text channel registration status

Arguments:
  channel     Text channel (sms, telegram)

Options:
  -h, --help  display help for command

```

## anuma api text unregister

```
Usage: anuma api text unregister [options] <channel>

Unregister text channel

Arguments:
  channel     Text channel (sms, telegram)

Options:
  -h, --help  display help for command

```

## anuma api tools

```
Usage: anuma api tools [options] [command]

List available tools

Options:
  -h, --help      display help for command

Commands:
  list            List available tools
  help [command]  display help for command

```

## anuma api tools list

```
Usage: anuma api tools list [options]

List available tools

Options:
  -h, --help  display help for command

```

## anuma api usage

```
Usage: anuma api usage [options] [command]

Get usage by model

Options:
  -h, --help        display help for command

Commands:
  models [options]  Get usage by model
  help [command]    display help for command

```

## anuma api usage models

```
Usage: anuma api usage models [options]

Get usage by model

Options:
  --start <value>   Start of date range in RFC 3339 format (e.g.
                    2024-01-01T00:00:00Z). Must be used with end. Takes
                    precedence over period.
  --end <value>     End of date range in RFC 3339 format (e.g.
                    2024-01-31T23:59:59Z). Must be used with start. Takes
                    precedence over period.
  --period <value>  Time period. Day aliases: 7d, 30d, 90d, 180d, 365d.
                    Durations: 10m, 30m, 1h, 6h, 12h, 24h, 72h. Default: 30d.
                    Max: 365d.
  -h, --help        display help for command

```

---
Source: https://docs.anuma.ai/conversations

# Conversations

Chat applications need to persist messages and manage history across sessions. The SDK's conversation system handles this automatically — when you send a message, it's saved locally along with the response.

## Persistence

The Portal API is stateless. It processes your request and returns a response, but doesn't remember anything. The SDK bridges this gap by saving everything to a local WatermelonDB database in the browser. Messages survive page refreshes, conversation data never leaves the device unless you explicitly send it, and users control their own data.

Previous messages are included as context automatically when you send new messages, giving the AI awareness of the ongoing discussion. You can configure how many messages to include or disable history entirely for standalone requests.

Conversations can optionally belong to a [project](/sdk/react/Hooks/useProjects), letting users group related chats together.

## Usage

The [`useChatStorage`](/sdk/react/Hooks/useChatStorage) hook handles persistent conversations:

```tsx
const {
  sendMessage,
  conversationId,
  createConversation,
  setConversationId,
  deleteConversation,
  getConversations,
} = useChatStorage({ database, getToken });
```

When you call [`sendMessage`](/sdk/react/Internal/interfaces/UseChatStorageResult#sendmessage), the message is saved to the database first, then sent to the Portal API along with conversation history. The response streams back in real-time, and once complete, it's saved locally. If the user cancels mid-stream, partial responses are still preserved.

The [Chat with Storage](/tutorials/nextjs/conversations) tutorial walks through a complete implementation.

For simple one-off completions without persistence, use [`useChat`](/sdk/react/Hooks/useChat) instead.

---
Source: https://docs.anuma.ai/files

# Files and Images

Language models work with text, but users want to share documents and images. The SDK bridges this gap by automatically extracting text from files before sending them as context.

## Document Processing

The SDK extracts text from PDF (all pages), Word documents (raw text), Excel spreadsheets (structured JSON with sheet names), and ZIP archives (recursively processing files inside). Processing happens automatically when you attach files to a message. The extracted text is sent as context to the model, while original metadata is preserved for your UI.

For more control over individual file types, see [`usePdf`](/sdk/react/Hooks/usePdf) and [`useOCR`](/sdk/react/Hooks/useOCR). To manage file attachments directly, use [`useFiles`](/sdk/react/Hooks/useFiles).

## Images

Images are sent directly to vision models without text extraction. Models can identify objects, read text in images, understand charts, and answer questions about visual content. If you need text extracted from images specifically, use the OCR utility separately.

## With Chat

[`useChatStorage`](/sdk/react/Hooks/useChatStorage) handles file processing automatically when you send messages with attachments. You can configure processing behavior:

```tsx
const { sendMessage } = useChatStorage({
  database,
  getToken,
  fileProcessingOptions: {
    maxFileSizeBytes: 10 * 1024 * 1024, // 10MB
    keepOriginalFiles: true,
    onProgress: (current, total) => setProgress(current / total),
  },
});
```

## Generated Content

When models generate images through the image generation tool, the SDK downloads them automatically, stores them encrypted locally, and persists them in conversation history. Temporary API URLs are replaced with permanent local storage, so images remain available even after the original URLs expire.

---
Source: https://docs.anuma.ai/memory

# Memory

Users expect AI to remember what they've talked about before. Anuma provides two complementary memory systems that work as client-side tools the model can call during conversation.

The [memory engine](/memory/engine) searches past conversations using semantic similarity. Your messages are the memory — no separate extraction step needed. When the model needs to recall something, it searches stored messages and returns the closest matches, even if they use different words than the original conversation.

The [memory vault](/memory/vault) stores curated facts the model saves on behalf of the user — things like names, preferences, and project requirements. Unlike the engine, which treats every message as potential memory, the vault contains only information that was deliberately captured.

Both systems are built into [`useChatStorage`](/sdk/react/Hooks/useChatStorage) and use the same embedding infrastructure for semantic search.

---
Source: https://docs.anuma.ai/memory/engine

# Memory Engine

A chat that forgets everything between sessions isn't very useful. Users expect the AI to remember what they've talked about before — their preferences, past questions, and ongoing projects. The memory engine searches past conversations using semantic similarity, so the model can recall relevant context without you building a separate memory system.

## How It Works

The memory engine doesn't require a separate extraction step — your conversation messages are the memory. When [`useChatStorage`](/sdk/react/Hooks/useChatStorage) saves a message, it automatically generates an embedding vector and stores it alongside the text. Long messages are split into overlapping [chunks](/sdk/react/Internal/interfaces/TextChunk) first (default 400 characters with 50 character overlap), so search can match against specific parts of a message rather than the whole thing. Messages shorter than the minimum content length are skipped.

When the model needs to recall something, it calls the [`search_memory`](/sdk/react/Internal/functions/createMemoryEngineTool) tool with a natural language query. The engine embeds that query, compares it against all stored chunk and message embeddings using cosine similarity, and returns the closest matches — even if they use different words than the original conversation.

## Setup

Embedding generation is enabled by default in [`useChatStorage`](/sdk/react/Hooks/useChatStorage). Messages are embedded automatically after saving, and chunking happens transparently for longer messages.

```tsx
const { sendMessage, createMemoryEngineTool } = useChatStorage({
  database,
  getToken,
  autoEmbedMessages: true, // default
});
```

To give the model access to memory, create the engine tool and pass it as a client tool when sending messages:

```tsx
const memoryTool = createMemoryEngineTool({ limit: 5 });

await sendMessage({
  content: "What were we discussing last week?",
  clientTools: [memoryTool],
});
```

The model decides when to use the tool. If the user asks something that might benefit from past context, the model calls it, gets relevant chunks back, and weaves that information into its response. If the question is self-contained, it skips the tool entirely.

## Search Options

You can configure search behavior through [`MemoryEngineSearchOptions`](/sdk/react/Internal/interfaces/MemoryEngineSearchOptions):

```tsx
const memoryTool = createMemoryEngineTool({
  limit: 5,
  minSimilarity: 0.4,
  excludeConversationId: conversationId,
  includeAssistant: true,
  sortBy: "chronological",
});
```

`limit` controls how many results come back (default 8). `minSimilarity` sets a threshold between 0 and 1 for how closely a stored chunk must match the query (default 0.3). `excludeConversationId` filters out the current conversation so the model doesn't "remember" things already in its context window. By default only user messages are searched; set `includeAssistant` to `true` to also match against assistant responses. Results can be sorted by `similarity` (most relevant first, the default) or `chronological` (oldest first).

---
Source: https://docs.anuma.ai/memory/vault

# Memory Vault

The memory engine searches past conversations, but some things are worth remembering more explicitly — a user's name, their timezone, dietary preferences, or project requirements. The memory vault is a persistent store for curated facts that the model saves on behalf of the user. Unlike the engine, which treats every message as potential memory, the vault contains only information that was deliberately captured.

## How It Works

The vault operates through two client-side tools that the model can call during conversation:

[`memory_vault_save`](/sdk/react/Internal/functions/createMemoryVaultTool) creates or updates a vault entry. When the model notices the user sharing something worth remembering ("I'm vegetarian" or "my budget is $5000"), it calls this tool to persist that fact. If an entry already exists on the same topic, the model updates it rather than creating a duplicate — keeping the vault compact with one entry per topic.

[`memory_vault_search`](/sdk/react/Internal/functions/createMemoryVaultSearchTool) queries the vault using semantic similarity, just like the memory engine searches conversations. The model calls this when the user asks something that might relate to a stored fact, or before saving a new entry to check for duplicates. Results come back as [`VaultSearchResult`](/sdk/react/Internal/interfaces/VaultSearchResult) objects with IDs that the model can reference for updates.

Both tools are powered by the same embedding infrastructure as the engine. Vault entries are embedded when saved, cached in an LRU cache for fast search, and compared against queries using cosine similarity.

## Setup

The vault tools are created through [`useChatStorage`](/sdk/react/Hooks/useChatStorage), which sets up the database context, authentication, and embedding cache automatically.

```tsx
const {
  sendMessage,
  createMemoryVaultTool,
  createMemoryVaultSearchTool,
} = useChatStorage({
  database,
  getToken,
});
```

Pass both tools as client tools when sending messages:

```tsx
const saveTool = createMemoryVaultTool({
  onSave: async (operation) => {
    // Show a confirmation UI, return true to proceed
    return await confirmWithUser(operation);
  },
});

const searchTool = createMemoryVaultSearchTool({
  limit: 5,
  minSimilarity: 0.1,
});

await sendMessage({
  content: "Remember that I prefer dark mode.",
  clientTools: [saveTool, searchTool],
});
```

The model handles the workflow end to end. When something is worth saving, it first searches for an existing entry on the topic, then either creates a new entry or updates the existing one with merged information.

## Save Confirmation

The `onSave` callback in [`MemoryVaultToolOptions`](/sdk/react/Internal/interfaces/MemoryVaultToolOptions) lets you intercept every save before it happens. The callback receives a [`VaultSaveOperation`](/sdk/react/Internal/interfaces/VaultSaveOperation) describing what's about to change — whether it's a new entry or an update, the content, and for updates, the previous content so you can show a diff. Return `true` to confirm or `false` to cancel.

```tsx
const saveTool = createMemoryVaultTool({
  onSave: async (operation) => {
    if (operation.action === "update") {
      console.log(`Updating: "${operation.previousContent}" → "${operation.content}"`);
    } else {
      console.log(`Saving: "${operation.content}"`);
    }
    return true;
  },
});
```

When no `onSave` callback is provided, saves require manual approval through the host app's `onToolCall` handler instead.

## Search Options

Search behavior is configured through [`MemoryVaultSearchOptions`](/sdk/react/Internal/interfaces/MemoryVaultSearchOptions). The `limit` parameter sets the maximum number of results (default 5), and `minSimilarity` controls the minimum cosine similarity threshold (default 0.1). The vault uses a lower default threshold than the engine because vault entries are typically short and precise, so even lower similarity scores can be meaningful. You can also filter by `scopes` to search only specific partitions.

```tsx
const searchTool = createMemoryVaultSearchTool({
  limit: 10,
  minSimilarity: 0.2,
  scopes: ["private"],
});
```

Vault entries are pre-embedded when the hook initializes, so search only needs to embed the query — not re-embed every vault entry on each call. When a new entry is saved, it's eagerly embedded and added to the cache so it's immediately searchable.

## Managing Vault Entries

Beyond the LLM tools, `useChatStorage` exposes methods for building a settings UI where users can view, edit, and delete their stored memories directly. Each memory is a [`StoredVaultMemory`](/sdk/react/Internal/interfaces/StoredVaultMemory) with a `scope` field (defaulting to "private") that can partition entries — for example, separating personal preferences from shared project context.

```tsx
const {
  getVaultMemories,
  createVaultMemory,
  updateVaultMemory,
  deleteVaultMemory,
} = useChatStorage({ database, getToken });

// List all memories
const memories = await getVaultMemories();

// Create manually
await createVaultMemory("Prefers dark mode");

// Update
await updateVaultMemory(memory.uniqueId, "Prefers dark mode with blue accent");

// Delete (soft delete)
await deleteVaultMemory(memory.uniqueId);
```

---
Source: https://docs.anuma.ai/models/list

# Models List

This is a complete list of models available through the Portal API.

---
Source: https://docs.anuma.ai/models/overview

# Models

One of the main advantages of building with Anuma is access to models from OpenAI, Google, Anthropic, xAI, and open-source providers through a single API. You specify the model per request, so you can use a lightweight model for simple tasks and a reasoning model for complex ones — without changing any integration code.

Models span different capabilities: text generation, vision (image understanding), reasoning (extended thinking), image generation, code generation, and audio processing. Many models combine multiple capabilities — for example, GPT-4o and Claude handle both text and vision in one model.

To specify a model, pass its identifier when calling [`sendMessage`](/sdk/react/Internal/interfaces/UseChatStorageResult#sendmessage):

```tsx
await sendMessage({
  content: "Explain quantum computing",
  model: "gpt-4o-mini",
});
```

To fetch the list of available models at runtime, use [`useModels`](/sdk/react/Hooks/useModels). This returns the current models from the Portal API, so your app always reflects what's available without hardcoding model names.

See the [full list of available models](/models/list).

---
Source: https://docs.anuma.ai/sdk

# Anuma SDK

A TypeScript SDK for building AI-powered applications with streaming chat
completions, long-term memory, tool calling, and end-to-end encryption.

To learn more, check out the [Documentation](https://docs.anuma.ai/).

## Installation

```bash
npm install @anuma/sdk@next
```

## Getting Started

Create an app on the [Anuma Dashboard](https://dashboard.anuma.ai/) to get your
API key or configure Privy authentication.

## Usage

### React Hooks

```tsx
import { useChat } from "@anuma/sdk/react";

const { sendMessage, isLoading, stop } = useChat({
  getToken: async () => token,
  onData: (chunk) => console.log(chunk),
});

await sendMessage({
  messages: [{ role: "user", content: [{ type: "text", text: "Hello!" }] }],
  model: "fireworks/accounts/fireworks/models/kimi-k2p5",
});
```

### API Functions

```ts
import { postApiV1Responses } from "@anuma/sdk/client";

const response = await postApiV1Responses({
  body: {
    messages: [
      { role: "user", content: [{ type: "text", text: "Hello!" }] },
    ],
    model: "fireworks/accounts/fireworks/models/kimi-k2p5",
  },
  headers: {
    Authorization: `Bearer ${apiKey}`,
  },
});
```

### Platforms

The SDK provides entry points for different platforms:

* `@anuma/sdk/react` — React hooks
* `@anuma/sdk/expo` — React Native / Expo
* `@anuma/sdk/client` — Generated API client and types

## Features

The SDK gives you access to a unified API across multiple LLM providers through
a single integration. Key capabilities include:

* Streaming chat completions with tool calling and auto-execution
* Extended thinking and reasoning support
* Long-term memory with semantic search and encrypted storage
* Voice recording and transcription via Whisper
* PDF and image text extraction (OCR)
* Phone call integration
* End-to-end encryption with wallet-based key management
* Credit and subscription management

## Documentation

https://docs.anuma.ai/

## Contributing

Contributions are welcome. Please open an issue or pull request on
[GitHub](https://github.com/anuma-ai/sdk).

## Modules

| Module | Description |
| ------ | ------ |
| [client](client/index.md) | - |
| [expo](expo/index.md) | React Native hooks for building AI-powered mobile applications. |
| [next](next/index.md) | Next.js configuration plugin for @anuma/sdk |
| [react](react/index.md) | The `@anuma/sdk/react` package provides a collection of React hooks designed to simplify building AI features in your applications. These hooks abstract away the complexity of managing streaming responses, loading states, authentication, and real-time updates, letting you focus on creating great user experiences. |
| [vercel](vercel/index.md) | Helper utilities for integrating the `useChat` hook and [Vercel AI Elements](https://ai-sdk.dev/elements). |

---
Source: https://docs.anuma.ai/sdk/client

# Overview

## Type Aliases

| Type Alias | Description |
| ------ | ------ |
| [AuthJwk](Internal/type-aliases/AuthJwk.md) | - |
| [AuthJwks](Internal/type-aliases/AuthJwks.md) | - |
| [ClientOptions](Internal/type-aliases/ClientOptions.md) | - |
| [ConfigCompactLists](Internal/type-aliases/ConfigCompactLists.md) | - |
| [ConfigCuratedModel](Internal/type-aliases/ConfigCuratedModel.md) | - |
| [ConfigCuratedModelsResponse](Internal/type-aliases/ConfigCuratedModelsResponse.md) | - |
| [DeleteApiV1AccountData](Internal/type-aliases/DeleteApiV1AccountData.md) | - |
| [DeleteApiV1AccountError](Internal/type-aliases/DeleteApiV1AccountError.md) | - |
| [DeleteApiV1AccountErrors](Internal/type-aliases/DeleteApiV1AccountErrors.md) | - |
| [DeleteApiV1AccountResponse](Internal/type-aliases/DeleteApiV1AccountResponse.md) | - |
| [DeleteApiV1AccountResponses](Internal/type-aliases/DeleteApiV1AccountResponses.md) | - |
| [DeleteApiV1AdminAgentsByIdData](Internal/type-aliases/DeleteApiV1AdminAgentsByIdData.md) | - |
| [DeleteApiV1AdminAgentsByIdError](Internal/type-aliases/DeleteApiV1AdminAgentsByIdError.md) | - |
| [DeleteApiV1AdminAgentsByIdErrors](Internal/type-aliases/DeleteApiV1AdminAgentsByIdErrors.md) | - |
| [DeleteApiV1AdminAgentsByIdResponse](Internal/type-aliases/DeleteApiV1AdminAgentsByIdResponse.md) | - |
| [DeleteApiV1AdminAgentsByIdResponses](Internal/type-aliases/DeleteApiV1AdminAgentsByIdResponses.md) | - |
| [DeleteApiV1AdminAppsByAppIdApiKeysByIdData](Internal/type-aliases/DeleteApiV1AdminAppsByAppIdApiKeysByIdData.md) | - |
| [DeleteApiV1AdminAppsByAppIdApiKeysByIdError](Internal/type-aliases/DeleteApiV1AdminAppsByAppIdApiKeysByIdError.md) | - |
| [DeleteApiV1AdminAppsByAppIdApiKeysByIdErrors](Internal/type-aliases/DeleteApiV1AdminAppsByAppIdApiKeysByIdErrors.md) | - |
| [DeleteApiV1AdminAppsByAppIdApiKeysByIdResponse](Internal/type-aliases/DeleteApiV1AdminAppsByAppIdApiKeysByIdResponse.md) | - |
| [DeleteApiV1AdminAppsByAppIdApiKeysByIdResponses](Internal/type-aliases/DeleteApiV1AdminAppsByAppIdApiKeysByIdResponses.md) | - |
| [DeleteApiV1AdminAppsByIdData](Internal/type-aliases/DeleteApiV1AdminAppsByIdData.md) | - |
| [DeleteApiV1AdminAppsByIdError](Internal/type-aliases/DeleteApiV1AdminAppsByIdError.md) | - |
| [DeleteApiV1AdminAppsByIdErrors](Internal/type-aliases/DeleteApiV1AdminAppsByIdErrors.md) | - |
| [DeleteApiV1AdminAppsByIdResponse](Internal/type-aliases/DeleteApiV1AdminAppsByIdResponse.md) | - |
| [DeleteApiV1AdminAppsByIdResponses](Internal/type-aliases/DeleteApiV1AdminAppsByIdResponses.md) | - |
| [DeleteApiV1AdminOauthClientsByClientIdData](Internal/type-aliases/DeleteApiV1AdminOauthClientsByClientIdData.md) | - |
| [DeleteApiV1AdminOauthClientsByClientIdError](Internal/type-aliases/DeleteApiV1AdminOauthClientsByClientIdError.md) | - |
| [DeleteApiV1AdminOauthClientsByClientIdErrors](Internal/type-aliases/DeleteApiV1AdminOauthClientsByClientIdErrors.md) | - |
| [DeleteApiV1AdminOauthClientsByClientIdResponse](Internal/type-aliases/DeleteApiV1AdminOauthClientsByClientIdResponse.md) | - |
| [DeleteApiV1AdminOauthClientsByClientIdResponses](Internal/type-aliases/DeleteApiV1AdminOauthClientsByClientIdResponses.md) | - |
| [DeleteApiV1AdminPersonasByIdData](Internal/type-aliases/DeleteApiV1AdminPersonasByIdData.md) | - |
| [DeleteApiV1AdminPersonasByIdError](Internal/type-aliases/DeleteApiV1AdminPersonasByIdError.md) | - |
| [DeleteApiV1AdminPersonasByIdErrors](Internal/type-aliases/DeleteApiV1AdminPersonasByIdErrors.md) | - |
| [DeleteApiV1AdminPersonasByIdResponse](Internal/type-aliases/DeleteApiV1AdminPersonasByIdResponse.md) | - |
| [DeleteApiV1AdminPersonasByIdResponses](Internal/type-aliases/DeleteApiV1AdminPersonasByIdResponses.md) | - |
| [DeleteApiV1AdminTextResetData](Internal/type-aliases/DeleteApiV1AdminTextResetData.md) | - |
| [DeleteApiV1AdminTextResetError](Internal/type-aliases/DeleteApiV1AdminTextResetError.md) | - |
| [DeleteApiV1AdminTextResetErrors](Internal/type-aliases/DeleteApiV1AdminTextResetErrors.md) | - |
| [DeleteApiV1AdminTextResetResponse](Internal/type-aliases/DeleteApiV1AdminTextResetResponse.md) | - |
| [DeleteApiV1AdminTextResetResponses](Internal/type-aliases/DeleteApiV1AdminTextResetResponses.md) | - |
| [DeleteApiV1AdminUsersDeleteData](Internal/type-aliases/DeleteApiV1AdminUsersDeleteData.md) | - |
| [DeleteApiV1AdminUsersDeleteError](Internal/type-aliases/DeleteApiV1AdminUsersDeleteError.md) | - |
| [DeleteApiV1AdminUsersDeleteErrors](Internal/type-aliases/DeleteApiV1AdminUsersDeleteErrors.md) | - |
| [DeleteApiV1AdminUsersDeleteResponse](Internal/type-aliases/DeleteApiV1AdminUsersDeleteResponse.md) | - |
| [DeleteApiV1AdminUsersDeleteResponses](Internal/type-aliases/DeleteApiV1AdminUsersDeleteResponses.md) | - |
| [DeleteApiV1AuthMfaPasskeyCredentialsByCredentialIdData](Internal/type-aliases/DeleteApiV1AuthMfaPasskeyCredentialsByCredentialIdData.md) | - |
| [DeleteApiV1AuthMfaPasskeyCredentialsByCredentialIdError](Internal/type-aliases/DeleteApiV1AuthMfaPasskeyCredentialsByCredentialIdError.md) | - |
| [DeleteApiV1AuthMfaPasskeyCredentialsByCredentialIdErrors](Internal/type-aliases/DeleteApiV1AuthMfaPasskeyCredentialsByCredentialIdErrors.md) | - |
| [DeleteApiV1AuthMfaPasskeyCredentialsByCredentialIdResponse](Internal/type-aliases/DeleteApiV1AuthMfaPasskeyCredentialsByCredentialIdResponse.md) | - |
| [DeleteApiV1AuthMfaPasskeyCredentialsByCredentialIdResponses](Internal/type-aliases/DeleteApiV1AuthMfaPasskeyCredentialsByCredentialIdResponses.md) | - |
| [DeleteApiV1DeveloperAppsByAppUuidApiKeysByKeyIdData](Internal/type-aliases/DeleteApiV1DeveloperAppsByAppUuidApiKeysByKeyIdData.md) | - |
| [DeleteApiV1DeveloperAppsByAppUuidApiKeysByKeyIdError](Internal/type-aliases/DeleteApiV1DeveloperAppsByAppUuidApiKeysByKeyIdError.md) | - |
| [DeleteApiV1DeveloperAppsByAppUuidApiKeysByKeyIdErrors](Internal/type-aliases/DeleteApiV1DeveloperAppsByAppUuidApiKeysByKeyIdErrors.md) | - |
| [DeleteApiV1DeveloperAppsByAppUuidApiKeysByKeyIdResponse](Internal/type-aliases/DeleteApiV1DeveloperAppsByAppUuidApiKeysByKeyIdResponse.md) | - |
| [DeleteApiV1DeveloperAppsByAppUuidApiKeysByKeyIdResponses](Internal/type-aliases/DeleteApiV1DeveloperAppsByAppUuidApiKeysByKeyIdResponses.md) | - |
| [DeleteApiV1DeveloperAppsByAppUuidData](Internal/type-aliases/DeleteApiV1DeveloperAppsByAppUuidData.md) | - |
| [DeleteApiV1DeveloperAppsByAppUuidError](Internal/type-aliases/DeleteApiV1DeveloperAppsByAppUuidError.md) | - |
| [DeleteApiV1DeveloperAppsByAppUuidErrors](Internal/type-aliases/DeleteApiV1DeveloperAppsByAppUuidErrors.md) | - |
| [DeleteApiV1DeveloperAppsByAppUuidPrivyData](Internal/type-aliases/DeleteApiV1DeveloperAppsByAppUuidPrivyData.md) | - |
| [DeleteApiV1DeveloperAppsByAppUuidPrivyError](Internal/type-aliases/DeleteApiV1DeveloperAppsByAppUuidPrivyError.md) | - |
| [DeleteApiV1DeveloperAppsByAppUuidPrivyErrors](Internal/type-aliases/DeleteApiV1DeveloperAppsByAppUuidPrivyErrors.md) | - |
| [DeleteApiV1DeveloperAppsByAppUuidPrivyResponse](Internal/type-aliases/DeleteApiV1DeveloperAppsByAppUuidPrivyResponse.md) | - |
| [DeleteApiV1DeveloperAppsByAppUuidPrivyResponses](Internal/type-aliases/DeleteApiV1DeveloperAppsByAppUuidPrivyResponses.md) | - |
| [DeleteApiV1DeveloperAppsByAppUuidResponse](Internal/type-aliases/DeleteApiV1DeveloperAppsByAppUuidResponse.md) | - |
| [DeleteApiV1DeveloperAppsByAppUuidResponses](Internal/type-aliases/DeleteApiV1DeveloperAppsByAppUuidResponses.md) | - |
| [DeleteApiV1TextByChannelUnregisterData](Internal/type-aliases/DeleteApiV1TextByChannelUnregisterData.md) | - |
| [DeleteApiV1TextByChannelUnregisterError](Internal/type-aliases/DeleteApiV1TextByChannelUnregisterError.md) | - |
| [DeleteApiV1TextByChannelUnregisterErrors](Internal/type-aliases/DeleteApiV1TextByChannelUnregisterErrors.md) | - |
| [DeleteApiV1TextByChannelUnregisterResponse](Internal/type-aliases/DeleteApiV1TextByChannelUnregisterResponse.md) | - |
| [DeleteApiV1TextByChannelUnregisterResponses](Internal/type-aliases/DeleteApiV1TextByChannelUnregisterResponses.md) | - |
| [DeleteApiV1UserApiKeysByKeyIdData](Internal/type-aliases/DeleteApiV1UserApiKeysByKeyIdData.md) | - |
| [DeleteApiV1UserApiKeysByKeyIdError](Internal/type-aliases/DeleteApiV1UserApiKeysByKeyIdError.md) | - |
| [DeleteApiV1UserApiKeysByKeyIdErrors](Internal/type-aliases/DeleteApiV1UserApiKeysByKeyIdErrors.md) | - |
| [DeleteApiV1UserApiKeysByKeyIdResponse](Internal/type-aliases/DeleteApiV1UserApiKeysByKeyIdResponse.md) | - |
| [DeleteApiV1UserApiKeysByKeyIdResponses](Internal/type-aliases/DeleteApiV1UserApiKeysByKeyIdResponses.md) | - |
| [DeleteApiV1UserOauthGrantsByIdData](Internal/type-aliases/DeleteApiV1UserOauthGrantsByIdData.md) | - |
| [DeleteApiV1UserOauthGrantsByIdError](Internal/type-aliases/DeleteApiV1UserOauthGrantsByIdError.md) | - |
| [DeleteApiV1UserOauthGrantsByIdErrors](Internal/type-aliases/DeleteApiV1UserOauthGrantsByIdErrors.md) | - |
| [DeleteApiV1UserOauthGrantsByIdResponse](Internal/type-aliases/DeleteApiV1UserOauthGrantsByIdResponse.md) | - |
| [DeleteApiV1UserOauthGrantsByIdResponses](Internal/type-aliases/DeleteApiV1UserOauthGrantsByIdResponses.md) | - |
| [GetApiV1AdminAppsByAppIdApiKeysByIdData](Internal/type-aliases/GetApiV1AdminAppsByAppIdApiKeysByIdData.md) | - |
| [GetApiV1AdminAppsByAppIdApiKeysByIdError](Internal/type-aliases/GetApiV1AdminAppsByAppIdApiKeysByIdError.md) | - |
| [GetApiV1AdminAppsByAppIdApiKeysByIdErrors](Internal/type-aliases/GetApiV1AdminAppsByAppIdApiKeysByIdErrors.md) | - |
| [GetApiV1AdminAppsByAppIdApiKeysByIdResponse](Internal/type-aliases/GetApiV1AdminAppsByAppIdApiKeysByIdResponse.md) | - |
| [GetApiV1AdminAppsByAppIdApiKeysByIdResponses](Internal/type-aliases/GetApiV1AdminAppsByAppIdApiKeysByIdResponses.md) | - |
| [GetApiV1AdminAppsByAppIdApiKeysData](Internal/type-aliases/GetApiV1AdminAppsByAppIdApiKeysData.md) | - |
| [GetApiV1AdminAppsByAppIdApiKeysError](Internal/type-aliases/GetApiV1AdminAppsByAppIdApiKeysError.md) | - |
| [GetApiV1AdminAppsByAppIdApiKeysErrors](Internal/type-aliases/GetApiV1AdminAppsByAppIdApiKeysErrors.md) | - |
| [GetApiV1AdminAppsByAppIdApiKeysResponse](Internal/type-aliases/GetApiV1AdminAppsByAppIdApiKeysResponse.md) | - |
| [GetApiV1AdminAppsByAppIdApiKeysResponses](Internal/type-aliases/GetApiV1AdminAppsByAppIdApiKeysResponses.md) | - |
| [GetApiV1AdminAppsByIdData](Internal/type-aliases/GetApiV1AdminAppsByIdData.md) | - |
| [GetApiV1AdminAppsByIdError](Internal/type-aliases/GetApiV1AdminAppsByIdError.md) | - |
| [GetApiV1AdminAppsByIdErrors](Internal/type-aliases/GetApiV1AdminAppsByIdErrors.md) | - |
| [GetApiV1AdminAppsByIdResponse](Internal/type-aliases/GetApiV1AdminAppsByIdResponse.md) | - |
| [GetApiV1AdminAppsByIdResponses](Internal/type-aliases/GetApiV1AdminAppsByIdResponses.md) | - |
| [GetApiV1AdminAppsData](Internal/type-aliases/GetApiV1AdminAppsData.md) | - |
| [GetApiV1AdminAppsError](Internal/type-aliases/GetApiV1AdminAppsError.md) | - |
| [GetApiV1AdminAppsErrors](Internal/type-aliases/GetApiV1AdminAppsErrors.md) | - |
| [GetApiV1AdminAppsResponse](Internal/type-aliases/GetApiV1AdminAppsResponse.md) | - |
| [GetApiV1AdminAppsResponses](Internal/type-aliases/GetApiV1AdminAppsResponses.md) | - |
| [GetApiV1AdminOauthClientsByClientIdData](Internal/type-aliases/GetApiV1AdminOauthClientsByClientIdData.md) | - |
| [GetApiV1AdminOauthClientsByClientIdError](Internal/type-aliases/GetApiV1AdminOauthClientsByClientIdError.md) | - |
| [GetApiV1AdminOauthClientsByClientIdErrors](Internal/type-aliases/GetApiV1AdminOauthClientsByClientIdErrors.md) | - |
| [GetApiV1AdminOauthClientsByClientIdResponse](Internal/type-aliases/GetApiV1AdminOauthClientsByClientIdResponse.md) | - |
| [GetApiV1AdminOauthClientsByClientIdResponses](Internal/type-aliases/GetApiV1AdminOauthClientsByClientIdResponses.md) | - |
| [GetApiV1AdminOauthClientsData](Internal/type-aliases/GetApiV1AdminOauthClientsData.md) | - |
| [GetApiV1AdminOauthClientsResponse](Internal/type-aliases/GetApiV1AdminOauthClientsResponse.md) | - |
| [GetApiV1AdminOauthClientsResponses](Internal/type-aliases/GetApiV1AdminOauthClientsResponses.md) | - |
| [GetApiV1AdminPrivyIdentifiersAuditData](Internal/type-aliases/GetApiV1AdminPrivyIdentifiersAuditData.md) | - |
| [GetApiV1AdminPrivyIdentifiersAuditError](Internal/type-aliases/GetApiV1AdminPrivyIdentifiersAuditError.md) | - |
| [GetApiV1AdminPrivyIdentifiersAuditErrors](Internal/type-aliases/GetApiV1AdminPrivyIdentifiersAuditErrors.md) | - |
| [GetApiV1AdminPrivyIdentifiersAuditResponse](Internal/type-aliases/GetApiV1AdminPrivyIdentifiersAuditResponse.md) | - |
| [GetApiV1AdminPrivyIdentifiersAuditResponses](Internal/type-aliases/GetApiV1AdminPrivyIdentifiersAuditResponses.md) | - |
| [GetApiV1AdminUsersLookupData](Internal/type-aliases/GetApiV1AdminUsersLookupData.md) | - |
| [GetApiV1AdminUsersLookupError](Internal/type-aliases/GetApiV1AdminUsersLookupError.md) | - |
| [GetApiV1AdminUsersLookupErrors](Internal/type-aliases/GetApiV1AdminUsersLookupErrors.md) | - |
| [GetApiV1AdminUsersLookupResponse](Internal/type-aliases/GetApiV1AdminUsersLookupResponse.md) | - |
| [GetApiV1AdminUsersLookupResponses](Internal/type-aliases/GetApiV1AdminUsersLookupResponses.md) | - |
| [GetApiV1AgentPreferencesData](Internal/type-aliases/GetApiV1AgentPreferencesData.md) | - |
| [GetApiV1AgentPreferencesError](Internal/type-aliases/GetApiV1AgentPreferencesError.md) | - |
| [GetApiV1AgentPreferencesErrors](Internal/type-aliases/GetApiV1AgentPreferencesErrors.md) | - |
| [GetApiV1AgentPreferencesResponse](Internal/type-aliases/GetApiV1AgentPreferencesResponse.md) | - |
| [GetApiV1AgentPreferencesResponses](Internal/type-aliases/GetApiV1AgentPreferencesResponses.md) | - |
| [GetApiV1AgentsByIdData](Internal/type-aliases/GetApiV1AgentsByIdData.md) | - |
| [GetApiV1AgentsByIdError](Internal/type-aliases/GetApiV1AgentsByIdError.md) | - |
| [GetApiV1AgentsByIdErrors](Internal/type-aliases/GetApiV1AgentsByIdErrors.md) | - |
| [GetApiV1AgentsByIdResponse](Internal/type-aliases/GetApiV1AgentsByIdResponse.md) | - |
| [GetApiV1AgentsByIdResponses](Internal/type-aliases/GetApiV1AgentsByIdResponses.md) | - |
| [GetApiV1AgentsData](Internal/type-aliases/GetApiV1AgentsData.md) | - |
| [GetApiV1AgentsError](Internal/type-aliases/GetApiV1AgentsError.md) | - |
| [GetApiV1AgentsErrors](Internal/type-aliases/GetApiV1AgentsErrors.md) | - |
| [GetApiV1AgentsResponse](Internal/type-aliases/GetApiV1AgentsResponse.md) | - |
| [GetApiV1AgentsResponses](Internal/type-aliases/GetApiV1AgentsResponses.md) | - |
| [GetApiV1AuthMfaStatusData](Internal/type-aliases/GetApiV1AuthMfaStatusData.md) | - |
| [GetApiV1AuthMfaStatusError](Internal/type-aliases/GetApiV1AuthMfaStatusError.md) | - |
| [GetApiV1AuthMfaStatusErrors](Internal/type-aliases/GetApiV1AuthMfaStatusErrors.md) | - |
| [GetApiV1AuthMfaStatusResponse](Internal/type-aliases/GetApiV1AuthMfaStatusResponse.md) | - |
| [GetApiV1AuthMfaStatusResponses](Internal/type-aliases/GetApiV1AuthMfaStatusResponses.md) | - |
| [GetApiV1BootstrapData](Internal/type-aliases/GetApiV1BootstrapData.md) | - |
| [GetApiV1BootstrapError](Internal/type-aliases/GetApiV1BootstrapError.md) | - |
| [GetApiV1BootstrapErrors](Internal/type-aliases/GetApiV1BootstrapErrors.md) | - |
| [GetApiV1BootstrapResponse](Internal/type-aliases/GetApiV1BootstrapResponse.md) | - |
| [GetApiV1BootstrapResponses](Internal/type-aliases/GetApiV1BootstrapResponses.md) | - |
| [GetApiV1ConfigData](Internal/type-aliases/GetApiV1ConfigData.md) | - |
| [GetApiV1ConfigError](Internal/type-aliases/GetApiV1ConfigError.md) | - |
| [GetApiV1ConfigErrors](Internal/type-aliases/GetApiV1ConfigErrors.md) | - |
| [GetApiV1ConfigResponse](Internal/type-aliases/GetApiV1ConfigResponse.md) | - |
| [GetApiV1ConfigResponses](Internal/type-aliases/GetApiV1ConfigResponses.md) | - |
| [GetApiV1CreditsBalanceData](Internal/type-aliases/GetApiV1CreditsBalanceData.md) | - |
| [GetApiV1CreditsBalanceError](Internal/type-aliases/GetApiV1CreditsBalanceError.md) | - |
| [GetApiV1CreditsBalanceErrors](Internal/type-aliases/GetApiV1CreditsBalanceErrors.md) | - |
| [GetApiV1CreditsBalanceResponse](Internal/type-aliases/GetApiV1CreditsBalanceResponse.md) | - |
| [GetApiV1CreditsBalanceResponses](Internal/type-aliases/GetApiV1CreditsBalanceResponses.md) | - |
| [GetApiV1CreditsPacksData](Internal/type-aliases/GetApiV1CreditsPacksData.md) | - |
| [GetApiV1CreditsPacksError](Internal/type-aliases/GetApiV1CreditsPacksError.md) | - |
| [GetApiV1CreditsPacksErrors](Internal/type-aliases/GetApiV1CreditsPacksErrors.md) | - |
| [GetApiV1CreditsPacksResponse](Internal/type-aliases/GetApiV1CreditsPacksResponse.md) | - |
| [GetApiV1CreditsPacksResponses](Internal/type-aliases/GetApiV1CreditsPacksResponses.md) | - |
| [GetApiV1CuratedModelsData](Internal/type-aliases/GetApiV1CuratedModelsData.md) | - |
| [GetApiV1CuratedModelsResponse](Internal/type-aliases/GetApiV1CuratedModelsResponse.md) | - |
| [GetApiV1CuratedModelsResponses](Internal/type-aliases/GetApiV1CuratedModelsResponses.md) | - |
| [GetApiV1DeveloperAppsByAppUuidApiKeysData](Internal/type-aliases/GetApiV1DeveloperAppsByAppUuidApiKeysData.md) | - |
| [GetApiV1DeveloperAppsByAppUuidApiKeysError](Internal/type-aliases/GetApiV1DeveloperAppsByAppUuidApiKeysError.md) | - |
| [GetApiV1DeveloperAppsByAppUuidApiKeysErrors](Internal/type-aliases/GetApiV1DeveloperAppsByAppUuidApiKeysErrors.md) | - |
| [GetApiV1DeveloperAppsByAppUuidApiKeysResponse](Internal/type-aliases/GetApiV1DeveloperAppsByAppUuidApiKeysResponse.md) | - |
| [GetApiV1DeveloperAppsByAppUuidApiKeysResponses](Internal/type-aliases/GetApiV1DeveloperAppsByAppUuidApiKeysResponses.md) | - |
| [GetApiV1DeveloperAppsByAppUuidData](Internal/type-aliases/GetApiV1DeveloperAppsByAppUuidData.md) | - |
| [GetApiV1DeveloperAppsByAppUuidError](Internal/type-aliases/GetApiV1DeveloperAppsByAppUuidError.md) | - |
| [GetApiV1DeveloperAppsByAppUuidErrors](Internal/type-aliases/GetApiV1DeveloperAppsByAppUuidErrors.md) | - |
| [GetApiV1DeveloperAppsByAppUuidResponse](Internal/type-aliases/GetApiV1DeveloperAppsByAppUuidResponse.md) | - |
| [GetApiV1DeveloperAppsByAppUuidResponses](Internal/type-aliases/GetApiV1DeveloperAppsByAppUuidResponses.md) | - |
| [GetApiV1DeveloperAppsByAppUuidUsageData](Internal/type-aliases/GetApiV1DeveloperAppsByAppUuidUsageData.md) | - |
| [GetApiV1DeveloperAppsByAppUuidUsageError](Internal/type-aliases/GetApiV1DeveloperAppsByAppUuidUsageError.md) | - |
| [GetApiV1DeveloperAppsByAppUuidUsageErrors](Internal/type-aliases/GetApiV1DeveloperAppsByAppUuidUsageErrors.md) | - |
| [GetApiV1DeveloperAppsByAppUuidUsageResponse](Internal/type-aliases/GetApiV1DeveloperAppsByAppUuidUsageResponse.md) | - |
| [GetApiV1DeveloperAppsByAppUuidUsageResponses](Internal/type-aliases/GetApiV1DeveloperAppsByAppUuidUsageResponses.md) | - |
| [GetApiV1DeveloperAppsByAppUuidUsageUsersData](Internal/type-aliases/GetApiV1DeveloperAppsByAppUuidUsageUsersData.md) | - |
| [GetApiV1DeveloperAppsByAppUuidUsageUsersError](Internal/type-aliases/GetApiV1DeveloperAppsByAppUuidUsageUsersError.md) | - |
| [GetApiV1DeveloperAppsByAppUuidUsageUsersErrors](Internal/type-aliases/GetApiV1DeveloperAppsByAppUuidUsageUsersErrors.md) | - |
| [GetApiV1DeveloperAppsByAppUuidUsageUsersResponse](Internal/type-aliases/GetApiV1DeveloperAppsByAppUuidUsageUsersResponse.md) | - |
| [GetApiV1DeveloperAppsByAppUuidUsageUsersResponses](Internal/type-aliases/GetApiV1DeveloperAppsByAppUuidUsageUsersResponses.md) | - |
| [GetApiV1DeveloperAppsByAppUuidUsersByAddressData](Internal/type-aliases/GetApiV1DeveloperAppsByAppUuidUsersByAddressData.md) | - |
| [GetApiV1DeveloperAppsByAppUuidUsersByAddressError](Internal/type-aliases/GetApiV1DeveloperAppsByAppUuidUsersByAddressError.md) | - |
| [GetApiV1DeveloperAppsByAppUuidUsersByAddressErrors](Internal/type-aliases/GetApiV1DeveloperAppsByAppUuidUsersByAddressErrors.md) | - |
| [GetApiV1DeveloperAppsByAppUuidUsersByAddressResponse](Internal/type-aliases/GetApiV1DeveloperAppsByAppUuidUsersByAddressResponse.md) | - |
| [GetApiV1DeveloperAppsByAppUuidUsersByAddressResponses](Internal/type-aliases/GetApiV1DeveloperAppsByAppUuidUsersByAddressResponses.md) | - |
| [GetApiV1DeveloperAppsByAppUuidUsersData](Internal/type-aliases/GetApiV1DeveloperAppsByAppUuidUsersData.md) | - |
| [GetApiV1DeveloperAppsByAppUuidUsersError](Internal/type-aliases/GetApiV1DeveloperAppsByAppUuidUsersError.md) | - |
| [GetApiV1DeveloperAppsByAppUuidUsersErrors](Internal/type-aliases/GetApiV1DeveloperAppsByAppUuidUsersErrors.md) | - |
| [GetApiV1DeveloperAppsByAppUuidUsersResponse](Internal/type-aliases/GetApiV1DeveloperAppsByAppUuidUsersResponse.md) | - |
| [GetApiV1DeveloperAppsByAppUuidUsersResponses](Internal/type-aliases/GetApiV1DeveloperAppsByAppUuidUsersResponses.md) | - |
| [GetApiV1DeveloperAppsData](Internal/type-aliases/GetApiV1DeveloperAppsData.md) | - |
| [GetApiV1DeveloperAppsError](Internal/type-aliases/GetApiV1DeveloperAppsError.md) | - |
| [GetApiV1DeveloperAppsErrors](Internal/type-aliases/GetApiV1DeveloperAppsErrors.md) | - |
| [GetApiV1DeveloperAppsResponse](Internal/type-aliases/GetApiV1DeveloperAppsResponse.md) | - |
| [GetApiV1DeveloperAppsResponses](Internal/type-aliases/GetApiV1DeveloperAppsResponses.md) | - |
| [GetApiV1DeveloperBillingData](Internal/type-aliases/GetApiV1DeveloperBillingData.md) | - |
| [GetApiV1DeveloperBillingError](Internal/type-aliases/GetApiV1DeveloperBillingError.md) | - |
| [GetApiV1DeveloperBillingErrors](Internal/type-aliases/GetApiV1DeveloperBillingErrors.md) | - |
| [GetApiV1DeveloperBillingResponse](Internal/type-aliases/GetApiV1DeveloperBillingResponse.md) | - |
| [GetApiV1DeveloperBillingResponses](Internal/type-aliases/GetApiV1DeveloperBillingResponses.md) | - |
| [GetApiV1DocsSwaggerJsonData](Internal/type-aliases/GetApiV1DocsSwaggerJsonData.md) | - |
| [GetApiV1DocsSwaggerJsonResponse](Internal/type-aliases/GetApiV1DocsSwaggerJsonResponse.md) | - |
| [GetApiV1DocsSwaggerJsonResponses](Internal/type-aliases/GetApiV1DocsSwaggerJsonResponses.md) | - |
| [GetApiV1GuestBootstrapData](Internal/type-aliases/GetApiV1GuestBootstrapData.md) | - |
| [GetApiV1GuestBootstrapError](Internal/type-aliases/GetApiV1GuestBootstrapError.md) | - |
| [GetApiV1GuestBootstrapErrors](Internal/type-aliases/GetApiV1GuestBootstrapErrors.md) | - |
| [GetApiV1GuestBootstrapResponse](Internal/type-aliases/GetApiV1GuestBootstrapResponse.md) | - |
| [GetApiV1GuestBootstrapResponses](Internal/type-aliases/GetApiV1GuestBootstrapResponses.md) | - |
| [GetApiV1ModelsData](Internal/type-aliases/GetApiV1ModelsData.md) | - |
| [GetApiV1ModelsError](Internal/type-aliases/GetApiV1ModelsError.md) | - |
| [GetApiV1ModelsErrors](Internal/type-aliases/GetApiV1ModelsErrors.md) | - |
| [GetApiV1ModelsResponse](Internal/type-aliases/GetApiV1ModelsResponse.md) | - |
| [GetApiV1ModelsResponses](Internal/type-aliases/GetApiV1ModelsResponses.md) | - |
| [GetApiV1PersonasByIdData](Internal/type-aliases/GetApiV1PersonasByIdData.md) | - |
| [GetApiV1PersonasByIdError](Internal/type-aliases/GetApiV1PersonasByIdError.md) | - |
| [GetApiV1PersonasByIdErrors](Internal/type-aliases/GetApiV1PersonasByIdErrors.md) | - |
| [GetApiV1PersonasByIdResponse](Internal/type-aliases/GetApiV1PersonasByIdResponse.md) | - |
| [GetApiV1PersonasByIdResponses](Internal/type-aliases/GetApiV1PersonasByIdResponses.md) | - |
| [GetApiV1PersonasData](Internal/type-aliases/GetApiV1PersonasData.md) | - |
| [GetApiV1PersonasError](Internal/type-aliases/GetApiV1PersonasError.md) | - |
| [GetApiV1PersonasErrors](Internal/type-aliases/GetApiV1PersonasErrors.md) | - |
| [GetApiV1PersonasResponse](Internal/type-aliases/GetApiV1PersonasResponse.md) | - |
| [GetApiV1PersonasResponses](Internal/type-aliases/GetApiV1PersonasResponses.md) | - |
| [GetApiV1PhoneCallsByCallIdData](Internal/type-aliases/GetApiV1PhoneCallsByCallIdData.md) | - |
| [GetApiV1PhoneCallsByCallIdError](Internal/type-aliases/GetApiV1PhoneCallsByCallIdError.md) | - |
| [GetApiV1PhoneCallsByCallIdErrors](Internal/type-aliases/GetApiV1PhoneCallsByCallIdErrors.md) | - |
| [GetApiV1PhoneCallsByCallIdResponse](Internal/type-aliases/GetApiV1PhoneCallsByCallIdResponse.md) | - |
| [GetApiV1PhoneCallsByCallIdResponses](Internal/type-aliases/GetApiV1PhoneCallsByCallIdResponses.md) | - |
| [GetApiV1SubscriptionsPlansData](Internal/type-aliases/GetApiV1SubscriptionsPlansData.md) | - |
| [GetApiV1SubscriptionsPlansError](Internal/type-aliases/GetApiV1SubscriptionsPlansError.md) | - |
| [GetApiV1SubscriptionsPlansErrors](Internal/type-aliases/GetApiV1SubscriptionsPlansErrors.md) | - |
| [GetApiV1SubscriptionsPlansResponse](Internal/type-aliases/GetApiV1SubscriptionsPlansResponse.md) | - |
| [GetApiV1SubscriptionsPlansResponses](Internal/type-aliases/GetApiV1SubscriptionsPlansResponses.md) | - |
| [GetApiV1SubscriptionsStatusData](Internal/type-aliases/GetApiV1SubscriptionsStatusData.md) | - |
| [GetApiV1SubscriptionsStatusError](Internal/type-aliases/GetApiV1SubscriptionsStatusError.md) | - |
| [GetApiV1SubscriptionsStatusErrors](Internal/type-aliases/GetApiV1SubscriptionsStatusErrors.md) | - |
| [GetApiV1SubscriptionsStatusResponse](Internal/type-aliases/GetApiV1SubscriptionsStatusResponse.md) | - |
| [GetApiV1SubscriptionsStatusResponses](Internal/type-aliases/GetApiV1SubscriptionsStatusResponses.md) | - |
| [GetApiV1TextByChannelLookupData](Internal/type-aliases/GetApiV1TextByChannelLookupData.md) | - |
| [GetApiV1TextByChannelLookupError](Internal/type-aliases/GetApiV1TextByChannelLookupError.md) | - |
| [GetApiV1TextByChannelLookupErrors](Internal/type-aliases/GetApiV1TextByChannelLookupErrors.md) | - |
| [GetApiV1TextByChannelLookupResponse](Internal/type-aliases/GetApiV1TextByChannelLookupResponse.md) | - |
| [GetApiV1TextByChannelLookupResponses](Internal/type-aliases/GetApiV1TextByChannelLookupResponses.md) | - |
| [GetApiV1TextByChannelStatusData](Internal/type-aliases/GetApiV1TextByChannelStatusData.md) | - |
| [GetApiV1TextByChannelStatusError](Internal/type-aliases/GetApiV1TextByChannelStatusError.md) | - |
| [GetApiV1TextByChannelStatusErrors](Internal/type-aliases/GetApiV1TextByChannelStatusErrors.md) | - |
| [GetApiV1TextByChannelStatusResponse](Internal/type-aliases/GetApiV1TextByChannelStatusResponse.md) | - |
| [GetApiV1TextByChannelStatusResponses](Internal/type-aliases/GetApiV1TextByChannelStatusResponses.md) | - |
| [GetApiV1ToolsData](Internal/type-aliases/GetApiV1ToolsData.md) | - |
| [GetApiV1ToolsError](Internal/type-aliases/GetApiV1ToolsError.md) | - |
| [GetApiV1ToolsErrors](Internal/type-aliases/GetApiV1ToolsErrors.md) | - |
| [GetApiV1ToolsResponse](Internal/type-aliases/GetApiV1ToolsResponse.md) | - |
| [GetApiV1ToolsResponses](Internal/type-aliases/GetApiV1ToolsResponses.md) | - |
| [GetApiV1UsageByModalityData](Internal/type-aliases/GetApiV1UsageByModalityData.md) | - |
| [GetApiV1UsageByModalityError](Internal/type-aliases/GetApiV1UsageByModalityError.md) | - |
| [GetApiV1UsageByModalityErrors](Internal/type-aliases/GetApiV1UsageByModalityErrors.md) | - |
| [GetApiV1UsageByModalityResponse](Internal/type-aliases/GetApiV1UsageByModalityResponse.md) | - |
| [GetApiV1UsageByModalityResponses](Internal/type-aliases/GetApiV1UsageByModalityResponses.md) | - |
| [GetApiV1UsageModelsData](Internal/type-aliases/GetApiV1UsageModelsData.md) | - |
| [GetApiV1UsageModelsError](Internal/type-aliases/GetApiV1UsageModelsError.md) | - |
| [GetApiV1UsageModelsErrors](Internal/type-aliases/GetApiV1UsageModelsErrors.md) | - |
| [GetApiV1UsageModelsResponse](Internal/type-aliases/GetApiV1UsageModelsResponse.md) | - |
| [GetApiV1UsageModelsResponses](Internal/type-aliases/GetApiV1UsageModelsResponses.md) | - |
| [GetApiV1UserApiKeysData](Internal/type-aliases/GetApiV1UserApiKeysData.md) | - |
| [GetApiV1UserApiKeysError](Internal/type-aliases/GetApiV1UserApiKeysError.md) | - |
| [GetApiV1UserApiKeysErrors](Internal/type-aliases/GetApiV1UserApiKeysErrors.md) | - |
| [GetApiV1UserApiKeysResponse](Internal/type-aliases/GetApiV1UserApiKeysResponse.md) | - |
| [GetApiV1UserApiKeysResponses](Internal/type-aliases/GetApiV1UserApiKeysResponses.md) | - |
| [GetApiV1UserOauthGrantsData](Internal/type-aliases/GetApiV1UserOauthGrantsData.md) | - |
| [GetApiV1UserOauthGrantsError](Internal/type-aliases/GetApiV1UserOauthGrantsError.md) | - |
| [GetApiV1UserOauthGrantsErrors](Internal/type-aliases/GetApiV1UserOauthGrantsErrors.md) | - |
| [GetApiV1UserOauthGrantsResponse](Internal/type-aliases/GetApiV1UserOauthGrantsResponse.md) | - |
| [GetApiV1UserOauthGrantsResponses](Internal/type-aliases/GetApiV1UserOauthGrantsResponses.md) | - |
| [GetHealthData](Internal/type-aliases/GetHealthData.md) | - |
| [GetHealthError](Internal/type-aliases/GetHealthError.md) | - |
| [GetHealthErrors](Internal/type-aliases/GetHealthErrors.md) | - |
| [GetHealthResponse](Internal/type-aliases/GetHealthResponse.md) | - |
| [GetHealthResponses](Internal/type-aliases/GetHealthResponses.md) | - |
| [GetOauthAuthorizeData](Internal/type-aliases/GetOauthAuthorizeData.md) | - |
| [GetOauthAuthorizeError](Internal/type-aliases/GetOauthAuthorizeError.md) | - |
| [GetOauthAuthorizeErrors](Internal/type-aliases/GetOauthAuthorizeErrors.md) | - |
| [GetOauthConsentData](Internal/type-aliases/GetOauthConsentData.md) | - |
| [GetOauthConsentError](Internal/type-aliases/GetOauthConsentError.md) | - |
| [GetOauthConsentErrors](Internal/type-aliases/GetOauthConsentErrors.md) | - |
| [GetOauthConsentResponse](Internal/type-aliases/GetOauthConsentResponse.md) | - |
| [GetOauthConsentResponses](Internal/type-aliases/GetOauthConsentResponses.md) | - |
| [GetWellKnownJwksJsonData](Internal/type-aliases/GetWellKnownJwksJsonData.md) | - |
| [GetWellKnownJwksJsonResponse](Internal/type-aliases/GetWellKnownJwksJsonResponse.md) | - |
| [GetWellKnownJwksJsonResponses](Internal/type-aliases/GetWellKnownJwksJsonResponses.md) | - |
| [HandlersAddCreditsRequest](Internal/type-aliases/HandlersAddCreditsRequest.md) | - |
| [HandlersAddCreditsResponse](Internal/type-aliases/HandlersAddCreditsResponse.md) | - |
| [HandlersAgentListItem](Internal/type-aliases/HandlersAgentListItem.md) | - |
| [HandlersAgentListResponse](Internal/type-aliases/HandlersAgentListResponse.md) | - |
| [HandlersAgentResponse](Internal/type-aliases/HandlersAgentResponse.md) | - |
| [HandlersApiKeyResponse](Internal/type-aliases/HandlersApiKeyResponse.md) | - |
| [HandlersApiKeyWithKeyResponse](Internal/type-aliases/HandlersApiKeyWithKeyResponse.md) | - |
| [HandlersAppConfig](Internal/type-aliases/HandlersAppConfig.md) | - |
| [HandlersAppResponse](Internal/type-aliases/HandlersAppResponse.md) | - |
| [HandlersAppUsageResponse](Internal/type-aliases/HandlersAppUsageResponse.md) | - |
| [HandlersAppUserUsageResponse](Internal/type-aliases/HandlersAppUserUsageResponse.md) | - |
| [HandlersBillingHistoryResponse](Internal/type-aliases/HandlersBillingHistoryResponse.md) | - |
| [HandlersBillingRecordResponse](Internal/type-aliases/HandlersBillingRecordResponse.md) | - |
| [HandlersBootstrapBuild](Internal/type-aliases/HandlersBootstrapBuild.md) | Build is the server build metadata at the time of bootstrap. |
| [HandlersBootstrapResponse](Internal/type-aliases/HandlersBootstrapResponse.md) | - |
| [HandlersBootstrapUser](Internal/type-aliases/HandlersBootstrapUser.md) | User is the authenticated identity context. |
| [HandlersCancelScheduledDowngradeResponse](Internal/type-aliases/HandlersCancelScheduledDowngradeResponse.md) | - |
| [HandlersCancelSubscriptionResponse](Internal/type-aliases/HandlersCancelSubscriptionResponse.md) | - |
| [HandlersCheckoutSessionResponse](Internal/type-aliases/HandlersCheckoutSessionResponse.md) | - |
| [HandlersConfigResponse](Internal/type-aliases/HandlersConfigResponse.md) | - |
| [HandlersConfigurePrivyRequest](Internal/type-aliases/HandlersConfigurePrivyRequest.md) | - |
| [HandlersConsentApproveResponse](Internal/type-aliases/HandlersConsentApproveResponse.md) | - |
| [HandlersCreateAgentRequest](Internal/type-aliases/HandlersCreateAgentRequest.md) | - |
| [HandlersCreateApiKeyRequest](Internal/type-aliases/HandlersCreateApiKeyRequest.md) | - |
| [HandlersCreateAppRequest](Internal/type-aliases/HandlersCreateAppRequest.md) | - |
| [HandlersCreateCheckoutSessionRequest](Internal/type-aliases/HandlersCreateCheckoutSessionRequest.md) | - |
| [HandlersCreateCreditPackCheckoutRequest](Internal/type-aliases/HandlersCreateCreditPackCheckoutRequest.md) | - |
| [HandlersCreateCustomerPortalRequest](Internal/type-aliases/HandlersCreateCustomerPortalRequest.md) | - |
| [HandlersCreateDeveloperAppRequest](Internal/type-aliases/HandlersCreateDeveloperAppRequest.md) | - |
| [HandlersCreateOAuthClientRequest](Internal/type-aliases/HandlersCreateOAuthClientRequest.md) | - |
| [HandlersCreateOAuthClientResponse](Internal/type-aliases/HandlersCreateOAuthClientResponse.md) | - |
| [HandlersCreatePersonaRequest](Internal/type-aliases/HandlersCreatePersonaRequest.md) | - |
| [HandlersCreatePhoneCallRequest](Internal/type-aliases/HandlersCreatePhoneCallRequest.md) | - |
| [HandlersCreditBalanceResponse](Internal/type-aliases/HandlersCreditBalanceResponse.md) | - |
| [HandlersCreditPack](Internal/type-aliases/HandlersCreditPack.md) | - |
| [HandlersCreditPacksResponse](Internal/type-aliases/HandlersCreditPacksResponse.md) | - |
| [HandlersCustomerPortalResponse](Internal/type-aliases/HandlersCustomerPortalResponse.md) | - |
| [HandlersDeleteUserResponse](Internal/type-aliases/HandlersDeleteUserResponse.md) | - |
| [HandlersDeveloperApiKeyRequest](Internal/type-aliases/HandlersDeveloperApiKeyRequest.md) | - |
| [HandlersDeveloperApiKeyResponse](Internal/type-aliases/HandlersDeveloperApiKeyResponse.md) | - |
| [HandlersDeveloperApiKeyWithSecretResponse](Internal/type-aliases/HandlersDeveloperApiKeyWithSecretResponse.md) | - |
| [HandlersDeveloperAppResponse](Internal/type-aliases/HandlersDeveloperAppResponse.md) | - |
| [HandlersDeveloperUserResponse](Internal/type-aliases/HandlersDeveloperUserResponse.md) | - |
| [HandlersDisableRequest](Internal/type-aliases/HandlersDisableRequest.md) | - |
| [HandlersExchangeRequest](Internal/type-aliases/HandlersExchangeRequest.md) | - |
| [HandlersExpiringCredits](Internal/type-aliases/HandlersExpiringCredits.md) | - |
| [HandlersFundDeveloperAppRequest](Internal/type-aliases/HandlersFundDeveloperAppRequest.md) | - |
| [HandlersGeneratedApiKey](Internal/type-aliases/HandlersGeneratedApiKey.md) | - |
| [HandlersGetToolsResponse](Internal/type-aliases/HandlersGetToolsResponse.md) | - |
| [HandlersGrantResponse](Internal/type-aliases/HandlersGrantResponse.md) | - |
| [HandlersGuestBootstrapResponse](Internal/type-aliases/HandlersGuestBootstrapResponse.md) | - |
| [HandlersGuestChatResponse](Internal/type-aliases/HandlersGuestChatResponse.md) | - |
| [HandlersGuestLimitResponse](Internal/type-aliases/HandlersGuestLimitResponse.md) | - |
| [HandlersHealthResponse](Internal/type-aliases/HandlersHealthResponse.md) | - |
| [HandlersListApiKeysResponse](Internal/type-aliases/HandlersListApiKeysResponse.md) | - |
| [HandlersListAppsResponse](Internal/type-aliases/HandlersListAppsResponse.md) | - |
| [HandlersListDeveloperApiKeysResponse](Internal/type-aliases/HandlersListDeveloperApiKeysResponse.md) | - |
| [HandlersListDeveloperAppsResponse](Internal/type-aliases/HandlersListDeveloperAppsResponse.md) | - |
| [HandlersListOAuthClientsResponse](Internal/type-aliases/HandlersListOAuthClientsResponse.md) | - |
| [HandlersListUserApiKeysResponse](Internal/type-aliases/HandlersListUserApiKeysResponse.md) | - |
| [HandlersListUsersResponse](Internal/type-aliases/HandlersListUsersResponse.md) | - |
| [HandlersMfaSessionResponse](Internal/type-aliases/HandlersMfaSessionResponse.md) | - |
| [HandlersMfaStatusResponse](Internal/type-aliases/HandlersMfaStatusResponse.md) | - |
| [HandlersModalityUsageItem](Internal/type-aliases/HandlersModalityUsageItem.md) | - |
| [HandlersModelToolUsageItem](Internal/type-aliases/HandlersModelToolUsageItem.md) | - |
| [HandlersModelUsageItem](Internal/type-aliases/HandlersModelUsageItem.md) | - |
| [HandlersOAuthClientResponse](Internal/type-aliases/HandlersOAuthClientResponse.md) | - |
| [HandlersOauthTokenError](Internal/type-aliases/HandlersOauthTokenError.md) | - |
| [HandlersOAuthTokenResponse](Internal/type-aliases/HandlersOAuthTokenResponse.md) | - |
| [HandlersPaginationResponse](Internal/type-aliases/HandlersPaginationResponse.md) | - |
| [HandlersPasskeyCredentialDto](Internal/type-aliases/HandlersPasskeyCredentialDto.md) | - |
| [HandlersPasskeyDeleteResponse](Internal/type-aliases/HandlersPasskeyDeleteResponse.md) | - |
| [HandlersPasskeyEnrollFinishRequest](Internal/type-aliases/HandlersPasskeyEnrollFinishRequest.md) | - |
| [HandlersPasskeyEnrollFinishResponse](Internal/type-aliases/HandlersPasskeyEnrollFinishResponse.md) | - |
| [HandlersPasskeyVerifyFinishRequest](Internal/type-aliases/HandlersPasskeyVerifyFinishRequest.md) | - |
| [HandlersPersonaListResponse](Internal/type-aliases/HandlersPersonaListResponse.md) | - |
| [HandlersPersonaResponse](Internal/type-aliases/HandlersPersonaResponse.md) | - |
| [HandlersPhoneCallResponse](Internal/type-aliases/HandlersPhoneCallResponse.md) | - |
| [HandlersPhoneCallTranscriptEntry](Internal/type-aliases/HandlersPhoneCallTranscriptEntry.md) | - |
| [HandlersPrivyIdentifierAuditEntry](Internal/type-aliases/HandlersPrivyIdentifierAuditEntry.md) | - |
| [HandlersPrivyIdentifierAuditResponse](Internal/type-aliases/HandlersPrivyIdentifierAuditResponse.md) | - |
| [HandlersPrivyIdentifierMigrateFailure](Internal/type-aliases/HandlersPrivyIdentifierMigrateFailure.md) | - |
| [HandlersPrivyIdentifierMigrateResponse](Internal/type-aliases/HandlersPrivyIdentifierMigrateResponse.md) | - |
| [HandlersRedeemTokensRequest](Internal/type-aliases/HandlersRedeemTokensRequest.md) | - |
| [HandlersRedeemTokensResponse](Internal/type-aliases/HandlersRedeemTokensResponse.md) | - |
| [HandlersRefreshRequest](Internal/type-aliases/HandlersRefreshRequest.md) | - |
| [HandlersRegisterTextResponse](Internal/type-aliases/HandlersRegisterTextResponse.md) | - |
| [HandlersRenewSubscriptionResponse](Internal/type-aliases/HandlersRenewSubscriptionResponse.md) | - |
| [HandlersRevokeRequest](Internal/type-aliases/HandlersRevokeRequest.md) | - |
| [HandlersScheduleDowngradeRequest](Internal/type-aliases/HandlersScheduleDowngradeRequest.md) | - |
| [HandlersScheduleDowngradeResponse](Internal/type-aliases/HandlersScheduleDowngradeResponse.md) | - |
| [HandlersSeedApiKeyInput](Internal/type-aliases/HandlersSeedApiKeyInput.md) | - |
| [HandlersSeedAppInput](Internal/type-aliases/HandlersSeedAppInput.md) | - |
| [HandlersSeedAppsRequest](Internal/type-aliases/HandlersSeedAppsRequest.md) | - |
| [HandlersSeedAppsResponse](Internal/type-aliases/HandlersSeedAppsResponse.md) | - |
| [HandlersSetSubscriptionTierRequest](Internal/type-aliases/HandlersSetSubscriptionTierRequest.md) | - |
| [HandlersSetSubscriptionTierResponse](Internal/type-aliases/HandlersSetSubscriptionTierResponse.md) | - |
| [HandlersSetUserAgentPreferenceRequest](Internal/type-aliases/HandlersSetUserAgentPreferenceRequest.md) | - |
| [HandlersSmsStatusDto](Internal/type-aliases/HandlersSmsStatusDto.md) | - |
| [HandlersSubscriptionPlan](Internal/type-aliases/HandlersSubscriptionPlan.md) | - |
| [HandlersSubscriptionPlansResponse](Internal/type-aliases/HandlersSubscriptionPlansResponse.md) | - |
| [HandlersSubscriptionStatusResponse](Internal/type-aliases/HandlersSubscriptionStatusResponse.md) | - |
| [HandlersTokenResponse](Internal/type-aliases/HandlersTokenResponse.md) | - |
| [HandlersTool](Internal/type-aliases/HandlersTool.md) | - |
| [HandlersToolCallDetailItem](Internal/type-aliases/HandlersToolCallDetailItem.md) | - |
| [HandlersTopUpUserRequest](Internal/type-aliases/HandlersTopUpUserRequest.md) | - |
| [HandlersTotpEnrollInitResponse](Internal/type-aliases/HandlersTotpEnrollInitResponse.md) | - |
| [HandlersTotpVerifyRequest](Internal/type-aliases/HandlersTotpVerifyRequest.md) | - |
| [HandlersUnregisterTextResponse](Internal/type-aliases/HandlersUnregisterTextResponse.md) | - |
| [HandlersUpdateAgentRequest](Internal/type-aliases/HandlersUpdateAgentRequest.md) | - |
| [HandlersUpdateApiKeyRequest](Internal/type-aliases/HandlersUpdateApiKeyRequest.md) | - |
| [HandlersUpdateAppRequest](Internal/type-aliases/HandlersUpdateAppRequest.md) | - |
| [HandlersUpdateDeveloperAppRequest](Internal/type-aliases/HandlersUpdateDeveloperAppRequest.md) | - |
| [HandlersUpdateGrantRequest](Internal/type-aliases/HandlersUpdateGrantRequest.md) | - |
| [HandlersUpdateOAuthClientRequest](Internal/type-aliases/HandlersUpdateOAuthClientRequest.md) | - |
| [HandlersUpdatePersonaRequest](Internal/type-aliases/HandlersUpdatePersonaRequest.md) | - |
| [HandlersUpdateUserLimitRequest](Internal/type-aliases/HandlersUpdateUserLimitRequest.md) | - |
| [HandlersUpgradeSubscriptionRequest](Internal/type-aliases/HandlersUpgradeSubscriptionRequest.md) | - |
| [HandlersUpgradeSubscriptionResponse](Internal/type-aliases/HandlersUpgradeSubscriptionResponse.md) | - |
| [HandlersUsageByModalityResponse](Internal/type-aliases/HandlersUsageByModalityResponse.md) | - |
| [HandlersUsageByModalityTotals](Internal/type-aliases/HandlersUsageByModalityTotals.md) | - |
| [HandlersUsageByModelResponse](Internal/type-aliases/HandlersUsageByModelResponse.md) | - |
| [HandlersUsagePeriod](Internal/type-aliases/HandlersUsagePeriod.md) | - |
| [HandlersUsageTimeseriesPoint](Internal/type-aliases/HandlersUsageTimeseriesPoint.md) | - |
| [HandlersUsageTotals](Internal/type-aliases/HandlersUsageTotals.md) | - |
| [HandlersUserAgentPreferenceResponse](Internal/type-aliases/HandlersUserAgentPreferenceResponse.md) | - |
| [HandlersUserAgentPreferencesListResponse](Internal/type-aliases/HandlersUserAgentPreferencesListResponse.md) | - |
| [HandlersUserApiKeyRequest](Internal/type-aliases/HandlersUserApiKeyRequest.md) | - |
| [HandlersUserApiKeyResponse](Internal/type-aliases/HandlersUserApiKeyResponse.md) | - |
| [HandlersUserApiKeyWithSecretResponse](Internal/type-aliases/HandlersUserApiKeyWithSecretResponse.md) | - |
| [HandlersUserLookupAccount](Internal/type-aliases/HandlersUserLookupAccount.md) | - |
| [HandlersUserLookupEnrollment](Internal/type-aliases/HandlersUserLookupEnrollment.md) | - |
| [HandlersUserLookupResponse](Internal/type-aliases/HandlersUserLookupResponse.md) | - |
| [HandlersUserLookupTextReg](Internal/type-aliases/HandlersUserLookupTextReg.md) | - |
| [HandlersUserUsageResponse](Internal/type-aliases/HandlersUserUsageResponse.md) | - |
| [HandlersVerifyRequest](Internal/type-aliases/HandlersVerifyRequest.md) | - |
| [HandlersWalletDetails](Internal/type-aliases/HandlersWalletDetails.md) | Wallet account details |
| [LlmapiChatCompletionExtraFields](Internal/type-aliases/LlmapiChatCompletionExtraFields.md) | ExtraFields contains additional metadata |
| [LlmapiChatCompletionRequest](Internal/type-aliases/LlmapiChatCompletionRequest.md) | - |
| [LlmapiChatCompletionResponse](Internal/type-aliases/LlmapiChatCompletionResponse.md) | - |
| [LlmapiChatCompletionTool](Internal/type-aliases/LlmapiChatCompletionTool.md) | - |
| [LlmapiChatCompletionToolChoice](Internal/type-aliases/LlmapiChatCompletionToolChoice.md) | ToolChoice controls tool usage |
| [LlmapiChatCompletionUsage](Internal/type-aliases/LlmapiChatCompletionUsage.md) | Usage contains token usage information |
| [LlmapiChoice](Internal/type-aliases/LlmapiChoice.md) | - |
| [LlmapiEmbeddingData](Internal/type-aliases/LlmapiEmbeddingData.md) | - |
| [LlmapiEmbeddingExtraFields](Internal/type-aliases/LlmapiEmbeddingExtraFields.md) | ExtraFields contains additional metadata |
| [LlmapiEmbeddingRequest](Internal/type-aliases/LlmapiEmbeddingRequest.md) | - |
| [LlmapiEmbeddingResponse](Internal/type-aliases/LlmapiEmbeddingResponse.md) | - |
| [LlmapiEmbeddingUsage](Internal/type-aliases/LlmapiEmbeddingUsage.md) | Usage contains token usage information |
| [LlmapiMcpTool](Internal/type-aliases/LlmapiMcpTool.md) | - |
| [LlmapiMessage](Internal/type-aliases/LlmapiMessage.md) | Message is the generated message |
| [LlmapiMessageContentFile](Internal/type-aliases/LlmapiMessageContentFile.md) | File is used when Type=input\_file (for Responses API) |
| [LlmapiMessageContentImage](Internal/type-aliases/LlmapiMessageContentImage.md) | ImageURL is used when Type=image\_url or Type=input\_image |
| [LlmapiMessageContentPart](Internal/type-aliases/LlmapiMessageContentPart.md) | - |
| [LlmapiModel](Internal/type-aliases/LlmapiModel.md) | - |
| [LlmapiModelArchitecture](Internal/type-aliases/LlmapiModelArchitecture.md) | Architecture describes the model's technical capabilities |
| [LlmapiModelPerRequestLimits](Internal/type-aliases/LlmapiModelPerRequestLimits.md) | PerRequestLimits contains rate limiting information |
| [LlmapiModelPricing](Internal/type-aliases/LlmapiModelPricing.md) | Pricing contains the pricing structure for using this model |
| [LlmapiModelsListExtraFields](Internal/type-aliases/LlmapiModelsListExtraFields.md) | ExtraFields contains additional metadata |
| [LlmapiModelsListResponse](Internal/type-aliases/LlmapiModelsListResponse.md) | - |
| [LlmapiModelTopProvider](Internal/type-aliases/LlmapiModelTopProvider.md) | TopProvider contains configuration details for the primary provider |
| [LlmapiResponseExtraFields](Internal/type-aliases/LlmapiResponseExtraFields.md) | ExtraFields contains additional metadata |
| [LlmapiResponseInput](Internal/type-aliases/LlmapiResponseInput.md) | Input can be a simple text string or an array of messages for multi-turn conversations. When continuing after client tool calls, pass the messages array from the previous response. |
| [LlmapiResponseOutputContent](Internal/type-aliases/LlmapiResponseOutputContent.md) | - |
| [LlmapiResponseOutputItem](Internal/type-aliases/LlmapiResponseOutputItem.md) | - |
| [LlmapiResponseReasoning](Internal/type-aliases/LlmapiResponseReasoning.md) | Reasoning configures reasoning for o-series and other reasoning models |
| [LlmapiResponseRequest](Internal/type-aliases/LlmapiResponseRequest.md) | - |
| [LlmapiResponseResponse](Internal/type-aliases/LlmapiResponseResponse.md) | - |
| [LlmapiResponseTool](Internal/type-aliases/LlmapiResponseTool.md) | - |
| [LlmapiResponseToolChoice](Internal/type-aliases/LlmapiResponseToolChoice.md) | ToolChoice controls tool usage |
| [LlmapiResponseUsage](Internal/type-aliases/LlmapiResponseUsage.md) | Usage contains token usage information |
| [LlmapiRole](Internal/type-aliases/LlmapiRole.md) | Role is the message role (system, user, assistant, tool) |
| [LlmapiThinkingOptions](Internal/type-aliases/LlmapiThinkingOptions.md) | Thinking configures extended thinking for Anthropic models |
| [LlmapiToolCall](Internal/type-aliases/LlmapiToolCall.md) | - |
| [LlmapiToolCallEvent](Internal/type-aliases/LlmapiToolCallEvent.md) | - |
| [LlmapiToolCallFunction](Internal/type-aliases/LlmapiToolCallFunction.md) | Function contains the function call details |
| [McpToolSchema](Internal/type-aliases/McpToolSchema.md) | - |
| [ModelsRegisterTextRequest](Internal/type-aliases/ModelsRegisterTextRequest.md) | - |
| [ModelsTextChannel](Internal/type-aliases/ModelsTextChannel.md) | - |
| [ModelsTextLookupResult](Internal/type-aliases/ModelsTextLookupResult.md) | - |
| [ModelsTextStatusResponse](Internal/type-aliases/ModelsTextStatusResponse.md) | - |
| [Options](Internal/type-aliases/Options.md) | - |
| [PatchApiV1AdminOauthClientsByClientIdData](Internal/type-aliases/PatchApiV1AdminOauthClientsByClientIdData.md) | - |
| [PatchApiV1AdminOauthClientsByClientIdError](Internal/type-aliases/PatchApiV1AdminOauthClientsByClientIdError.md) | - |
| [PatchApiV1AdminOauthClientsByClientIdErrors](Internal/type-aliases/PatchApiV1AdminOauthClientsByClientIdErrors.md) | - |
| [PatchApiV1AdminOauthClientsByClientIdResponse](Internal/type-aliases/PatchApiV1AdminOauthClientsByClientIdResponse.md) | - |
| [PatchApiV1AdminOauthClientsByClientIdResponses](Internal/type-aliases/PatchApiV1AdminOauthClientsByClientIdResponses.md) | - |
| [PatchApiV1DeveloperAppsByAppUuidData](Internal/type-aliases/PatchApiV1DeveloperAppsByAppUuidData.md) | - |
| [PatchApiV1DeveloperAppsByAppUuidError](Internal/type-aliases/PatchApiV1DeveloperAppsByAppUuidError.md) | - |
| [PatchApiV1DeveloperAppsByAppUuidErrors](Internal/type-aliases/PatchApiV1DeveloperAppsByAppUuidErrors.md) | - |
| [PatchApiV1DeveloperAppsByAppUuidResponse](Internal/type-aliases/PatchApiV1DeveloperAppsByAppUuidResponse.md) | - |
| [PatchApiV1DeveloperAppsByAppUuidResponses](Internal/type-aliases/PatchApiV1DeveloperAppsByAppUuidResponses.md) | - |
| [PatchApiV1DeveloperAppsByAppUuidUsersByAddressData](Internal/type-aliases/PatchApiV1DeveloperAppsByAppUuidUsersByAddressData.md) | - |
| [PatchApiV1DeveloperAppsByAppUuidUsersByAddressError](Internal/type-aliases/PatchApiV1DeveloperAppsByAppUuidUsersByAddressError.md) | - |
| [PatchApiV1DeveloperAppsByAppUuidUsersByAddressErrors](Internal/type-aliases/PatchApiV1DeveloperAppsByAppUuidUsersByAddressErrors.md) | - |
| [PatchApiV1DeveloperAppsByAppUuidUsersByAddressResponse](Internal/type-aliases/PatchApiV1DeveloperAppsByAppUuidUsersByAddressResponse.md) | - |
| [PatchApiV1DeveloperAppsByAppUuidUsersByAddressResponses](Internal/type-aliases/PatchApiV1DeveloperAppsByAppUuidUsersByAddressResponses.md) | - |
| [PatchApiV1UserOauthGrantsByIdData](Internal/type-aliases/PatchApiV1UserOauthGrantsByIdData.md) | - |
| [PatchApiV1UserOauthGrantsByIdError](Internal/type-aliases/PatchApiV1UserOauthGrantsByIdError.md) | - |
| [PatchApiV1UserOauthGrantsByIdErrors](Internal/type-aliases/PatchApiV1UserOauthGrantsByIdErrors.md) | - |
| [PatchApiV1UserOauthGrantsByIdResponse](Internal/type-aliases/PatchApiV1UserOauthGrantsByIdResponse.md) | - |
| [PatchApiV1UserOauthGrantsByIdResponses](Internal/type-aliases/PatchApiV1UserOauthGrantsByIdResponses.md) | - |
| [PostApiV1AdminAddCreditsData](Internal/type-aliases/PostApiV1AdminAddCreditsData.md) | - |
| [PostApiV1AdminAddCreditsError](Internal/type-aliases/PostApiV1AdminAddCreditsError.md) | - |
| [PostApiV1AdminAddCreditsErrors](Internal/type-aliases/PostApiV1AdminAddCreditsErrors.md) | - |
| [PostApiV1AdminAddCreditsResponse](Internal/type-aliases/PostApiV1AdminAddCreditsResponse.md) | - |
| [PostApiV1AdminAddCreditsResponses](Internal/type-aliases/PostApiV1AdminAddCreditsResponses.md) | - |
| [PostApiV1AdminAgentsData](Internal/type-aliases/PostApiV1AdminAgentsData.md) | - |
| [PostApiV1AdminAgentsError](Internal/type-aliases/PostApiV1AdminAgentsError.md) | - |
| [PostApiV1AdminAgentsErrors](Internal/type-aliases/PostApiV1AdminAgentsErrors.md) | - |
| [PostApiV1AdminAgentsResponse](Internal/type-aliases/PostApiV1AdminAgentsResponse.md) | - |
| [PostApiV1AdminAgentsResponses](Internal/type-aliases/PostApiV1AdminAgentsResponses.md) | - |
| [PostApiV1AdminAppsByAppIdApiKeysData](Internal/type-aliases/PostApiV1AdminAppsByAppIdApiKeysData.md) | - |
| [PostApiV1AdminAppsByAppIdApiKeysError](Internal/type-aliases/PostApiV1AdminAppsByAppIdApiKeysError.md) | - |
| [PostApiV1AdminAppsByAppIdApiKeysErrors](Internal/type-aliases/PostApiV1AdminAppsByAppIdApiKeysErrors.md) | - |
| [PostApiV1AdminAppsByAppIdApiKeysResponse](Internal/type-aliases/PostApiV1AdminAppsByAppIdApiKeysResponse.md) | - |
| [PostApiV1AdminAppsByAppIdApiKeysResponses](Internal/type-aliases/PostApiV1AdminAppsByAppIdApiKeysResponses.md) | - |
| [PostApiV1AdminAppsData](Internal/type-aliases/PostApiV1AdminAppsData.md) | - |
| [PostApiV1AdminAppsError](Internal/type-aliases/PostApiV1AdminAppsError.md) | - |
| [PostApiV1AdminAppsErrors](Internal/type-aliases/PostApiV1AdminAppsErrors.md) | - |
| [PostApiV1AdminAppsResponse](Internal/type-aliases/PostApiV1AdminAppsResponse.md) | - |
| [PostApiV1AdminAppsResponses](Internal/type-aliases/PostApiV1AdminAppsResponses.md) | - |
| [PostApiV1AdminOauthClientsData](Internal/type-aliases/PostApiV1AdminOauthClientsData.md) | - |
| [PostApiV1AdminOauthClientsError](Internal/type-aliases/PostApiV1AdminOauthClientsError.md) | - |
| [PostApiV1AdminOauthClientsErrors](Internal/type-aliases/PostApiV1AdminOauthClientsErrors.md) | - |
| [PostApiV1AdminOauthClientsResponse](Internal/type-aliases/PostApiV1AdminOauthClientsResponse.md) | - |
| [PostApiV1AdminOauthClientsResponses](Internal/type-aliases/PostApiV1AdminOauthClientsResponses.md) | - |
| [PostApiV1AdminPersonasData](Internal/type-aliases/PostApiV1AdminPersonasData.md) | - |
| [PostApiV1AdminPersonasError](Internal/type-aliases/PostApiV1AdminPersonasError.md) | - |
| [PostApiV1AdminPersonasErrors](Internal/type-aliases/PostApiV1AdminPersonasErrors.md) | - |
| [PostApiV1AdminPersonasResponse](Internal/type-aliases/PostApiV1AdminPersonasResponse.md) | - |
| [PostApiV1AdminPersonasResponses](Internal/type-aliases/PostApiV1AdminPersonasResponses.md) | - |
| [PostApiV1AdminPrivyIdentifiersMigrateData](Internal/type-aliases/PostApiV1AdminPrivyIdentifiersMigrateData.md) | - |
| [PostApiV1AdminPrivyIdentifiersMigrateError](Internal/type-aliases/PostApiV1AdminPrivyIdentifiersMigrateError.md) | - |
| [PostApiV1AdminPrivyIdentifiersMigrateErrors](Internal/type-aliases/PostApiV1AdminPrivyIdentifiersMigrateErrors.md) | - |
| [PostApiV1AdminPrivyIdentifiersMigrateResponse](Internal/type-aliases/PostApiV1AdminPrivyIdentifiersMigrateResponse.md) | - |
| [PostApiV1AdminPrivyIdentifiersMigrateResponses](Internal/type-aliases/PostApiV1AdminPrivyIdentifiersMigrateResponses.md) | - |
| [PostApiV1AdminSeedAppsData](Internal/type-aliases/PostApiV1AdminSeedAppsData.md) | - |
| [PostApiV1AdminSeedAppsError](Internal/type-aliases/PostApiV1AdminSeedAppsError.md) | - |
| [PostApiV1AdminSeedAppsErrors](Internal/type-aliases/PostApiV1AdminSeedAppsErrors.md) | - |
| [PostApiV1AdminSeedAppsResponse](Internal/type-aliases/PostApiV1AdminSeedAppsResponse.md) | - |
| [PostApiV1AdminSeedAppsResponses](Internal/type-aliases/PostApiV1AdminSeedAppsResponses.md) | - |
| [PostApiV1AdminSubscriptionTierData](Internal/type-aliases/PostApiV1AdminSubscriptionTierData.md) | - |
| [PostApiV1AdminSubscriptionTierError](Internal/type-aliases/PostApiV1AdminSubscriptionTierError.md) | - |
| [PostApiV1AdminSubscriptionTierErrors](Internal/type-aliases/PostApiV1AdminSubscriptionTierErrors.md) | - |
| [PostApiV1AdminSubscriptionTierResponse](Internal/type-aliases/PostApiV1AdminSubscriptionTierResponse.md) | - |
| [PostApiV1AdminSubscriptionTierResponses](Internal/type-aliases/PostApiV1AdminSubscriptionTierResponses.md) | - |
| [PostApiV1AuthMfaDisableData](Internal/type-aliases/PostApiV1AuthMfaDisableData.md) | - |
| [PostApiV1AuthMfaDisableError](Internal/type-aliases/PostApiV1AuthMfaDisableError.md) | - |
| [PostApiV1AuthMfaDisableErrors](Internal/type-aliases/PostApiV1AuthMfaDisableErrors.md) | - |
| [PostApiV1AuthMfaDisableResponse](Internal/type-aliases/PostApiV1AuthMfaDisableResponse.md) | - |
| [PostApiV1AuthMfaDisableResponses](Internal/type-aliases/PostApiV1AuthMfaDisableResponses.md) | - |
| [PostApiV1AuthMfaPasskeyEnrollBeginData](Internal/type-aliases/PostApiV1AuthMfaPasskeyEnrollBeginData.md) | - |
| [PostApiV1AuthMfaPasskeyEnrollBeginError](Internal/type-aliases/PostApiV1AuthMfaPasskeyEnrollBeginError.md) | - |
| [PostApiV1AuthMfaPasskeyEnrollBeginErrors](Internal/type-aliases/PostApiV1AuthMfaPasskeyEnrollBeginErrors.md) | - |
| [PostApiV1AuthMfaPasskeyEnrollBeginResponse](Internal/type-aliases/PostApiV1AuthMfaPasskeyEnrollBeginResponse.md) | - |
| [PostApiV1AuthMfaPasskeyEnrollBeginResponses](Internal/type-aliases/PostApiV1AuthMfaPasskeyEnrollBeginResponses.md) | - |
| [PostApiV1AuthMfaPasskeyEnrollFinishData](Internal/type-aliases/PostApiV1AuthMfaPasskeyEnrollFinishData.md) | - |
| [PostApiV1AuthMfaPasskeyEnrollFinishError](Internal/type-aliases/PostApiV1AuthMfaPasskeyEnrollFinishError.md) | - |
| [PostApiV1AuthMfaPasskeyEnrollFinishErrors](Internal/type-aliases/PostApiV1AuthMfaPasskeyEnrollFinishErrors.md) | - |
| [PostApiV1AuthMfaPasskeyEnrollFinishResponse](Internal/type-aliases/PostApiV1AuthMfaPasskeyEnrollFinishResponse.md) | - |
| [PostApiV1AuthMfaPasskeyEnrollFinishResponses](Internal/type-aliases/PostApiV1AuthMfaPasskeyEnrollFinishResponses.md) | - |
| [PostApiV1AuthMfaPasskeyVerifyBeginData](Internal/type-aliases/PostApiV1AuthMfaPasskeyVerifyBeginData.md) | - |
| [PostApiV1AuthMfaPasskeyVerifyBeginError](Internal/type-aliases/PostApiV1AuthMfaPasskeyVerifyBeginError.md) | - |
| [PostApiV1AuthMfaPasskeyVerifyBeginErrors](Internal/type-aliases/PostApiV1AuthMfaPasskeyVerifyBeginErrors.md) | - |
| [PostApiV1AuthMfaPasskeyVerifyBeginResponse](Internal/type-aliases/PostApiV1AuthMfaPasskeyVerifyBeginResponse.md) | - |
| [PostApiV1AuthMfaPasskeyVerifyBeginResponses](Internal/type-aliases/PostApiV1AuthMfaPasskeyVerifyBeginResponses.md) | - |
| [PostApiV1AuthMfaPasskeyVerifyFinishData](Internal/type-aliases/PostApiV1AuthMfaPasskeyVerifyFinishData.md) | - |
| [PostApiV1AuthMfaPasskeyVerifyFinishError](Internal/type-aliases/PostApiV1AuthMfaPasskeyVerifyFinishError.md) | - |
| [PostApiV1AuthMfaPasskeyVerifyFinishErrors](Internal/type-aliases/PostApiV1AuthMfaPasskeyVerifyFinishErrors.md) | - |
| [PostApiV1AuthMfaPasskeyVerifyFinishResponse](Internal/type-aliases/PostApiV1AuthMfaPasskeyVerifyFinishResponse.md) | - |
| [PostApiV1AuthMfaPasskeyVerifyFinishResponses](Internal/type-aliases/PostApiV1AuthMfaPasskeyVerifyFinishResponses.md) | - |
| [PostApiV1AuthMfaRecoveryCodesRegenerateData](Internal/type-aliases/PostApiV1AuthMfaRecoveryCodesRegenerateData.md) | - |
| [PostApiV1AuthMfaRecoveryCodesRegenerateError](Internal/type-aliases/PostApiV1AuthMfaRecoveryCodesRegenerateError.md) | - |
| [PostApiV1AuthMfaRecoveryCodesRegenerateErrors](Internal/type-aliases/PostApiV1AuthMfaRecoveryCodesRegenerateErrors.md) | - |
| [PostApiV1AuthMfaRecoveryCodesRegenerateResponse](Internal/type-aliases/PostApiV1AuthMfaRecoveryCodesRegenerateResponse.md) | - |
| [PostApiV1AuthMfaRecoveryCodesRegenerateResponses](Internal/type-aliases/PostApiV1AuthMfaRecoveryCodesRegenerateResponses.md) | - |
| [PostApiV1AuthMfaTotpEnrollInitData](Internal/type-aliases/PostApiV1AuthMfaTotpEnrollInitData.md) | - |
| [PostApiV1AuthMfaTotpEnrollInitError](Internal/type-aliases/PostApiV1AuthMfaTotpEnrollInitError.md) | - |
| [PostApiV1AuthMfaTotpEnrollInitErrors](Internal/type-aliases/PostApiV1AuthMfaTotpEnrollInitErrors.md) | - |
| [PostApiV1AuthMfaTotpEnrollInitResponse](Internal/type-aliases/PostApiV1AuthMfaTotpEnrollInitResponse.md) | - |
| [PostApiV1AuthMfaTotpEnrollInitResponses](Internal/type-aliases/PostApiV1AuthMfaTotpEnrollInitResponses.md) | - |
| [PostApiV1AuthMfaTotpEnrollVerifyData](Internal/type-aliases/PostApiV1AuthMfaTotpEnrollVerifyData.md) | - |
| [PostApiV1AuthMfaTotpEnrollVerifyError](Internal/type-aliases/PostApiV1AuthMfaTotpEnrollVerifyError.md) | - |
| [PostApiV1AuthMfaTotpEnrollVerifyErrors](Internal/type-aliases/PostApiV1AuthMfaTotpEnrollVerifyErrors.md) | - |
| [PostApiV1AuthMfaTotpEnrollVerifyResponse](Internal/type-aliases/PostApiV1AuthMfaTotpEnrollVerifyResponse.md) | - |
| [PostApiV1AuthMfaTotpEnrollVerifyResponses](Internal/type-aliases/PostApiV1AuthMfaTotpEnrollVerifyResponses.md) | - |
| [PostApiV1AuthMfaVerifyData](Internal/type-aliases/PostApiV1AuthMfaVerifyData.md) | - |
| [PostApiV1AuthMfaVerifyError](Internal/type-aliases/PostApiV1AuthMfaVerifyError.md) | - |
| [PostApiV1AuthMfaVerifyErrors](Internal/type-aliases/PostApiV1AuthMfaVerifyErrors.md) | - |
| [PostApiV1AuthMfaVerifyResponse](Internal/type-aliases/PostApiV1AuthMfaVerifyResponse.md) | - |
| [PostApiV1AuthMfaVerifyResponses](Internal/type-aliases/PostApiV1AuthMfaVerifyResponses.md) | - |
| [PostApiV1ChatCompletionsData](Internal/type-aliases/PostApiV1ChatCompletionsData.md) | - |
| [PostApiV1ChatCompletionsError](Internal/type-aliases/PostApiV1ChatCompletionsError.md) | - |
| [PostApiV1ChatCompletionsErrors](Internal/type-aliases/PostApiV1ChatCompletionsErrors.md) | - |
| [PostApiV1ChatCompletionsResponse](Internal/type-aliases/PostApiV1ChatCompletionsResponse.md) | - |
| [PostApiV1ChatCompletionsResponses](Internal/type-aliases/PostApiV1ChatCompletionsResponses.md) | - |
| [PostApiV1CreditsPurchaseData](Internal/type-aliases/PostApiV1CreditsPurchaseData.md) | - |
| [PostApiV1CreditsPurchaseError](Internal/type-aliases/PostApiV1CreditsPurchaseError.md) | - |
| [PostApiV1CreditsPurchaseErrors](Internal/type-aliases/PostApiV1CreditsPurchaseErrors.md) | - |
| [PostApiV1CreditsPurchaseResponse](Internal/type-aliases/PostApiV1CreditsPurchaseResponse.md) | - |
| [PostApiV1CreditsPurchaseResponses](Internal/type-aliases/PostApiV1CreditsPurchaseResponses.md) | - |
| [PostApiV1CreditsRedeemTokensData](Internal/type-aliases/PostApiV1CreditsRedeemTokensData.md) | - |
| [PostApiV1CreditsRedeemTokensError](Internal/type-aliases/PostApiV1CreditsRedeemTokensError.md) | - |
| [PostApiV1CreditsRedeemTokensErrors](Internal/type-aliases/PostApiV1CreditsRedeemTokensErrors.md) | - |
| [PostApiV1CreditsRedeemTokensResponse](Internal/type-aliases/PostApiV1CreditsRedeemTokensResponse.md) | - |
| [PostApiV1CreditsRedeemTokensResponses](Internal/type-aliases/PostApiV1CreditsRedeemTokensResponses.md) | - |
| [PostApiV1DeveloperAppsByAppUuidApiKeysData](Internal/type-aliases/PostApiV1DeveloperAppsByAppUuidApiKeysData.md) | - |
| [PostApiV1DeveloperAppsByAppUuidApiKeysError](Internal/type-aliases/PostApiV1DeveloperAppsByAppUuidApiKeysError.md) | - |
| [PostApiV1DeveloperAppsByAppUuidApiKeysErrors](Internal/type-aliases/PostApiV1DeveloperAppsByAppUuidApiKeysErrors.md) | - |
| [PostApiV1DeveloperAppsByAppUuidApiKeysResponse](Internal/type-aliases/PostApiV1DeveloperAppsByAppUuidApiKeysResponse.md) | - |
| [PostApiV1DeveloperAppsByAppUuidApiKeysResponses](Internal/type-aliases/PostApiV1DeveloperAppsByAppUuidApiKeysResponses.md) | - |
| [PostApiV1DeveloperAppsByAppUuidFundData](Internal/type-aliases/PostApiV1DeveloperAppsByAppUuidFundData.md) | - |
| [PostApiV1DeveloperAppsByAppUuidFundError](Internal/type-aliases/PostApiV1DeveloperAppsByAppUuidFundError.md) | - |
| [PostApiV1DeveloperAppsByAppUuidFundErrors](Internal/type-aliases/PostApiV1DeveloperAppsByAppUuidFundErrors.md) | - |
| [PostApiV1DeveloperAppsByAppUuidFundResponse](Internal/type-aliases/PostApiV1DeveloperAppsByAppUuidFundResponse.md) | - |
| [PostApiV1DeveloperAppsByAppUuidFundResponses](Internal/type-aliases/PostApiV1DeveloperAppsByAppUuidFundResponses.md) | - |
| [PostApiV1DeveloperAppsByAppUuidPrivyData](Internal/type-aliases/PostApiV1DeveloperAppsByAppUuidPrivyData.md) | - |
| [PostApiV1DeveloperAppsByAppUuidPrivyError](Internal/type-aliases/PostApiV1DeveloperAppsByAppUuidPrivyError.md) | - |
| [PostApiV1DeveloperAppsByAppUuidPrivyErrors](Internal/type-aliases/PostApiV1DeveloperAppsByAppUuidPrivyErrors.md) | - |
| [PostApiV1DeveloperAppsByAppUuidPrivyResponse](Internal/type-aliases/PostApiV1DeveloperAppsByAppUuidPrivyResponse.md) | - |
| [PostApiV1DeveloperAppsByAppUuidPrivyResponses](Internal/type-aliases/PostApiV1DeveloperAppsByAppUuidPrivyResponses.md) | - |
| [PostApiV1DeveloperAppsByAppUuidUsersByAddressTopUpData](Internal/type-aliases/PostApiV1DeveloperAppsByAppUuidUsersByAddressTopUpData.md) | - |
| [PostApiV1DeveloperAppsByAppUuidUsersByAddressTopUpError](Internal/type-aliases/PostApiV1DeveloperAppsByAppUuidUsersByAddressTopUpError.md) | - |
| [PostApiV1DeveloperAppsByAppUuidUsersByAddressTopUpErrors](Internal/type-aliases/PostApiV1DeveloperAppsByAppUuidUsersByAddressTopUpErrors.md) | - |
| [PostApiV1DeveloperAppsByAppUuidUsersByAddressTopUpResponse](Internal/type-aliases/PostApiV1DeveloperAppsByAppUuidUsersByAddressTopUpResponse.md) | - |
| [PostApiV1DeveloperAppsByAppUuidUsersByAddressTopUpResponses](Internal/type-aliases/PostApiV1DeveloperAppsByAppUuidUsersByAddressTopUpResponses.md) | - |
| [PostApiV1DeveloperAppsData](Internal/type-aliases/PostApiV1DeveloperAppsData.md) | - |
| [PostApiV1DeveloperAppsError](Internal/type-aliases/PostApiV1DeveloperAppsError.md) | - |
| [PostApiV1DeveloperAppsErrors](Internal/type-aliases/PostApiV1DeveloperAppsErrors.md) | - |
| [PostApiV1DeveloperAppsResponse](Internal/type-aliases/PostApiV1DeveloperAppsResponse.md) | - |
| [PostApiV1DeveloperAppsResponses](Internal/type-aliases/PostApiV1DeveloperAppsResponses.md) | - |
| [PostApiV1EmbeddingsData](Internal/type-aliases/PostApiV1EmbeddingsData.md) | - |
| [PostApiV1EmbeddingsError](Internal/type-aliases/PostApiV1EmbeddingsError.md) | - |
| [PostApiV1EmbeddingsErrors](Internal/type-aliases/PostApiV1EmbeddingsErrors.md) | - |
| [PostApiV1EmbeddingsResponse](Internal/type-aliases/PostApiV1EmbeddingsResponse.md) | - |
| [PostApiV1EmbeddingsResponses](Internal/type-aliases/PostApiV1EmbeddingsResponses.md) | - |
| [PostApiV1GuestChatCompletionsData](Internal/type-aliases/PostApiV1GuestChatCompletionsData.md) | - |
| [PostApiV1GuestChatCompletionsError](Internal/type-aliases/PostApiV1GuestChatCompletionsError.md) | - |
| [PostApiV1GuestChatCompletionsErrors](Internal/type-aliases/PostApiV1GuestChatCompletionsErrors.md) | - |
| [PostApiV1GuestChatCompletionsResponse](Internal/type-aliases/PostApiV1GuestChatCompletionsResponse.md) | - |
| [PostApiV1GuestChatCompletionsResponses](Internal/type-aliases/PostApiV1GuestChatCompletionsResponses.md) | - |
| [PostApiV1PhoneCallsData](Internal/type-aliases/PostApiV1PhoneCallsData.md) | - |
| [PostApiV1PhoneCallsError](Internal/type-aliases/PostApiV1PhoneCallsError.md) | - |
| [PostApiV1PhoneCallsErrors](Internal/type-aliases/PostApiV1PhoneCallsErrors.md) | - |
| [PostApiV1PhoneCallsResponse](Internal/type-aliases/PostApiV1PhoneCallsResponse.md) | - |
| [PostApiV1PhoneCallsResponses](Internal/type-aliases/PostApiV1PhoneCallsResponses.md) | - |
| [PostApiV1ResponsesData](Internal/type-aliases/PostApiV1ResponsesData.md) | - |
| [PostApiV1ResponsesError](Internal/type-aliases/PostApiV1ResponsesError.md) | - |
| [PostApiV1ResponsesErrors](Internal/type-aliases/PostApiV1ResponsesErrors.md) | - |
| [PostApiV1ResponsesResponse](Internal/type-aliases/PostApiV1ResponsesResponse.md) | - |
| [PostApiV1ResponsesResponses](Internal/type-aliases/PostApiV1ResponsesResponses.md) | - |
| [PostApiV1SubscriptionsCancelData](Internal/type-aliases/PostApiV1SubscriptionsCancelData.md) | - |
| [PostApiV1SubscriptionsCancelError](Internal/type-aliases/PostApiV1SubscriptionsCancelError.md) | - |
| [PostApiV1SubscriptionsCancelErrors](Internal/type-aliases/PostApiV1SubscriptionsCancelErrors.md) | - |
| [PostApiV1SubscriptionsCancelResponse](Internal/type-aliases/PostApiV1SubscriptionsCancelResponse.md) | - |
| [PostApiV1SubscriptionsCancelResponses](Internal/type-aliases/PostApiV1SubscriptionsCancelResponses.md) | - |
| [PostApiV1SubscriptionsCancelScheduledDowngradeData](Internal/type-aliases/PostApiV1SubscriptionsCancelScheduledDowngradeData.md) | - |
| [PostApiV1SubscriptionsCancelScheduledDowngradeError](Internal/type-aliases/PostApiV1SubscriptionsCancelScheduledDowngradeError.md) | - |
| [PostApiV1SubscriptionsCancelScheduledDowngradeErrors](Internal/type-aliases/PostApiV1SubscriptionsCancelScheduledDowngradeErrors.md) | - |
| [PostApiV1SubscriptionsCancelScheduledDowngradeResponse](Internal/type-aliases/PostApiV1SubscriptionsCancelScheduledDowngradeResponse.md) | - |
| [PostApiV1SubscriptionsCancelScheduledDowngradeResponses](Internal/type-aliases/PostApiV1SubscriptionsCancelScheduledDowngradeResponses.md) | - |
| [PostApiV1SubscriptionsCreateCheckoutSessionData](Internal/type-aliases/PostApiV1SubscriptionsCreateCheckoutSessionData.md) | - |
| [PostApiV1SubscriptionsCreateCheckoutSessionError](Internal/type-aliases/PostApiV1SubscriptionsCreateCheckoutSessionError.md) | - |
| [PostApiV1SubscriptionsCreateCheckoutSessionErrors](Internal/type-aliases/PostApiV1SubscriptionsCreateCheckoutSessionErrors.md) | - |
| [PostApiV1SubscriptionsCreateCheckoutSessionResponse](Internal/type-aliases/PostApiV1SubscriptionsCreateCheckoutSessionResponse.md) | - |
| [PostApiV1SubscriptionsCreateCheckoutSessionResponses](Internal/type-aliases/PostApiV1SubscriptionsCreateCheckoutSessionResponses.md) | - |
| [PostApiV1SubscriptionsCustomerPortalData](Internal/type-aliases/PostApiV1SubscriptionsCustomerPortalData.md) | - |
| [PostApiV1SubscriptionsCustomerPortalError](Internal/type-aliases/PostApiV1SubscriptionsCustomerPortalError.md) | - |
| [PostApiV1SubscriptionsCustomerPortalErrors](Internal/type-aliases/PostApiV1SubscriptionsCustomerPortalErrors.md) | - |
| [PostApiV1SubscriptionsCustomerPortalResponse](Internal/type-aliases/PostApiV1SubscriptionsCustomerPortalResponse.md) | - |
| [PostApiV1SubscriptionsCustomerPortalResponses](Internal/type-aliases/PostApiV1SubscriptionsCustomerPortalResponses.md) | - |
| [PostApiV1SubscriptionsRenewData](Internal/type-aliases/PostApiV1SubscriptionsRenewData.md) | - |
| [PostApiV1SubscriptionsRenewError](Internal/type-aliases/PostApiV1SubscriptionsRenewError.md) | - |
| [PostApiV1SubscriptionsRenewErrors](Internal/type-aliases/PostApiV1SubscriptionsRenewErrors.md) | - |
| [PostApiV1SubscriptionsRenewResponse](Internal/type-aliases/PostApiV1SubscriptionsRenewResponse.md) | - |
| [PostApiV1SubscriptionsRenewResponses](Internal/type-aliases/PostApiV1SubscriptionsRenewResponses.md) | - |
| [PostApiV1SubscriptionsScheduleDowngradeData](Internal/type-aliases/PostApiV1SubscriptionsScheduleDowngradeData.md) | - |
| [PostApiV1SubscriptionsScheduleDowngradeError](Internal/type-aliases/PostApiV1SubscriptionsScheduleDowngradeError.md) | - |
| [PostApiV1SubscriptionsScheduleDowngradeErrors](Internal/type-aliases/PostApiV1SubscriptionsScheduleDowngradeErrors.md) | - |
| [PostApiV1SubscriptionsScheduleDowngradeResponse](Internal/type-aliases/PostApiV1SubscriptionsScheduleDowngradeResponse.md) | - |
| [PostApiV1SubscriptionsScheduleDowngradeResponses](Internal/type-aliases/PostApiV1SubscriptionsScheduleDowngradeResponses.md) | - |
| [PostApiV1SubscriptionsUpgradeData](Internal/type-aliases/PostApiV1SubscriptionsUpgradeData.md) | - |
| [PostApiV1SubscriptionsUpgradeError](Internal/type-aliases/PostApiV1SubscriptionsUpgradeError.md) | - |
| [PostApiV1SubscriptionsUpgradeErrors](Internal/type-aliases/PostApiV1SubscriptionsUpgradeErrors.md) | - |
| [PostApiV1SubscriptionsUpgradeResponse](Internal/type-aliases/PostApiV1SubscriptionsUpgradeResponse.md) | - |
| [PostApiV1SubscriptionsUpgradeResponses](Internal/type-aliases/PostApiV1SubscriptionsUpgradeResponses.md) | - |
| [PostApiV1SubscriptionsWebhookData](Internal/type-aliases/PostApiV1SubscriptionsWebhookData.md) | - |
| [PostApiV1SubscriptionsWebhookError](Internal/type-aliases/PostApiV1SubscriptionsWebhookError.md) | - |
| [PostApiV1SubscriptionsWebhookErrors](Internal/type-aliases/PostApiV1SubscriptionsWebhookErrors.md) | - |
| [PostApiV1SubscriptionsWebhookResponse](Internal/type-aliases/PostApiV1SubscriptionsWebhookResponse.md) | - |
| [PostApiV1SubscriptionsWebhookResponses](Internal/type-aliases/PostApiV1SubscriptionsWebhookResponses.md) | - |
| [PostApiV1TextByChannelRegisterData](Internal/type-aliases/PostApiV1TextByChannelRegisterData.md) | - |
| [PostApiV1TextByChannelRegisterError](Internal/type-aliases/PostApiV1TextByChannelRegisterError.md) | - |
| [PostApiV1TextByChannelRegisterErrors](Internal/type-aliases/PostApiV1TextByChannelRegisterErrors.md) | - |
| [PostApiV1TextByChannelRegisterResponse](Internal/type-aliases/PostApiV1TextByChannelRegisterResponse.md) | - |
| [PostApiV1TextByChannelRegisterResponses](Internal/type-aliases/PostApiV1TextByChannelRegisterResponses.md) | - |
| [PostApiV1UserApiKeysData](Internal/type-aliases/PostApiV1UserApiKeysData.md) | - |
| [PostApiV1UserApiKeysError](Internal/type-aliases/PostApiV1UserApiKeysError.md) | - |
| [PostApiV1UserApiKeysErrors](Internal/type-aliases/PostApiV1UserApiKeysErrors.md) | - |
| [PostApiV1UserApiKeysResponse](Internal/type-aliases/PostApiV1UserApiKeysResponse.md) | - |
| [PostApiV1UserApiKeysResponses](Internal/type-aliases/PostApiV1UserApiKeysResponses.md) | - |
| [PostApiV1WebhooksRevenuecatData](Internal/type-aliases/PostApiV1WebhooksRevenuecatData.md) | - |
| [PostApiV1WebhooksRevenuecatError](Internal/type-aliases/PostApiV1WebhooksRevenuecatError.md) | - |
| [PostApiV1WebhooksRevenuecatErrors](Internal/type-aliases/PostApiV1WebhooksRevenuecatErrors.md) | - |
| [PostApiV1WebhooksRevenuecatResponse](Internal/type-aliases/PostApiV1WebhooksRevenuecatResponse.md) | - |
| [PostApiV1WebhooksRevenuecatResponses](Internal/type-aliases/PostApiV1WebhooksRevenuecatResponses.md) | - |
| [PostAuthOauthByProviderExchangeData](Internal/type-aliases/PostAuthOauthByProviderExchangeData.md) | - |
| [PostAuthOauthByProviderExchangeError](Internal/type-aliases/PostAuthOauthByProviderExchangeError.md) | - |
| [PostAuthOauthByProviderExchangeErrors](Internal/type-aliases/PostAuthOauthByProviderExchangeErrors.md) | - |
| [PostAuthOauthByProviderExchangeResponse](Internal/type-aliases/PostAuthOauthByProviderExchangeResponse.md) | - |
| [PostAuthOauthByProviderExchangeResponses](Internal/type-aliases/PostAuthOauthByProviderExchangeResponses.md) | - |
| [PostAuthOauthByProviderRefreshData](Internal/type-aliases/PostAuthOauthByProviderRefreshData.md) | - |
| [PostAuthOauthByProviderRefreshError](Internal/type-aliases/PostAuthOauthByProviderRefreshError.md) | - |
| [PostAuthOauthByProviderRefreshErrors](Internal/type-aliases/PostAuthOauthByProviderRefreshErrors.md) | - |
| [PostAuthOauthByProviderRefreshResponse](Internal/type-aliases/PostAuthOauthByProviderRefreshResponse.md) | - |
| [PostAuthOauthByProviderRefreshResponses](Internal/type-aliases/PostAuthOauthByProviderRefreshResponses.md) | - |
| [PostAuthOauthByProviderRevokeData](Internal/type-aliases/PostAuthOauthByProviderRevokeData.md) | - |
| [PostAuthOauthByProviderRevokeError](Internal/type-aliases/PostAuthOauthByProviderRevokeError.md) | - |
| [PostAuthOauthByProviderRevokeErrors](Internal/type-aliases/PostAuthOauthByProviderRevokeErrors.md) | - |
| [PostAuthOauthByProviderRevokeResponse](Internal/type-aliases/PostAuthOauthByProviderRevokeResponse.md) | - |
| [PostAuthOauthByProviderRevokeResponses](Internal/type-aliases/PostAuthOauthByProviderRevokeResponses.md) | - |
| [PostOauthConsentData](Internal/type-aliases/PostOauthConsentData.md) | - |
| [PostOauthConsentError](Internal/type-aliases/PostOauthConsentError.md) | - |
| [PostOauthConsentErrors](Internal/type-aliases/PostOauthConsentErrors.md) | - |
| [PostOauthConsentResponse](Internal/type-aliases/PostOauthConsentResponse.md) | - |
| [PostOauthConsentResponses](Internal/type-aliases/PostOauthConsentResponses.md) | - |
| [PostOauthRevokeData](Internal/type-aliases/PostOauthRevokeData.md) | - |
| [PostOauthRevokeError](Internal/type-aliases/PostOauthRevokeError.md) | - |
| [PostOauthRevokeErrors](Internal/type-aliases/PostOauthRevokeErrors.md) | - |
| [PostOauthRevokeResponse](Internal/type-aliases/PostOauthRevokeResponse.md) | - |
| [PostOauthRevokeResponses](Internal/type-aliases/PostOauthRevokeResponses.md) | - |
| [PostOauthTokenData](Internal/type-aliases/PostOauthTokenData.md) | - |
| [PostOauthTokenError](Internal/type-aliases/PostOauthTokenError.md) | - |
| [PostOauthTokenErrors](Internal/type-aliases/PostOauthTokenErrors.md) | - |
| [PostOauthTokenResponse](Internal/type-aliases/PostOauthTokenResponse.md) | - |
| [PostOauthTokenResponses](Internal/type-aliases/PostOauthTokenResponses.md) | - |
| [PutApiV1AdminAgentsByIdData](Internal/type-aliases/PutApiV1AdminAgentsByIdData.md) | - |
| [PutApiV1AdminAgentsByIdError](Internal/type-aliases/PutApiV1AdminAgentsByIdError.md) | - |
| [PutApiV1AdminAgentsByIdErrors](Internal/type-aliases/PutApiV1AdminAgentsByIdErrors.md) | - |
| [PutApiV1AdminAgentsByIdResponse](Internal/type-aliases/PutApiV1AdminAgentsByIdResponse.md) | - |
| [PutApiV1AdminAgentsByIdResponses](Internal/type-aliases/PutApiV1AdminAgentsByIdResponses.md) | - |
| [PutApiV1AdminAppsByAppIdApiKeysByIdData](Internal/type-aliases/PutApiV1AdminAppsByAppIdApiKeysByIdData.md) | - |
| [PutApiV1AdminAppsByAppIdApiKeysByIdError](Internal/type-aliases/PutApiV1AdminAppsByAppIdApiKeysByIdError.md) | - |
| [PutApiV1AdminAppsByAppIdApiKeysByIdErrors](Internal/type-aliases/PutApiV1AdminAppsByAppIdApiKeysByIdErrors.md) | - |
| [PutApiV1AdminAppsByAppIdApiKeysByIdResponse](Internal/type-aliases/PutApiV1AdminAppsByAppIdApiKeysByIdResponse.md) | - |
| [PutApiV1AdminAppsByAppIdApiKeysByIdResponses](Internal/type-aliases/PutApiV1AdminAppsByAppIdApiKeysByIdResponses.md) | - |
| [PutApiV1AdminAppsByIdData](Internal/type-aliases/PutApiV1AdminAppsByIdData.md) | - |
| [PutApiV1AdminAppsByIdError](Internal/type-aliases/PutApiV1AdminAppsByIdError.md) | - |
| [PutApiV1AdminAppsByIdErrors](Internal/type-aliases/PutApiV1AdminAppsByIdErrors.md) | - |
| [PutApiV1AdminAppsByIdResponse](Internal/type-aliases/PutApiV1AdminAppsByIdResponse.md) | - |
| [PutApiV1AdminAppsByIdResponses](Internal/type-aliases/PutApiV1AdminAppsByIdResponses.md) | - |
| [PutApiV1AdminPersonasByIdData](Internal/type-aliases/PutApiV1AdminPersonasByIdData.md) | - |
| [PutApiV1AdminPersonasByIdError](Internal/type-aliases/PutApiV1AdminPersonasByIdError.md) | - |
| [PutApiV1AdminPersonasByIdErrors](Internal/type-aliases/PutApiV1AdminPersonasByIdErrors.md) | - |
| [PutApiV1AdminPersonasByIdResponse](Internal/type-aliases/PutApiV1AdminPersonasByIdResponse.md) | - |
| [PutApiV1AdminPersonasByIdResponses](Internal/type-aliases/PutApiV1AdminPersonasByIdResponses.md) | - |
| [PutApiV1AgentsByIdPreferenceData](Internal/type-aliases/PutApiV1AgentsByIdPreferenceData.md) | - |
| [PutApiV1AgentsByIdPreferenceError](Internal/type-aliases/PutApiV1AgentsByIdPreferenceError.md) | - |
| [PutApiV1AgentsByIdPreferenceErrors](Internal/type-aliases/PutApiV1AgentsByIdPreferenceErrors.md) | - |
| [PutApiV1AgentsByIdPreferenceResponse](Internal/type-aliases/PutApiV1AgentsByIdPreferenceResponse.md) | - |
| [PutApiV1AgentsByIdPreferenceResponses](Internal/type-aliases/PutApiV1AgentsByIdPreferenceResponses.md) | - |
| [ResponseErrorResponse](Internal/type-aliases/ResponseErrorResponse.md) | - |

## Functions

| Function | Description |
| ------ | ------ |
| [deleteApiV1Account](Internal/functions/deleteApiV1Account.md) | Delete the authenticated user's account |
| [deleteApiV1AdminAgentsById](Internal/functions/deleteApiV1AdminAgentsById.md) | Delete agent |
| [deleteApiV1AdminAppsByAppIdApiKeysById](Internal/functions/deleteApiV1AdminAppsByAppIdApiKeysById.md) | Delete API key |
| [deleteApiV1AdminAppsById](Internal/functions/deleteApiV1AdminAppsById.md) | Delete app |
| [deleteApiV1AdminOauthClientsByClientId](Internal/functions/deleteApiV1AdminOauthClientsByClientId.md) | Revoke an OAuth client (soft delete) |
| [deleteApiV1AdminPersonasById](Internal/functions/deleteApiV1AdminPersonasById.md) | Delete persona |
| [deleteApiV1AdminTextReset](Internal/functions/deleteApiV1AdminTextReset.md) | Reset text registrations |
| [deleteApiV1AdminUsersDelete](Internal/functions/deleteApiV1AdminUsersDelete.md) | Delete user account (admin) |
| [deleteApiV1AuthMfaPasskeyCredentialsByCredentialId](Internal/functions/deleteApiV1AuthMfaPasskeyCredentialsByCredentialId.md) | Delete a passkey |
| [deleteApiV1DeveloperAppsByAppUuid](Internal/functions/deleteApiV1DeveloperAppsByAppUuid.md) | Delete app |
| [deleteApiV1DeveloperAppsByAppUuidApiKeysByKeyId](Internal/functions/deleteApiV1DeveloperAppsByAppUuidApiKeysByKeyId.md) | Delete API key |
| [deleteApiV1DeveloperAppsByAppUuidPrivy](Internal/functions/deleteApiV1DeveloperAppsByAppUuidPrivy.md) | Remove Privy |
| [deleteApiV1TextByChannelUnregister](Internal/functions/deleteApiV1TextByChannelUnregister.md) | Unregister text channel |
| [deleteApiV1UserApiKeysByKeyId](Internal/functions/deleteApiV1UserApiKeysByKeyId.md) | Delete user API key |
| [deleteApiV1UserOauthGrantsById](Internal/functions/deleteApiV1UserOauthGrantsById.md) | Revoke OAuth grant |
| [getApiV1AdminApps](Internal/functions/getApiV1AdminApps.md) | List all apps |
| [getApiV1AdminAppsByAppIdApiKeys](Internal/functions/getApiV1AdminAppsByAppIdApiKeys.md) | List API keys for an app |
| [getApiV1AdminAppsByAppIdApiKeysById](Internal/functions/getApiV1AdminAppsByAppIdApiKeysById.md) | Get API key by ID |
| [getApiV1AdminAppsById](Internal/functions/getApiV1AdminAppsById.md) | Get app by ID |
| [getApiV1AdminOauthClients](Internal/functions/getApiV1AdminOauthClients.md) | List OAuth clients |
| [getApiV1AdminOauthClientsByClientId](Internal/functions/getApiV1AdminOauthClientsByClientId.md) | Get an OAuth client |
| [getApiV1AdminPrivyIdentifiersAudit](Internal/functions/getApiV1AdminPrivyIdentifiersAudit.md) | Audit Privy wallet identifiers |
| [getApiV1AdminUsersLookup](Internal/functions/getApiV1AdminUsersLookup.md) | Lookup user by identifier |
| [getApiV1AgentPreferences](Internal/functions/getApiV1AgentPreferences.md) | List user agent preferences |
| [getApiV1Agents](Internal/functions/getApiV1Agents.md) | List agents |
| [getApiV1AgentsById](Internal/functions/getApiV1AgentsById.md) | Get agent |
| [getApiV1AuthMfaStatus](Internal/functions/getApiV1AuthMfaStatus.md) | MFA status |
| [getApiV1Bootstrap](Internal/functions/getApiV1Bootstrap.md) | Bootstrap client session |
| [getApiV1Config](Internal/functions/getApiV1Config.md) | Get configuration |
| [getApiV1CreditsBalance](Internal/functions/getApiV1CreditsBalance.md) | Get credit balance |
| [getApiV1CreditsPacks](Internal/functions/getApiV1CreditsPacks.md) | List available credit packs |
| [getApiV1CuratedModels](Internal/functions/getApiV1CuratedModels.md) | List curated models |
| [getApiV1DeveloperApps](Internal/functions/getApiV1DeveloperApps.md) | List apps |
| [getApiV1DeveloperAppsByAppUuid](Internal/functions/getApiV1DeveloperAppsByAppUuid.md) | Get app |
| [getApiV1DeveloperAppsByAppUuidApiKeys](Internal/functions/getApiV1DeveloperAppsByAppUuidApiKeys.md) | List API keys |
| [getApiV1DeveloperAppsByAppUuidUsage](Internal/functions/getApiV1DeveloperAppsByAppUuidUsage.md) | Get app usage |
| [getApiV1DeveloperAppsByAppUuidUsageUsers](Internal/functions/getApiV1DeveloperAppsByAppUuidUsageUsers.md) | Get app user usage |
| [getApiV1DeveloperAppsByAppUuidUsers](Internal/functions/getApiV1DeveloperAppsByAppUuidUsers.md) | List users |
| [getApiV1DeveloperAppsByAppUuidUsersByAddress](Internal/functions/getApiV1DeveloperAppsByAppUuidUsersByAddress.md) | Get user |
| [getApiV1DeveloperBilling](Internal/functions/getApiV1DeveloperBilling.md) | Get billing history |
| [getApiV1DocsSwaggerJson](Internal/functions/getApiV1DocsSwaggerJson.md) | Get OpenAPI specification |
| [getApiV1GuestBootstrap](Internal/functions/getApiV1GuestBootstrap.md) | Bootstrap guest session |
| [getApiV1Models](Internal/functions/getApiV1Models.md) | List available models |
| [getApiV1Personas](Internal/functions/getApiV1Personas.md) | List personas |
| [getApiV1PersonasById](Internal/functions/getApiV1PersonasById.md) | Get persona |
| [getApiV1PhoneCallsByCallId](Internal/functions/getApiV1PhoneCallsByCallId.md) | Get phone call |
| [getApiV1SubscriptionsPlans](Internal/functions/getApiV1SubscriptionsPlans.md) | List available subscription plans |
| [getApiV1SubscriptionsStatus](Internal/functions/getApiV1SubscriptionsStatus.md) | Get subscription status |
| [getApiV1TextByChannelLookup](Internal/functions/getApiV1TextByChannelLookup.md) | Lookup text channel registration by identifier |
| [getApiV1TextByChannelStatus](Internal/functions/getApiV1TextByChannelStatus.md) | Get text channel registration status |
| [getApiV1Tools](Internal/functions/getApiV1Tools.md) | List available tools |
| [getApiV1UsageByModality](Internal/functions/getApiV1UsageByModality.md) | Get usage by modality |
| [getApiV1UsageModels](Internal/functions/getApiV1UsageModels.md) | Get usage by model |
| [getApiV1UserApiKeys](Internal/functions/getApiV1UserApiKeys.md) | List user API keys |
| [getApiV1UserOauthGrants](Internal/functions/getApiV1UserOauthGrants.md) | List user OAuth grants |
| [getHealth](Internal/functions/getHealth.md) | Health check |
| [getOauthAuthorize](Internal/functions/getOauthAuthorize.md) | OAuth 2.0 authorization endpoint |
| [getOauthConsent](Internal/functions/getOauthConsent.md) | OAuth consent screen |
| [getWellKnownJwksJson](Internal/functions/getWellKnownJwksJson.md) | OAuth 2.0 JSON Web Key Set |
| [patchApiV1AdminOauthClientsByClientId](Internal/functions/patchApiV1AdminOauthClientsByClientId.md) | Update an OAuth client |
| [patchApiV1DeveloperAppsByAppUuid](Internal/functions/patchApiV1DeveloperAppsByAppUuid.md) | Update app |
| [patchApiV1DeveloperAppsByAppUuidUsersByAddress](Internal/functions/patchApiV1DeveloperAppsByAppUuidUsersByAddress.md) | Update user limit |
| [patchApiV1UserOauthGrantsById](Internal/functions/patchApiV1UserOauthGrantsById.md) | Update OAuth grant |
| [postApiV1AdminAddCredits](Internal/functions/postApiV1AdminAddCredits.md) | Add credits to user |
| [postApiV1AdminAgents](Internal/functions/postApiV1AdminAgents.md) | Create agent |
| [postApiV1AdminApps](Internal/functions/postApiV1AdminApps.md) | Create app |
| [postApiV1AdminAppsByAppIdApiKeys](Internal/functions/postApiV1AdminAppsByAppIdApiKeys.md) | Create API key |
| [postApiV1AdminOauthClients](Internal/functions/postApiV1AdminOauthClients.md) | Create an OAuth client (agent registration) |
| [postApiV1AdminPersonas](Internal/functions/postApiV1AdminPersonas.md) | Create persona |
| [postApiV1AdminPrivyIdentifiersMigrate](Internal/functions/postApiV1AdminPrivyIdentifiersMigrate.md) | Migrate Privy wallet identifiers |
| [postApiV1AdminSeedApps](Internal/functions/postApiV1AdminSeedApps.md) | Seed apps and API keys |
| [postApiV1AdminSubscriptionTier](Internal/functions/postApiV1AdminSubscriptionTier.md) | Set user subscription tier |
| [postApiV1AuthMfaDisable](Internal/functions/postApiV1AuthMfaDisable.md) | Disable MFA |
| [postApiV1AuthMfaPasskeyEnrollBegin](Internal/functions/postApiV1AuthMfaPasskeyEnrollBegin.md) | Begin passkey enrollment |
| [postApiV1AuthMfaPasskeyEnrollFinish](Internal/functions/postApiV1AuthMfaPasskeyEnrollFinish.md) | Finish passkey enrollment |
| [postApiV1AuthMfaPasskeyVerifyBegin](Internal/functions/postApiV1AuthMfaPasskeyVerifyBegin.md) | Begin passkey login verification |
| [postApiV1AuthMfaPasskeyVerifyFinish](Internal/functions/postApiV1AuthMfaPasskeyVerifyFinish.md) | Finish passkey login verification |
| [postApiV1AuthMfaRecoveryCodesRegenerate](Internal/functions/postApiV1AuthMfaRecoveryCodesRegenerate.md) | Regenerate recovery codes |
| [postApiV1AuthMfaTotpEnrollInit](Internal/functions/postApiV1AuthMfaTotpEnrollInit.md) | Begin TOTP enrollment |
| [postApiV1AuthMfaTotpEnrollVerify](Internal/functions/postApiV1AuthMfaTotpEnrollVerify.md) | Verify TOTP enrollment |
| [postApiV1AuthMfaVerify](Internal/functions/postApiV1AuthMfaVerify.md) | Verify MFA at login |
| [postApiV1ChatCompletions](Internal/functions/postApiV1ChatCompletions.md) | Create chat completion |
| [postApiV1CreditsPurchase](Internal/functions/postApiV1CreditsPurchase.md) | Create credit pack checkout session |
| [postApiV1CreditsRedeemTokens](Internal/functions/postApiV1CreditsRedeemTokens.md) | Redeem Anuma Tokens for credits |
| [postApiV1DeveloperApps](Internal/functions/postApiV1DeveloperApps.md) | Create app |
| [postApiV1DeveloperAppsByAppUuidApiKeys](Internal/functions/postApiV1DeveloperAppsByAppUuidApiKeys.md) | Create API key |
| [postApiV1DeveloperAppsByAppUuidFund](Internal/functions/postApiV1DeveloperAppsByAppUuidFund.md) | Fund developer app balance |
| [postApiV1DeveloperAppsByAppUuidPrivy](Internal/functions/postApiV1DeveloperAppsByAppUuidPrivy.md) | Configure Privy |
| [postApiV1DeveloperAppsByAppUuidUsersByAddressTopUp](Internal/functions/postApiV1DeveloperAppsByAppUuidUsersByAddressTopUp.md) | Top up user credits |
| [postApiV1Embeddings](Internal/functions/postApiV1Embeddings.md) | Create embeddings |
| [postApiV1GuestChatCompletions](Internal/functions/postApiV1GuestChatCompletions.md) | Guest chat completion (free trial) |
| [postApiV1PhoneCalls](Internal/functions/postApiV1PhoneCalls.md) | Create phone call |
| [postApiV1Responses](Internal/functions/postApiV1Responses.md) | Create response |
| [postApiV1SubscriptionsCancel](Internal/functions/postApiV1SubscriptionsCancel.md) | Cancel subscription |
| [postApiV1SubscriptionsCancelScheduledDowngrade](Internal/functions/postApiV1SubscriptionsCancelScheduledDowngrade.md) | Cancel scheduled downgrade |
| [postApiV1SubscriptionsCreateCheckoutSession](Internal/functions/postApiV1SubscriptionsCreateCheckoutSession.md) | Create checkout session |
| [postApiV1SubscriptionsCustomerPortal](Internal/functions/postApiV1SubscriptionsCustomerPortal.md) | Create customer portal session |
| [postApiV1SubscriptionsRenew](Internal/functions/postApiV1SubscriptionsRenew.md) | Renew subscription |
| [postApiV1SubscriptionsScheduleDowngrade](Internal/functions/postApiV1SubscriptionsScheduleDowngrade.md) | Schedule subscription downgrade |
| [postApiV1SubscriptionsUpgrade](Internal/functions/postApiV1SubscriptionsUpgrade.md) | Upgrade subscription |
| [postApiV1SubscriptionsWebhook](Internal/functions/postApiV1SubscriptionsWebhook.md) | Handle Stripe webhook |
| [postApiV1TextByChannelRegister](Internal/functions/postApiV1TextByChannelRegister.md) | Register identifier for text channel |
| [postApiV1UserApiKeys](Internal/functions/postApiV1UserApiKeys.md) | Create user API key |
| [postApiV1WebhooksRevenuecat](Internal/functions/postApiV1WebhooksRevenuecat.md) | Handle RevenueCat webhook |
| [postAuthOauthByProviderExchange](Internal/functions/postAuthOauthByProviderExchange.md) | Exchange authorization code for tokens |
| [postAuthOauthByProviderRefresh](Internal/functions/postAuthOauthByProviderRefresh.md) | Refresh access token |
| [postAuthOauthByProviderRevoke](Internal/functions/postAuthOauthByProviderRevoke.md) | Revoke OAuth token |
| [postOauthConsent](Internal/functions/postOauthConsent.md) | Process OAuth consent |
| [postOauthRevoke](Internal/functions/postOauthRevoke.md) | OAuth 2.0 token revocation (RFC 7009) |
| [postOauthToken](Internal/functions/postOauthToken.md) | OAuth 2.0 token endpoint |
| [putApiV1AdminAgentsById](Internal/functions/putApiV1AdminAgentsById.md) | Update agent |
| [putApiV1AdminAppsByAppIdApiKeysById](Internal/functions/putApiV1AdminAppsByAppIdApiKeysById.md) | Update API key |
| [putApiV1AdminAppsById](Internal/functions/putApiV1AdminAppsById.md) | Update app |
| [putApiV1AdminPersonasById](Internal/functions/putApiV1AdminPersonasById.md) | Update persona |
| [putApiV1AgentsByIdPreference](Internal/functions/putApiV1AgentsByIdPreference.md) | Set user agent preference |

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/deleteApiV1Account

# deleteApiV1Account

> **deleteApiV1Account**<`ThrowOnError`>(`options?`: [`Options`](../type-aliases/Options.md)<[`DeleteApiV1AccountData`](../type-aliases/DeleteApiV1AccountData.md), `ThrowOnError`>): `RequestResult`<[`DeleteApiV1AccountResponses`](../type-aliases/DeleteApiV1AccountResponses.md), [`DeleteApiV1AccountErrors`](../type-aliases/DeleteApiV1AccountErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:38](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#38)

Delete the authenticated user's account

Permanently deletes the user's account and all associated data. Cancels any active Stripe subscription.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options?`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`DeleteApiV1AccountData`](../type-aliases/DeleteApiV1AccountData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`DeleteApiV1AccountResponses`](../type-aliases/DeleteApiV1AccountResponses.md), [`DeleteApiV1AccountErrors`](../type-aliases/DeleteApiV1AccountErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/deleteApiV1AdminAgentsById

# deleteApiV1AdminAgentsById

> **deleteApiV1AdminAgentsById**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`DeleteApiV1AdminAgentsByIdData`](../type-aliases/DeleteApiV1AdminAgentsByIdData.md), `ThrowOnError`>): `RequestResult`<[`DeleteApiV1AdminAgentsByIdResponses`](../type-aliases/DeleteApiV1AdminAgentsByIdResponses.md), [`DeleteApiV1AdminAgentsByIdErrors`](../type-aliases/DeleteApiV1AdminAgentsByIdErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:82](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#82)

Delete agent

Deletes an agent by ID. Requires admin API key.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`DeleteApiV1AdminAgentsByIdData`](../type-aliases/DeleteApiV1AdminAgentsByIdData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`DeleteApiV1AdminAgentsByIdResponses`](../type-aliases/DeleteApiV1AdminAgentsByIdResponses.md), [`DeleteApiV1AdminAgentsByIdErrors`](../type-aliases/DeleteApiV1AdminAgentsByIdErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/deleteApiV1AdminAppsByAppIdApiKeysById

# deleteApiV1AdminAppsByAppIdApiKeysById

> **deleteApiV1AdminAppsByAppIdApiKeysById**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`DeleteApiV1AdminAppsByAppIdApiKeysByIdData`](../type-aliases/DeleteApiV1AdminAppsByAppIdApiKeysByIdData.md), `ThrowOnError`>): `RequestResult`<[`DeleteApiV1AdminAppsByAppIdApiKeysByIdResponses`](../type-aliases/DeleteApiV1AdminAppsByAppIdApiKeysByIdResponses.md), [`DeleteApiV1AdminAppsByAppIdApiKeysByIdErrors`](../type-aliases/DeleteApiV1AdminAppsByAppIdApiKeysByIdErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:166](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#166)

Delete API key

Deletes an API key by ID. Requires admin API key.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`DeleteApiV1AdminAppsByAppIdApiKeysByIdData`](../type-aliases/DeleteApiV1AdminAppsByAppIdApiKeysByIdData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`DeleteApiV1AdminAppsByAppIdApiKeysByIdResponses`](../type-aliases/DeleteApiV1AdminAppsByAppIdApiKeysByIdResponses.md), [`DeleteApiV1AdminAppsByAppIdApiKeysByIdErrors`](../type-aliases/DeleteApiV1AdminAppsByAppIdApiKeysByIdErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/deleteApiV1AdminAppsById

# deleteApiV1AdminAppsById

> **deleteApiV1AdminAppsById**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`DeleteApiV1AdminAppsByIdData`](../type-aliases/DeleteApiV1AdminAppsByIdData.md), `ThrowOnError`>): `RequestResult`<[`DeleteApiV1AdminAppsByIdResponses`](../type-aliases/DeleteApiV1AdminAppsByIdResponses.md), [`DeleteApiV1AdminAppsByIdErrors`](../type-aliases/DeleteApiV1AdminAppsByIdErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:206](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#206)

Delete app

Deletes an app by ID. Requires admin API key.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`DeleteApiV1AdminAppsByIdData`](../type-aliases/DeleteApiV1AdminAppsByIdData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`DeleteApiV1AdminAppsByIdResponses`](../type-aliases/DeleteApiV1AdminAppsByIdResponses.md), [`DeleteApiV1AdminAppsByIdErrors`](../type-aliases/DeleteApiV1AdminAppsByIdErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/deleteApiV1AdminOauthClientsByClientId

# deleteApiV1AdminOauthClientsByClientId

> **deleteApiV1AdminOauthClientsByClientId**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`DeleteApiV1AdminOauthClientsByClientIdData`](../type-aliases/DeleteApiV1AdminOauthClientsByClientIdData.md), `ThrowOnError`>): `RequestResult`<[`DeleteApiV1AdminOauthClientsByClientIdResponses`](../type-aliases/DeleteApiV1AdminOauthClientsByClientIdResponses.md), [`DeleteApiV1AdminOauthClientsByClientIdErrors`](../type-aliases/DeleteApiV1AdminOauthClientsByClientIdErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:272](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#272)

Revoke an OAuth client (soft delete)

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`DeleteApiV1AdminOauthClientsByClientIdData`](../type-aliases/DeleteApiV1AdminOauthClientsByClientIdData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`DeleteApiV1AdminOauthClientsByClientIdResponses`](../type-aliases/DeleteApiV1AdminOauthClientsByClientIdResponses.md), [`DeleteApiV1AdminOauthClientsByClientIdErrors`](../type-aliases/DeleteApiV1AdminOauthClientsByClientIdErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/deleteApiV1AdminPersonasById

# deleteApiV1AdminPersonasById

> **deleteApiV1AdminPersonasById**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`DeleteApiV1AdminPersonasByIdData`](../type-aliases/DeleteApiV1AdminPersonasByIdData.md), `ThrowOnError`>): `RequestResult`<[`DeleteApiV1AdminPersonasByIdResponses`](../type-aliases/DeleteApiV1AdminPersonasByIdResponses.md), [`DeleteApiV1AdminPersonasByIdErrors`](../type-aliases/DeleteApiV1AdminPersonasByIdErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:324](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#324)

Delete persona

Deletes a persona by its ID. Requires admin API key.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`DeleteApiV1AdminPersonasByIdData`](../type-aliases/DeleteApiV1AdminPersonasByIdData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`DeleteApiV1AdminPersonasByIdResponses`](../type-aliases/DeleteApiV1AdminPersonasByIdResponses.md), [`DeleteApiV1AdminPersonasByIdErrors`](../type-aliases/DeleteApiV1AdminPersonasByIdErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/deleteApiV1AdminTextReset

# deleteApiV1AdminTextReset

> **deleteApiV1AdminTextReset**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`DeleteApiV1AdminTextResetData`](../type-aliases/DeleteApiV1AdminTextResetData.md), `ThrowOnError`>): `RequestResult`<[`DeleteApiV1AdminTextResetResponses`](../type-aliases/DeleteApiV1AdminTextResetResponses.md), [`DeleteApiV1AdminTextResetErrors`](../type-aliases/DeleteApiV1AdminTextResetErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:408](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#408)

Reset text registrations

Deactivates all active text registrations for a given wallet address.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`DeleteApiV1AdminTextResetData`](../type-aliases/DeleteApiV1AdminTextResetData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`DeleteApiV1AdminTextResetResponses`](../type-aliases/DeleteApiV1AdminTextResetResponses.md), [`DeleteApiV1AdminTextResetErrors`](../type-aliases/DeleteApiV1AdminTextResetErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/deleteApiV1AdminUsersDelete

# deleteApiV1AdminUsersDelete

> **deleteApiV1AdminUsersDelete**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`DeleteApiV1AdminUsersDeleteData`](../type-aliases/DeleteApiV1AdminUsersDeleteData.md), `ThrowOnError`>): `RequestResult`<[`DeleteApiV1AdminUsersDeleteResponses`](../type-aliases/DeleteApiV1AdminUsersDeleteResponses.md), [`DeleteApiV1AdminUsersDeleteErrors`](../type-aliases/DeleteApiV1AdminUsersDeleteErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:420](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#420)

Delete user account (admin)

Permanently deletes a user account and all associated cascading data (enrollments, requests, credit claims, etc.) and best-effort cancels any Stripe subscription. Accepts wallet\_address, phone, telegram, or email (exactly one required). Returns stripe\_cleanup\_succeeded=false when the account was deleted but the Stripe customer cleanup failed — operator must clean up Stripe manually.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`DeleteApiV1AdminUsersDeleteData`](../type-aliases/DeleteApiV1AdminUsersDeleteData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`DeleteApiV1AdminUsersDeleteResponses`](../type-aliases/DeleteApiV1AdminUsersDeleteResponses.md), [`DeleteApiV1AdminUsersDeleteErrors`](../type-aliases/DeleteApiV1AdminUsersDeleteErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/deleteApiV1AuthMfaPasskeyCredentialsByCredentialId

# deleteApiV1AuthMfaPasskeyCredentialsByCredentialId

> **deleteApiV1AuthMfaPasskeyCredentialsByCredentialId**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`DeleteApiV1AuthMfaPasskeyCredentialsByCredentialIdData`](../type-aliases/DeleteApiV1AuthMfaPasskeyCredentialsByCredentialIdData.md), `ThrowOnError`>): `RequestResult`<[`DeleteApiV1AuthMfaPasskeyCredentialsByCredentialIdResponses`](../type-aliases/DeleteApiV1AuthMfaPasskeyCredentialsByCredentialIdResponses.md), [`DeleteApiV1AuthMfaPasskeyCredentialsByCredentialIdErrors`](../type-aliases/DeleteApiV1AuthMfaPasskeyCredentialsByCredentialIdErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:508](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#508)

Delete a passkey

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`DeleteApiV1AuthMfaPasskeyCredentialsByCredentialIdData`](../type-aliases/DeleteApiV1AuthMfaPasskeyCredentialsByCredentialIdData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`DeleteApiV1AuthMfaPasskeyCredentialsByCredentialIdResponses`](../type-aliases/DeleteApiV1AuthMfaPasskeyCredentialsByCredentialIdResponses.md), [`DeleteApiV1AuthMfaPasskeyCredentialsByCredentialIdErrors`](../type-aliases/DeleteApiV1AuthMfaPasskeyCredentialsByCredentialIdErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/deleteApiV1DeveloperAppsByAppUuid

# deleteApiV1DeveloperAppsByAppUuid

> **deleteApiV1DeveloperAppsByAppUuid**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`DeleteApiV1DeveloperAppsByAppUuidData`](../type-aliases/DeleteApiV1DeveloperAppsByAppUuidData.md), `ThrowOnError`>): `RequestResult`<[`DeleteApiV1DeveloperAppsByAppUuidResponses`](../type-aliases/DeleteApiV1DeveloperAppsByAppUuidResponses.md), [`DeleteApiV1DeveloperAppsByAppUuidErrors`](../type-aliases/DeleteApiV1DeveloperAppsByAppUuidErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:764](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#764)

Delete app

Soft-deletes an app by deactivating it. The app can be reactivated later.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`DeleteApiV1DeveloperAppsByAppUuidData`](../type-aliases/DeleteApiV1DeveloperAppsByAppUuidData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`DeleteApiV1DeveloperAppsByAppUuidResponses`](../type-aliases/DeleteApiV1DeveloperAppsByAppUuidResponses.md), [`DeleteApiV1DeveloperAppsByAppUuidErrors`](../type-aliases/DeleteApiV1DeveloperAppsByAppUuidErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/deleteApiV1DeveloperAppsByAppUuidApiKeysByKeyId

# deleteApiV1DeveloperAppsByAppUuidApiKeysByKeyId

> **deleteApiV1DeveloperAppsByAppUuidApiKeysByKeyId**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`DeleteApiV1DeveloperAppsByAppUuidApiKeysByKeyIdData`](../type-aliases/DeleteApiV1DeveloperAppsByAppUuidApiKeysByKeyIdData.md), `ThrowOnError`>): `RequestResult`<[`DeleteApiV1DeveloperAppsByAppUuidApiKeysByKeyIdResponses`](../type-aliases/DeleteApiV1DeveloperAppsByAppUuidApiKeysByKeyIdResponses.md), [`DeleteApiV1DeveloperAppsByAppUuidApiKeysByKeyIdErrors`](../type-aliases/DeleteApiV1DeveloperAppsByAppUuidApiKeysByKeyIdErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:832](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#832)

Delete API key

Revokes (deletes) an API key.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`DeleteApiV1DeveloperAppsByAppUuidApiKeysByKeyIdData`](../type-aliases/DeleteApiV1DeveloperAppsByAppUuidApiKeysByKeyIdData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`DeleteApiV1DeveloperAppsByAppUuidApiKeysByKeyIdResponses`](../type-aliases/DeleteApiV1DeveloperAppsByAppUuidApiKeysByKeyIdResponses.md), [`DeleteApiV1DeveloperAppsByAppUuidApiKeysByKeyIdErrors`](../type-aliases/DeleteApiV1DeveloperAppsByAppUuidApiKeysByKeyIdErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/deleteApiV1DeveloperAppsByAppUuidPrivy

# deleteApiV1DeveloperAppsByAppUuidPrivy

> **deleteApiV1DeveloperAppsByAppUuidPrivy**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`DeleteApiV1DeveloperAppsByAppUuidPrivyData`](../type-aliases/DeleteApiV1DeveloperAppsByAppUuidPrivyData.md), `ThrowOnError`>): `RequestResult`<[`DeleteApiV1DeveloperAppsByAppUuidPrivyResponses`](../type-aliases/DeleteApiV1DeveloperAppsByAppUuidPrivyResponses.md), [`DeleteApiV1DeveloperAppsByAppUuidPrivyErrors`](../type-aliases/DeleteApiV1DeveloperAppsByAppUuidPrivyErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:860](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#860)

Remove Privy

Removes Privy authentication configuration from an app.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`DeleteApiV1DeveloperAppsByAppUuidPrivyData`](../type-aliases/DeleteApiV1DeveloperAppsByAppUuidPrivyData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`DeleteApiV1DeveloperAppsByAppUuidPrivyResponses`](../type-aliases/DeleteApiV1DeveloperAppsByAppUuidPrivyResponses.md), [`DeleteApiV1DeveloperAppsByAppUuidPrivyErrors`](../type-aliases/DeleteApiV1DeveloperAppsByAppUuidPrivyErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/deleteApiV1TextByChannelUnregister

# deleteApiV1TextByChannelUnregister

> **deleteApiV1TextByChannelUnregister**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`DeleteApiV1TextByChannelUnregisterData`](../type-aliases/DeleteApiV1TextByChannelUnregisterData.md), `ThrowOnError`>): `RequestResult`<[`DeleteApiV1TextByChannelUnregisterResponses`](../type-aliases/DeleteApiV1TextByChannelUnregisterResponses.md), [`DeleteApiV1TextByChannelUnregisterErrors`](../type-aliases/DeleteApiV1TextByChannelUnregisterErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:1297](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#1297)

Unregister text channel

Deactivates the text channel registration for the authenticated user.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`DeleteApiV1TextByChannelUnregisterData`](../type-aliases/DeleteApiV1TextByChannelUnregisterData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`DeleteApiV1TextByChannelUnregisterResponses`](../type-aliases/DeleteApiV1TextByChannelUnregisterResponses.md), [`DeleteApiV1TextByChannelUnregisterErrors`](../type-aliases/DeleteApiV1TextByChannelUnregisterErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/deleteApiV1UserApiKeysByKeyId

# deleteApiV1UserApiKeysByKeyId

> **deleteApiV1UserApiKeysByKeyId**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`DeleteApiV1UserApiKeysByKeyIdData`](../type-aliases/DeleteApiV1UserApiKeysByKeyIdData.md), `ThrowOnError`>): `RequestResult`<[`DeleteApiV1UserApiKeysByKeyIdResponses`](../type-aliases/DeleteApiV1UserApiKeysByKeyIdResponses.md), [`DeleteApiV1UserApiKeysByKeyIdErrors`](../type-aliases/DeleteApiV1UserApiKeysByKeyIdErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:1373](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#1373)

Delete user API key

Deletes an API key owned by the authenticated user.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`DeleteApiV1UserApiKeysByKeyIdData`](../type-aliases/DeleteApiV1UserApiKeysByKeyIdData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`DeleteApiV1UserApiKeysByKeyIdResponses`](../type-aliases/DeleteApiV1UserApiKeysByKeyIdResponses.md), [`DeleteApiV1UserApiKeysByKeyIdErrors`](../type-aliases/DeleteApiV1UserApiKeysByKeyIdErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/deleteApiV1UserOauthGrantsById

# deleteApiV1UserOauthGrantsById

> **deleteApiV1UserOauthGrantsById**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`DeleteApiV1UserOauthGrantsByIdData`](../type-aliases/DeleteApiV1UserOauthGrantsByIdData.md), `ThrowOnError`>): `RequestResult`<[`DeleteApiV1UserOauthGrantsByIdResponses`](../type-aliases/DeleteApiV1UserOauthGrantsByIdResponses.md), [`DeleteApiV1UserOauthGrantsByIdErrors`](../type-aliases/DeleteApiV1UserOauthGrantsByIdErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:1397](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#1397)

Revoke OAuth grant

Revokes an OAuth grant owned by the authenticated user, disabling the associated agent's access.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`DeleteApiV1UserOauthGrantsByIdData`](../type-aliases/DeleteApiV1UserOauthGrantsByIdData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`DeleteApiV1UserOauthGrantsByIdResponses`](../type-aliases/DeleteApiV1UserOauthGrantsByIdResponses.md), [`DeleteApiV1UserOauthGrantsByIdErrors`](../type-aliases/DeleteApiV1UserOauthGrantsByIdErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/getApiV1AdminApps

# getApiV1AdminApps

> **getApiV1AdminApps**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`GetApiV1AdminAppsData`](../type-aliases/GetApiV1AdminAppsData.md), `ThrowOnError`>): `RequestResult`<[`GetApiV1AdminAppsResponses`](../type-aliases/GetApiV1AdminAppsResponses.md), [`GetApiV1AdminAppsErrors`](../type-aliases/GetApiV1AdminAppsErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:110](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#110)

List all apps

Returns all registered apps with pagination. Requires admin API key.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`GetApiV1AdminAppsData`](../type-aliases/GetApiV1AdminAppsData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`GetApiV1AdminAppsResponses`](../type-aliases/GetApiV1AdminAppsResponses.md), [`GetApiV1AdminAppsErrors`](../type-aliases/GetApiV1AdminAppsErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/getApiV1AdminAppsByAppIdApiKeys

# getApiV1AdminAppsByAppIdApiKeys

> **getApiV1AdminAppsByAppIdApiKeys**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`GetApiV1AdminAppsByAppIdApiKeysData`](../type-aliases/GetApiV1AdminAppsByAppIdApiKeysData.md), `ThrowOnError`>): `RequestResult`<[`GetApiV1AdminAppsByAppIdApiKeysResponses`](../type-aliases/GetApiV1AdminAppsByAppIdApiKeysResponses.md), [`GetApiV1AdminAppsByAppIdApiKeysErrors`](../type-aliases/GetApiV1AdminAppsByAppIdApiKeysErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:138](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#138)

List API keys for an app

Returns API keys for the specified app with pagination. Requires admin API key.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`GetApiV1AdminAppsByAppIdApiKeysData`](../type-aliases/GetApiV1AdminAppsByAppIdApiKeysData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`GetApiV1AdminAppsByAppIdApiKeysResponses`](../type-aliases/GetApiV1AdminAppsByAppIdApiKeysResponses.md), [`GetApiV1AdminAppsByAppIdApiKeysErrors`](../type-aliases/GetApiV1AdminAppsByAppIdApiKeysErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/getApiV1AdminAppsByAppIdApiKeysById

# getApiV1AdminAppsByAppIdApiKeysById

> **getApiV1AdminAppsByAppIdApiKeysById**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`GetApiV1AdminAppsByAppIdApiKeysByIdData`](../type-aliases/GetApiV1AdminAppsByAppIdApiKeysByIdData.md), `ThrowOnError`>): `RequestResult`<[`GetApiV1AdminAppsByAppIdApiKeysByIdResponses`](../type-aliases/GetApiV1AdminAppsByAppIdApiKeysByIdResponses.md), [`GetApiV1AdminAppsByAppIdApiKeysByIdErrors`](../type-aliases/GetApiV1AdminAppsByAppIdApiKeysByIdErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:178](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#178)

Get API key by ID

Returns a single API key by its ID with wallet balance details. Requires admin API key.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`GetApiV1AdminAppsByAppIdApiKeysByIdData`](../type-aliases/GetApiV1AdminAppsByAppIdApiKeysByIdData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`GetApiV1AdminAppsByAppIdApiKeysByIdResponses`](../type-aliases/GetApiV1AdminAppsByAppIdApiKeysByIdResponses.md), [`GetApiV1AdminAppsByAppIdApiKeysByIdErrors`](../type-aliases/GetApiV1AdminAppsByAppIdApiKeysByIdErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/getApiV1AdminAppsById

# getApiV1AdminAppsById

> **getApiV1AdminAppsById**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`GetApiV1AdminAppsByIdData`](../type-aliases/GetApiV1AdminAppsByIdData.md), `ThrowOnError`>): `RequestResult`<[`GetApiV1AdminAppsByIdResponses`](../type-aliases/GetApiV1AdminAppsByIdResponses.md), [`GetApiV1AdminAppsByIdErrors`](../type-aliases/GetApiV1AdminAppsByIdErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:218](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#218)

Get app by ID

Returns a single app by its ID. Requires admin API key.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`GetApiV1AdminAppsByIdData`](../type-aliases/GetApiV1AdminAppsByIdData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`GetApiV1AdminAppsByIdResponses`](../type-aliases/GetApiV1AdminAppsByIdResponses.md), [`GetApiV1AdminAppsByIdErrors`](../type-aliases/GetApiV1AdminAppsByIdErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/getApiV1AdminOauthClients

# getApiV1AdminOauthClients

> **getApiV1AdminOauthClients**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`GetApiV1AdminOauthClientsData`](../type-aliases/GetApiV1AdminOauthClientsData.md), `ThrowOnError`>): `RequestResult`<[`GetApiV1AdminOauthClientsResponses`](../type-aliases/GetApiV1AdminOauthClientsResponses.md), `unknown`, `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:246](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#246)

List OAuth clients

Returns OAuth clients with pagination. Requires admin API key.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`GetApiV1AdminOauthClientsData`](../type-aliases/GetApiV1AdminOauthClientsData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`GetApiV1AdminOauthClientsResponses`](../type-aliases/GetApiV1AdminOauthClientsResponses.md), `unknown`, `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/getApiV1AdminOauthClientsByClientId

# getApiV1AdminOauthClientsByClientId

> **getApiV1AdminOauthClientsByClientId**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`GetApiV1AdminOauthClientsByClientIdData`](../type-aliases/GetApiV1AdminOauthClientsByClientIdData.md), `ThrowOnError`>): `RequestResult`<[`GetApiV1AdminOauthClientsByClientIdResponses`](../type-aliases/GetApiV1AdminOauthClientsByClientIdResponses.md), [`GetApiV1AdminOauthClientsByClientIdErrors`](../type-aliases/GetApiV1AdminOauthClientsByClientIdErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:282](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#282)

Get an OAuth client

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`GetApiV1AdminOauthClientsByClientIdData`](../type-aliases/GetApiV1AdminOauthClientsByClientIdData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`GetApiV1AdminOauthClientsByClientIdResponses`](../type-aliases/GetApiV1AdminOauthClientsByClientIdResponses.md), [`GetApiV1AdminOauthClientsByClientIdErrors`](../type-aliases/GetApiV1AdminOauthClientsByClientIdErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/getApiV1AdminPrivyIdentifiersAudit

# getApiV1AdminPrivyIdentifiersAudit

> **getApiV1AdminPrivyIdentifiersAudit**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`GetApiV1AdminPrivyIdentifiersAuditData`](../type-aliases/GetApiV1AdminPrivyIdentifiersAuditData.md), `ThrowOnError`>): `RequestResult`<[`GetApiV1AdminPrivyIdentifiersAuditResponses`](../type-aliases/GetApiV1AdminPrivyIdentifiersAuditResponses.md), [`GetApiV1AdminPrivyIdentifiersAuditErrors`](../type-aliases/GetApiV1AdminPrivyIdentifiersAuditErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:352](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#352)

Audit Privy wallet identifiers

Lists accounts whose stored wallet identifier differs from the embedded wallet the Privy admin API returns for the same user. Read-only — no changes are written.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`GetApiV1AdminPrivyIdentifiersAuditData`](../type-aliases/GetApiV1AdminPrivyIdentifiersAuditData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`GetApiV1AdminPrivyIdentifiersAuditResponses`](../type-aliases/GetApiV1AdminPrivyIdentifiersAuditResponses.md), [`GetApiV1AdminPrivyIdentifiersAuditErrors`](../type-aliases/GetApiV1AdminPrivyIdentifiersAuditErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/getApiV1AdminUsersLookup

# getApiV1AdminUsersLookup

> **getApiV1AdminUsersLookup**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`GetApiV1AdminUsersLookupData`](../type-aliases/GetApiV1AdminUsersLookupData.md), `ThrowOnError`>): `RequestResult`<[`GetApiV1AdminUsersLookupResponses`](../type-aliases/GetApiV1AdminUsersLookupResponses.md), [`GetApiV1AdminUsersLookupErrors`](../type-aliases/GetApiV1AdminUsersLookupErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:432](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#432)

Lookup user by identifier

Retrieves account details, all app enrollments with balances, and text registrations. Accepts wallet\_address, phone, telegram, or email (exactly one required).

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`GetApiV1AdminUsersLookupData`](../type-aliases/GetApiV1AdminUsersLookupData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`GetApiV1AdminUsersLookupResponses`](../type-aliases/GetApiV1AdminUsersLookupResponses.md), [`GetApiV1AdminUsersLookupErrors`](../type-aliases/GetApiV1AdminUsersLookupErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/getApiV1AgentPreferences

# getApiV1AgentPreferences

> **getApiV1AgentPreferences**<`ThrowOnError`>(`options?`: [`Options`](../type-aliases/Options.md)<[`GetApiV1AgentPreferencesData`](../type-aliases/GetApiV1AgentPreferencesData.md), `ThrowOnError`>): `RequestResult`<[`GetApiV1AgentPreferencesResponses`](../type-aliases/GetApiV1AgentPreferencesResponses.md), [`GetApiV1AgentPreferencesErrors`](../type-aliases/GetApiV1AgentPreferencesErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:444](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#444)

List user agent preferences

Returns all model preferences the user has set for agents

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options?`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`GetApiV1AgentPreferencesData`](../type-aliases/GetApiV1AgentPreferencesData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`GetApiV1AgentPreferencesResponses`](../type-aliases/GetApiV1AgentPreferencesResponses.md), [`GetApiV1AgentPreferencesErrors`](../type-aliases/GetApiV1AgentPreferencesErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/getApiV1Agents

# getApiV1Agents

> **getApiV1Agents**<`ThrowOnError`>(`options?`: [`Options`](../type-aliases/Options.md)<[`GetApiV1AgentsData`](../type-aliases/GetApiV1AgentsData.md), `ThrowOnError`>): `RequestResult`<[`GetApiV1AgentsResponses`](../type-aliases/GetApiV1AgentsResponses.md), [`GetApiV1AgentsErrors`](../type-aliases/GetApiV1AgentsErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:456](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#456)

List agents

Returns all active agents available in the system

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options?`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`GetApiV1AgentsData`](../type-aliases/GetApiV1AgentsData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`GetApiV1AgentsResponses`](../type-aliases/GetApiV1AgentsResponses.md), [`GetApiV1AgentsErrors`](../type-aliases/GetApiV1AgentsErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/getApiV1AgentsById

# getApiV1AgentsById

> **getApiV1AgentsById**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`GetApiV1AgentsByIdData`](../type-aliases/GetApiV1AgentsByIdData.md), `ThrowOnError`>): `RequestResult`<[`GetApiV1AgentsByIdResponses`](../type-aliases/GetApiV1AgentsByIdResponses.md), [`GetApiV1AgentsByIdErrors`](../type-aliases/GetApiV1AgentsByIdErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:468](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#468)

Get agent

Returns a specific agent by its ID

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`GetApiV1AgentsByIdData`](../type-aliases/GetApiV1AgentsByIdData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`GetApiV1AgentsByIdResponses`](../type-aliases/GetApiV1AgentsByIdResponses.md), [`GetApiV1AgentsByIdErrors`](../type-aliases/GetApiV1AgentsByIdErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/getApiV1AuthMfaStatus

# getApiV1AuthMfaStatus

> **getApiV1AuthMfaStatus**<`ThrowOnError`>(`options?`: [`Options`](../type-aliases/Options.md)<[`GetApiV1AuthMfaStatusData`](../type-aliases/GetApiV1AuthMfaStatusData.md), `ThrowOnError`>): `RequestResult`<[`GetApiV1AuthMfaStatusResponses`](../type-aliases/GetApiV1AuthMfaStatusResponses.md), [`GetApiV1AuthMfaStatusErrors`](../type-aliases/GetApiV1AuthMfaStatusErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:578](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#578)

MFA status

Returns whether MFA is enabled and which factors are enrolled.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options?`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`GetApiV1AuthMfaStatusData`](../type-aliases/GetApiV1AuthMfaStatusData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`GetApiV1AuthMfaStatusResponses`](../type-aliases/GetApiV1AuthMfaStatusResponses.md), [`GetApiV1AuthMfaStatusErrors`](../type-aliases/GetApiV1AuthMfaStatusErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/getApiV1Bootstrap

# getApiV1Bootstrap

> **getApiV1Bootstrap**<`ThrowOnError`>(`options?`: [`Options`](../type-aliases/Options.md)<[`GetApiV1BootstrapData`](../type-aliases/GetApiV1BootstrapData.md), `ThrowOnError`>): `RequestResult`<[`GetApiV1BootstrapResponses`](../type-aliases/GetApiV1BootstrapResponses.md), [`GetApiV1BootstrapErrors`](../type-aliases/GetApiV1BootstrapErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:628](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#628)

Bootstrap client session

Returns the authenticated user identity, feature-flag assignments, and server build metadata in a single call. Intended to be called once after auth resolves on the client.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options?`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`GetApiV1BootstrapData`](../type-aliases/GetApiV1BootstrapData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`GetApiV1BootstrapResponses`](../type-aliases/GetApiV1BootstrapResponses.md), [`GetApiV1BootstrapErrors`](../type-aliases/GetApiV1BootstrapErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/getApiV1Config

# getApiV1Config

> **getApiV1Config**<`ThrowOnError`>(`options?`: [`Options`](../type-aliases/Options.md)<[`GetApiV1ConfigData`](../type-aliases/GetApiV1ConfigData.md), `ThrowOnError`>): `RequestResult`<[`GetApiV1ConfigResponses`](../type-aliases/GetApiV1ConfigResponses.md), [`GetApiV1ConfigErrors`](../type-aliases/GetApiV1ConfigErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:656](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#656)

Get configuration

Returns public configuration including registered apps

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options?`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`GetApiV1ConfigData`](../type-aliases/GetApiV1ConfigData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`GetApiV1ConfigResponses`](../type-aliases/GetApiV1ConfigResponses.md), [`GetApiV1ConfigErrors`](../type-aliases/GetApiV1ConfigErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/getApiV1CreditsBalance

# getApiV1CreditsBalance

> **getApiV1CreditsBalance**<`ThrowOnError`>(`options?`: [`Options`](../type-aliases/Options.md)<[`GetApiV1CreditsBalanceData`](../type-aliases/GetApiV1CreditsBalanceData.md), `ThrowOnError`>): `RequestResult`<[`GetApiV1CreditsBalanceResponses`](../type-aliases/GetApiV1CreditsBalanceResponses.md), [`GetApiV1CreditsBalanceErrors`](../type-aliases/GetApiV1CreditsBalanceErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:668](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#668)

Get credit balance

Returns the credit balance and related information for the authenticated user. Optionally accepts X-Timezone header for accurate next claim time calculation.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options?`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`GetApiV1CreditsBalanceData`](../type-aliases/GetApiV1CreditsBalanceData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`GetApiV1CreditsBalanceResponses`](../type-aliases/GetApiV1CreditsBalanceResponses.md), [`GetApiV1CreditsBalanceErrors`](../type-aliases/GetApiV1CreditsBalanceErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/getApiV1CreditsPacks

# getApiV1CreditsPacks

> **getApiV1CreditsPacks**<`ThrowOnError`>(`options?`: [`Options`](../type-aliases/Options.md)<[`GetApiV1CreditsPacksData`](../type-aliases/GetApiV1CreditsPacksData.md), `ThrowOnError`>): `RequestResult`<[`GetApiV1CreditsPacksResponses`](../type-aliases/GetApiV1CreditsPacksResponses.md), [`GetApiV1CreditsPacksErrors`](../type-aliases/GetApiV1CreditsPacksErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:680](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#680)

List available credit packs

Returns available credit packs with prices fetched from Stripe.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options?`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`GetApiV1CreditsPacksData`](../type-aliases/GetApiV1CreditsPacksData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`GetApiV1CreditsPacksResponses`](../type-aliases/GetApiV1CreditsPacksResponses.md), [`GetApiV1CreditsPacksErrors`](../type-aliases/GetApiV1CreditsPacksErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/getApiV1CuratedModels

# getApiV1CuratedModels

> **getApiV1CuratedModels**<`ThrowOnError`>(`options?`: [`Options`](../type-aliases/Options.md)<[`GetApiV1CuratedModelsData`](../type-aliases/GetApiV1CuratedModelsData.md), `ThrowOnError`>): `RequestResult`<[`GetApiV1CuratedModelsResponses`](../type-aliases/GetApiV1CuratedModelsResponses.md), `unknown`, `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:724](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#724)

List curated models

Returns the product-curated catalog of models with display metadata (name, description, provider, price tier, quality, privacy flag, tier gate). Replaces the hardcoded list previously maintained in the web/mobile clients. Public, no auth required.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options?`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`GetApiV1CuratedModelsData`](../type-aliases/GetApiV1CuratedModelsData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`GetApiV1CuratedModelsResponses`](../type-aliases/GetApiV1CuratedModelsResponses.md), `unknown`, `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/getApiV1DeveloperApps

# getApiV1DeveloperApps

> **getApiV1DeveloperApps**<`ThrowOnError`>(`options?`: [`Options`](../type-aliases/Options.md)<[`GetApiV1DeveloperAppsData`](../type-aliases/GetApiV1DeveloperAppsData.md), `ThrowOnError`>): `RequestResult`<[`GetApiV1DeveloperAppsResponses`](../type-aliases/GetApiV1DeveloperAppsResponses.md), [`GetApiV1DeveloperAppsErrors`](../type-aliases/GetApiV1DeveloperAppsErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:736](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#736)

List apps

Lists all apps owned by the authenticated developer with pagination.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options?`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`GetApiV1DeveloperAppsData`](../type-aliases/GetApiV1DeveloperAppsData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`GetApiV1DeveloperAppsResponses`](../type-aliases/GetApiV1DeveloperAppsResponses.md), [`GetApiV1DeveloperAppsErrors`](../type-aliases/GetApiV1DeveloperAppsErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/getApiV1DeveloperAppsByAppUuid

# getApiV1DeveloperAppsByAppUuid

> **getApiV1DeveloperAppsByAppUuid**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`GetApiV1DeveloperAppsByAppUuidData`](../type-aliases/GetApiV1DeveloperAppsByAppUuidData.md), `ThrowOnError`>): `RequestResult`<[`GetApiV1DeveloperAppsByAppUuidResponses`](../type-aliases/GetApiV1DeveloperAppsByAppUuidResponses.md), [`GetApiV1DeveloperAppsByAppUuidErrors`](../type-aliases/GetApiV1DeveloperAppsByAppUuidErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:776](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#776)

Get app

Retrieves details of a specific app owned by the developer.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`GetApiV1DeveloperAppsByAppUuidData`](../type-aliases/GetApiV1DeveloperAppsByAppUuidData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`GetApiV1DeveloperAppsByAppUuidResponses`](../type-aliases/GetApiV1DeveloperAppsByAppUuidResponses.md), [`GetApiV1DeveloperAppsByAppUuidErrors`](../type-aliases/GetApiV1DeveloperAppsByAppUuidErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/getApiV1DeveloperAppsByAppUuidApiKeys

# getApiV1DeveloperAppsByAppUuidApiKeys

> **getApiV1DeveloperAppsByAppUuidApiKeys**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`GetApiV1DeveloperAppsByAppUuidApiKeysData`](../type-aliases/GetApiV1DeveloperAppsByAppUuidApiKeysData.md), `ThrowOnError`>): `RequestResult`<[`GetApiV1DeveloperAppsByAppUuidApiKeysResponses`](../type-aliases/GetApiV1DeveloperAppsByAppUuidApiKeysResponses.md), [`GetApiV1DeveloperAppsByAppUuidApiKeysErrors`](../type-aliases/GetApiV1DeveloperAppsByAppUuidApiKeysErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:804](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#804)

List API keys

Lists all API keys for the app (without secrets) with pagination.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`GetApiV1DeveloperAppsByAppUuidApiKeysData`](../type-aliases/GetApiV1DeveloperAppsByAppUuidApiKeysData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`GetApiV1DeveloperAppsByAppUuidApiKeysResponses`](../type-aliases/GetApiV1DeveloperAppsByAppUuidApiKeysResponses.md), [`GetApiV1DeveloperAppsByAppUuidApiKeysErrors`](../type-aliases/GetApiV1DeveloperAppsByAppUuidApiKeysErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/getApiV1DeveloperAppsByAppUuidUsage

# getApiV1DeveloperAppsByAppUuidUsage

> **getApiV1DeveloperAppsByAppUuidUsage**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`GetApiV1DeveloperAppsByAppUuidUsageData`](../type-aliases/GetApiV1DeveloperAppsByAppUuidUsageData.md), `ThrowOnError`>): `RequestResult`<[`GetApiV1DeveloperAppsByAppUuidUsageResponses`](../type-aliases/GetApiV1DeveloperAppsByAppUuidUsageResponses.md), [`GetApiV1DeveloperAppsByAppUuidUsageErrors`](../type-aliases/GetApiV1DeveloperAppsByAppUuidUsageErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:888](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#888)

Get app usage

Returns aggregate usage data and timeseries for an app within a time range.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`GetApiV1DeveloperAppsByAppUuidUsageData`](../type-aliases/GetApiV1DeveloperAppsByAppUuidUsageData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`GetApiV1DeveloperAppsByAppUuidUsageResponses`](../type-aliases/GetApiV1DeveloperAppsByAppUuidUsageResponses.md), [`GetApiV1DeveloperAppsByAppUuidUsageErrors`](../type-aliases/GetApiV1DeveloperAppsByAppUuidUsageErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/getApiV1DeveloperAppsByAppUuidUsageUsers

# getApiV1DeveloperAppsByAppUuidUsageUsers

> **getApiV1DeveloperAppsByAppUuidUsageUsers**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`GetApiV1DeveloperAppsByAppUuidUsageUsersData`](../type-aliases/GetApiV1DeveloperAppsByAppUuidUsageUsersData.md), `ThrowOnError`>): `RequestResult`<[`GetApiV1DeveloperAppsByAppUuidUsageUsersResponses`](../type-aliases/GetApiV1DeveloperAppsByAppUuidUsageUsersResponses.md), [`GetApiV1DeveloperAppsByAppUuidUsageUsersErrors`](../type-aliases/GetApiV1DeveloperAppsByAppUuidUsageUsersErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:900](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#900)

Get app user usage

Returns per-user usage data for an app within a time range, paginated.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`GetApiV1DeveloperAppsByAppUuidUsageUsersData`](../type-aliases/GetApiV1DeveloperAppsByAppUuidUsageUsersData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`GetApiV1DeveloperAppsByAppUuidUsageUsersResponses`](../type-aliases/GetApiV1DeveloperAppsByAppUuidUsageUsersResponses.md), [`GetApiV1DeveloperAppsByAppUuidUsageUsersErrors`](../type-aliases/GetApiV1DeveloperAppsByAppUuidUsageUsersErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/getApiV1DeveloperAppsByAppUuidUsers

# getApiV1DeveloperAppsByAppUuidUsers

> **getApiV1DeveloperAppsByAppUuidUsers**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`GetApiV1DeveloperAppsByAppUuidUsersData`](../type-aliases/GetApiV1DeveloperAppsByAppUuidUsersData.md), `ThrowOnError`>): `RequestResult`<[`GetApiV1DeveloperAppsByAppUuidUsersResponses`](../type-aliases/GetApiV1DeveloperAppsByAppUuidUsersResponses.md), [`GetApiV1DeveloperAppsByAppUuidUsersErrors`](../type-aliases/GetApiV1DeveloperAppsByAppUuidUsersErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:912](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#912)

List users

Lists all users enrolled in the app with their credit balances.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`GetApiV1DeveloperAppsByAppUuidUsersData`](../type-aliases/GetApiV1DeveloperAppsByAppUuidUsersData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`GetApiV1DeveloperAppsByAppUuidUsersResponses`](../type-aliases/GetApiV1DeveloperAppsByAppUuidUsersResponses.md), [`GetApiV1DeveloperAppsByAppUuidUsersErrors`](../type-aliases/GetApiV1DeveloperAppsByAppUuidUsersErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/getApiV1DeveloperAppsByAppUuidUsersByAddress

# getApiV1DeveloperAppsByAppUuidUsersByAddress

> **getApiV1DeveloperAppsByAppUuidUsersByAddress**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`GetApiV1DeveloperAppsByAppUuidUsersByAddressData`](../type-aliases/GetApiV1DeveloperAppsByAppUuidUsersByAddressData.md), `ThrowOnError`>): `RequestResult`<[`GetApiV1DeveloperAppsByAppUuidUsersByAddressResponses`](../type-aliases/GetApiV1DeveloperAppsByAppUuidUsersByAddressResponses.md), [`GetApiV1DeveloperAppsByAppUuidUsersByAddressErrors`](../type-aliases/GetApiV1DeveloperAppsByAppUuidUsersByAddressErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:924](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#924)

Get user

Retrieves details of a specific user enrolled in the app.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`GetApiV1DeveloperAppsByAppUuidUsersByAddressData`](../type-aliases/GetApiV1DeveloperAppsByAppUuidUsersByAddressData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`GetApiV1DeveloperAppsByAppUuidUsersByAddressResponses`](../type-aliases/GetApiV1DeveloperAppsByAppUuidUsersByAddressResponses.md), [`GetApiV1DeveloperAppsByAppUuidUsersByAddressErrors`](../type-aliases/GetApiV1DeveloperAppsByAppUuidUsersByAddressErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/getApiV1DeveloperBilling

# getApiV1DeveloperBilling

> **getApiV1DeveloperBilling**<`ThrowOnError`>(`options?`: [`Options`](../type-aliases/Options.md)<[`GetApiV1DeveloperBillingData`](../type-aliases/GetApiV1DeveloperBillingData.md), `ThrowOnError`>): `RequestResult`<[`GetApiV1DeveloperBillingResponses`](../type-aliases/GetApiV1DeveloperBillingResponses.md), [`GetApiV1DeveloperBillingErrors`](../type-aliases/GetApiV1DeveloperBillingErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:968](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#968)

Get billing history

Returns a paginated list of the developer's completed app funding payments.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options?`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`GetApiV1DeveloperBillingData`](../type-aliases/GetApiV1DeveloperBillingData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`GetApiV1DeveloperBillingResponses`](../type-aliases/GetApiV1DeveloperBillingResponses.md), [`GetApiV1DeveloperBillingErrors`](../type-aliases/GetApiV1DeveloperBillingErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/getApiV1DocsSwaggerJson

# getApiV1DocsSwaggerJson

> **getApiV1DocsSwaggerJson**<`ThrowOnError`>(`options?`: [`Options`](../type-aliases/Options.md)<[`GetApiV1DocsSwaggerJsonData`](../type-aliases/GetApiV1DocsSwaggerJsonData.md), `ThrowOnError`>): `RequestResult`<[`GetApiV1DocsSwaggerJsonResponses`](../type-aliases/GetApiV1DocsSwaggerJsonResponses.md), `unknown`, `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:980](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#980)

Get OpenAPI specification

Returns the OpenAPI 3.1 specification for this API

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options?`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`GetApiV1DocsSwaggerJsonData`](../type-aliases/GetApiV1DocsSwaggerJsonData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`GetApiV1DocsSwaggerJsonResponses`](../type-aliases/GetApiV1DocsSwaggerJsonResponses.md), `unknown`, `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/getApiV1GuestBootstrap

# getApiV1GuestBootstrap

> **getApiV1GuestBootstrap**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`GetApiV1GuestBootstrapData`](../type-aliases/GetApiV1GuestBootstrapData.md), `ThrowOnError`>): `RequestResult`<[`GetApiV1GuestBootstrapResponses`](../type-aliases/GetApiV1GuestBootstrapResponses.md), [`GetApiV1GuestBootstrapErrors`](../type-aliases/GetApiV1GuestBootstrapErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:1008](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#1008)

Bootstrap guest session

Returns feature-flag assignments and server build metadata for an unauthenticated visitor. The client must generate a UUID v4 on first visit, persist it locally, and send it as X-Guest-ID on every call. Returns 400 if the header is missing or malformed.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`GetApiV1GuestBootstrapData`](../type-aliases/GetApiV1GuestBootstrapData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`GetApiV1GuestBootstrapResponses`](../type-aliases/GetApiV1GuestBootstrapResponses.md), [`GetApiV1GuestBootstrapErrors`](../type-aliases/GetApiV1GuestBootstrapErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/getApiV1Models

# getApiV1Models

> **getApiV1Models**<`ThrowOnError`>(`options?`: [`Options`](../type-aliases/Options.md)<[`GetApiV1ModelsData`](../type-aliases/GetApiV1ModelsData.md), `ThrowOnError`>): `RequestResult`<[`GetApiV1ModelsResponses`](../type-aliases/GetApiV1ModelsResponses.md), [`GetApiV1ModelsErrors`](../type-aliases/GetApiV1ModelsErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:1036](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#1036)

List available models

Returns a list of all available models from the configured gateway with optional filters. Models include modality information indicating their capabilities (e.g., llm, embedding, vision, image, audio, reasoning, code, reranker, multimodal, video).

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options?`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`GetApiV1ModelsData`](../type-aliases/GetApiV1ModelsData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`GetApiV1ModelsResponses`](../type-aliases/GetApiV1ModelsResponses.md), [`GetApiV1ModelsErrors`](../type-aliases/GetApiV1ModelsErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/getApiV1Personas

# getApiV1Personas

> **getApiV1Personas**<`ThrowOnError`>(`options?`: [`Options`](../type-aliases/Options.md)<[`GetApiV1PersonasData`](../type-aliases/GetApiV1PersonasData.md), `ThrowOnError`>): `RequestResult`<[`GetApiV1PersonasResponses`](../type-aliases/GetApiV1PersonasResponses.md), [`GetApiV1PersonasErrors`](../type-aliases/GetApiV1PersonasErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:1048](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#1048)

List personas

Returns all personas with the prompt field stripped from config

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options?`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`GetApiV1PersonasData`](../type-aliases/GetApiV1PersonasData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`GetApiV1PersonasResponses`](../type-aliases/GetApiV1PersonasResponses.md), [`GetApiV1PersonasErrors`](../type-aliases/GetApiV1PersonasErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/getApiV1PersonasById

# getApiV1PersonasById

> **getApiV1PersonasById**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`GetApiV1PersonasByIdData`](../type-aliases/GetApiV1PersonasByIdData.md), `ThrowOnError`>): `RequestResult`<[`GetApiV1PersonasByIdResponses`](../type-aliases/GetApiV1PersonasByIdResponses.md), [`GetApiV1PersonasByIdErrors`](../type-aliases/GetApiV1PersonasByIdErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:1060](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#1060)

Get persona

Returns a specific persona by its ID with full configuration

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`GetApiV1PersonasByIdData`](../type-aliases/GetApiV1PersonasByIdData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`GetApiV1PersonasByIdResponses`](../type-aliases/GetApiV1PersonasByIdResponses.md), [`GetApiV1PersonasByIdErrors`](../type-aliases/GetApiV1PersonasByIdErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/getApiV1PhoneCallsByCallId

# getApiV1PhoneCallsByCallId

> **getApiV1PhoneCallsByCallId**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`GetApiV1PhoneCallsByCallIdData`](../type-aliases/GetApiV1PhoneCallsByCallIdData.md), `ThrowOnError`>): `RequestResult`<[`GetApiV1PhoneCallsByCallIdResponses`](../type-aliases/GetApiV1PhoneCallsByCallIdResponses.md), [`GetApiV1PhoneCallsByCallIdErrors`](../type-aliases/GetApiV1PhoneCallsByCallIdErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:1089](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#1089)

Get phone call

Returns the latest Bland.ai call status, summary, and transcript details for a queued phone call.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`GetApiV1PhoneCallsByCallIdData`](../type-aliases/GetApiV1PhoneCallsByCallIdData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`GetApiV1PhoneCallsByCallIdResponses`](../type-aliases/GetApiV1PhoneCallsByCallIdResponses.md), [`GetApiV1PhoneCallsByCallIdErrors`](../type-aliases/GetApiV1PhoneCallsByCallIdErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/getApiV1SubscriptionsPlans

# getApiV1SubscriptionsPlans

> **getApiV1SubscriptionsPlans**<`ThrowOnError`>(`options?`: [`Options`](../type-aliases/Options.md)<[`GetApiV1SubscriptionsPlansData`](../type-aliases/GetApiV1SubscriptionsPlansData.md), `ThrowOnError`>): `RequestResult`<[`GetApiV1SubscriptionsPlansResponses`](../type-aliases/GetApiV1SubscriptionsPlansResponses.md), [`GetApiV1SubscriptionsPlansErrors`](../type-aliases/GetApiV1SubscriptionsPlansErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:1173](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#1173)

List available subscription plans

Returns available subscription plans with prices fetched from Stripe.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options?`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`GetApiV1SubscriptionsPlansData`](../type-aliases/GetApiV1SubscriptionsPlansData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`GetApiV1SubscriptionsPlansResponses`](../type-aliases/GetApiV1SubscriptionsPlansResponses.md), [`GetApiV1SubscriptionsPlansErrors`](../type-aliases/GetApiV1SubscriptionsPlansErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/getApiV1SubscriptionsStatus

# getApiV1SubscriptionsStatus

> **getApiV1SubscriptionsStatus**<`ThrowOnError`>(`options?`: [`Options`](../type-aliases/Options.md)<[`GetApiV1SubscriptionsStatusData`](../type-aliases/GetApiV1SubscriptionsStatusData.md), `ThrowOnError`>): `RequestResult`<[`GetApiV1SubscriptionsStatusResponses`](../type-aliases/GetApiV1SubscriptionsStatusResponses.md), [`GetApiV1SubscriptionsStatusErrors`](../type-aliases/GetApiV1SubscriptionsStatusErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:1213](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#1213)

Get subscription status

Returns the current subscription status, plan, and billing period info

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options?`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`GetApiV1SubscriptionsStatusData`](../type-aliases/GetApiV1SubscriptionsStatusData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`GetApiV1SubscriptionsStatusResponses`](../type-aliases/GetApiV1SubscriptionsStatusResponses.md), [`GetApiV1SubscriptionsStatusErrors`](../type-aliases/GetApiV1SubscriptionsStatusErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/getApiV1TextByChannelLookup

# getApiV1TextByChannelLookup

> **getApiV1TextByChannelLookup**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`GetApiV1TextByChannelLookupData`](../type-aliases/GetApiV1TextByChannelLookupData.md), `ThrowOnError`>): `RequestResult`<[`GetApiV1TextByChannelLookupResponses`](../type-aliases/GetApiV1TextByChannelLookupResponses.md), [`GetApiV1TextByChannelLookupErrors`](../type-aliases/GetApiV1TextByChannelLookupErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:1257](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#1257)

Lookup text channel registration by identifier

Looks up an active text channel registration by identifier. Requires service-level API key authentication. Results are scoped to the calling app.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`GetApiV1TextByChannelLookupData`](../type-aliases/GetApiV1TextByChannelLookupData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`GetApiV1TextByChannelLookupResponses`](../type-aliases/GetApiV1TextByChannelLookupResponses.md), [`GetApiV1TextByChannelLookupErrors`](../type-aliases/GetApiV1TextByChannelLookupErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/getApiV1TextByChannelStatus

# getApiV1TextByChannelStatus

> **getApiV1TextByChannelStatus**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`GetApiV1TextByChannelStatusData`](../type-aliases/GetApiV1TextByChannelStatusData.md), `ThrowOnError`>): `RequestResult`<[`GetApiV1TextByChannelStatusResponses`](../type-aliases/GetApiV1TextByChannelStatusResponses.md), [`GetApiV1TextByChannelStatusErrors`](../type-aliases/GetApiV1TextByChannelStatusErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:1285](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#1285)

Get text channel registration status

Returns the text channel registration status for the authenticated user.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`GetApiV1TextByChannelStatusData`](../type-aliases/GetApiV1TextByChannelStatusData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`GetApiV1TextByChannelStatusResponses`](../type-aliases/GetApiV1TextByChannelStatusResponses.md), [`GetApiV1TextByChannelStatusErrors`](../type-aliases/GetApiV1TextByChannelStatusErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/getApiV1Tools

# getApiV1Tools

> **getApiV1Tools**<`ThrowOnError`>(`options?`: [`Options`](../type-aliases/Options.md)<[`GetApiV1ToolsData`](../type-aliases/GetApiV1ToolsData.md), `ThrowOnError`>): `RequestResult`<[`GetApiV1ToolsResponses`](../type-aliases/GetApiV1ToolsResponses.md), [`GetApiV1ToolsErrors`](../type-aliases/GetApiV1ToolsErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:1309](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#1309)

List available tools

Returns a map of available MCP tool schemas indexed by tool name.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options?`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`GetApiV1ToolsData`](../type-aliases/GetApiV1ToolsData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`GetApiV1ToolsResponses`](../type-aliases/GetApiV1ToolsResponses.md), [`GetApiV1ToolsErrors`](../type-aliases/GetApiV1ToolsErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/getApiV1UsageByModality

# getApiV1UsageByModality

> **getApiV1UsageByModality**<`ThrowOnError`>(`options?`: [`Options`](../type-aliases/Options.md)<[`GetApiV1UsageByModalityData`](../type-aliases/GetApiV1UsageByModalityData.md), `ThrowOnError`>): `RequestResult`<[`GetApiV1UsageByModalityResponses`](../type-aliases/GetApiV1UsageByModalityResponses.md), [`GetApiV1UsageByModalityErrors`](../type-aliases/GetApiV1UsageByModalityErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:1321](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#1321)

Get usage by modality

Returns usage grouped into the four user-facing modality buckets (text, image, video, audio) for the authenticated user within a time period. Tool spend is attributed to the bucket of the calling model. Unknown models default to text.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options?`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`GetApiV1UsageByModalityData`](../type-aliases/GetApiV1UsageByModalityData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`GetApiV1UsageByModalityResponses`](../type-aliases/GetApiV1UsageByModalityResponses.md), [`GetApiV1UsageByModalityErrors`](../type-aliases/GetApiV1UsageByModalityErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/getApiV1UsageModels

# getApiV1UsageModels

> **getApiV1UsageModels**<`ThrowOnError`>(`options?`: [`Options`](../type-aliases/Options.md)<[`GetApiV1UsageModelsData`](../type-aliases/GetApiV1UsageModelsData.md), `ThrowOnError`>): `RequestResult`<[`GetApiV1UsageModelsResponses`](../type-aliases/GetApiV1UsageModelsResponses.md), [`GetApiV1UsageModelsErrors`](../type-aliases/GetApiV1UsageModelsErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:1333](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#1333)

Get usage by model

Returns per-model usage (spend, requests, tokens) and tool usage grouped by model for the authenticated user within a time period.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options?`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`GetApiV1UsageModelsData`](../type-aliases/GetApiV1UsageModelsData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`GetApiV1UsageModelsResponses`](../type-aliases/GetApiV1UsageModelsResponses.md), [`GetApiV1UsageModelsErrors`](../type-aliases/GetApiV1UsageModelsErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/getApiV1UserApiKeys

# getApiV1UserApiKeys

> **getApiV1UserApiKeys**<`ThrowOnError`>(`options?`: [`Options`](../type-aliases/Options.md)<[`GetApiV1UserApiKeysData`](../type-aliases/GetApiV1UserApiKeysData.md), `ThrowOnError`>): `RequestResult`<[`GetApiV1UserApiKeysResponses`](../type-aliases/GetApiV1UserApiKeysResponses.md), [`GetApiV1UserApiKeysErrors`](../type-aliases/GetApiV1UserApiKeysErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:1345](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#1345)

List user API keys

Lists all API keys owned by the authenticated user for the app they are authenticated against.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options?`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`GetApiV1UserApiKeysData`](../type-aliases/GetApiV1UserApiKeysData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`GetApiV1UserApiKeysResponses`](../type-aliases/GetApiV1UserApiKeysResponses.md), [`GetApiV1UserApiKeysErrors`](../type-aliases/GetApiV1UserApiKeysErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/getApiV1UserOauthGrants

# getApiV1UserOauthGrants

> **getApiV1UserOauthGrants**<`ThrowOnError`>(`options?`: [`Options`](../type-aliases/Options.md)<[`GetApiV1UserOauthGrantsData`](../type-aliases/GetApiV1UserOauthGrantsData.md), `ThrowOnError`>): `RequestResult`<[`GetApiV1UserOauthGrantsResponses`](../type-aliases/GetApiV1UserOauthGrantsResponses.md), [`GetApiV1UserOauthGrantsErrors`](../type-aliases/GetApiV1UserOauthGrantsErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:1385](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#1385)

List user OAuth grants

Returns all OAuth grants (active and revoked) for the authenticated user, including today's daily spend.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options?`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`GetApiV1UserOauthGrantsData`](../type-aliases/GetApiV1UserOauthGrantsData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`GetApiV1UserOauthGrantsResponses`](../type-aliases/GetApiV1UserOauthGrantsResponses.md), [`GetApiV1UserOauthGrantsErrors`](../type-aliases/GetApiV1UserOauthGrantsErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/getHealth

# getHealth

> **getHealth**<`ThrowOnError`>(`options?`: [`Options`](../type-aliases/Options.md)<[`GetHealthData`](../type-aliases/GetHealthData.md), `ThrowOnError`>): `RequestResult`<[`GetHealthResponses`](../type-aliases/GetHealthResponses.md), [`GetHealthErrors`](../type-aliases/GetHealthErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:1489](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#1489)

Health check

Returns the current health status of the service.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options?`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`GetHealthData`](../type-aliases/GetHealthData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`GetHealthResponses`](../type-aliases/GetHealthResponses.md), [`GetHealthErrors`](../type-aliases/GetHealthErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/getOauthAuthorize

# getOauthAuthorize

> **getOauthAuthorize**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`GetOauthAuthorizeData`](../type-aliases/GetOauthAuthorizeData.md), `ThrowOnError`>): `RequestResult`<`unknown`, [`GetOauthAuthorizeErrors`](../type-aliases/GetOauthAuthorizeErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:1501](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#1501)

OAuth 2.0 authorization endpoint

Starts the OAuth 2.0 authorization code flow. Requires the user to be authenticated via Privy JWT. When the requested scopes fit an existing grant, auto-issues a code; otherwise 302s back with error=access\_denied (consent UI lands in PR #2).

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`GetOauthAuthorizeData`](../type-aliases/GetOauthAuthorizeData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<`unknown`, [`GetOauthAuthorizeErrors`](../type-aliases/GetOauthAuthorizeErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/getOauthConsent

# getOauthConsent

> **getOauthConsent**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`GetOauthConsentData`](../type-aliases/GetOauthConsentData.md), `ThrowOnError`>): `RequestResult`<[`GetOauthConsentResponses`](../type-aliases/GetOauthConsentResponses.md), [`GetOauthConsentErrors`](../type-aliases/GetOauthConsentErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:1513](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#1513)

OAuth consent screen

Displays the consent form for the user to approve or deny an OAuth application.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`GetOauthConsentData`](../type-aliases/GetOauthConsentData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`GetOauthConsentResponses`](../type-aliases/GetOauthConsentResponses.md), [`GetOauthConsentErrors`](../type-aliases/GetOauthConsentErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/getWellKnownJwksJson

# getWellKnownJwksJson

> **getWellKnownJwksJson**<`ThrowOnError`>(`options?`: [`Options`](../type-aliases/Options.md)<[`GetWellKnownJwksJsonData`](../type-aliases/GetWellKnownJwksJsonData.md), `ThrowOnError`>): `RequestResult`<[`GetWellKnownJwksJsonResponses`](../type-aliases/GetWellKnownJwksJsonResponses.md), `unknown`, `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:26](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#26)

OAuth 2.0 JSON Web Key Set

Returns the portal's OAuth signing public keys for verifying portal-issued access tokens.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options?`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`GetWellKnownJwksJsonData`](../type-aliases/GetWellKnownJwksJsonData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`GetWellKnownJwksJsonResponses`](../type-aliases/GetWellKnownJwksJsonResponses.md), `unknown`, `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/patchApiV1AdminOauthClientsByClientId

# patchApiV1AdminOauthClientsByClientId

> **patchApiV1AdminOauthClientsByClientId**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`PatchApiV1AdminOauthClientsByClientIdData`](../type-aliases/PatchApiV1AdminOauthClientsByClientIdData.md), `ThrowOnError`>): `RequestResult`<[`PatchApiV1AdminOauthClientsByClientIdResponses`](../type-aliases/PatchApiV1AdminOauthClientsByClientIdResponses.md), [`PatchApiV1AdminOauthClientsByClientIdErrors`](../type-aliases/PatchApiV1AdminOauthClientsByClientIdErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:292](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#292)

Update an OAuth client

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`PatchApiV1AdminOauthClientsByClientIdData`](../type-aliases/PatchApiV1AdminOauthClientsByClientIdData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`PatchApiV1AdminOauthClientsByClientIdResponses`](../type-aliases/PatchApiV1AdminOauthClientsByClientIdResponses.md), [`PatchApiV1AdminOauthClientsByClientIdErrors`](../type-aliases/PatchApiV1AdminOauthClientsByClientIdErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/patchApiV1DeveloperAppsByAppUuid

# patchApiV1DeveloperAppsByAppUuid

> **patchApiV1DeveloperAppsByAppUuid**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`PatchApiV1DeveloperAppsByAppUuidData`](../type-aliases/PatchApiV1DeveloperAppsByAppUuidData.md), `ThrowOnError`>): `RequestResult`<[`PatchApiV1DeveloperAppsByAppUuidResponses`](../type-aliases/PatchApiV1DeveloperAppsByAppUuidResponses.md), [`PatchApiV1DeveloperAppsByAppUuidErrors`](../type-aliases/PatchApiV1DeveloperAppsByAppUuidErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:788](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#788)

Update app

Updates an app's settings. Only provided fields are updated.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`PatchApiV1DeveloperAppsByAppUuidData`](../type-aliases/PatchApiV1DeveloperAppsByAppUuidData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`PatchApiV1DeveloperAppsByAppUuidResponses`](../type-aliases/PatchApiV1DeveloperAppsByAppUuidResponses.md), [`PatchApiV1DeveloperAppsByAppUuidErrors`](../type-aliases/PatchApiV1DeveloperAppsByAppUuidErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/patchApiV1DeveloperAppsByAppUuidUsersByAddress

# patchApiV1DeveloperAppsByAppUuidUsersByAddress

> **patchApiV1DeveloperAppsByAppUuidUsersByAddress**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`PatchApiV1DeveloperAppsByAppUuidUsersByAddressData`](../type-aliases/PatchApiV1DeveloperAppsByAppUuidUsersByAddressData.md), `ThrowOnError`>): `RequestResult`<[`PatchApiV1DeveloperAppsByAppUuidUsersByAddressResponses`](../type-aliases/PatchApiV1DeveloperAppsByAppUuidUsersByAddressResponses.md), [`PatchApiV1DeveloperAppsByAppUuidUsersByAddressErrors`](../type-aliases/PatchApiV1DeveloperAppsByAppUuidUsersByAddressErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:936](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#936)

Update user limit

Updates a user's cost limit. Credits are transferred from the app balance.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`PatchApiV1DeveloperAppsByAppUuidUsersByAddressData`](../type-aliases/PatchApiV1DeveloperAppsByAppUuidUsersByAddressData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`PatchApiV1DeveloperAppsByAppUuidUsersByAddressResponses`](../type-aliases/PatchApiV1DeveloperAppsByAppUuidUsersByAddressResponses.md), [`PatchApiV1DeveloperAppsByAppUuidUsersByAddressErrors`](../type-aliases/PatchApiV1DeveloperAppsByAppUuidUsersByAddressErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/patchApiV1UserOauthGrantsById

# patchApiV1UserOauthGrantsById

> **patchApiV1UserOauthGrantsById**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`PatchApiV1UserOauthGrantsByIdData`](../type-aliases/PatchApiV1UserOauthGrantsByIdData.md), `ThrowOnError`>): `RequestResult`<[`PatchApiV1UserOauthGrantsByIdResponses`](../type-aliases/PatchApiV1UserOauthGrantsByIdResponses.md), [`PatchApiV1UserOauthGrantsByIdErrors`](../type-aliases/PatchApiV1UserOauthGrantsByIdErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:1409](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#1409)

Update OAuth grant

Updates the daily spending cap on an OAuth grant owned by the authenticated user.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`PatchApiV1UserOauthGrantsByIdData`](../type-aliases/PatchApiV1UserOauthGrantsByIdData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`PatchApiV1UserOauthGrantsByIdResponses`](../type-aliases/PatchApiV1UserOauthGrantsByIdResponses.md), [`PatchApiV1UserOauthGrantsByIdErrors`](../type-aliases/PatchApiV1UserOauthGrantsByIdErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/postApiV1AdminAddCredits

# postApiV1AdminAddCredits

> **postApiV1AdminAddCredits**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`PostApiV1AdminAddCreditsData`](../type-aliases/PostApiV1AdminAddCreditsData.md), `ThrowOnError`>): `RequestResult`<[`PostApiV1AdminAddCreditsResponses`](../type-aliases/PostApiV1AdminAddCreditsResponses.md), [`PostApiV1AdminAddCreditsErrors`](../type-aliases/PostApiV1AdminAddCreditsErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:50](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#50)

Add credits to user

Adds credits to a user's account.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`PostApiV1AdminAddCreditsData`](../type-aliases/PostApiV1AdminAddCreditsData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`PostApiV1AdminAddCreditsResponses`](../type-aliases/PostApiV1AdminAddCreditsResponses.md), [`PostApiV1AdminAddCreditsErrors`](../type-aliases/PostApiV1AdminAddCreditsErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/postApiV1AdminAgents

# postApiV1AdminAgents

> **postApiV1AdminAgents**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`PostApiV1AdminAgentsData`](../type-aliases/PostApiV1AdminAgentsData.md), `ThrowOnError`>): `RequestResult`<[`PostApiV1AdminAgentsResponses`](../type-aliases/PostApiV1AdminAgentsResponses.md), [`PostApiV1AdminAgentsErrors`](../type-aliases/PostApiV1AdminAgentsErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:66](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#66)

Create agent

Creates a new agent. Requires admin API key.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`PostApiV1AdminAgentsData`](../type-aliases/PostApiV1AdminAgentsData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`PostApiV1AdminAgentsResponses`](../type-aliases/PostApiV1AdminAgentsResponses.md), [`PostApiV1AdminAgentsErrors`](../type-aliases/PostApiV1AdminAgentsErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/postApiV1AdminApps

# postApiV1AdminApps

> **postApiV1AdminApps**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`PostApiV1AdminAppsData`](../type-aliases/PostApiV1AdminAppsData.md), `ThrowOnError`>): `RequestResult`<[`PostApiV1AdminAppsResponses`](../type-aliases/PostApiV1AdminAppsResponses.md), [`PostApiV1AdminAppsErrors`](../type-aliases/PostApiV1AdminAppsErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:122](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#122)

Create app

Creates a new app. Requires admin API key.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`PostApiV1AdminAppsData`](../type-aliases/PostApiV1AdminAppsData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`PostApiV1AdminAppsResponses`](../type-aliases/PostApiV1AdminAppsResponses.md), [`PostApiV1AdminAppsErrors`](../type-aliases/PostApiV1AdminAppsErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/postApiV1AdminAppsByAppIdApiKeys

# postApiV1AdminAppsByAppIdApiKeys

> **postApiV1AdminAppsByAppIdApiKeys**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`PostApiV1AdminAppsByAppIdApiKeysData`](../type-aliases/PostApiV1AdminAppsByAppIdApiKeysData.md), `ThrowOnError`>): `RequestResult`<[`PostApiV1AdminAppsByAppIdApiKeysResponses`](../type-aliases/PostApiV1AdminAppsByAppIdApiKeysResponses.md), [`PostApiV1AdminAppsByAppIdApiKeysErrors`](../type-aliases/PostApiV1AdminAppsByAppIdApiKeysErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:150](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#150)

Create API key

Creates a new API key for an app. Requires admin API key.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`PostApiV1AdminAppsByAppIdApiKeysData`](../type-aliases/PostApiV1AdminAppsByAppIdApiKeysData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`PostApiV1AdminAppsByAppIdApiKeysResponses`](../type-aliases/PostApiV1AdminAppsByAppIdApiKeysResponses.md), [`PostApiV1AdminAppsByAppIdApiKeysErrors`](../type-aliases/PostApiV1AdminAppsByAppIdApiKeysErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/postApiV1AdminOauthClients

# postApiV1AdminOauthClients

> **postApiV1AdminOauthClients**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`PostApiV1AdminOauthClientsData`](../type-aliases/PostApiV1AdminOauthClientsData.md), `ThrowOnError`>): `RequestResult`<[`PostApiV1AdminOauthClientsResponses`](../type-aliases/PostApiV1AdminOauthClientsResponses.md), [`PostApiV1AdminOauthClientsErrors`](../type-aliases/PostApiV1AdminOauthClientsErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:258](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#258)

Create an OAuth client (agent registration)

Registers a new OAuth 2.0 client. Public clients (default) authenticate via PKCE and have no secret. Confidential clients receive a plaintext secret in the response (returned exactly once).

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`PostApiV1AdminOauthClientsData`](../type-aliases/PostApiV1AdminOauthClientsData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`PostApiV1AdminOauthClientsResponses`](../type-aliases/PostApiV1AdminOauthClientsResponses.md), [`PostApiV1AdminOauthClientsErrors`](../type-aliases/PostApiV1AdminOauthClientsErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/postApiV1AdminPersonas

# postApiV1AdminPersonas

> **postApiV1AdminPersonas**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`PostApiV1AdminPersonasData`](../type-aliases/PostApiV1AdminPersonasData.md), `ThrowOnError`>): `RequestResult`<[`PostApiV1AdminPersonasResponses`](../type-aliases/PostApiV1AdminPersonasResponses.md), [`PostApiV1AdminPersonasErrors`](../type-aliases/PostApiV1AdminPersonasErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:308](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#308)

Create persona

Creates a new persona. Requires admin API key.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`PostApiV1AdminPersonasData`](../type-aliases/PostApiV1AdminPersonasData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`PostApiV1AdminPersonasResponses`](../type-aliases/PostApiV1AdminPersonasResponses.md), [`PostApiV1AdminPersonasErrors`](../type-aliases/PostApiV1AdminPersonasErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/postApiV1AdminPrivyIdentifiersMigrate

# postApiV1AdminPrivyIdentifiersMigrate

> **postApiV1AdminPrivyIdentifiersMigrate**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`PostApiV1AdminPrivyIdentifiersMigrateData`](../type-aliases/PostApiV1AdminPrivyIdentifiersMigrateData.md), `ThrowOnError`>): `RequestResult`<[`PostApiV1AdminPrivyIdentifiersMigrateResponses`](../type-aliases/PostApiV1AdminPrivyIdentifiersMigrateResponses.md), [`PostApiV1AdminPrivyIdentifiersMigrateErrors`](../type-aliases/PostApiV1AdminPrivyIdentifiersMigrateErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:364](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#364)

Migrate Privy wallet identifiers

Rewrites each account's stored wallet identifier to the embedded wallet returned by the Privy admin API. Idempotent — accounts already pointing at the embedded wallet are skipped.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`PostApiV1AdminPrivyIdentifiersMigrateData`](../type-aliases/PostApiV1AdminPrivyIdentifiersMigrateData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`PostApiV1AdminPrivyIdentifiersMigrateResponses`](../type-aliases/PostApiV1AdminPrivyIdentifiersMigrateResponses.md), [`PostApiV1AdminPrivyIdentifiersMigrateErrors`](../type-aliases/PostApiV1AdminPrivyIdentifiersMigrateErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/postApiV1AdminSeedApps

# postApiV1AdminSeedApps

> **postApiV1AdminSeedApps**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`PostApiV1AdminSeedAppsData`](../type-aliases/PostApiV1AdminSeedAppsData.md), `ThrowOnError`>): `RequestResult`<[`PostApiV1AdminSeedAppsResponses`](../type-aliases/PostApiV1AdminSeedAppsResponses.md), [`PostApiV1AdminSeedAppsErrors`](../type-aliases/PostApiV1AdminSeedAppsErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:376](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#376)

Seed apps and API keys

Seeds apps and their API keys into the database. Uses upsert - existing apps are updated. Requires admin API key.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`PostApiV1AdminSeedAppsData`](../type-aliases/PostApiV1AdminSeedAppsData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`PostApiV1AdminSeedAppsResponses`](../type-aliases/PostApiV1AdminSeedAppsResponses.md), [`PostApiV1AdminSeedAppsErrors`](../type-aliases/PostApiV1AdminSeedAppsErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/postApiV1AdminSubscriptionTier

# postApiV1AdminSubscriptionTier

> **postApiV1AdminSubscriptionTier**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`PostApiV1AdminSubscriptionTierData`](../type-aliases/PostApiV1AdminSubscriptionTierData.md), `ThrowOnError`>): `RequestResult`<[`PostApiV1AdminSubscriptionTierResponses`](../type-aliases/PostApiV1AdminSubscriptionTierResponses.md), [`PostApiV1AdminSubscriptionTierErrors`](../type-aliases/PostApiV1AdminSubscriptionTierErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:392](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#392)

Set user subscription tier

Sets a user's subscription tier (basic, starter, or pro). Requires admin API key.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`PostApiV1AdminSubscriptionTierData`](../type-aliases/PostApiV1AdminSubscriptionTierData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`PostApiV1AdminSubscriptionTierResponses`](../type-aliases/PostApiV1AdminSubscriptionTierResponses.md), [`PostApiV1AdminSubscriptionTierErrors`](../type-aliases/PostApiV1AdminSubscriptionTierErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/postApiV1AuthMfaDisable

# postApiV1AuthMfaDisable

> **postApiV1AuthMfaDisable**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`PostApiV1AuthMfaDisableData`](../type-aliases/PostApiV1AuthMfaDisableData.md), `ThrowOnError`>): `RequestResult`<[`PostApiV1AuthMfaDisableResponses`](../type-aliases/PostApiV1AuthMfaDisableResponses.md), [`PostApiV1AuthMfaDisableErrors`](../type-aliases/PostApiV1AuthMfaDisableErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:494](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#494)

Disable MFA

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`PostApiV1AuthMfaDisableData`](../type-aliases/PostApiV1AuthMfaDisableData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`PostApiV1AuthMfaDisableResponses`](../type-aliases/PostApiV1AuthMfaDisableResponses.md), [`PostApiV1AuthMfaDisableErrors`](../type-aliases/PostApiV1AuthMfaDisableErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/postApiV1AuthMfaPasskeyEnrollBegin

# postApiV1AuthMfaPasskeyEnrollBegin

> **postApiV1AuthMfaPasskeyEnrollBegin**<`ThrowOnError`>(`options?`: [`Options`](../type-aliases/Options.md)<[`PostApiV1AuthMfaPasskeyEnrollBeginData`](../type-aliases/PostApiV1AuthMfaPasskeyEnrollBeginData.md), `ThrowOnError`>): `RequestResult`<[`PostApiV1AuthMfaPasskeyEnrollBeginResponses`](../type-aliases/PostApiV1AuthMfaPasskeyEnrollBeginResponses.md), [`PostApiV1AuthMfaPasskeyEnrollBeginErrors`](../type-aliases/PostApiV1AuthMfaPasskeyEnrollBeginErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:518](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#518)

Begin passkey enrollment

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options?`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`PostApiV1AuthMfaPasskeyEnrollBeginData`](../type-aliases/PostApiV1AuthMfaPasskeyEnrollBeginData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`PostApiV1AuthMfaPasskeyEnrollBeginResponses`](../type-aliases/PostApiV1AuthMfaPasskeyEnrollBeginResponses.md), [`PostApiV1AuthMfaPasskeyEnrollBeginErrors`](../type-aliases/PostApiV1AuthMfaPasskeyEnrollBeginErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/postApiV1AuthMfaPasskeyEnrollFinish

# postApiV1AuthMfaPasskeyEnrollFinish

> **postApiV1AuthMfaPasskeyEnrollFinish**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`PostApiV1AuthMfaPasskeyEnrollFinishData`](../type-aliases/PostApiV1AuthMfaPasskeyEnrollFinishData.md), `ThrowOnError`>): `RequestResult`<[`PostApiV1AuthMfaPasskeyEnrollFinishResponses`](../type-aliases/PostApiV1AuthMfaPasskeyEnrollFinishResponses.md), [`PostApiV1AuthMfaPasskeyEnrollFinishErrors`](../type-aliases/PostApiV1AuthMfaPasskeyEnrollFinishErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:528](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#528)

Finish passkey enrollment

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`PostApiV1AuthMfaPasskeyEnrollFinishData`](../type-aliases/PostApiV1AuthMfaPasskeyEnrollFinishData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`PostApiV1AuthMfaPasskeyEnrollFinishResponses`](../type-aliases/PostApiV1AuthMfaPasskeyEnrollFinishResponses.md), [`PostApiV1AuthMfaPasskeyEnrollFinishErrors`](../type-aliases/PostApiV1AuthMfaPasskeyEnrollFinishErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/postApiV1AuthMfaPasskeyVerifyBegin

# postApiV1AuthMfaPasskeyVerifyBegin

> **postApiV1AuthMfaPasskeyVerifyBegin**<`ThrowOnError`>(`options?`: [`Options`](../type-aliases/Options.md)<[`PostApiV1AuthMfaPasskeyVerifyBeginData`](../type-aliases/PostApiV1AuthMfaPasskeyVerifyBeginData.md), `ThrowOnError`>): `RequestResult`<[`PostApiV1AuthMfaPasskeyVerifyBeginResponses`](../type-aliases/PostApiV1AuthMfaPasskeyVerifyBeginResponses.md), [`PostApiV1AuthMfaPasskeyVerifyBeginErrors`](../type-aliases/PostApiV1AuthMfaPasskeyVerifyBeginErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:542](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#542)

Begin passkey login verification

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options?`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`PostApiV1AuthMfaPasskeyVerifyBeginData`](../type-aliases/PostApiV1AuthMfaPasskeyVerifyBeginData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`PostApiV1AuthMfaPasskeyVerifyBeginResponses`](../type-aliases/PostApiV1AuthMfaPasskeyVerifyBeginResponses.md), [`PostApiV1AuthMfaPasskeyVerifyBeginErrors`](../type-aliases/PostApiV1AuthMfaPasskeyVerifyBeginErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/postApiV1AuthMfaPasskeyVerifyFinish

# postApiV1AuthMfaPasskeyVerifyFinish

> **postApiV1AuthMfaPasskeyVerifyFinish**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`PostApiV1AuthMfaPasskeyVerifyFinishData`](../type-aliases/PostApiV1AuthMfaPasskeyVerifyFinishData.md), `ThrowOnError`>): `RequestResult`<[`PostApiV1AuthMfaPasskeyVerifyFinishResponses`](../type-aliases/PostApiV1AuthMfaPasskeyVerifyFinishResponses.md), [`PostApiV1AuthMfaPasskeyVerifyFinishErrors`](../type-aliases/PostApiV1AuthMfaPasskeyVerifyFinishErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:552](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#552)

Finish passkey login verification

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`PostApiV1AuthMfaPasskeyVerifyFinishData`](../type-aliases/PostApiV1AuthMfaPasskeyVerifyFinishData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`PostApiV1AuthMfaPasskeyVerifyFinishResponses`](../type-aliases/PostApiV1AuthMfaPasskeyVerifyFinishResponses.md), [`PostApiV1AuthMfaPasskeyVerifyFinishErrors`](../type-aliases/PostApiV1AuthMfaPasskeyVerifyFinishErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/postApiV1AuthMfaRecoveryCodesRegenerate

# postApiV1AuthMfaRecoveryCodesRegenerate

> **postApiV1AuthMfaRecoveryCodesRegenerate**<`ThrowOnError`>(`options?`: [`Options`](../type-aliases/Options.md)<[`PostApiV1AuthMfaRecoveryCodesRegenerateData`](../type-aliases/PostApiV1AuthMfaRecoveryCodesRegenerateData.md), `ThrowOnError`>): `RequestResult`<[`PostApiV1AuthMfaRecoveryCodesRegenerateResponses`](../type-aliases/PostApiV1AuthMfaRecoveryCodesRegenerateResponses.md), [`PostApiV1AuthMfaRecoveryCodesRegenerateErrors`](../type-aliases/PostApiV1AuthMfaRecoveryCodesRegenerateErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:566](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#566)

Regenerate recovery codes

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options?`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`PostApiV1AuthMfaRecoveryCodesRegenerateData`](../type-aliases/PostApiV1AuthMfaRecoveryCodesRegenerateData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`PostApiV1AuthMfaRecoveryCodesRegenerateResponses`](../type-aliases/PostApiV1AuthMfaRecoveryCodesRegenerateResponses.md), [`PostApiV1AuthMfaRecoveryCodesRegenerateErrors`](../type-aliases/PostApiV1AuthMfaRecoveryCodesRegenerateErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/postApiV1AuthMfaTotpEnrollInit

# postApiV1AuthMfaTotpEnrollInit

> **postApiV1AuthMfaTotpEnrollInit**<`ThrowOnError`>(`options?`: [`Options`](../type-aliases/Options.md)<[`PostApiV1AuthMfaTotpEnrollInitData`](../type-aliases/PostApiV1AuthMfaTotpEnrollInitData.md), `ThrowOnError`>): `RequestResult`<[`PostApiV1AuthMfaTotpEnrollInitResponses`](../type-aliases/PostApiV1AuthMfaTotpEnrollInitResponses.md), [`PostApiV1AuthMfaTotpEnrollInitErrors`](../type-aliases/PostApiV1AuthMfaTotpEnrollInitErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:588](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#588)

Begin TOTP enrollment

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options?`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`PostApiV1AuthMfaTotpEnrollInitData`](../type-aliases/PostApiV1AuthMfaTotpEnrollInitData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`PostApiV1AuthMfaTotpEnrollInitResponses`](../type-aliases/PostApiV1AuthMfaTotpEnrollInitResponses.md), [`PostApiV1AuthMfaTotpEnrollInitErrors`](../type-aliases/PostApiV1AuthMfaTotpEnrollInitErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/postApiV1AuthMfaTotpEnrollVerify

# postApiV1AuthMfaTotpEnrollVerify

> **postApiV1AuthMfaTotpEnrollVerify**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`PostApiV1AuthMfaTotpEnrollVerifyData`](../type-aliases/PostApiV1AuthMfaTotpEnrollVerifyData.md), `ThrowOnError`>): `RequestResult`<[`PostApiV1AuthMfaTotpEnrollVerifyResponses`](../type-aliases/PostApiV1AuthMfaTotpEnrollVerifyResponses.md), [`PostApiV1AuthMfaTotpEnrollVerifyErrors`](../type-aliases/PostApiV1AuthMfaTotpEnrollVerifyErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:598](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#598)

Verify TOTP enrollment

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`PostApiV1AuthMfaTotpEnrollVerifyData`](../type-aliases/PostApiV1AuthMfaTotpEnrollVerifyData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`PostApiV1AuthMfaTotpEnrollVerifyResponses`](../type-aliases/PostApiV1AuthMfaTotpEnrollVerifyResponses.md), [`PostApiV1AuthMfaTotpEnrollVerifyErrors`](../type-aliases/PostApiV1AuthMfaTotpEnrollVerifyErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/postApiV1AuthMfaVerify

# postApiV1AuthMfaVerify

> **postApiV1AuthMfaVerify**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`PostApiV1AuthMfaVerifyData`](../type-aliases/PostApiV1AuthMfaVerifyData.md), `ThrowOnError`>): `RequestResult`<[`PostApiV1AuthMfaVerifyResponses`](../type-aliases/PostApiV1AuthMfaVerifyResponses.md), [`PostApiV1AuthMfaVerifyErrors`](../type-aliases/PostApiV1AuthMfaVerifyErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:612](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#612)

Verify MFA at login

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`PostApiV1AuthMfaVerifyData`](../type-aliases/PostApiV1AuthMfaVerifyData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`PostApiV1AuthMfaVerifyResponses`](../type-aliases/PostApiV1AuthMfaVerifyResponses.md), [`PostApiV1AuthMfaVerifyErrors`](../type-aliases/PostApiV1AuthMfaVerifyErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/postApiV1ChatCompletions

# postApiV1ChatCompletions

> **postApiV1ChatCompletions**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`PostApiV1ChatCompletionsData`](../type-aliases/PostApiV1ChatCompletionsData.md), `ThrowOnError`>): `RequestResult`<[`PostApiV1ChatCompletionsResponses`](../type-aliases/PostApiV1ChatCompletionsResponses.md), [`PostApiV1ChatCompletionsErrors`](../type-aliases/PostApiV1ChatCompletionsErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:640](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#640)

Create chat completion

Generates a chat completion using the configured gateway. Supports streaming when stream=true.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`PostApiV1ChatCompletionsData`](../type-aliases/PostApiV1ChatCompletionsData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`PostApiV1ChatCompletionsResponses`](../type-aliases/PostApiV1ChatCompletionsResponses.md), [`PostApiV1ChatCompletionsErrors`](../type-aliases/PostApiV1ChatCompletionsErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/postApiV1CreditsPurchase

# postApiV1CreditsPurchase

> **postApiV1CreditsPurchase**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`PostApiV1CreditsPurchaseData`](../type-aliases/PostApiV1CreditsPurchaseData.md), `ThrowOnError`>): `RequestResult`<[`PostApiV1CreditsPurchaseResponses`](../type-aliases/PostApiV1CreditsPurchaseResponses.md), [`PostApiV1CreditsPurchaseErrors`](../type-aliases/PostApiV1CreditsPurchaseErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:692](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#692)

Create credit pack checkout session

Creates a Stripe Checkout Session for purchasing a one-time credit pack and returns the checkout URL.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`PostApiV1CreditsPurchaseData`](../type-aliases/PostApiV1CreditsPurchaseData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`PostApiV1CreditsPurchaseResponses`](../type-aliases/PostApiV1CreditsPurchaseResponses.md), [`PostApiV1CreditsPurchaseErrors`](../type-aliases/PostApiV1CreditsPurchaseErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/postApiV1CreditsRedeemTokens

# postApiV1CreditsRedeemTokens

> **postApiV1CreditsRedeemTokens**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`PostApiV1CreditsRedeemTokensData`](../type-aliases/PostApiV1CreditsRedeemTokensData.md), `ThrowOnError`>): `RequestResult`<[`PostApiV1CreditsRedeemTokensResponses`](../type-aliases/PostApiV1CreditsRedeemTokensResponses.md), [`PostApiV1CreditsRedeemTokensErrors`](../type-aliases/PostApiV1CreditsRedeemTokensErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:708](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#708)

Redeem Anuma Tokens for credits

Burns the specified amount of Anuma Tokens via the portal operator and adds equivalent credits to the user's enrollment. User must have approved the portal operator to spend their tokens first.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`PostApiV1CreditsRedeemTokensData`](../type-aliases/PostApiV1CreditsRedeemTokensData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`PostApiV1CreditsRedeemTokensResponses`](../type-aliases/PostApiV1CreditsRedeemTokensResponses.md), [`PostApiV1CreditsRedeemTokensErrors`](../type-aliases/PostApiV1CreditsRedeemTokensErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/postApiV1DeveloperApps

# postApiV1DeveloperApps

> **postApiV1DeveloperApps**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`PostApiV1DeveloperAppsData`](../type-aliases/PostApiV1DeveloperAppsData.md), `ThrowOnError`>): `RequestResult`<[`PostApiV1DeveloperAppsResponses`](../type-aliases/PostApiV1DeveloperAppsResponses.md), [`PostApiV1DeveloperAppsErrors`](../type-aliases/PostApiV1DeveloperAppsErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:748](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#748)

Create app

Creates a new app owned by the authenticated developer.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`PostApiV1DeveloperAppsData`](../type-aliases/PostApiV1DeveloperAppsData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`PostApiV1DeveloperAppsResponses`](../type-aliases/PostApiV1DeveloperAppsResponses.md), [`PostApiV1DeveloperAppsErrors`](../type-aliases/PostApiV1DeveloperAppsErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/postApiV1DeveloperAppsByAppUuidApiKeys

# postApiV1DeveloperAppsByAppUuidApiKeys

> **postApiV1DeveloperAppsByAppUuidApiKeys**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`PostApiV1DeveloperAppsByAppUuidApiKeysData`](../type-aliases/PostApiV1DeveloperAppsByAppUuidApiKeysData.md), `ThrowOnError`>): `RequestResult`<[`PostApiV1DeveloperAppsByAppUuidApiKeysResponses`](../type-aliases/PostApiV1DeveloperAppsByAppUuidApiKeysResponses.md), [`PostApiV1DeveloperAppsByAppUuidApiKeysErrors`](../type-aliases/PostApiV1DeveloperAppsByAppUuidApiKeysErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:816](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#816)

Create API key

Creates a new API key for the app. The full key is only shown once.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`PostApiV1DeveloperAppsByAppUuidApiKeysData`](../type-aliases/PostApiV1DeveloperAppsByAppUuidApiKeysData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`PostApiV1DeveloperAppsByAppUuidApiKeysResponses`](../type-aliases/PostApiV1DeveloperAppsByAppUuidApiKeysResponses.md), [`PostApiV1DeveloperAppsByAppUuidApiKeysErrors`](../type-aliases/PostApiV1DeveloperAppsByAppUuidApiKeysErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/postApiV1DeveloperAppsByAppUuidFund

# postApiV1DeveloperAppsByAppUuidFund

> **postApiV1DeveloperAppsByAppUuidFund**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`PostApiV1DeveloperAppsByAppUuidFundData`](../type-aliases/PostApiV1DeveloperAppsByAppUuidFundData.md), `ThrowOnError`>): `RequestResult`<[`PostApiV1DeveloperAppsByAppUuidFundResponses`](../type-aliases/PostApiV1DeveloperAppsByAppUuidFundResponses.md), [`PostApiV1DeveloperAppsByAppUuidFundErrors`](../type-aliases/PostApiV1DeveloperAppsByAppUuidFundErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:844](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#844)

Fund developer app balance

Creates a Stripe checkout session to purchase credits for the app balance

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`PostApiV1DeveloperAppsByAppUuidFundData`](../type-aliases/PostApiV1DeveloperAppsByAppUuidFundData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`PostApiV1DeveloperAppsByAppUuidFundResponses`](../type-aliases/PostApiV1DeveloperAppsByAppUuidFundResponses.md), [`PostApiV1DeveloperAppsByAppUuidFundErrors`](../type-aliases/PostApiV1DeveloperAppsByAppUuidFundErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/postApiV1DeveloperAppsByAppUuidPrivy

# postApiV1DeveloperAppsByAppUuidPrivy

> **postApiV1DeveloperAppsByAppUuidPrivy**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`PostApiV1DeveloperAppsByAppUuidPrivyData`](../type-aliases/PostApiV1DeveloperAppsByAppUuidPrivyData.md), `ThrowOnError`>): `RequestResult`<[`PostApiV1DeveloperAppsByAppUuidPrivyResponses`](../type-aliases/PostApiV1DeveloperAppsByAppUuidPrivyResponses.md), [`PostApiV1DeveloperAppsByAppUuidPrivyErrors`](../type-aliases/PostApiV1DeveloperAppsByAppUuidPrivyErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:872](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#872)

Configure Privy

Configures Privy authentication for an app.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`PostApiV1DeveloperAppsByAppUuidPrivyData`](../type-aliases/PostApiV1DeveloperAppsByAppUuidPrivyData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`PostApiV1DeveloperAppsByAppUuidPrivyResponses`](../type-aliases/PostApiV1DeveloperAppsByAppUuidPrivyResponses.md), [`PostApiV1DeveloperAppsByAppUuidPrivyErrors`](../type-aliases/PostApiV1DeveloperAppsByAppUuidPrivyErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/postApiV1DeveloperAppsByAppUuidUsersByAddressTopUp

# postApiV1DeveloperAppsByAppUuidUsersByAddressTopUp

> **postApiV1DeveloperAppsByAppUuidUsersByAddressTopUp**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`PostApiV1DeveloperAppsByAppUuidUsersByAddressTopUpData`](../type-aliases/PostApiV1DeveloperAppsByAppUuidUsersByAddressTopUpData.md), `ThrowOnError`>): `RequestResult`<[`PostApiV1DeveloperAppsByAppUuidUsersByAddressTopUpResponses`](../type-aliases/PostApiV1DeveloperAppsByAppUuidUsersByAddressTopUpResponses.md), [`PostApiV1DeveloperAppsByAppUuidUsersByAddressTopUpErrors`](../type-aliases/PostApiV1DeveloperAppsByAppUuidUsersByAddressTopUpErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:952](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#952)

Top up user credits

Adds credits to a user's enrollment. Credits are transferred from the app balance atomically.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`PostApiV1DeveloperAppsByAppUuidUsersByAddressTopUpData`](../type-aliases/PostApiV1DeveloperAppsByAppUuidUsersByAddressTopUpData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`PostApiV1DeveloperAppsByAppUuidUsersByAddressTopUpResponses`](../type-aliases/PostApiV1DeveloperAppsByAppUuidUsersByAddressTopUpResponses.md), [`PostApiV1DeveloperAppsByAppUuidUsersByAddressTopUpErrors`](../type-aliases/PostApiV1DeveloperAppsByAppUuidUsersByAddressTopUpErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/postApiV1Embeddings

# postApiV1Embeddings

> **postApiV1Embeddings**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`PostApiV1EmbeddingsData`](../type-aliases/PostApiV1EmbeddingsData.md), `ThrowOnError`>): `RequestResult`<[`PostApiV1EmbeddingsResponses`](../type-aliases/PostApiV1EmbeddingsResponses.md), [`PostApiV1EmbeddingsErrors`](../type-aliases/PostApiV1EmbeddingsErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:992](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#992)

Create embeddings

Generates embeddings using the configured gateway.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`PostApiV1EmbeddingsData`](../type-aliases/PostApiV1EmbeddingsData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`PostApiV1EmbeddingsResponses`](../type-aliases/PostApiV1EmbeddingsResponses.md), [`PostApiV1EmbeddingsErrors`](../type-aliases/PostApiV1EmbeddingsErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/postApiV1GuestChatCompletions

# postApiV1GuestChatCompletions

> **postApiV1GuestChatCompletions**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`PostApiV1GuestChatCompletionsData`](../type-aliases/PostApiV1GuestChatCompletionsData.md), `ThrowOnError`>): `RequestResult`<[`PostApiV1GuestChatCompletionsResponses`](../type-aliases/PostApiV1GuestChatCompletionsResponses.md), [`PostApiV1GuestChatCompletionsErrors`](../type-aliases/PostApiV1GuestChatCompletionsErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:1020](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#1020)

Guest chat completion (free trial)

Unauthenticated chat completion locked to a single model with a per-guest message cap. Each guest UUID gets a fixed number of free messages; subsequent requests return 402 with a sign-up prompt.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`PostApiV1GuestChatCompletionsData`](../type-aliases/PostApiV1GuestChatCompletionsData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`PostApiV1GuestChatCompletionsResponses`](../type-aliases/PostApiV1GuestChatCompletionsResponses.md), [`PostApiV1GuestChatCompletionsErrors`](../type-aliases/PostApiV1GuestChatCompletionsErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/postApiV1PhoneCalls

# postApiV1PhoneCalls

> **postApiV1PhoneCalls**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`PostApiV1PhoneCallsData`](../type-aliases/PostApiV1PhoneCallsData.md), `ThrowOnError`>): `RequestResult`<[`PostApiV1PhoneCallsResponses`](../type-aliases/PostApiV1PhoneCallsResponses.md), [`PostApiV1PhoneCallsErrors`](../type-aliases/PostApiV1PhoneCallsErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:1073](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#1073)

Create phone call

Queues an AI phone call on behalf of the authenticated user.
Phone numbers must be in E.164 format with country code (e.g., +15551234567).

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`PostApiV1PhoneCallsData`](../type-aliases/PostApiV1PhoneCallsData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`PostApiV1PhoneCallsResponses`](../type-aliases/PostApiV1PhoneCallsResponses.md), [`PostApiV1PhoneCallsErrors`](../type-aliases/PostApiV1PhoneCallsErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/postApiV1Responses

# postApiV1Responses

> **postApiV1Responses**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`PostApiV1ResponsesData`](../type-aliases/PostApiV1ResponsesData.md), `ThrowOnError`>): `RequestResult`<[`PostApiV1ResponsesResponses`](../type-aliases/PostApiV1ResponsesResponses.md), [`PostApiV1ResponsesErrors`](../type-aliases/PostApiV1ResponsesErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:1101](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#1101)

Create response

Generates a response using the Responses API format. Supports streaming when stream=true.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`PostApiV1ResponsesData`](../type-aliases/PostApiV1ResponsesData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`PostApiV1ResponsesResponses`](../type-aliases/PostApiV1ResponsesResponses.md), [`PostApiV1ResponsesErrors`](../type-aliases/PostApiV1ResponsesErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/postApiV1SubscriptionsCancel

# postApiV1SubscriptionsCancel

> **postApiV1SubscriptionsCancel**<`ThrowOnError`>(`options?`: [`Options`](../type-aliases/Options.md)<[`PostApiV1SubscriptionsCancelData`](../type-aliases/PostApiV1SubscriptionsCancelData.md), `ThrowOnError`>): `RequestResult`<[`PostApiV1SubscriptionsCancelResponses`](../type-aliases/PostApiV1SubscriptionsCancelResponses.md), [`PostApiV1SubscriptionsCancelErrors`](../type-aliases/PostApiV1SubscriptionsCancelErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:1117](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#1117)

Cancel subscription

Cancels the user's subscription at the end of the current billing period (cancel\_at\_period\_end)

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options?`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`PostApiV1SubscriptionsCancelData`](../type-aliases/PostApiV1SubscriptionsCancelData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`PostApiV1SubscriptionsCancelResponses`](../type-aliases/PostApiV1SubscriptionsCancelResponses.md), [`PostApiV1SubscriptionsCancelErrors`](../type-aliases/PostApiV1SubscriptionsCancelErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/postApiV1SubscriptionsCancelScheduledDowngrade

# postApiV1SubscriptionsCancelScheduledDowngrade

> **postApiV1SubscriptionsCancelScheduledDowngrade**<`ThrowOnError`>(`options?`: [`Options`](../type-aliases/Options.md)<[`PostApiV1SubscriptionsCancelScheduledDowngradeData`](../type-aliases/PostApiV1SubscriptionsCancelScheduledDowngradeData.md), `ThrowOnError`>): `RequestResult`<[`PostApiV1SubscriptionsCancelScheduledDowngradeResponses`](../type-aliases/PostApiV1SubscriptionsCancelScheduledDowngradeResponses.md), [`PostApiV1SubscriptionsCancelScheduledDowngradeErrors`](../type-aliases/PostApiV1SubscriptionsCancelScheduledDowngradeErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:1129](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#1129)

Cancel scheduled downgrade

Cancels a scheduled plan downgrade by releasing the Stripe Subscription Schedule, keeping the current plan active.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options?`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`PostApiV1SubscriptionsCancelScheduledDowngradeData`](../type-aliases/PostApiV1SubscriptionsCancelScheduledDowngradeData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`PostApiV1SubscriptionsCancelScheduledDowngradeResponses`](../type-aliases/PostApiV1SubscriptionsCancelScheduledDowngradeResponses.md), [`PostApiV1SubscriptionsCancelScheduledDowngradeErrors`](../type-aliases/PostApiV1SubscriptionsCancelScheduledDowngradeErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/postApiV1SubscriptionsCreateCheckoutSession

# postApiV1SubscriptionsCreateCheckoutSession

> **postApiV1SubscriptionsCreateCheckoutSession**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`PostApiV1SubscriptionsCreateCheckoutSessionData`](../type-aliases/PostApiV1SubscriptionsCreateCheckoutSessionData.md), `ThrowOnError`>): `RequestResult`<[`PostApiV1SubscriptionsCreateCheckoutSessionResponses`](../type-aliases/PostApiV1SubscriptionsCreateCheckoutSessionResponses.md), [`PostApiV1SubscriptionsCreateCheckoutSessionErrors`](../type-aliases/PostApiV1SubscriptionsCreateCheckoutSessionErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:1141](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#1141)

Create checkout session

Creates a Stripe Checkout Session for a subscription plan and returns the checkout URL. Identify the plan with either price\_id directly, or tier ("starter"/"pro") + interval ("month"/"year").

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`PostApiV1SubscriptionsCreateCheckoutSessionData`](../type-aliases/PostApiV1SubscriptionsCreateCheckoutSessionData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`PostApiV1SubscriptionsCreateCheckoutSessionResponses`](../type-aliases/PostApiV1SubscriptionsCreateCheckoutSessionResponses.md), [`PostApiV1SubscriptionsCreateCheckoutSessionErrors`](../type-aliases/PostApiV1SubscriptionsCreateCheckoutSessionErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/postApiV1SubscriptionsCustomerPortal

# postApiV1SubscriptionsCustomerPortal

> **postApiV1SubscriptionsCustomerPortal**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`PostApiV1SubscriptionsCustomerPortalData`](../type-aliases/PostApiV1SubscriptionsCustomerPortalData.md), `ThrowOnError`>): `RequestResult`<[`PostApiV1SubscriptionsCustomerPortalResponses`](../type-aliases/PostApiV1SubscriptionsCustomerPortalResponses.md), [`PostApiV1SubscriptionsCustomerPortalErrors`](../type-aliases/PostApiV1SubscriptionsCustomerPortalErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:1157](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#1157)

Create customer portal session

Creates a Stripe Customer Portal session for managing subscription and returns the portal URL

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`PostApiV1SubscriptionsCustomerPortalData`](../type-aliases/PostApiV1SubscriptionsCustomerPortalData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`PostApiV1SubscriptionsCustomerPortalResponses`](../type-aliases/PostApiV1SubscriptionsCustomerPortalResponses.md), [`PostApiV1SubscriptionsCustomerPortalErrors`](../type-aliases/PostApiV1SubscriptionsCustomerPortalErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/postApiV1SubscriptionsRenew

# postApiV1SubscriptionsRenew

> **postApiV1SubscriptionsRenew**<`ThrowOnError`>(`options?`: [`Options`](../type-aliases/Options.md)<[`PostApiV1SubscriptionsRenewData`](../type-aliases/PostApiV1SubscriptionsRenewData.md), `ThrowOnError`>): `RequestResult`<[`PostApiV1SubscriptionsRenewResponses`](../type-aliases/PostApiV1SubscriptionsRenewResponses.md), [`PostApiV1SubscriptionsRenewErrors`](../type-aliases/PostApiV1SubscriptionsRenewErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:1185](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#1185)

Renew subscription

Reactivates a subscription that was scheduled for cancellation (undoes cancel\_at\_period\_end)

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options?`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`PostApiV1SubscriptionsRenewData`](../type-aliases/PostApiV1SubscriptionsRenewData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`PostApiV1SubscriptionsRenewResponses`](../type-aliases/PostApiV1SubscriptionsRenewResponses.md), [`PostApiV1SubscriptionsRenewErrors`](../type-aliases/PostApiV1SubscriptionsRenewErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/postApiV1SubscriptionsScheduleDowngrade

# postApiV1SubscriptionsScheduleDowngrade

> **postApiV1SubscriptionsScheduleDowngrade**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`PostApiV1SubscriptionsScheduleDowngradeData`](../type-aliases/PostApiV1SubscriptionsScheduleDowngradeData.md), `ThrowOnError`>): `RequestResult`<[`PostApiV1SubscriptionsScheduleDowngradeResponses`](../type-aliases/PostApiV1SubscriptionsScheduleDowngradeResponses.md), [`PostApiV1SubscriptionsScheduleDowngradeErrors`](../type-aliases/PostApiV1SubscriptionsScheduleDowngradeErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:1197](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#1197)

Schedule subscription downgrade

Schedules a plan downgrade (tier or interval) to take effect at the end of the current billing period using Stripe Subscription Schedules.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`PostApiV1SubscriptionsScheduleDowngradeData`](../type-aliases/PostApiV1SubscriptionsScheduleDowngradeData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`PostApiV1SubscriptionsScheduleDowngradeResponses`](../type-aliases/PostApiV1SubscriptionsScheduleDowngradeResponses.md), [`PostApiV1SubscriptionsScheduleDowngradeErrors`](../type-aliases/PostApiV1SubscriptionsScheduleDowngradeErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/postApiV1SubscriptionsUpgrade

# postApiV1SubscriptionsUpgrade

> **postApiV1SubscriptionsUpgrade**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`PostApiV1SubscriptionsUpgradeData`](../type-aliases/PostApiV1SubscriptionsUpgradeData.md), `ThrowOnError`>): `RequestResult`<[`PostApiV1SubscriptionsUpgradeResponses`](../type-aliases/PostApiV1SubscriptionsUpgradeResponses.md), [`PostApiV1SubscriptionsUpgradeErrors`](../type-aliases/PostApiV1SubscriptionsUpgradeErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:1225](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#1225)

Upgrade subscription

Upgrades the current subscription to a higher tier or from monthly to annual billing by modifying the existing Stripe subscription in-place. No extra credits are allocated for the current month; the new plan's credit amount starts at the next billing cycle.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`PostApiV1SubscriptionsUpgradeData`](../type-aliases/PostApiV1SubscriptionsUpgradeData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`PostApiV1SubscriptionsUpgradeResponses`](../type-aliases/PostApiV1SubscriptionsUpgradeResponses.md), [`PostApiV1SubscriptionsUpgradeErrors`](../type-aliases/PostApiV1SubscriptionsUpgradeErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/postApiV1SubscriptionsWebhook

# postApiV1SubscriptionsWebhook

> **postApiV1SubscriptionsWebhook**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`PostApiV1SubscriptionsWebhookData`](../type-aliases/PostApiV1SubscriptionsWebhookData.md), `ThrowOnError`>): `RequestResult`<[`PostApiV1SubscriptionsWebhookResponses`](../type-aliases/PostApiV1SubscriptionsWebhookResponses.md), [`PostApiV1SubscriptionsWebhookErrors`](../type-aliases/PostApiV1SubscriptionsWebhookErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:1241](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#1241)

Handle Stripe webhook

Receives and processes Stripe webhook events for subscription lifecycle management

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`PostApiV1SubscriptionsWebhookData`](../type-aliases/PostApiV1SubscriptionsWebhookData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`PostApiV1SubscriptionsWebhookResponses`](../type-aliases/PostApiV1SubscriptionsWebhookResponses.md), [`PostApiV1SubscriptionsWebhookErrors`](../type-aliases/PostApiV1SubscriptionsWebhookErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/postApiV1TextByChannelRegister

# postApiV1TextByChannelRegister

> **postApiV1TextByChannelRegister**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`PostApiV1TextByChannelRegisterData`](../type-aliases/PostApiV1TextByChannelRegisterData.md), `ThrowOnError`>): `RequestResult`<[`PostApiV1TextByChannelRegisterResponses`](../type-aliases/PostApiV1TextByChannelRegisterResponses.md), [`PostApiV1TextByChannelRegisterErrors`](../type-aliases/PostApiV1TextByChannelRegisterErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:1269](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#1269)

Register identifier for text channel

Registers an identifier (phone, email, etc.) for text channel interaction. The identifier must be linked in the user's Privy account (for SMS). Idempotent for the same account+channel (updates preferred model).

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`PostApiV1TextByChannelRegisterData`](../type-aliases/PostApiV1TextByChannelRegisterData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`PostApiV1TextByChannelRegisterResponses`](../type-aliases/PostApiV1TextByChannelRegisterResponses.md), [`PostApiV1TextByChannelRegisterErrors`](../type-aliases/PostApiV1TextByChannelRegisterErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/postApiV1UserApiKeys

# postApiV1UserApiKeys

> **postApiV1UserApiKeys**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`PostApiV1UserApiKeysData`](../type-aliases/PostApiV1UserApiKeysData.md), `ThrowOnError`>): `RequestResult`<[`PostApiV1UserApiKeysResponses`](../type-aliases/PostApiV1UserApiKeysResponses.md), [`PostApiV1UserApiKeysErrors`](../type-aliases/PostApiV1UserApiKeysErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:1357](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#1357)

Create user API key

Creates a new API key for the authenticated user, scoped to the app they are authenticated against. The full key is only shown once. Requires JWT authentication (API key auth is not allowed).

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`PostApiV1UserApiKeysData`](../type-aliases/PostApiV1UserApiKeysData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`PostApiV1UserApiKeysResponses`](../type-aliases/PostApiV1UserApiKeysResponses.md), [`PostApiV1UserApiKeysErrors`](../type-aliases/PostApiV1UserApiKeysErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/postApiV1WebhooksRevenuecat

# postApiV1WebhooksRevenuecat

> **postApiV1WebhooksRevenuecat**<`ThrowOnError`>(`options?`: [`Options`](../type-aliases/Options.md)<[`PostApiV1WebhooksRevenuecatData`](../type-aliases/PostApiV1WebhooksRevenuecatData.md), `ThrowOnError`>): `RequestResult`<[`PostApiV1WebhooksRevenuecatResponses`](../type-aliases/PostApiV1WebhooksRevenuecatResponses.md), [`PostApiV1WebhooksRevenuecatErrors`](../type-aliases/PostApiV1WebhooksRevenuecatErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:1425](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#1425)

Handle RevenueCat webhook

Processes RevenueCat webhook events for in-app purchases

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options?`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`PostApiV1WebhooksRevenuecatData`](../type-aliases/PostApiV1WebhooksRevenuecatData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`PostApiV1WebhooksRevenuecatResponses`](../type-aliases/PostApiV1WebhooksRevenuecatResponses.md), [`PostApiV1WebhooksRevenuecatErrors`](../type-aliases/PostApiV1WebhooksRevenuecatErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/postAuthOauthByProviderExchange

# postAuthOauthByProviderExchange

> **postAuthOauthByProviderExchange**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`PostAuthOauthByProviderExchangeData`](../type-aliases/PostAuthOauthByProviderExchangeData.md), `ThrowOnError`>): `RequestResult`<[`PostAuthOauthByProviderExchangeResponses`](../type-aliases/PostAuthOauthByProviderExchangeResponses.md), [`PostAuthOauthByProviderExchangeErrors`](../type-aliases/PostAuthOauthByProviderExchangeErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:1441](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#1441)

Exchange authorization code for tokens

Exchanges an OAuth authorization code for access and refresh tokens

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`PostAuthOauthByProviderExchangeData`](../type-aliases/PostAuthOauthByProviderExchangeData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`PostAuthOauthByProviderExchangeResponses`](../type-aliases/PostAuthOauthByProviderExchangeResponses.md), [`PostAuthOauthByProviderExchangeErrors`](../type-aliases/PostAuthOauthByProviderExchangeErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/postAuthOauthByProviderRefresh

# postAuthOauthByProviderRefresh

> **postAuthOauthByProviderRefresh**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`PostAuthOauthByProviderRefreshData`](../type-aliases/PostAuthOauthByProviderRefreshData.md), `ThrowOnError`>): `RequestResult`<[`PostAuthOauthByProviderRefreshResponses`](../type-aliases/PostAuthOauthByProviderRefreshResponses.md), [`PostAuthOauthByProviderRefreshErrors`](../type-aliases/PostAuthOauthByProviderRefreshErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:1457](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#1457)

Refresh access token

Refreshes an expired access token using a refresh token

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`PostAuthOauthByProviderRefreshData`](../type-aliases/PostAuthOauthByProviderRefreshData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`PostAuthOauthByProviderRefreshResponses`](../type-aliases/PostAuthOauthByProviderRefreshResponses.md), [`PostAuthOauthByProviderRefreshErrors`](../type-aliases/PostAuthOauthByProviderRefreshErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/postAuthOauthByProviderRevoke

# postAuthOauthByProviderRevoke

> **postAuthOauthByProviderRevoke**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`PostAuthOauthByProviderRevokeData`](../type-aliases/PostAuthOauthByProviderRevokeData.md), `ThrowOnError`>): `RequestResult`<[`PostAuthOauthByProviderRevokeResponses`](../type-aliases/PostAuthOauthByProviderRevokeResponses.md), [`PostAuthOauthByProviderRevokeErrors`](../type-aliases/PostAuthOauthByProviderRevokeErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:1473](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#1473)

Revoke OAuth token

Revokes an OAuth access or refresh token

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`PostAuthOauthByProviderRevokeData`](../type-aliases/PostAuthOauthByProviderRevokeData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`PostAuthOauthByProviderRevokeResponses`](../type-aliases/PostAuthOauthByProviderRevokeResponses.md), [`PostAuthOauthByProviderRevokeErrors`](../type-aliases/PostAuthOauthByProviderRevokeErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/postOauthConsent

# postOauthConsent

> **postOauthConsent**<`ThrowOnError`>(`options?`: [`Options`](../type-aliases/Options.md)<[`PostOauthConsentData`](../type-aliases/PostOauthConsentData.md), `ThrowOnError`>): `RequestResult`<[`PostOauthConsentResponses`](../type-aliases/PostOauthConsentResponses.md), [`PostOauthConsentErrors`](../type-aliases/PostOauthConsentErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:1525](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#1525)

Process OAuth consent

Handles the consent form submission. Approve creates a grant and returns the auth code as JSON when the caller sends `Accept: application/json`, or as a 302 redirect to redirect\_uri otherwise. Deny mirrors the same content negotiation: JSON error body or redirect with `error=access_denied`.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options?`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`PostOauthConsentData`](../type-aliases/PostOauthConsentData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`PostOauthConsentResponses`](../type-aliases/PostOauthConsentResponses.md), [`PostOauthConsentErrors`](../type-aliases/PostOauthConsentErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/postOauthRevoke

# postOauthRevoke

> **postOauthRevoke**<`ThrowOnError`>(`options?`: [`Options`](../type-aliases/Options.md)<[`PostOauthRevokeData`](../type-aliases/PostOauthRevokeData.md), `ThrowOnError`>): `RequestResult`<[`PostOauthRevokeResponses`](../type-aliases/PostOauthRevokeResponses.md), [`PostOauthRevokeErrors`](../type-aliases/PostOauthRevokeErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:1542](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#1542)

OAuth 2.0 token revocation (RFC 7009)

Revokes a refresh token, or (with token\_type\_hint=grant) the entire grant. Always returns 200 per RFC 7009 when the client is authenticated.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options?`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`PostOauthRevokeData`](../type-aliases/PostOauthRevokeData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`PostOauthRevokeResponses`](../type-aliases/PostOauthRevokeResponses.md), [`PostOauthRevokeErrors`](../type-aliases/PostOauthRevokeErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/postOauthToken

# postOauthToken

> **postOauthToken**<`ThrowOnError`>(`options?`: [`Options`](../type-aliases/Options.md)<[`PostOauthTokenData`](../type-aliases/PostOauthTokenData.md), `ThrowOnError`>): `RequestResult`<[`PostOauthTokenResponses`](../type-aliases/PostOauthTokenResponses.md), [`PostOauthTokenErrors`](../type-aliases/PostOauthTokenErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:1559](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#1559)

OAuth 2.0 token endpoint

Exchanges an authorization code or rotates a refresh token for a new access+refresh pair.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options?`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`PostOauthTokenData`](../type-aliases/PostOauthTokenData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`PostOauthTokenResponses`](../type-aliases/PostOauthTokenResponses.md), [`PostOauthTokenErrors`](../type-aliases/PostOauthTokenErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/putApiV1AdminAgentsById

# putApiV1AdminAgentsById

> **putApiV1AdminAgentsById**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`PutApiV1AdminAgentsByIdData`](../type-aliases/PutApiV1AdminAgentsByIdData.md), `ThrowOnError`>): `RequestResult`<[`PutApiV1AdminAgentsByIdResponses`](../type-aliases/PutApiV1AdminAgentsByIdResponses.md), [`PutApiV1AdminAgentsByIdErrors`](../type-aliases/PutApiV1AdminAgentsByIdErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:94](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#94)

Update agent

Updates an existing agent. Requires admin API key. Only provided fields are updated.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`PutApiV1AdminAgentsByIdData`](../type-aliases/PutApiV1AdminAgentsByIdData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`PutApiV1AdminAgentsByIdResponses`](../type-aliases/PutApiV1AdminAgentsByIdResponses.md), [`PutApiV1AdminAgentsByIdErrors`](../type-aliases/PutApiV1AdminAgentsByIdErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/putApiV1AdminAppsByAppIdApiKeysById

# putApiV1AdminAppsByAppIdApiKeysById

> **putApiV1AdminAppsByAppIdApiKeysById**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`PutApiV1AdminAppsByAppIdApiKeysByIdData`](../type-aliases/PutApiV1AdminAppsByAppIdApiKeysByIdData.md), `ThrowOnError`>): `RequestResult`<[`PutApiV1AdminAppsByAppIdApiKeysByIdResponses`](../type-aliases/PutApiV1AdminAppsByAppIdApiKeysByIdResponses.md), [`PutApiV1AdminAppsByAppIdApiKeysByIdErrors`](../type-aliases/PutApiV1AdminAppsByAppIdApiKeysByIdErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:190](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#190)

Update API key

Updates an existing API key. Only provided fields are updated. Requires admin API key.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`PutApiV1AdminAppsByAppIdApiKeysByIdData`](../type-aliases/PutApiV1AdminAppsByAppIdApiKeysByIdData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`PutApiV1AdminAppsByAppIdApiKeysByIdResponses`](../type-aliases/PutApiV1AdminAppsByAppIdApiKeysByIdResponses.md), [`PutApiV1AdminAppsByAppIdApiKeysByIdErrors`](../type-aliases/PutApiV1AdminAppsByAppIdApiKeysByIdErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/putApiV1AdminAppsById

# putApiV1AdminAppsById

> **putApiV1AdminAppsById**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`PutApiV1AdminAppsByIdData`](../type-aliases/PutApiV1AdminAppsByIdData.md), `ThrowOnError`>): `RequestResult`<[`PutApiV1AdminAppsByIdResponses`](../type-aliases/PutApiV1AdminAppsByIdResponses.md), [`PutApiV1AdminAppsByIdErrors`](../type-aliases/PutApiV1AdminAppsByIdErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:230](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#230)

Update app

Updates an existing app. Only provided fields are updated. Requires admin API key.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`PutApiV1AdminAppsByIdData`](../type-aliases/PutApiV1AdminAppsByIdData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`PutApiV1AdminAppsByIdResponses`](../type-aliases/PutApiV1AdminAppsByIdResponses.md), [`PutApiV1AdminAppsByIdErrors`](../type-aliases/PutApiV1AdminAppsByIdErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/putApiV1AdminPersonasById

# putApiV1AdminPersonasById

> **putApiV1AdminPersonasById**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`PutApiV1AdminPersonasByIdData`](../type-aliases/PutApiV1AdminPersonasByIdData.md), `ThrowOnError`>): `RequestResult`<[`PutApiV1AdminPersonasByIdResponses`](../type-aliases/PutApiV1AdminPersonasByIdResponses.md), [`PutApiV1AdminPersonasByIdErrors`](../type-aliases/PutApiV1AdminPersonasByIdErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:336](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#336)

Update persona

Updates an existing persona. Requires admin API key.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`PutApiV1AdminPersonasByIdData`](../type-aliases/PutApiV1AdminPersonasByIdData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`PutApiV1AdminPersonasByIdResponses`](../type-aliases/PutApiV1AdminPersonasByIdResponses.md), [`PutApiV1AdminPersonasByIdErrors`](../type-aliases/PutApiV1AdminPersonasByIdErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/functions/putApiV1AgentsByIdPreference

# putApiV1AgentsByIdPreference

> **putApiV1AgentsByIdPreference**<`ThrowOnError`>(`options`: [`Options`](../type-aliases/Options.md)<[`PutApiV1AgentsByIdPreferenceData`](../type-aliases/PutApiV1AgentsByIdPreferenceData.md), `ThrowOnError`>): `RequestResult`<[`PutApiV1AgentsByIdPreferenceResponses`](../type-aliases/PutApiV1AgentsByIdPreferenceResponses.md), [`PutApiV1AgentsByIdPreferenceErrors`](../type-aliases/PutApiV1AgentsByIdPreferenceErrors.md), `ThrowOnError`>

Defined in: [src/client/sdk.gen.ts:480](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#480)

Set user agent preference

Sets or updates the user's preferred model for a specific agent

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`Options`](../type-aliases/Options.md)<[`PutApiV1AgentsByIdPreferenceData`](../type-aliases/PutApiV1AgentsByIdPreferenceData.md), `ThrowOnError`>

</td>
</tr>
</tbody>
</table>

## Returns

`RequestResult`<[`PutApiV1AgentsByIdPreferenceResponses`](../type-aliases/PutApiV1AgentsByIdPreferenceResponses.md), [`PutApiV1AgentsByIdPreferenceErrors`](../type-aliases/PutApiV1AgentsByIdPreferenceErrors.md), `ThrowOnError`>

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/AuthJwk

# AuthJwk

> **AuthJwk** = `object`

Defined in: [src/client/types.gen.ts:7](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#7)

## Properties

### alg?

> `optional` **alg**: `string`

Defined in: [src/client/types.gen.ts:8](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#8)

***

### crv?

> `optional` **crv**: `string`

Defined in: [src/client/types.gen.ts:9](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#9)

***

### kid?

> `optional` **kid**: `string`

Defined in: [src/client/types.gen.ts:10](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#10)

***

### kty?

> `optional` **kty**: `string`

Defined in: [src/client/types.gen.ts:11](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#11)

***

### use?

> `optional` **use**: `string`

Defined in: [src/client/types.gen.ts:12](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#12)

***

### x?

> `optional` **x**: `string`

Defined in: [src/client/types.gen.ts:13](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#13)

***

### y?

> `optional` **y**: `string`

Defined in: [src/client/types.gen.ts:14](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#14)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/AuthJwks

# AuthJwks

> **AuthJwks** = `object`

Defined in: [src/client/types.gen.ts:17](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#17)

## Properties

### keys?

> `optional` **keys**: [`AuthJwk`](AuthJwk.md)\[]

Defined in: [src/client/types.gen.ts:18](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#18)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/ClientOptions

# ClientOptions

> **ClientOptions** = `object`

Defined in: [src/client/types.gen.ts:3](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3)

## Properties

### baseUrl

> **baseUrl**: `` `${string}://${string}` `` | `string` & `object`

Defined in: [src/client/types.gen.ts:4](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/ConfigCompactLists

# ConfigCompactLists

> **ConfigCompactLists** = `object`

Defined in: [src/client/types.gen.ts:21](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#21)

## Properties

### private?

> `optional` **private**: `string`\[]

Defined in: [src/client/types.gen.ts:22](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#22)

***

### standard?

> `optional` **standard**: `string`\[]

Defined in: [src/client/types.gen.ts:23](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#23)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/ConfigCuratedModel

# ConfigCuratedModel

> **ConfigCuratedModel** = `object`

Defined in: [src/client/types.gen.ts:26](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#26)

## Properties

### active?

> `optional` **active**: `boolean`

Defined in: [src/client/types.gen.ts:27](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#27)

***

### category?

> `optional` **category**: `string`

Defined in: [src/client/types.gen.ts:31](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#31)

"text" | "image" | "vision"

***

### description?

> `optional` **description**: `string`

Defined in: [src/client/types.gen.ts:32](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#32)

***

### featured?

> `optional` **featured**: `boolean`

Defined in: [src/client/types.gen.ts:33](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#33)

***

### group\_display\_name?

> `optional` **group\_display\_name**: `string`

Defined in: [src/client/types.gen.ts:34](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#34)

***

### id?

> `optional` **id**: `string`

Defined in: [src/client/types.gen.ts:35](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#35)

***

### is\_new?

> `optional` **is\_new**: `boolean`

Defined in: [src/client/types.gen.ts:42](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#42)

IsNew flags a recently-shipped model so clients can render a
"New" badge in the picker. Set true on freshly-launched additions;
product should clear it once the model has been GA for a release
or two so the badge stays meaningful.

***

### is\_private?

> `optional` **is\_private**: `boolean`

Defined in: [src/client/types.gen.ts:43](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#43)

***

### modalities?

> `optional` **modalities**: `string`\[]

Defined in: [src/client/types.gen.ts:44](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#44)

***

### name?

> `optional` **name**: `string`

Defined in: [src/client/types.gen.ts:45](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#45)

***

### price\_tier?

> `optional` **price\_tier**: `string`

Defined in: [src/client/types.gen.ts:49](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#49)

"$" | "$$" | "$$$"

***

### provider?

> `optional` **provider**: `string`

Defined in: [src/client/types.gen.ts:50](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#50)

***

### quality?

> `optional` **quality**: `string`

Defined in: [src/client/types.gen.ts:54](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#54)

"high" | "medium" | "low"

***

### required\_tier?

> `optional` **required\_tier**: `string`

Defined in: [src/client/types.gen.ts:58](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#58)

"" | "Starter" | "Pro"

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/ConfigCuratedModelsResponse

# ConfigCuratedModelsResponse

> **ConfigCuratedModelsResponse** = `object`

Defined in: [src/client/types.gen.ts:61](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#61)

## Properties

### compact?

> `optional` **compact**: [`ConfigCompactLists`](ConfigCompactLists.md)

Defined in: [src/client/types.gen.ts:62](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#62)

***

### models?

> `optional` **models**: [`ConfigCuratedModel`](ConfigCuratedModel.md)\[]

Defined in: [src/client/types.gen.ts:63](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#63)

***

### version?

> `optional` **version**: `string`

Defined in: [src/client/types.gen.ts:64](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#64)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1AccountData

# DeleteApiV1AccountData

> **DeleteApiV1AccountData** = `object`

Defined in: [src/client/types.gen.ts:2623](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2623)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:2624](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2624)

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:2625](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2625)

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:2626](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2626)

***

### url

> **url**: `"/api/v1/account"`

Defined in: [src/client/types.gen.ts:2627](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2627)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1AccountError

# DeleteApiV1AccountError

> **DeleteApiV1AccountError** = [`DeleteApiV1AccountErrors`](DeleteApiV1AccountErrors.md)\[keyof [`DeleteApiV1AccountErrors`](DeleteApiV1AccountErrors.md)]

Defined in: [src/client/types.gen.ts:2645](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2645)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1AccountErrors

# DeleteApiV1AccountErrors

> **DeleteApiV1AccountErrors** = `object`

Defined in: [src/client/types.gen.ts:2630](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2630)

## Properties

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:2634](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2634)

Unauthorized

***

### 404

> **404**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:2638](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2638)

Account not found

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:2642](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2642)

Internal server error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1AccountResponse

# DeleteApiV1AccountResponse

> **DeleteApiV1AccountResponse** = [`DeleteApiV1AccountResponses`](DeleteApiV1AccountResponses.md)\[keyof [`DeleteApiV1AccountResponses`](DeleteApiV1AccountResponses.md)]

Defined in: [src/client/types.gen.ts:2656](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2656)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1AccountResponses

# DeleteApiV1AccountResponses

> **DeleteApiV1AccountResponses** = `object`

Defined in: [src/client/types.gen.ts:2647](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2647)

## Properties

### 200

> **200**: `object`

Defined in: [src/client/types.gen.ts:2651](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2651)

Account deleted

**Index Signature**

\[`key`: `string`]: `string`

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1AdminAgentsByIdData

# DeleteApiV1AdminAgentsByIdData

> **DeleteApiV1AdminAgentsByIdData** = `object`

Defined in: [src/client/types.gen.ts:2746](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2746)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:2747](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2747)

***

### headers

> **headers**: `object`

Defined in: [src/client/types.gen.ts:2748](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2748)

**X-Admin-API-Key**

> **X-Admin-API-Key**: `string`

Admin API key

***

### path

> **path**: `object`

Defined in: [src/client/types.gen.ts:2754](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2754)

**id**

> **id**: `number`

Agent ID

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:2760](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2760)

***

### url

> **url**: `"/api/v1/admin/agents/{id}"`

Defined in: [src/client/types.gen.ts:2761](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2761)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1AdminAgentsByIdError

# DeleteApiV1AdminAgentsByIdError

> **DeleteApiV1AdminAgentsByIdError** = [`DeleteApiV1AdminAgentsByIdErrors`](DeleteApiV1AdminAgentsByIdErrors.md)\[keyof [`DeleteApiV1AdminAgentsByIdErrors`](DeleteApiV1AdminAgentsByIdErrors.md)]

Defined in: [src/client/types.gen.ts:2783](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2783)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1AdminAgentsByIdErrors

# DeleteApiV1AdminAgentsByIdErrors

> **DeleteApiV1AdminAgentsByIdErrors** = `object`

Defined in: [src/client/types.gen.ts:2764](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2764)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:2768](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2768)

Bad Request

***

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:2772](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2772)

Unauthorized

***

### 404

> **404**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:2776](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2776)

Not Found

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:2780](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2780)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1AdminAgentsByIdResponse

# DeleteApiV1AdminAgentsByIdResponse

> **DeleteApiV1AdminAgentsByIdResponse** = [`DeleteApiV1AdminAgentsByIdResponses`](DeleteApiV1AdminAgentsByIdResponses.md)\[keyof [`DeleteApiV1AdminAgentsByIdResponses`](DeleteApiV1AdminAgentsByIdResponses.md)]

Defined in: [src/client/types.gen.ts:2794](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2794)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1AdminAgentsByIdResponses

# DeleteApiV1AdminAgentsByIdResponses

> **DeleteApiV1AdminAgentsByIdResponses** = `object`

Defined in: [src/client/types.gen.ts:2785](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2785)

## Properties

### 200

> **200**: `object`

Defined in: [src/client/types.gen.ts:2789](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2789)

OK

**Index Signature**

\[`key`: `string`]: `string`

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1AdminAppsByAppIdApiKeysByIdData

# DeleteApiV1AdminAppsByAppIdApiKeysByIdData

> **DeleteApiV1AdminAppsByAppIdApiKeysByIdData** = `object`

Defined in: [src/client/types.gen.ts:3045](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3045)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:3046](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3046)

***

### headers

> **headers**: `object`

Defined in: [src/client/types.gen.ts:3047](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3047)

**X-Admin-API-Key**

> **X-Admin-API-Key**: `string`

Admin API key

***

### path

> **path**: `object`

Defined in: [src/client/types.gen.ts:3053](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3053)

**app\_id**

> **app\_id**: `number`

App ID

**id**

> **id**: `number`

API Key ID

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:3063](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3063)

***

### url

> **url**: `"/api/v1/admin/apps/{app_id}/api-keys/{id}"`

Defined in: [src/client/types.gen.ts:3064](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3064)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1AdminAppsByAppIdApiKeysByIdError

# DeleteApiV1AdminAppsByAppIdApiKeysByIdError

> **DeleteApiV1AdminAppsByAppIdApiKeysByIdError** = [`DeleteApiV1AdminAppsByAppIdApiKeysByIdErrors`](DeleteApiV1AdminAppsByAppIdApiKeysByIdErrors.md)\[keyof [`DeleteApiV1AdminAppsByAppIdApiKeysByIdErrors`](DeleteApiV1AdminAppsByAppIdApiKeysByIdErrors.md)]

Defined in: [src/client/types.gen.ts:3082](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3082)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1AdminAppsByAppIdApiKeysByIdErrors

# DeleteApiV1AdminAppsByAppIdApiKeysByIdErrors

> **DeleteApiV1AdminAppsByAppIdApiKeysByIdErrors** = `object`

Defined in: [src/client/types.gen.ts:3067](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3067)

## Properties

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:3071](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3071)

Unauthorized

***

### 404

> **404**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:3075](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3075)

Not Found

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:3079](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3079)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1AdminAppsByAppIdApiKeysByIdResponse

# DeleteApiV1AdminAppsByAppIdApiKeysByIdResponse

> **DeleteApiV1AdminAppsByAppIdApiKeysByIdResponse** = [`DeleteApiV1AdminAppsByAppIdApiKeysByIdResponses`](DeleteApiV1AdminAppsByAppIdApiKeysByIdResponses.md)\[keyof [`DeleteApiV1AdminAppsByAppIdApiKeysByIdResponses`](DeleteApiV1AdminAppsByAppIdApiKeysByIdResponses.md)]

Defined in: [src/client/types.gen.ts:3093](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3093)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1AdminAppsByAppIdApiKeysByIdResponses

# DeleteApiV1AdminAppsByAppIdApiKeysByIdResponses

> **DeleteApiV1AdminAppsByAppIdApiKeysByIdResponses** = `object`

Defined in: [src/client/types.gen.ts:3084](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3084)

## Properties

### 200

> **200**: `object`

Defined in: [src/client/types.gen.ts:3088](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3088)

OK

**Index Signature**

\[`key`: `string`]: `string`

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1AdminAppsByIdData

# DeleteApiV1AdminAppsByIdData

> **DeleteApiV1AdminAppsByIdData** = `object`

Defined in: [src/client/types.gen.ts:3198](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3198)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:3199](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3199)

***

### headers

> **headers**: `object`

Defined in: [src/client/types.gen.ts:3200](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3200)

**X-Admin-API-Key**

> **X-Admin-API-Key**: `string`

Admin API key

***

### path

> **path**: `object`

Defined in: [src/client/types.gen.ts:3206](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3206)

**id**

> **id**: `number`

App ID

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:3212](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3212)

***

### url

> **url**: `"/api/v1/admin/apps/{id}"`

Defined in: [src/client/types.gen.ts:3213](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3213)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1AdminAppsByIdError

# DeleteApiV1AdminAppsByIdError

> **DeleteApiV1AdminAppsByIdError** = [`DeleteApiV1AdminAppsByIdErrors`](DeleteApiV1AdminAppsByIdErrors.md)\[keyof [`DeleteApiV1AdminAppsByIdErrors`](DeleteApiV1AdminAppsByIdErrors.md)]

Defined in: [src/client/types.gen.ts:3231](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3231)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1AdminAppsByIdErrors

# DeleteApiV1AdminAppsByIdErrors

> **DeleteApiV1AdminAppsByIdErrors** = `object`

Defined in: [src/client/types.gen.ts:3216](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3216)

## Properties

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:3220](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3220)

Unauthorized

***

### 404

> **404**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:3224](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3224)

Not Found

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:3228](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3228)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1AdminAppsByIdResponse

# DeleteApiV1AdminAppsByIdResponse

> **DeleteApiV1AdminAppsByIdResponse** = [`DeleteApiV1AdminAppsByIdResponses`](DeleteApiV1AdminAppsByIdResponses.md)\[keyof [`DeleteApiV1AdminAppsByIdResponses`](DeleteApiV1AdminAppsByIdResponses.md)]

Defined in: [src/client/types.gen.ts:3242](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3242)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1AdminAppsByIdResponses

# DeleteApiV1AdminAppsByIdResponses

> **DeleteApiV1AdminAppsByIdResponses** = `object`

Defined in: [src/client/types.gen.ts:3233](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3233)

## Properties

### 200

> **200**: `object`

Defined in: [src/client/types.gen.ts:3237](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3237)

OK

**Index Signature**

\[`key`: `string`]: `string`

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1AdminOauthClientsByClientIdData

# DeleteApiV1AdminOauthClientsByClientIdData

> **DeleteApiV1AdminOauthClientsByClientIdData** = `object`

Defined in: [src/client/types.gen.ts:3412](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3412)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:3413](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3413)

***

### headers

> **headers**: `object`

Defined in: [src/client/types.gen.ts:3414](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3414)

**X-Admin-API-Key**

> **X-Admin-API-Key**: `string`

Admin API key

***

### path

> **path**: `object`

Defined in: [src/client/types.gen.ts:3420](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3420)

**client\_id**

> **client\_id**: `string`

OAuth client ID

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:3426](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3426)

***

### url

> **url**: `"/api/v1/admin/oauth/clients/{client_id}"`

Defined in: [src/client/types.gen.ts:3427](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3427)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1AdminOauthClientsByClientIdError

# DeleteApiV1AdminOauthClientsByClientIdError

> **DeleteApiV1AdminOauthClientsByClientIdError** = [`DeleteApiV1AdminOauthClientsByClientIdErrors`](DeleteApiV1AdminOauthClientsByClientIdErrors.md)\[keyof [`DeleteApiV1AdminOauthClientsByClientIdErrors`](DeleteApiV1AdminOauthClientsByClientIdErrors.md)]

Defined in: [src/client/types.gen.ts:3437](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3437)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1AdminOauthClientsByClientIdErrors

# DeleteApiV1AdminOauthClientsByClientIdErrors

> **DeleteApiV1AdminOauthClientsByClientIdErrors** = `object`

Defined in: [src/client/types.gen.ts:3430](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3430)

## Properties

### 404

> **404**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:3434](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3434)

Not Found

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1AdminOauthClientsByClientIdResponse

# DeleteApiV1AdminOauthClientsByClientIdResponse

> **DeleteApiV1AdminOauthClientsByClientIdResponse** = [`DeleteApiV1AdminOauthClientsByClientIdResponses`](DeleteApiV1AdminOauthClientsByClientIdResponses.md)\[keyof [`DeleteApiV1AdminOauthClientsByClientIdResponses`](DeleteApiV1AdminOauthClientsByClientIdResponses.md)]

Defined in: [src/client/types.gen.ts:3446](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3446)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1AdminOauthClientsByClientIdResponses

# DeleteApiV1AdminOauthClientsByClientIdResponses

> **DeleteApiV1AdminOauthClientsByClientIdResponses** = `object`

Defined in: [src/client/types.gen.ts:3439](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3439)

## Properties

### 204

> **204**: `void`

Defined in: [src/client/types.gen.ts:3443](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3443)

No Content

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1AdminPersonasByIdData

# DeleteApiV1AdminPersonasByIdData

> **DeleteApiV1AdminPersonasByIdData** = `object`

Defined in: [src/client/types.gen.ts:3565](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3565)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:3566](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3566)

***

### headers

> **headers**: `object`

Defined in: [src/client/types.gen.ts:3567](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3567)

**X-Admin-API-Key**

> **X-Admin-API-Key**: `string`

Admin API key

***

### path

> **path**: `object`

Defined in: [src/client/types.gen.ts:3573](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3573)

**id**

> **id**: `number`

Persona ID

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:3579](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3579)

***

### url

> **url**: `"/api/v1/admin/personas/{id}"`

Defined in: [src/client/types.gen.ts:3580](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3580)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1AdminPersonasByIdError

# DeleteApiV1AdminPersonasByIdError

> **DeleteApiV1AdminPersonasByIdError** = [`DeleteApiV1AdminPersonasByIdErrors`](DeleteApiV1AdminPersonasByIdErrors.md)\[keyof [`DeleteApiV1AdminPersonasByIdErrors`](DeleteApiV1AdminPersonasByIdErrors.md)]

Defined in: [src/client/types.gen.ts:3602](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3602)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1AdminPersonasByIdErrors

# DeleteApiV1AdminPersonasByIdErrors

> **DeleteApiV1AdminPersonasByIdErrors** = `object`

Defined in: [src/client/types.gen.ts:3583](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3583)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:3587](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3587)

Bad Request

***

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:3591](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3591)

Unauthorized

***

### 404

> **404**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:3595](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3595)

Not Found

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:3599](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3599)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1AdminPersonasByIdResponse

# DeleteApiV1AdminPersonasByIdResponse

> **DeleteApiV1AdminPersonasByIdResponse** = [`DeleteApiV1AdminPersonasByIdResponses`](DeleteApiV1AdminPersonasByIdResponses.md)\[keyof [`DeleteApiV1AdminPersonasByIdResponses`](DeleteApiV1AdminPersonasByIdResponses.md)]

Defined in: [src/client/types.gen.ts:3613](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3613)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1AdminPersonasByIdResponses

# DeleteApiV1AdminPersonasByIdResponses

> **DeleteApiV1AdminPersonasByIdResponses** = `object`

Defined in: [src/client/types.gen.ts:3604](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3604)

## Properties

### 200

> **200**: `object`

Defined in: [src/client/types.gen.ts:3608](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3608)

OK

**Index Signature**

\[`key`: `string`]: `string`

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1AdminTextResetData

# DeleteApiV1AdminTextResetData

> **DeleteApiV1AdminTextResetData** = `object`

Defined in: [src/client/types.gen.ts:3824](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3824)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:3825](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3825)

***

### headers

> **headers**: `object`

Defined in: [src/client/types.gen.ts:3826](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3826)

**X-Admin-API-Key**

> **X-Admin-API-Key**: `string`

Admin API key

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:3832](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3832)

***

### query

> **query**: `object`

Defined in: [src/client/types.gen.ts:3833](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3833)

**wallet\_address**

> **wallet\_address**: `string`

User wallet address

***

### url

> **url**: `"/api/v1/admin/text/reset"`

Defined in: [src/client/types.gen.ts:3839](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3839)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1AdminTextResetError

# DeleteApiV1AdminTextResetError

> **DeleteApiV1AdminTextResetError** = [`DeleteApiV1AdminTextResetErrors`](DeleteApiV1AdminTextResetErrors.md)\[keyof [`DeleteApiV1AdminTextResetErrors`](DeleteApiV1AdminTextResetErrors.md)]

Defined in: [src/client/types.gen.ts:3861](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3861)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1AdminTextResetErrors

# DeleteApiV1AdminTextResetErrors

> **DeleteApiV1AdminTextResetErrors** = `object`

Defined in: [src/client/types.gen.ts:3842](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3842)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:3846](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3846)

Bad Request

***

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:3850](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3850)

Unauthorized

***

### 404

> **404**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:3854](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3854)

Not Found

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:3858](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3858)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1AdminTextResetResponse

# DeleteApiV1AdminTextResetResponse

> **DeleteApiV1AdminTextResetResponse** = [`DeleteApiV1AdminTextResetResponses`](DeleteApiV1AdminTextResetResponses.md)\[keyof [`DeleteApiV1AdminTextResetResponses`](DeleteApiV1AdminTextResetResponses.md)]

Defined in: [src/client/types.gen.ts:3872](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3872)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1AdminTextResetResponses

# DeleteApiV1AdminTextResetResponses

> **DeleteApiV1AdminTextResetResponses** = `object`

Defined in: [src/client/types.gen.ts:3863](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3863)

## Properties

### 200

> **200**: `object`

Defined in: [src/client/types.gen.ts:3867](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3867)

OK

**Index Signature**

\[`key`: `string`]: `string`

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1AdminUsersDeleteData

# DeleteApiV1AdminUsersDeleteData

> **DeleteApiV1AdminUsersDeleteData** = `object`

Defined in: [src/client/types.gen.ts:3874](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3874)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:3875](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3875)

***

### headers

> **headers**: `object`

Defined in: [src/client/types.gen.ts:3876](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3876)

**X-Admin-API-Key**

> **X-Admin-API-Key**: `string`

Admin API key

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:3882](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3882)

***

### query?

> `optional` **query**: `object`

Defined in: [src/client/types.gen.ts:3883](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3883)

**email?**

> `optional` **email**: `string`

Email address (requires Privy credentials)

**phone?**

> `optional` **phone**: `string`

Phone number (e.g. +15551234567)

**telegram?**

> `optional` **telegram**: `string`

Telegram handle

**wallet\_address?**

> `optional` **wallet\_address**: `string`

User wallet address (0x...)

***

### url

> **url**: `"/api/v1/admin/users/delete"`

Defined in: [src/client/types.gen.ts:3901](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3901)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1AdminUsersDeleteError

# DeleteApiV1AdminUsersDeleteError

> **DeleteApiV1AdminUsersDeleteError** = [`DeleteApiV1AdminUsersDeleteErrors`](DeleteApiV1AdminUsersDeleteErrors.md)\[keyof [`DeleteApiV1AdminUsersDeleteErrors`](DeleteApiV1AdminUsersDeleteErrors.md)]

Defined in: [src/client/types.gen.ts:3923](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3923)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1AdminUsersDeleteErrors

# DeleteApiV1AdminUsersDeleteErrors

> **DeleteApiV1AdminUsersDeleteErrors** = `object`

Defined in: [src/client/types.gen.ts:3904](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3904)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:3908](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3908)

Bad Request

***

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:3912](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3912)

Unauthorized

***

### 404

> **404**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:3916](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3916)

Not Found

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:3920](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3920)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1AdminUsersDeleteResponse

# DeleteApiV1AdminUsersDeleteResponse

> **DeleteApiV1AdminUsersDeleteResponse** = [`DeleteApiV1AdminUsersDeleteResponses`](DeleteApiV1AdminUsersDeleteResponses.md)\[keyof [`DeleteApiV1AdminUsersDeleteResponses`](DeleteApiV1AdminUsersDeleteResponses.md)]

Defined in: [src/client/types.gen.ts:3932](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3932)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1AdminUsersDeleteResponses

# DeleteApiV1AdminUsersDeleteResponses

> **DeleteApiV1AdminUsersDeleteResponses** = `object`

Defined in: [src/client/types.gen.ts:3925](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3925)

## Properties

### 200

> **200**: [`HandlersDeleteUserResponse`](HandlersDeleteUserResponse.md)

Defined in: [src/client/types.gen.ts:3929](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3929)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1AuthMfaPasskeyCredentialsByCredentialIdData

# DeleteApiV1AuthMfaPasskeyCredentialsByCredentialIdData

> **DeleteApiV1AuthMfaPasskeyCredentialsByCredentialIdData** = `object`

Defined in: [src/client/types.gen.ts:4169](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4169)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:4170](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4170)

***

### path

> **path**: `object`

Defined in: [src/client/types.gen.ts:4171](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4171)

**credential\_id**

> **credential\_id**: `string`

base64url-encoded credential id

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:4177](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4177)

***

### url

> **url**: `"/api/v1/auth/mfa/passkey/credentials/{credential_id}"`

Defined in: [src/client/types.gen.ts:4178](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4178)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1AuthMfaPasskeyCredentialsByCredentialIdError

# DeleteApiV1AuthMfaPasskeyCredentialsByCredentialIdError

> **DeleteApiV1AuthMfaPasskeyCredentialsByCredentialIdError** = [`DeleteApiV1AuthMfaPasskeyCredentialsByCredentialIdErrors`](DeleteApiV1AuthMfaPasskeyCredentialsByCredentialIdErrors.md)\[keyof [`DeleteApiV1AuthMfaPasskeyCredentialsByCredentialIdErrors`](DeleteApiV1AuthMfaPasskeyCredentialsByCredentialIdErrors.md)]

Defined in: [src/client/types.gen.ts:4192](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4192)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1AuthMfaPasskeyCredentialsByCredentialIdErrors

# DeleteApiV1AuthMfaPasskeyCredentialsByCredentialIdErrors

> **DeleteApiV1AuthMfaPasskeyCredentialsByCredentialIdErrors** = `object`

Defined in: [src/client/types.gen.ts:4181](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4181)

## Properties

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4185](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4185)

Unauthorized

***

### 404

> **404**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4189](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4189)

Not Found

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1AuthMfaPasskeyCredentialsByCredentialIdResponse

# DeleteApiV1AuthMfaPasskeyCredentialsByCredentialIdResponse

> **DeleteApiV1AuthMfaPasskeyCredentialsByCredentialIdResponse** = [`DeleteApiV1AuthMfaPasskeyCredentialsByCredentialIdResponses`](DeleteApiV1AuthMfaPasskeyCredentialsByCredentialIdResponses.md)\[keyof [`DeleteApiV1AuthMfaPasskeyCredentialsByCredentialIdResponses`](DeleteApiV1AuthMfaPasskeyCredentialsByCredentialIdResponses.md)]

Defined in: [src/client/types.gen.ts:4201](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4201)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1AuthMfaPasskeyCredentialsByCredentialIdResponses

# DeleteApiV1AuthMfaPasskeyCredentialsByCredentialIdResponses

> **DeleteApiV1AuthMfaPasskeyCredentialsByCredentialIdResponses** = `object`

Defined in: [src/client/types.gen.ts:4194](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4194)

## Properties

### 200

> **200**: [`HandlersPasskeyDeleteResponse`](HandlersPasskeyDeleteResponse.md)

Defined in: [src/client/types.gen.ts:4198](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4198)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1DeveloperAppsByAppUuidApiKeysByKeyIdData

# DeleteApiV1DeveloperAppsByAppUuidApiKeysByKeyIdData

> **DeleteApiV1DeveloperAppsByAppUuidApiKeysByKeyIdData** = `object`

Defined in: [src/client/types.gen.ts:5057](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5057)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:5058](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5058)

***

### path

> **path**: `object`

Defined in: [src/client/types.gen.ts:5059](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5059)

**app\_uuid**

> **app\_uuid**: `string`

App UUID

**key\_id**

> **key\_id**: `number`

API Key ID

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:5069](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5069)

***

### url

> **url**: `"/api/v1/developer/apps/{app_uuid}/api-keys/{key_id}"`

Defined in: [src/client/types.gen.ts:5070](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5070)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1DeveloperAppsByAppUuidApiKeysByKeyIdError

# DeleteApiV1DeveloperAppsByAppUuidApiKeysByKeyIdError

> **DeleteApiV1DeveloperAppsByAppUuidApiKeysByKeyIdError** = [`DeleteApiV1DeveloperAppsByAppUuidApiKeysByKeyIdErrors`](DeleteApiV1DeveloperAppsByAppUuidApiKeysByKeyIdErrors.md)\[keyof [`DeleteApiV1DeveloperAppsByAppUuidApiKeysByKeyIdErrors`](DeleteApiV1DeveloperAppsByAppUuidApiKeysByKeyIdErrors.md)]

Defined in: [src/client/types.gen.ts:5092](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5092)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1DeveloperAppsByAppUuidApiKeysByKeyIdErrors

# DeleteApiV1DeveloperAppsByAppUuidApiKeysByKeyIdErrors

> **DeleteApiV1DeveloperAppsByAppUuidApiKeysByKeyIdErrors** = `object`

Defined in: [src/client/types.gen.ts:5073](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5073)

## Properties

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5077](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5077)

Unauthorized

***

### 403

> **403**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5081](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5081)

Forbidden

***

### 404

> **404**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5085](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5085)

Not Found

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5089](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5089)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1DeveloperAppsByAppUuidApiKeysByKeyIdResponse

# DeleteApiV1DeveloperAppsByAppUuidApiKeysByKeyIdResponse

> **DeleteApiV1DeveloperAppsByAppUuidApiKeysByKeyIdResponse** = [`DeleteApiV1DeveloperAppsByAppUuidApiKeysByKeyIdResponses`](DeleteApiV1DeveloperAppsByAppUuidApiKeysByKeyIdResponses.md)\[keyof [`DeleteApiV1DeveloperAppsByAppUuidApiKeysByKeyIdResponses`](DeleteApiV1DeveloperAppsByAppUuidApiKeysByKeyIdResponses.md)]

Defined in: [src/client/types.gen.ts:5103](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5103)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1DeveloperAppsByAppUuidApiKeysByKeyIdResponses

# DeleteApiV1DeveloperAppsByAppUuidApiKeysByKeyIdResponses

> **DeleteApiV1DeveloperAppsByAppUuidApiKeysByKeyIdResponses** = `object`

Defined in: [src/client/types.gen.ts:5094](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5094)

## Properties

### 200

> **200**: `object`

Defined in: [src/client/types.gen.ts:5098](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5098)

OK

**Index Signature**

\[`key`: `string`]: `string`

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1DeveloperAppsByAppUuidData

# DeleteApiV1DeveloperAppsByAppUuidData

> **DeleteApiV1DeveloperAppsByAppUuidData** = `object`

Defined in: [src/client/types.gen.ts:4818](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4818)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:4819](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4819)

***

### path

> **path**: `object`

Defined in: [src/client/types.gen.ts:4820](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4820)

**app\_uuid**

> **app\_uuid**: `string`

App UUID

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:4826](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4826)

***

### url

> **url**: `"/api/v1/developer/apps/{app_uuid}"`

Defined in: [src/client/types.gen.ts:4827](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4827)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1DeveloperAppsByAppUuidError

# DeleteApiV1DeveloperAppsByAppUuidError

> **DeleteApiV1DeveloperAppsByAppUuidError** = [`DeleteApiV1DeveloperAppsByAppUuidErrors`](DeleteApiV1DeveloperAppsByAppUuidErrors.md)\[keyof [`DeleteApiV1DeveloperAppsByAppUuidErrors`](DeleteApiV1DeveloperAppsByAppUuidErrors.md)]

Defined in: [src/client/types.gen.ts:4849](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4849)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1DeveloperAppsByAppUuidErrors

# DeleteApiV1DeveloperAppsByAppUuidErrors

> **DeleteApiV1DeveloperAppsByAppUuidErrors** = `object`

Defined in: [src/client/types.gen.ts:4830](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4830)

## Properties

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4834](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4834)

Unauthorized

***

### 403

> **403**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4838](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4838)

Forbidden

***

### 404

> **404**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4842](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4842)

Not Found

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4846](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4846)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1DeveloperAppsByAppUuidPrivyData

# DeleteApiV1DeveloperAppsByAppUuidPrivyData

> **DeleteApiV1DeveloperAppsByAppUuidPrivyData** = `object`

Defined in: [src/client/types.gen.ts:5154](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5154)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:5155](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5155)

***

### path

> **path**: `object`

Defined in: [src/client/types.gen.ts:5156](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5156)

**app\_uuid**

> **app\_uuid**: `string`

App UUID

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:5162](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5162)

***

### url

> **url**: `"/api/v1/developer/apps/{app_uuid}/privy"`

Defined in: [src/client/types.gen.ts:5163](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5163)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1DeveloperAppsByAppUuidPrivyError

# DeleteApiV1DeveloperAppsByAppUuidPrivyError

> **DeleteApiV1DeveloperAppsByAppUuidPrivyError** = [`DeleteApiV1DeveloperAppsByAppUuidPrivyErrors`](DeleteApiV1DeveloperAppsByAppUuidPrivyErrors.md)\[keyof [`DeleteApiV1DeveloperAppsByAppUuidPrivyErrors`](DeleteApiV1DeveloperAppsByAppUuidPrivyErrors.md)]

Defined in: [src/client/types.gen.ts:5185](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5185)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1DeveloperAppsByAppUuidPrivyErrors

# DeleteApiV1DeveloperAppsByAppUuidPrivyErrors

> **DeleteApiV1DeveloperAppsByAppUuidPrivyErrors** = `object`

Defined in: [src/client/types.gen.ts:5166](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5166)

## Properties

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5170](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5170)

Unauthorized

***

### 403

> **403**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5174](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5174)

Forbidden

***

### 404

> **404**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5178](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5178)

Not Found

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5182](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5182)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1DeveloperAppsByAppUuidPrivyResponse

# DeleteApiV1DeveloperAppsByAppUuidPrivyResponse

> **DeleteApiV1DeveloperAppsByAppUuidPrivyResponse** = [`DeleteApiV1DeveloperAppsByAppUuidPrivyResponses`](DeleteApiV1DeveloperAppsByAppUuidPrivyResponses.md)\[keyof [`DeleteApiV1DeveloperAppsByAppUuidPrivyResponses`](DeleteApiV1DeveloperAppsByAppUuidPrivyResponses.md)]

Defined in: [src/client/types.gen.ts:5194](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5194)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1DeveloperAppsByAppUuidPrivyResponses

# DeleteApiV1DeveloperAppsByAppUuidPrivyResponses

> **DeleteApiV1DeveloperAppsByAppUuidPrivyResponses** = `object`

Defined in: [src/client/types.gen.ts:5187](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5187)

## Properties

### 200

> **200**: [`HandlersDeveloperAppResponse`](HandlersDeveloperAppResponse.md)

Defined in: [src/client/types.gen.ts:5191](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5191)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1DeveloperAppsByAppUuidResponse

# DeleteApiV1DeveloperAppsByAppUuidResponse

> **DeleteApiV1DeveloperAppsByAppUuidResponse** = [`DeleteApiV1DeveloperAppsByAppUuidResponses`](DeleteApiV1DeveloperAppsByAppUuidResponses.md)\[keyof [`DeleteApiV1DeveloperAppsByAppUuidResponses`](DeleteApiV1DeveloperAppsByAppUuidResponses.md)]

Defined in: [src/client/types.gen.ts:4860](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4860)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1DeveloperAppsByAppUuidResponses

# DeleteApiV1DeveloperAppsByAppUuidResponses

> **DeleteApiV1DeveloperAppsByAppUuidResponses** = `object`

Defined in: [src/client/types.gen.ts:4851](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4851)

## Properties

### 200

> **200**: `object`

Defined in: [src/client/types.gen.ts:4855](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4855)

OK

**Index Signature**

\[`key`: `string`]: `string`

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1TextByChannelUnregisterData

# DeleteApiV1TextByChannelUnregisterData

> **DeleteApiV1TextByChannelUnregisterData** = `object`

Defined in: [src/client/types.gen.ts:6468](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6468)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:6469](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6469)

***

### path

> **path**: `object`

Defined in: [src/client/types.gen.ts:6470](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6470)

**channel**

> **channel**: `string`

Text channel (sms, telegram)

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:6476](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6476)

***

### url

> **url**: `"/api/v1/text/{channel}/unregister"`

Defined in: [src/client/types.gen.ts:6477](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6477)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1TextByChannelUnregisterError

# DeleteApiV1TextByChannelUnregisterError

> **DeleteApiV1TextByChannelUnregisterError** = [`DeleteApiV1TextByChannelUnregisterErrors`](DeleteApiV1TextByChannelUnregisterErrors.md)\[keyof [`DeleteApiV1TextByChannelUnregisterErrors`](DeleteApiV1TextByChannelUnregisterErrors.md)]

Defined in: [src/client/types.gen.ts:6495](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6495)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1TextByChannelUnregisterErrors

# DeleteApiV1TextByChannelUnregisterErrors

> **DeleteApiV1TextByChannelUnregisterErrors** = `object`

Defined in: [src/client/types.gen.ts:6480](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6480)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6484](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6484)

Invalid channel

***

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6488](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6488)

Unauthorized

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6492](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6492)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1TextByChannelUnregisterResponse

# DeleteApiV1TextByChannelUnregisterResponse

> **DeleteApiV1TextByChannelUnregisterResponse** = [`DeleteApiV1TextByChannelUnregisterResponses`](DeleteApiV1TextByChannelUnregisterResponses.md)\[keyof [`DeleteApiV1TextByChannelUnregisterResponses`](DeleteApiV1TextByChannelUnregisterResponses.md)]

Defined in: [src/client/types.gen.ts:6504](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6504)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1TextByChannelUnregisterResponses

# DeleteApiV1TextByChannelUnregisterResponses

> **DeleteApiV1TextByChannelUnregisterResponses** = `object`

Defined in: [src/client/types.gen.ts:6497](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6497)

## Properties

### 200

> **200**: [`HandlersUnregisterTextResponse`](HandlersUnregisterTextResponse.md)

Defined in: [src/client/types.gen.ts:6501](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6501)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1UserApiKeysByKeyIdData

# DeleteApiV1UserApiKeysByKeyIdData

> **DeleteApiV1UserApiKeysByKeyIdData** = `object`

Defined in: [src/client/types.gen.ts:6692](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6692)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:6693](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6693)

***

### path

> **path**: `object`

Defined in: [src/client/types.gen.ts:6694](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6694)

**key\_id**

> **key\_id**: `number`

API Key ID

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:6700](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6700)

***

### url

> **url**: `"/api/v1/user/api-keys/{key_id}"`

Defined in: [src/client/types.gen.ts:6701](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6701)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1UserApiKeysByKeyIdError

# DeleteApiV1UserApiKeysByKeyIdError

> **DeleteApiV1UserApiKeysByKeyIdError** = [`DeleteApiV1UserApiKeysByKeyIdErrors`](DeleteApiV1UserApiKeysByKeyIdErrors.md)\[keyof [`DeleteApiV1UserApiKeysByKeyIdErrors`](DeleteApiV1UserApiKeysByKeyIdErrors.md)]

Defined in: [src/client/types.gen.ts:6723](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6723)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1UserApiKeysByKeyIdErrors

# DeleteApiV1UserApiKeysByKeyIdErrors

> **DeleteApiV1UserApiKeysByKeyIdErrors** = `object`

Defined in: [src/client/types.gen.ts:6704](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6704)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6708](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6708)

Bad Request

***

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6712](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6712)

Unauthorized

***

### 404

> **404**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6716](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6716)

Not Found

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6720](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6720)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1UserApiKeysByKeyIdResponse

# DeleteApiV1UserApiKeysByKeyIdResponse

> **DeleteApiV1UserApiKeysByKeyIdResponse** = [`DeleteApiV1UserApiKeysByKeyIdResponses`](DeleteApiV1UserApiKeysByKeyIdResponses.md)\[keyof [`DeleteApiV1UserApiKeysByKeyIdResponses`](DeleteApiV1UserApiKeysByKeyIdResponses.md)]

Defined in: [src/client/types.gen.ts:6734](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6734)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1UserApiKeysByKeyIdResponses

# DeleteApiV1UserApiKeysByKeyIdResponses

> **DeleteApiV1UserApiKeysByKeyIdResponses** = `object`

Defined in: [src/client/types.gen.ts:6725](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6725)

## Properties

### 200

> **200**: `object`

Defined in: [src/client/types.gen.ts:6729](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6729)

OK

**Index Signature**

\[`key`: `string`]: `string`

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1UserOauthGrantsByIdData

# DeleteApiV1UserOauthGrantsByIdData

> **DeleteApiV1UserOauthGrantsByIdData** = `object`

Defined in: [src/client/types.gen.ts:6765](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6765)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:6766](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6766)

***

### path

> **path**: `object`

Defined in: [src/client/types.gen.ts:6767](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6767)

**id**

> **id**: `number`

Grant ID

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:6773](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6773)

***

### url

> **url**: `"/api/v1/user/oauth/grants/{id}"`

Defined in: [src/client/types.gen.ts:6774](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6774)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1UserOauthGrantsByIdError

# DeleteApiV1UserOauthGrantsByIdError

> **DeleteApiV1UserOauthGrantsByIdError** = [`DeleteApiV1UserOauthGrantsByIdErrors`](DeleteApiV1UserOauthGrantsByIdErrors.md)\[keyof [`DeleteApiV1UserOauthGrantsByIdErrors`](DeleteApiV1UserOauthGrantsByIdErrors.md)]

Defined in: [src/client/types.gen.ts:6788](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6788)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1UserOauthGrantsByIdErrors

# DeleteApiV1UserOauthGrantsByIdErrors

> **DeleteApiV1UserOauthGrantsByIdErrors** = `object`

Defined in: [src/client/types.gen.ts:6777](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6777)

## Properties

### 403

> **403**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6781](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6781)

Forbidden

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6785](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6785)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1UserOauthGrantsByIdResponse

# DeleteApiV1UserOauthGrantsByIdResponse

> **DeleteApiV1UserOauthGrantsByIdResponse** = [`DeleteApiV1UserOauthGrantsByIdResponses`](DeleteApiV1UserOauthGrantsByIdResponses.md)\[keyof [`DeleteApiV1UserOauthGrantsByIdResponses`](DeleteApiV1UserOauthGrantsByIdResponses.md)]

Defined in: [src/client/types.gen.ts:6799](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6799)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/DeleteApiV1UserOauthGrantsByIdResponses

# DeleteApiV1UserOauthGrantsByIdResponses

> **DeleteApiV1UserOauthGrantsByIdResponses** = `object`

Defined in: [src/client/types.gen.ts:6790](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6790)

## Properties

### 200

> **200**: `object`

Defined in: [src/client/types.gen.ts:6794](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6794)

OK

**Index Signature**

\[`key`: `string`]: `string`

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1AdminAppsByAppIdApiKeysByIdData

# GetApiV1AdminAppsByAppIdApiKeysByIdData

> **GetApiV1AdminAppsByAppIdApiKeysByIdData** = `object`

Defined in: [src/client/types.gen.ts:3095](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3095)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:3096](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3096)

***

### headers

> **headers**: `object`

Defined in: [src/client/types.gen.ts:3097](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3097)

**X-Admin-API-Key**

> **X-Admin-API-Key**: `string`

Admin API key

***

### path

> **path**: `object`

Defined in: [src/client/types.gen.ts:3103](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3103)

**app\_id**

> **app\_id**: `number`

App ID

**id**

> **id**: `number`

API Key ID

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:3113](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3113)

***

### url

> **url**: `"/api/v1/admin/apps/{app_id}/api-keys/{id}"`

Defined in: [src/client/types.gen.ts:3114](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3114)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1AdminAppsByAppIdApiKeysByIdError

# GetApiV1AdminAppsByAppIdApiKeysByIdError

> **GetApiV1AdminAppsByAppIdApiKeysByIdError** = [`GetApiV1AdminAppsByAppIdApiKeysByIdErrors`](GetApiV1AdminAppsByAppIdApiKeysByIdErrors.md)\[keyof [`GetApiV1AdminAppsByAppIdApiKeysByIdErrors`](GetApiV1AdminAppsByAppIdApiKeysByIdErrors.md)]

Defined in: [src/client/types.gen.ts:3132](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3132)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1AdminAppsByAppIdApiKeysByIdErrors

# GetApiV1AdminAppsByAppIdApiKeysByIdErrors

> **GetApiV1AdminAppsByAppIdApiKeysByIdErrors** = `object`

Defined in: [src/client/types.gen.ts:3117](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3117)

## Properties

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:3121](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3121)

Unauthorized

***

### 404

> **404**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:3125](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3125)

Not Found

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:3129](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3129)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1AdminAppsByAppIdApiKeysByIdResponse

# GetApiV1AdminAppsByAppIdApiKeysByIdResponse

> **GetApiV1AdminAppsByAppIdApiKeysByIdResponse** = [`GetApiV1AdminAppsByAppIdApiKeysByIdResponses`](GetApiV1AdminAppsByAppIdApiKeysByIdResponses.md)\[keyof [`GetApiV1AdminAppsByAppIdApiKeysByIdResponses`](GetApiV1AdminAppsByAppIdApiKeysByIdResponses.md)]

Defined in: [src/client/types.gen.ts:3141](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3141)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1AdminAppsByAppIdApiKeysByIdResponses

# GetApiV1AdminAppsByAppIdApiKeysByIdResponses

> **GetApiV1AdminAppsByAppIdApiKeysByIdResponses** = `object`

Defined in: [src/client/types.gen.ts:3134](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3134)

## Properties

### 200

> **200**: [`HandlersApiKeyResponse`](HandlersApiKeyResponse.md)

Defined in: [src/client/types.gen.ts:3138](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3138)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1AdminAppsByAppIdApiKeysData

# GetApiV1AdminAppsByAppIdApiKeysData

> **GetApiV1AdminAppsByAppIdApiKeysData** = `object`

Defined in: [src/client/types.gen.ts:2937](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2937)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:2938](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2938)

***

### headers

> **headers**: `object`

Defined in: [src/client/types.gen.ts:2939](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2939)

**X-Admin-API-Key**

> **X-Admin-API-Key**: `string`

Admin API key

***

### path

> **path**: `object`

Defined in: [src/client/types.gen.ts:2945](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2945)

**app\_id**

> **app\_id**: `number`

App ID

***

### query?

> `optional` **query**: `object`

Defined in: [src/client/types.gen.ts:2951](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2951)

**limit?**

> `optional` **limit**: `number`

Maximum number of API keys to return (default 50, max 100)

**offset?**

> `optional` **offset**: `number`

Number of API keys to skip (default 0)

***

### url

> **url**: `"/api/v1/admin/apps/{app_id}/api-keys"`

Defined in: [src/client/types.gen.ts:2961](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2961)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1AdminAppsByAppIdApiKeysError

# GetApiV1AdminAppsByAppIdApiKeysError

> **GetApiV1AdminAppsByAppIdApiKeysError** = [`GetApiV1AdminAppsByAppIdApiKeysErrors`](GetApiV1AdminAppsByAppIdApiKeysErrors.md)\[keyof [`GetApiV1AdminAppsByAppIdApiKeysErrors`](GetApiV1AdminAppsByAppIdApiKeysErrors.md)]

Defined in: [src/client/types.gen.ts:2983](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2983)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1AdminAppsByAppIdApiKeysErrors

# GetApiV1AdminAppsByAppIdApiKeysErrors

> **GetApiV1AdminAppsByAppIdApiKeysErrors** = `object`

Defined in: [src/client/types.gen.ts:2964](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2964)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:2968](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2968)

Bad Request

***

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:2972](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2972)

Unauthorized

***

### 404

> **404**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:2976](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2976)

Not Found

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:2980](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2980)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1AdminAppsByAppIdApiKeysResponse

# GetApiV1AdminAppsByAppIdApiKeysResponse

> **GetApiV1AdminAppsByAppIdApiKeysResponse** = [`GetApiV1AdminAppsByAppIdApiKeysResponses`](GetApiV1AdminAppsByAppIdApiKeysResponses.md)\[keyof [`GetApiV1AdminAppsByAppIdApiKeysResponses`](GetApiV1AdminAppsByAppIdApiKeysResponses.md)]

Defined in: [src/client/types.gen.ts:2992](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2992)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1AdminAppsByAppIdApiKeysResponses

# GetApiV1AdminAppsByAppIdApiKeysResponses

> **GetApiV1AdminAppsByAppIdApiKeysResponses** = `object`

Defined in: [src/client/types.gen.ts:2985](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2985)

## Properties

### 200

> **200**: [`HandlersListApiKeysResponse`](HandlersListApiKeysResponse.md)

Defined in: [src/client/types.gen.ts:2989](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2989)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1AdminAppsByIdData

# GetApiV1AdminAppsByIdData

> **GetApiV1AdminAppsByIdData** = `object`

Defined in: [src/client/types.gen.ts:3244](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3244)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:3245](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3245)

***

### headers

> **headers**: `object`

Defined in: [src/client/types.gen.ts:3246](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3246)

**X-Admin-API-Key**

> **X-Admin-API-Key**: `string`

Admin API key

***

### path

> **path**: `object`

Defined in: [src/client/types.gen.ts:3252](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3252)

**id**

> **id**: `number`

App ID

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:3258](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3258)

***

### url

> **url**: `"/api/v1/admin/apps/{id}"`

Defined in: [src/client/types.gen.ts:3259](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3259)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1AdminAppsByIdError

# GetApiV1AdminAppsByIdError

> **GetApiV1AdminAppsByIdError** = [`GetApiV1AdminAppsByIdErrors`](GetApiV1AdminAppsByIdErrors.md)\[keyof [`GetApiV1AdminAppsByIdErrors`](GetApiV1AdminAppsByIdErrors.md)]

Defined in: [src/client/types.gen.ts:3277](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3277)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1AdminAppsByIdErrors

# GetApiV1AdminAppsByIdErrors

> **GetApiV1AdminAppsByIdErrors** = `object`

Defined in: [src/client/types.gen.ts:3262](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3262)

## Properties

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:3266](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3266)

Unauthorized

***

### 404

> **404**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:3270](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3270)

Not Found

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:3274](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3274)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1AdminAppsByIdResponse

# GetApiV1AdminAppsByIdResponse

> **GetApiV1AdminAppsByIdResponse** = [`GetApiV1AdminAppsByIdResponses`](GetApiV1AdminAppsByIdResponses.md)\[keyof [`GetApiV1AdminAppsByIdResponses`](GetApiV1AdminAppsByIdResponses.md)]

Defined in: [src/client/types.gen.ts:3286](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3286)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1AdminAppsByIdResponses

# GetApiV1AdminAppsByIdResponses

> **GetApiV1AdminAppsByIdResponses** = `object`

Defined in: [src/client/types.gen.ts:3279](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3279)

## Properties

### 200

> **200**: [`HandlersAppResponse`](HandlersAppResponse.md)

Defined in: [src/client/types.gen.ts:3283](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3283)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1AdminAppsData

# GetApiV1AdminAppsData

> **GetApiV1AdminAppsData** = `object`

Defined in: [src/client/types.gen.ts:2847](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2847)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:2848](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2848)

***

### headers

> **headers**: `object`

Defined in: [src/client/types.gen.ts:2849](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2849)

**X-Admin-API-Key**

> **X-Admin-API-Key**: `string`

Admin API key

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:2855](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2855)

***

### query?

> `optional` **query**: `object`

Defined in: [src/client/types.gen.ts:2856](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2856)

**limit?**

> `optional` **limit**: `number`

Maximum number of apps to return (default 50, max 100)

**offset?**

> `optional` **offset**: `number`

Number of apps to skip (default 0)

***

### url

> **url**: `"/api/v1/admin/apps"`

Defined in: [src/client/types.gen.ts:2866](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2866)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1AdminAppsError

# GetApiV1AdminAppsError

> **GetApiV1AdminAppsError** = [`GetApiV1AdminAppsErrors`](GetApiV1AdminAppsErrors.md)\[keyof [`GetApiV1AdminAppsErrors`](GetApiV1AdminAppsErrors.md)]

Defined in: [src/client/types.gen.ts:2884](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2884)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1AdminAppsErrors

# GetApiV1AdminAppsErrors

> **GetApiV1AdminAppsErrors** = `object`

Defined in: [src/client/types.gen.ts:2869](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2869)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:2873](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2873)

Bad Request

***

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:2877](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2877)

Unauthorized

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:2881](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2881)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1AdminAppsResponse

# GetApiV1AdminAppsResponse

> **GetApiV1AdminAppsResponse** = [`GetApiV1AdminAppsResponses`](GetApiV1AdminAppsResponses.md)\[keyof [`GetApiV1AdminAppsResponses`](GetApiV1AdminAppsResponses.md)]

Defined in: [src/client/types.gen.ts:2893](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2893)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1AdminAppsResponses

# GetApiV1AdminAppsResponses

> **GetApiV1AdminAppsResponses** = `object`

Defined in: [src/client/types.gen.ts:2886](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2886)

## Properties

### 200

> **200**: [`HandlersListAppsResponse`](HandlersListAppsResponse.md)

Defined in: [src/client/types.gen.ts:2890](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2890)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1AdminOauthClientsByClientIdData

# GetApiV1AdminOauthClientsByClientIdData

> **GetApiV1AdminOauthClientsByClientIdData** = `object`

Defined in: [src/client/types.gen.ts:3448](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3448)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:3449](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3449)

***

### headers

> **headers**: `object`

Defined in: [src/client/types.gen.ts:3450](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3450)

**X-Admin-API-Key**

> **X-Admin-API-Key**: `string`

Admin API key

***

### path

> **path**: `object`

Defined in: [src/client/types.gen.ts:3456](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3456)

**client\_id**

> **client\_id**: `string`

OAuth client ID

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:3462](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3462)

***

### url

> **url**: `"/api/v1/admin/oauth/clients/{client_id}"`

Defined in: [src/client/types.gen.ts:3463](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3463)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1AdminOauthClientsByClientIdError

# GetApiV1AdminOauthClientsByClientIdError

> **GetApiV1AdminOauthClientsByClientIdError** = [`GetApiV1AdminOauthClientsByClientIdErrors`](GetApiV1AdminOauthClientsByClientIdErrors.md)\[keyof [`GetApiV1AdminOauthClientsByClientIdErrors`](GetApiV1AdminOauthClientsByClientIdErrors.md)]

Defined in: [src/client/types.gen.ts:3473](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3473)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1AdminOauthClientsByClientIdErrors

# GetApiV1AdminOauthClientsByClientIdErrors

> **GetApiV1AdminOauthClientsByClientIdErrors** = `object`

Defined in: [src/client/types.gen.ts:3466](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3466)

## Properties

### 404

> **404**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:3470](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3470)

Not Found

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1AdminOauthClientsByClientIdResponse

# GetApiV1AdminOauthClientsByClientIdResponse

> **GetApiV1AdminOauthClientsByClientIdResponse** = [`GetApiV1AdminOauthClientsByClientIdResponses`](GetApiV1AdminOauthClientsByClientIdResponses.md)\[keyof [`GetApiV1AdminOauthClientsByClientIdResponses`](GetApiV1AdminOauthClientsByClientIdResponses.md)]

Defined in: [src/client/types.gen.ts:3482](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3482)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1AdminOauthClientsByClientIdResponses

# GetApiV1AdminOauthClientsByClientIdResponses

> **GetApiV1AdminOauthClientsByClientIdResponses** = `object`

Defined in: [src/client/types.gen.ts:3475](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3475)

## Properties

### 200

> **200**: [`HandlersOAuthClientResponse`](HandlersOAuthClientResponse.md)

Defined in: [src/client/types.gen.ts:3479](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3479)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1AdminOauthClientsData

# GetApiV1AdminOauthClientsData

> **GetApiV1AdminOauthClientsData** = `object`

Defined in: [src/client/types.gen.ts:3339](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3339)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:3340](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3340)

***

### headers

> **headers**: `object`

Defined in: [src/client/types.gen.ts:3341](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3341)

**X-Admin-API-Key**

> **X-Admin-API-Key**: `string`

Admin API key

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:3347](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3347)

***

### query?

> `optional` **query**: `object`

Defined in: [src/client/types.gen.ts:3348](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3348)

**limit?**

> `optional` **limit**: `number`

Maximum clients to return (default 50, max 200)

**offset?**

> `optional` **offset**: `number`

Number of clients to skip (default 0)

***

### url

> **url**: `"/api/v1/admin/oauth/clients"`

Defined in: [src/client/types.gen.ts:3358](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3358)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1AdminOauthClientsResponse

# GetApiV1AdminOauthClientsResponse

> **GetApiV1AdminOauthClientsResponse** = [`GetApiV1AdminOauthClientsResponses`](GetApiV1AdminOauthClientsResponses.md)\[keyof [`GetApiV1AdminOauthClientsResponses`](GetApiV1AdminOauthClientsResponses.md)]

Defined in: [src/client/types.gen.ts:3368](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3368)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1AdminOauthClientsResponses

# GetApiV1AdminOauthClientsResponses

> **GetApiV1AdminOauthClientsResponses** = `object`

Defined in: [src/client/types.gen.ts:3361](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3361)

## Properties

### 200

> **200**: [`HandlersListOAuthClientsResponse`](HandlersListOAuthClientsResponse.md)

Defined in: [src/client/types.gen.ts:3365](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3365)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1AdminPrivyIdentifiersAuditData

# GetApiV1AdminPrivyIdentifiersAuditData

> **GetApiV1AdminPrivyIdentifiersAuditData** = `object`

Defined in: [src/client/types.gen.ts:3666](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3666)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:3667](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3667)

***

### headers

> **headers**: `object`

Defined in: [src/client/types.gen.ts:3668](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3668)

**X-Admin-API-Key**

> **X-Admin-API-Key**: `string`

Admin API key

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:3674](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3674)

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:3675](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3675)

***

### url

> **url**: `"/api/v1/admin/privy-identifiers/audit"`

Defined in: [src/client/types.gen.ts:3676](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3676)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1AdminPrivyIdentifiersAuditError

# GetApiV1AdminPrivyIdentifiersAuditError

> **GetApiV1AdminPrivyIdentifiersAuditError** = [`GetApiV1AdminPrivyIdentifiersAuditErrors`](GetApiV1AdminPrivyIdentifiersAuditErrors.md)\[keyof [`GetApiV1AdminPrivyIdentifiersAuditErrors`](GetApiV1AdminPrivyIdentifiersAuditErrors.md)]

Defined in: [src/client/types.gen.ts:3690](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3690)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1AdminPrivyIdentifiersAuditErrors

# GetApiV1AdminPrivyIdentifiersAuditErrors

> **GetApiV1AdminPrivyIdentifiersAuditErrors** = `object`

Defined in: [src/client/types.gen.ts:3679](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3679)

## Properties

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:3683](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3683)

Unauthorized

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:3687](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3687)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1AdminPrivyIdentifiersAuditResponse

# GetApiV1AdminPrivyIdentifiersAuditResponse

> **GetApiV1AdminPrivyIdentifiersAuditResponse** = [`GetApiV1AdminPrivyIdentifiersAuditResponses`](GetApiV1AdminPrivyIdentifiersAuditResponses.md)\[keyof [`GetApiV1AdminPrivyIdentifiersAuditResponses`](GetApiV1AdminPrivyIdentifiersAuditResponses.md)]

Defined in: [src/client/types.gen.ts:3699](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3699)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1AdminPrivyIdentifiersAuditResponses

# GetApiV1AdminPrivyIdentifiersAuditResponses

> **GetApiV1AdminPrivyIdentifiersAuditResponses** = `object`

Defined in: [src/client/types.gen.ts:3692](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3692)

## Properties

### 200

> **200**: [`HandlersPrivyIdentifierAuditResponse`](HandlersPrivyIdentifierAuditResponse.md)

Defined in: [src/client/types.gen.ts:3696](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3696)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1AdminUsersLookupData

# GetApiV1AdminUsersLookupData

> **GetApiV1AdminUsersLookupData** = `object`

Defined in: [src/client/types.gen.ts:3934](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3934)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:3935](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3935)

***

### headers

> **headers**: `object`

Defined in: [src/client/types.gen.ts:3936](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3936)

**X-Admin-API-Key**

> **X-Admin-API-Key**: `string`

Admin API key

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:3942](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3942)

***

### query?

> `optional` **query**: `object`

Defined in: [src/client/types.gen.ts:3943](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3943)

**email?**

> `optional` **email**: `string`

Email address (requires Privy credentials)

**phone?**

> `optional` **phone**: `string`

Phone number (e.g. +15551234567)

**telegram?**

> `optional` **telegram**: `string`

Telegram handle

**wallet\_address?**

> `optional` **wallet\_address**: `string`

User wallet address (0x...)

***

### url

> **url**: `"/api/v1/admin/users/lookup"`

Defined in: [src/client/types.gen.ts:3961](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3961)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1AdminUsersLookupError

# GetApiV1AdminUsersLookupError

> **GetApiV1AdminUsersLookupError** = [`GetApiV1AdminUsersLookupErrors`](GetApiV1AdminUsersLookupErrors.md)\[keyof [`GetApiV1AdminUsersLookupErrors`](GetApiV1AdminUsersLookupErrors.md)]

Defined in: [src/client/types.gen.ts:3983](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3983)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1AdminUsersLookupErrors

# GetApiV1AdminUsersLookupErrors

> **GetApiV1AdminUsersLookupErrors** = `object`

Defined in: [src/client/types.gen.ts:3964](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3964)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:3968](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3968)

Bad Request

***

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:3972](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3972)

Unauthorized

***

### 404

> **404**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:3976](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3976)

Not Found

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:3980](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3980)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1AdminUsersLookupResponse

# GetApiV1AdminUsersLookupResponse

> **GetApiV1AdminUsersLookupResponse** = [`GetApiV1AdminUsersLookupResponses`](GetApiV1AdminUsersLookupResponses.md)\[keyof [`GetApiV1AdminUsersLookupResponses`](GetApiV1AdminUsersLookupResponses.md)]

Defined in: [src/client/types.gen.ts:3992](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3992)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1AdminUsersLookupResponses

# GetApiV1AdminUsersLookupResponses

> **GetApiV1AdminUsersLookupResponses** = `object`

Defined in: [src/client/types.gen.ts:3985](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3985)

## Properties

### 200

> **200**: [`HandlersUserLookupResponse`](HandlersUserLookupResponse.md)

Defined in: [src/client/types.gen.ts:3989](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3989)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1AgentPreferencesData

# GetApiV1AgentPreferencesData

> **GetApiV1AgentPreferencesData** = `object`

Defined in: [src/client/types.gen.ts:3994](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3994)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:3995](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3995)

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:3996](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3996)

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:3997](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3997)

***

### url

> **url**: `"/api/v1/agent-preferences"`

Defined in: [src/client/types.gen.ts:3998](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3998)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1AgentPreferencesError

# GetApiV1AgentPreferencesError

> **GetApiV1AgentPreferencesError** = [`GetApiV1AgentPreferencesErrors`](GetApiV1AgentPreferencesErrors.md)\[keyof [`GetApiV1AgentPreferencesErrors`](GetApiV1AgentPreferencesErrors.md)]

Defined in: [src/client/types.gen.ts:4012](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4012)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1AgentPreferencesErrors

# GetApiV1AgentPreferencesErrors

> **GetApiV1AgentPreferencesErrors** = `object`

Defined in: [src/client/types.gen.ts:4001](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4001)

## Properties

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4005](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4005)

Unauthorized

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4009](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4009)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1AgentPreferencesResponse

# GetApiV1AgentPreferencesResponse

> **GetApiV1AgentPreferencesResponse** = [`GetApiV1AgentPreferencesResponses`](GetApiV1AgentPreferencesResponses.md)\[keyof [`GetApiV1AgentPreferencesResponses`](GetApiV1AgentPreferencesResponses.md)]

Defined in: [src/client/types.gen.ts:4021](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4021)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1AgentPreferencesResponses

# GetApiV1AgentPreferencesResponses

> **GetApiV1AgentPreferencesResponses** = `object`

Defined in: [src/client/types.gen.ts:4014](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4014)

## Properties

### 200

> **200**: [`HandlersUserAgentPreferencesListResponse`](HandlersUserAgentPreferencesListResponse.md)

Defined in: [src/client/types.gen.ts:4018](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4018)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1AgentsByIdData

# GetApiV1AgentsByIdData

> **GetApiV1AgentsByIdData** = `object`

Defined in: [src/client/types.gen.ts:4048](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4048)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:4049](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4049)

***

### path

> **path**: `object`

Defined in: [src/client/types.gen.ts:4050](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4050)

**id**

> **id**: `number`

Agent ID

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:4056](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4056)

***

### url

> **url**: `"/api/v1/agents/{id}"`

Defined in: [src/client/types.gen.ts:4057](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4057)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1AgentsByIdError

# GetApiV1AgentsByIdError

> **GetApiV1AgentsByIdError** = [`GetApiV1AgentsByIdErrors`](GetApiV1AgentsByIdErrors.md)\[keyof [`GetApiV1AgentsByIdErrors`](GetApiV1AgentsByIdErrors.md)]

Defined in: [src/client/types.gen.ts:4075](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4075)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1AgentsByIdErrors

# GetApiV1AgentsByIdErrors

> **GetApiV1AgentsByIdErrors** = `object`

Defined in: [src/client/types.gen.ts:4060](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4060)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4064](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4064)

Bad Request

***

### 404

> **404**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4068](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4068)

Not Found

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4072](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4072)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1AgentsByIdResponse

# GetApiV1AgentsByIdResponse

> **GetApiV1AgentsByIdResponse** = [`GetApiV1AgentsByIdResponses`](GetApiV1AgentsByIdResponses.md)\[keyof [`GetApiV1AgentsByIdResponses`](GetApiV1AgentsByIdResponses.md)]

Defined in: [src/client/types.gen.ts:4084](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4084)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1AgentsByIdResponses

# GetApiV1AgentsByIdResponses

> **GetApiV1AgentsByIdResponses** = `object`

Defined in: [src/client/types.gen.ts:4077](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4077)

## Properties

### 200

> **200**: [`HandlersAgentResponse`](HandlersAgentResponse.md)

Defined in: [src/client/types.gen.ts:4081](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4081)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1AgentsData

# GetApiV1AgentsData

> **GetApiV1AgentsData** = `object`

Defined in: [src/client/types.gen.ts:4023](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4023)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:4024](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4024)

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:4025](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4025)

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:4026](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4026)

***

### url

> **url**: `"/api/v1/agents"`

Defined in: [src/client/types.gen.ts:4027](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4027)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1AgentsError

# GetApiV1AgentsError

> **GetApiV1AgentsError** = [`GetApiV1AgentsErrors`](GetApiV1AgentsErrors.md)\[keyof [`GetApiV1AgentsErrors`](GetApiV1AgentsErrors.md)]

Defined in: [src/client/types.gen.ts:4037](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4037)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1AgentsErrors

# GetApiV1AgentsErrors

> **GetApiV1AgentsErrors** = `object`

Defined in: [src/client/types.gen.ts:4030](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4030)

## Properties

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4034](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4034)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1AgentsResponse

# GetApiV1AgentsResponse

> **GetApiV1AgentsResponse** = [`GetApiV1AgentsResponses`](GetApiV1AgentsResponses.md)\[keyof [`GetApiV1AgentsResponses`](GetApiV1AgentsResponses.md)]

Defined in: [src/client/types.gen.ts:4046](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4046)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1AgentsResponses

# GetApiV1AgentsResponses

> **GetApiV1AgentsResponses** = `object`

Defined in: [src/client/types.gen.ts:4039](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4039)

## Properties

### 200

> **200**: [`HandlersAgentListResponse`](HandlersAgentListResponse.md)

Defined in: [src/client/types.gen.ts:4043](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4043)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1AuthMfaStatusData

# GetApiV1AuthMfaStatusData

> **GetApiV1AuthMfaStatusData** = `object`

Defined in: [src/client/types.gen.ts:4356](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4356)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:4357](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4357)

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:4358](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4358)

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:4359](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4359)

***

### url

> **url**: `"/api/v1/auth/mfa/status"`

Defined in: [src/client/types.gen.ts:4360](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4360)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1AuthMfaStatusError

# GetApiV1AuthMfaStatusError

> **GetApiV1AuthMfaStatusError** = [`GetApiV1AuthMfaStatusErrors`](GetApiV1AuthMfaStatusErrors.md)\[keyof [`GetApiV1AuthMfaStatusErrors`](GetApiV1AuthMfaStatusErrors.md)]

Defined in: [src/client/types.gen.ts:4370](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4370)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1AuthMfaStatusErrors

# GetApiV1AuthMfaStatusErrors

> **GetApiV1AuthMfaStatusErrors** = `object`

Defined in: [src/client/types.gen.ts:4363](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4363)

## Properties

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4367](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4367)

Unauthorized

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1AuthMfaStatusResponse

# GetApiV1AuthMfaStatusResponse

> **GetApiV1AuthMfaStatusResponse** = [`GetApiV1AuthMfaStatusResponses`](GetApiV1AuthMfaStatusResponses.md)\[keyof [`GetApiV1AuthMfaStatusResponses`](GetApiV1AuthMfaStatusResponses.md)]

Defined in: [src/client/types.gen.ts:4379](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4379)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1AuthMfaStatusResponses

# GetApiV1AuthMfaStatusResponses

> **GetApiV1AuthMfaStatusResponses** = `object`

Defined in: [src/client/types.gen.ts:4372](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4372)

## Properties

### 200

> **200**: [`HandlersMfaStatusResponse`](HandlersMfaStatusResponse.md)

Defined in: [src/client/types.gen.ts:4376](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4376)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1BootstrapData

# GetApiV1BootstrapData

> **GetApiV1BootstrapData** = `object`

Defined in: [src/client/types.gen.ts:4478](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4478)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:4479](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4479)

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:4480](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4480)

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:4481](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4481)

***

### url

> **url**: `"/api/v1/bootstrap"`

Defined in: [src/client/types.gen.ts:4482](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4482)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1BootstrapError

# GetApiV1BootstrapError

> **GetApiV1BootstrapError** = [`GetApiV1BootstrapErrors`](GetApiV1BootstrapErrors.md)\[keyof [`GetApiV1BootstrapErrors`](GetApiV1BootstrapErrors.md)]

Defined in: [src/client/types.gen.ts:4492](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4492)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1BootstrapErrors

# GetApiV1BootstrapErrors

> **GetApiV1BootstrapErrors** = `object`

Defined in: [src/client/types.gen.ts:4485](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4485)

## Properties

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4489](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4489)

Unauthorized

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1BootstrapResponse

# GetApiV1BootstrapResponse

> **GetApiV1BootstrapResponse** = [`GetApiV1BootstrapResponses`](GetApiV1BootstrapResponses.md)\[keyof [`GetApiV1BootstrapResponses`](GetApiV1BootstrapResponses.md)]

Defined in: [src/client/types.gen.ts:4501](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4501)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1BootstrapResponses

# GetApiV1BootstrapResponses

> **GetApiV1BootstrapResponses** = `object`

Defined in: [src/client/types.gen.ts:4494](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4494)

## Properties

### 200

> **200**: [`HandlersBootstrapResponse`](HandlersBootstrapResponse.md)

Defined in: [src/client/types.gen.ts:4498](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4498)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1ConfigData

# GetApiV1ConfigData

> **GetApiV1ConfigData** = `object`

Defined in: [src/client/types.gen.ts:4547](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4547)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:4548](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4548)

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:4549](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4549)

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:4550](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4550)

***

### url

> **url**: `"/api/v1/config"`

Defined in: [src/client/types.gen.ts:4551](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4551)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1ConfigError

# GetApiV1ConfigError

> **GetApiV1ConfigError** = [`GetApiV1ConfigErrors`](GetApiV1ConfigErrors.md)\[keyof [`GetApiV1ConfigErrors`](GetApiV1ConfigErrors.md)]

Defined in: [src/client/types.gen.ts:4561](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4561)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1ConfigErrors

# GetApiV1ConfigErrors

> **GetApiV1ConfigErrors** = `object`

Defined in: [src/client/types.gen.ts:4554](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4554)

## Properties

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4558](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4558)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1ConfigResponse

# GetApiV1ConfigResponse

> **GetApiV1ConfigResponse** = [`GetApiV1ConfigResponses`](GetApiV1ConfigResponses.md)\[keyof [`GetApiV1ConfigResponses`](GetApiV1ConfigResponses.md)]

Defined in: [src/client/types.gen.ts:4570](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4570)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1ConfigResponses

# GetApiV1ConfigResponses

> **GetApiV1ConfigResponses** = `object`

Defined in: [src/client/types.gen.ts:4563](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4563)

## Properties

### 200

> **200**: [`HandlersConfigResponse`](HandlersConfigResponse.md)

Defined in: [src/client/types.gen.ts:4567](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4567)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1CreditsBalanceData

# GetApiV1CreditsBalanceData

> **GetApiV1CreditsBalanceData** = `object`

Defined in: [src/client/types.gen.ts:4572](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4572)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:4573](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4573)

***

### headers?

> `optional` **headers**: `object`

Defined in: [src/client/types.gen.ts:4574](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4574)

**X-Timezone?**

> `optional` **X-Timezone**: `string`

IANA timezone (e.g., America/New\_York)

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:4580](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4580)

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:4581](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4581)

***

### url

> **url**: `"/api/v1/credits/balance"`

Defined in: [src/client/types.gen.ts:4582](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4582)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1CreditsBalanceError

# GetApiV1CreditsBalanceError

> **GetApiV1CreditsBalanceError** = [`GetApiV1CreditsBalanceErrors`](GetApiV1CreditsBalanceErrors.md)\[keyof [`GetApiV1CreditsBalanceErrors`](GetApiV1CreditsBalanceErrors.md)]

Defined in: [src/client/types.gen.ts:4604](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4604)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1CreditsBalanceErrors

# GetApiV1CreditsBalanceErrors

> **GetApiV1CreditsBalanceErrors** = `object`

Defined in: [src/client/types.gen.ts:4585](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4585)

## Properties

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4589](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4589)

Unauthorized

***

### 403

> **403**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4593](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4593)

Balance endpoint not available for this app

***

### 404

> **404**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4597](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4597)

Account not found

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4601](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4601)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1CreditsBalanceResponse

# GetApiV1CreditsBalanceResponse

> **GetApiV1CreditsBalanceResponse** = [`GetApiV1CreditsBalanceResponses`](GetApiV1CreditsBalanceResponses.md)\[keyof [`GetApiV1CreditsBalanceResponses`](GetApiV1CreditsBalanceResponses.md)]

Defined in: [src/client/types.gen.ts:4613](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4613)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1CreditsBalanceResponses

# GetApiV1CreditsBalanceResponses

> **GetApiV1CreditsBalanceResponses** = `object`

Defined in: [src/client/types.gen.ts:4606](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4606)

## Properties

### 200

> **200**: [`HandlersCreditBalanceResponse`](HandlersCreditBalanceResponse.md)

Defined in: [src/client/types.gen.ts:4610](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4610)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1CreditsPacksData

# GetApiV1CreditsPacksData

> **GetApiV1CreditsPacksData** = `object`

Defined in: [src/client/types.gen.ts:4615](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4615)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:4616](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4616)

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:4617](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4617)

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:4618](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4618)

***

### url

> **url**: `"/api/v1/credits/packs"`

Defined in: [src/client/types.gen.ts:4619](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4619)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1CreditsPacksError

# GetApiV1CreditsPacksError

> **GetApiV1CreditsPacksError** = [`GetApiV1CreditsPacksErrors`](GetApiV1CreditsPacksErrors.md)\[keyof [`GetApiV1CreditsPacksErrors`](GetApiV1CreditsPacksErrors.md)]

Defined in: [src/client/types.gen.ts:4633](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4633)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1CreditsPacksErrors

# GetApiV1CreditsPacksErrors

> **GetApiV1CreditsPacksErrors** = `object`

Defined in: [src/client/types.gen.ts:4622](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4622)

## Properties

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4626](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4626)

Unauthorized

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4630](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4630)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1CreditsPacksResponse

# GetApiV1CreditsPacksResponse

> **GetApiV1CreditsPacksResponse** = [`GetApiV1CreditsPacksResponses`](GetApiV1CreditsPacksResponses.md)\[keyof [`GetApiV1CreditsPacksResponses`](GetApiV1CreditsPacksResponses.md)]

Defined in: [src/client/types.gen.ts:4642](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4642)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1CreditsPacksResponses

# GetApiV1CreditsPacksResponses

> **GetApiV1CreditsPacksResponses** = `object`

Defined in: [src/client/types.gen.ts:4635](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4635)

## Properties

### 200

> **200**: [`HandlersCreditPacksResponse`](HandlersCreditPacksResponse.md)

Defined in: [src/client/types.gen.ts:4639](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4639)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1CuratedModelsData

# GetApiV1CuratedModelsData

> **GetApiV1CuratedModelsData** = `object`

Defined in: [src/client/types.gen.ts:4724](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4724)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:4725](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4725)

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:4726](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4726)

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:4727](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4727)

***

### url

> **url**: `"/api/v1/curated-models"`

Defined in: [src/client/types.gen.ts:4728](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4728)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1CuratedModelsResponse

# GetApiV1CuratedModelsResponse

> **GetApiV1CuratedModelsResponse** = [`GetApiV1CuratedModelsResponses`](GetApiV1CuratedModelsResponses.md)\[keyof [`GetApiV1CuratedModelsResponses`](GetApiV1CuratedModelsResponses.md)]

Defined in: [src/client/types.gen.ts:4738](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4738)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1CuratedModelsResponses

# GetApiV1CuratedModelsResponses

> **GetApiV1CuratedModelsResponses** = `object`

Defined in: [src/client/types.gen.ts:4731](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4731)

## Properties

### 200

> **200**: [`ConfigCuratedModelsResponse`](ConfigCuratedModelsResponse.md)

Defined in: [src/client/types.gen.ts:4735](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4735)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1DeveloperAppsByAppUuidApiKeysData

# GetApiV1DeveloperAppsByAppUuidApiKeysData

> **GetApiV1DeveloperAppsByAppUuidApiKeysData** = `object`

Defined in: [src/client/types.gen.ts:4953](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4953)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:4954](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4954)

***

### path

> **path**: `object`

Defined in: [src/client/types.gen.ts:4955](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4955)

**app\_uuid**

> **app\_uuid**: `string`

App UUID

***

### query?

> `optional` **query**: `object`

Defined in: [src/client/types.gen.ts:4961](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4961)

**limit?**

> `optional` **limit**: `number`

Maximum number of API keys to return (default 50, max 100)

**offset?**

> `optional` **offset**: `number`

Number of API keys to skip (default 0)

***

### url

> **url**: `"/api/v1/developer/apps/{app_uuid}/api-keys"`

Defined in: [src/client/types.gen.ts:4971](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4971)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1DeveloperAppsByAppUuidApiKeysError

# GetApiV1DeveloperAppsByAppUuidApiKeysError

> **GetApiV1DeveloperAppsByAppUuidApiKeysError** = [`GetApiV1DeveloperAppsByAppUuidApiKeysErrors`](GetApiV1DeveloperAppsByAppUuidApiKeysErrors.md)\[keyof [`GetApiV1DeveloperAppsByAppUuidApiKeysErrors`](GetApiV1DeveloperAppsByAppUuidApiKeysErrors.md)]

Defined in: [src/client/types.gen.ts:4997](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4997)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1DeveloperAppsByAppUuidApiKeysErrors

# GetApiV1DeveloperAppsByAppUuidApiKeysErrors

> **GetApiV1DeveloperAppsByAppUuidApiKeysErrors** = `object`

Defined in: [src/client/types.gen.ts:4974](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4974)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4978](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4978)

Bad Request

***

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4982](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4982)

Unauthorized

***

### 403

> **403**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4986](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4986)

Forbidden

***

### 404

> **404**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4990](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4990)

Not Found

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4994](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4994)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1DeveloperAppsByAppUuidApiKeysResponse

# GetApiV1DeveloperAppsByAppUuidApiKeysResponse

> **GetApiV1DeveloperAppsByAppUuidApiKeysResponse** = [`GetApiV1DeveloperAppsByAppUuidApiKeysResponses`](GetApiV1DeveloperAppsByAppUuidApiKeysResponses.md)\[keyof [`GetApiV1DeveloperAppsByAppUuidApiKeysResponses`](GetApiV1DeveloperAppsByAppUuidApiKeysResponses.md)]

Defined in: [src/client/types.gen.ts:5006](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5006)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1DeveloperAppsByAppUuidApiKeysResponses

# GetApiV1DeveloperAppsByAppUuidApiKeysResponses

> **GetApiV1DeveloperAppsByAppUuidApiKeysResponses** = `object`

Defined in: [src/client/types.gen.ts:4999](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4999)

## Properties

### 200

> **200**: [`HandlersListDeveloperApiKeysResponse`](HandlersListDeveloperApiKeysResponse.md)

Defined in: [src/client/types.gen.ts:5003](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5003)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1DeveloperAppsByAppUuidData

# GetApiV1DeveloperAppsByAppUuidData

> **GetApiV1DeveloperAppsByAppUuidData** = `object`

Defined in: [src/client/types.gen.ts:4862](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4862)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:4863](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4863)

***

### path

> **path**: `object`

Defined in: [src/client/types.gen.ts:4864](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4864)

**app\_uuid**

> **app\_uuid**: `string`

App UUID

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:4870](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4870)

***

### url

> **url**: `"/api/v1/developer/apps/{app_uuid}"`

Defined in: [src/client/types.gen.ts:4871](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4871)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1DeveloperAppsByAppUuidError

# GetApiV1DeveloperAppsByAppUuidError

> **GetApiV1DeveloperAppsByAppUuidError** = [`GetApiV1DeveloperAppsByAppUuidErrors`](GetApiV1DeveloperAppsByAppUuidErrors.md)\[keyof [`GetApiV1DeveloperAppsByAppUuidErrors`](GetApiV1DeveloperAppsByAppUuidErrors.md)]

Defined in: [src/client/types.gen.ts:4893](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4893)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1DeveloperAppsByAppUuidErrors

# GetApiV1DeveloperAppsByAppUuidErrors

> **GetApiV1DeveloperAppsByAppUuidErrors** = `object`

Defined in: [src/client/types.gen.ts:4874](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4874)

## Properties

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4878](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4878)

Unauthorized

***

### 403

> **403**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4882](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4882)

Forbidden

***

### 404

> **404**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4886](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4886)

Not Found

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4890](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4890)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1DeveloperAppsByAppUuidResponse

# GetApiV1DeveloperAppsByAppUuidResponse

> **GetApiV1DeveloperAppsByAppUuidResponse** = [`GetApiV1DeveloperAppsByAppUuidResponses`](GetApiV1DeveloperAppsByAppUuidResponses.md)\[keyof [`GetApiV1DeveloperAppsByAppUuidResponses`](GetApiV1DeveloperAppsByAppUuidResponses.md)]

Defined in: [src/client/types.gen.ts:4902](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4902)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1DeveloperAppsByAppUuidResponses

# GetApiV1DeveloperAppsByAppUuidResponses

> **GetApiV1DeveloperAppsByAppUuidResponses** = `object`

Defined in: [src/client/types.gen.ts:4895](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4895)

## Properties

### 200

> **200**: [`HandlersDeveloperAppResponse`](HandlersDeveloperAppResponse.md)

Defined in: [src/client/types.gen.ts:4899](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4899)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1DeveloperAppsByAppUuidUsageData

# GetApiV1DeveloperAppsByAppUuidUsageData

> **GetApiV1DeveloperAppsByAppUuidUsageData** = `object`

Defined in: [src/client/types.gen.ts:5245](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5245)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:5246](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5246)

***

### path

> **path**: `object`

Defined in: [src/client/types.gen.ts:5247](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5247)

**app\_uuid**

> **app\_uuid**: `string`

App UUID

***

### query?

> `optional` **query**: `object`

Defined in: [src/client/types.gen.ts:5253](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5253)

**end\_time?**

> `optional` **end\_time**: `string`

End time (RFC3339). Defaults to now.

**granularity?**

> `optional` **granularity**: `string`

Timeseries granularity: 'day' (default) or 'hour'

**start\_time?**

> `optional` **start\_time**: `string`

Start time (RFC3339). Defaults to 30 days ago.

***

### url

> **url**: `"/api/v1/developer/apps/{app_uuid}/usage"`

Defined in: [src/client/types.gen.ts:5267](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5267)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1DeveloperAppsByAppUuidUsageError

# GetApiV1DeveloperAppsByAppUuidUsageError

> **GetApiV1DeveloperAppsByAppUuidUsageError** = [`GetApiV1DeveloperAppsByAppUuidUsageErrors`](GetApiV1DeveloperAppsByAppUuidUsageErrors.md)\[keyof [`GetApiV1DeveloperAppsByAppUuidUsageErrors`](GetApiV1DeveloperAppsByAppUuidUsageErrors.md)]

Defined in: [src/client/types.gen.ts:5293](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5293)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1DeveloperAppsByAppUuidUsageErrors

# GetApiV1DeveloperAppsByAppUuidUsageErrors

> **GetApiV1DeveloperAppsByAppUuidUsageErrors** = `object`

Defined in: [src/client/types.gen.ts:5270](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5270)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5274](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5274)

Bad Request

***

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5278](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5278)

Unauthorized

***

### 403

> **403**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5282](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5282)

Forbidden

***

### 404

> **404**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5286](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5286)

Not Found

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5290](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5290)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1DeveloperAppsByAppUuidUsageResponse

# GetApiV1DeveloperAppsByAppUuidUsageResponse

> **GetApiV1DeveloperAppsByAppUuidUsageResponse** = [`GetApiV1DeveloperAppsByAppUuidUsageResponses`](GetApiV1DeveloperAppsByAppUuidUsageResponses.md)\[keyof [`GetApiV1DeveloperAppsByAppUuidUsageResponses`](GetApiV1DeveloperAppsByAppUuidUsageResponses.md)]

Defined in: [src/client/types.gen.ts:5302](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5302)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1DeveloperAppsByAppUuidUsageResponses

# GetApiV1DeveloperAppsByAppUuidUsageResponses

> **GetApiV1DeveloperAppsByAppUuidUsageResponses** = `object`

Defined in: [src/client/types.gen.ts:5295](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5295)

## Properties

### 200

> **200**: [`HandlersAppUsageResponse`](HandlersAppUsageResponse.md)

Defined in: [src/client/types.gen.ts:5299](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5299)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1DeveloperAppsByAppUuidUsageUsersData

# GetApiV1DeveloperAppsByAppUuidUsageUsersData

> **GetApiV1DeveloperAppsByAppUuidUsageUsersData** = `object`

Defined in: [src/client/types.gen.ts:5304](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5304)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:5305](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5305)

***

### path

> **path**: `object`

Defined in: [src/client/types.gen.ts:5306](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5306)

**app\_uuid**

> **app\_uuid**: `string`

App UUID

***

### query?

> `optional` **query**: `object`

Defined in: [src/client/types.gen.ts:5312](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5312)

**end\_time?**

> `optional` **end\_time**: `string`

End time (RFC3339). Defaults to now.

**limit?**

> `optional` **limit**: `number`

Number of results (default 50, max 100)

**offset?**

> `optional` **offset**: `number`

Offset for pagination (default 0)

**start\_time?**

> `optional` **start\_time**: `string`

Start time (RFC3339). Defaults to 30 days ago.

***

### url

> **url**: `"/api/v1/developer/apps/{app_uuid}/usage/users"`

Defined in: [src/client/types.gen.ts:5330](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5330)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1DeveloperAppsByAppUuidUsageUsersError

# GetApiV1DeveloperAppsByAppUuidUsageUsersError

> **GetApiV1DeveloperAppsByAppUuidUsageUsersError** = [`GetApiV1DeveloperAppsByAppUuidUsageUsersErrors`](GetApiV1DeveloperAppsByAppUuidUsageUsersErrors.md)\[keyof [`GetApiV1DeveloperAppsByAppUuidUsageUsersErrors`](GetApiV1DeveloperAppsByAppUuidUsageUsersErrors.md)]

Defined in: [src/client/types.gen.ts:5356](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5356)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1DeveloperAppsByAppUuidUsageUsersErrors

# GetApiV1DeveloperAppsByAppUuidUsageUsersErrors

> **GetApiV1DeveloperAppsByAppUuidUsageUsersErrors** = `object`

Defined in: [src/client/types.gen.ts:5333](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5333)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5337](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5337)

Bad Request

***

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5341](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5341)

Unauthorized

***

### 403

> **403**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5345](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5345)

Forbidden

***

### 404

> **404**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5349](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5349)

Not Found

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5353](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5353)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1DeveloperAppsByAppUuidUsageUsersResponse

# GetApiV1DeveloperAppsByAppUuidUsageUsersResponse

> **GetApiV1DeveloperAppsByAppUuidUsageUsersResponse** = [`GetApiV1DeveloperAppsByAppUuidUsageUsersResponses`](GetApiV1DeveloperAppsByAppUuidUsageUsersResponses.md)\[keyof [`GetApiV1DeveloperAppsByAppUuidUsageUsersResponses`](GetApiV1DeveloperAppsByAppUuidUsageUsersResponses.md)]

Defined in: [src/client/types.gen.ts:5365](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5365)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1DeveloperAppsByAppUuidUsageUsersResponses

# GetApiV1DeveloperAppsByAppUuidUsageUsersResponses

> **GetApiV1DeveloperAppsByAppUuidUsageUsersResponses** = `object`

Defined in: [src/client/types.gen.ts:5358](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5358)

## Properties

### 200

> **200**: [`HandlersAppUserUsageResponse`](HandlersAppUserUsageResponse.md)

Defined in: [src/client/types.gen.ts:5362](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5362)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1DeveloperAppsByAppUuidUsersByAddressData

# GetApiV1DeveloperAppsByAppUuidUsersByAddressData

> **GetApiV1DeveloperAppsByAppUuidUsersByAddressData** = `object`

Defined in: [src/client/types.gen.ts:5418](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5418)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:5419](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5419)

***

### path

> **path**: `object`

Defined in: [src/client/types.gen.ts:5420](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5420)

**address**

> **address**: `string`

User wallet address

**app\_uuid**

> **app\_uuid**: `string`

App UUID

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:5430](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5430)

***

### url

> **url**: `"/api/v1/developer/apps/{app_uuid}/users/{address}"`

Defined in: [src/client/types.gen.ts:5431](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5431)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1DeveloperAppsByAppUuidUsersByAddressError

# GetApiV1DeveloperAppsByAppUuidUsersByAddressError

> **GetApiV1DeveloperAppsByAppUuidUsersByAddressError** = [`GetApiV1DeveloperAppsByAppUuidUsersByAddressErrors`](GetApiV1DeveloperAppsByAppUuidUsersByAddressErrors.md)\[keyof [`GetApiV1DeveloperAppsByAppUuidUsersByAddressErrors`](GetApiV1DeveloperAppsByAppUuidUsersByAddressErrors.md)]

Defined in: [src/client/types.gen.ts:5453](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5453)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1DeveloperAppsByAppUuidUsersByAddressErrors

# GetApiV1DeveloperAppsByAppUuidUsersByAddressErrors

> **GetApiV1DeveloperAppsByAppUuidUsersByAddressErrors** = `object`

Defined in: [src/client/types.gen.ts:5434](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5434)

## Properties

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5438](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5438)

Unauthorized

***

### 403

> **403**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5442](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5442)

Forbidden

***

### 404

> **404**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5446](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5446)

Not Found

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5450](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5450)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1DeveloperAppsByAppUuidUsersByAddressResponse

# GetApiV1DeveloperAppsByAppUuidUsersByAddressResponse

> **GetApiV1DeveloperAppsByAppUuidUsersByAddressResponse** = [`GetApiV1DeveloperAppsByAppUuidUsersByAddressResponses`](GetApiV1DeveloperAppsByAppUuidUsersByAddressResponses.md)\[keyof [`GetApiV1DeveloperAppsByAppUuidUsersByAddressResponses`](GetApiV1DeveloperAppsByAppUuidUsersByAddressResponses.md)]

Defined in: [src/client/types.gen.ts:5462](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5462)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1DeveloperAppsByAppUuidUsersByAddressResponses

# GetApiV1DeveloperAppsByAppUuidUsersByAddressResponses

> **GetApiV1DeveloperAppsByAppUuidUsersByAddressResponses** = `object`

Defined in: [src/client/types.gen.ts:5455](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5455)

## Properties

### 200

> **200**: [`HandlersDeveloperUserResponse`](HandlersDeveloperUserResponse.md)

Defined in: [src/client/types.gen.ts:5459](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5459)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1DeveloperAppsByAppUuidUsersData

# GetApiV1DeveloperAppsByAppUuidUsersData

> **GetApiV1DeveloperAppsByAppUuidUsersData** = `object`

Defined in: [src/client/types.gen.ts:5367](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5367)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:5368](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5368)

***

### path

> **path**: `object`

Defined in: [src/client/types.gen.ts:5369](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5369)

**app\_uuid**

> **app\_uuid**: `string`

App UUID

***

### query?

> `optional` **query**: `object`

Defined in: [src/client/types.gen.ts:5375](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5375)

**limit?**

> `optional` **limit**: `number`

Maximum number of users to return (default 50, max 200)

**offset?**

> `optional` **offset**: `number`

Number of users to skip (default 0)

***

### url

> **url**: `"/api/v1/developer/apps/{app_uuid}/users"`

Defined in: [src/client/types.gen.ts:5385](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5385)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1DeveloperAppsByAppUuidUsersError

# GetApiV1DeveloperAppsByAppUuidUsersError

> **GetApiV1DeveloperAppsByAppUuidUsersError** = [`GetApiV1DeveloperAppsByAppUuidUsersErrors`](GetApiV1DeveloperAppsByAppUuidUsersErrors.md)\[keyof [`GetApiV1DeveloperAppsByAppUuidUsersErrors`](GetApiV1DeveloperAppsByAppUuidUsersErrors.md)]

Defined in: [src/client/types.gen.ts:5407](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5407)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1DeveloperAppsByAppUuidUsersErrors

# GetApiV1DeveloperAppsByAppUuidUsersErrors

> **GetApiV1DeveloperAppsByAppUuidUsersErrors** = `object`

Defined in: [src/client/types.gen.ts:5388](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5388)

## Properties

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5392](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5392)

Unauthorized

***

### 403

> **403**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5396](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5396)

Forbidden

***

### 404

> **404**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5400](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5400)

Not Found

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5404](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5404)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1DeveloperAppsByAppUuidUsersResponse

# GetApiV1DeveloperAppsByAppUuidUsersResponse

> **GetApiV1DeveloperAppsByAppUuidUsersResponse** = [`GetApiV1DeveloperAppsByAppUuidUsersResponses`](GetApiV1DeveloperAppsByAppUuidUsersResponses.md)\[keyof [`GetApiV1DeveloperAppsByAppUuidUsersResponses`](GetApiV1DeveloperAppsByAppUuidUsersResponses.md)]

Defined in: [src/client/types.gen.ts:5416](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5416)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1DeveloperAppsByAppUuidUsersResponses

# GetApiV1DeveloperAppsByAppUuidUsersResponses

> **GetApiV1DeveloperAppsByAppUuidUsersResponses** = `object`

Defined in: [src/client/types.gen.ts:5409](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5409)

## Properties

### 200

> **200**: [`HandlersListUsersResponse`](HandlersListUsersResponse.md)

Defined in: [src/client/types.gen.ts:5413](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5413)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1DeveloperAppsData

# GetApiV1DeveloperAppsData

> **GetApiV1DeveloperAppsData** = `object`

Defined in: [src/client/types.gen.ts:4740](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4740)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:4741](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4741)

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:4742](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4742)

***

### query?

> `optional` **query**: `object`

Defined in: [src/client/types.gen.ts:4743](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4743)

**limit?**

> `optional` **limit**: `number`

Maximum number of apps to return (default 50, max 100)

**offset?**

> `optional` **offset**: `number`

Number of apps to skip (default 0)

***

### url

> **url**: `"/api/v1/developer/apps"`

Defined in: [src/client/types.gen.ts:4753](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4753)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1DeveloperAppsError

# GetApiV1DeveloperAppsError

> **GetApiV1DeveloperAppsError** = [`GetApiV1DeveloperAppsErrors`](GetApiV1DeveloperAppsErrors.md)\[keyof [`GetApiV1DeveloperAppsErrors`](GetApiV1DeveloperAppsErrors.md)]

Defined in: [src/client/types.gen.ts:4771](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4771)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1DeveloperAppsErrors

# GetApiV1DeveloperAppsErrors

> **GetApiV1DeveloperAppsErrors** = `object`

Defined in: [src/client/types.gen.ts:4756](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4756)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4760](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4760)

Bad Request

***

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4764](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4764)

Unauthorized

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4768](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4768)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1DeveloperAppsResponse

# GetApiV1DeveloperAppsResponse

> **GetApiV1DeveloperAppsResponse** = [`GetApiV1DeveloperAppsResponses`](GetApiV1DeveloperAppsResponses.md)\[keyof [`GetApiV1DeveloperAppsResponses`](GetApiV1DeveloperAppsResponses.md)]

Defined in: [src/client/types.gen.ts:4780](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4780)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1DeveloperAppsResponses

# GetApiV1DeveloperAppsResponses

> **GetApiV1DeveloperAppsResponses** = `object`

Defined in: [src/client/types.gen.ts:4773](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4773)

## Properties

### 200

> **200**: [`HandlersListDeveloperAppsResponse`](HandlersListDeveloperAppsResponse.md)

Defined in: [src/client/types.gen.ts:4777](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4777)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1DeveloperBillingData

# GetApiV1DeveloperBillingData

> **GetApiV1DeveloperBillingData** = `object`

Defined in: [src/client/types.gen.ts:5570](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5570)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:5571](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5571)

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:5572](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5572)

***

### query?

> `optional` **query**: `object`

Defined in: [src/client/types.gen.ts:5573](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5573)

**limit?**

> `optional` **limit**: `number`

Maximum number of records to return (default 50, max 100)

**offset?**

> `optional` **offset**: `number`

Number of records to skip (default 0)

***

### url

> **url**: `"/api/v1/developer/billing"`

Defined in: [src/client/types.gen.ts:5583](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5583)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1DeveloperBillingError

# GetApiV1DeveloperBillingError

> **GetApiV1DeveloperBillingError** = [`GetApiV1DeveloperBillingErrors`](GetApiV1DeveloperBillingErrors.md)\[keyof [`GetApiV1DeveloperBillingErrors`](GetApiV1DeveloperBillingErrors.md)]

Defined in: [src/client/types.gen.ts:5601](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5601)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1DeveloperBillingErrors

# GetApiV1DeveloperBillingErrors

> **GetApiV1DeveloperBillingErrors** = `object`

Defined in: [src/client/types.gen.ts:5586](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5586)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5590](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5590)

Bad Request

***

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5594](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5594)

Unauthorized

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5598](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5598)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1DeveloperBillingResponse

# GetApiV1DeveloperBillingResponse

> **GetApiV1DeveloperBillingResponse** = [`GetApiV1DeveloperBillingResponses`](GetApiV1DeveloperBillingResponses.md)\[keyof [`GetApiV1DeveloperBillingResponses`](GetApiV1DeveloperBillingResponses.md)]

Defined in: [src/client/types.gen.ts:5610](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5610)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1DeveloperBillingResponses

# GetApiV1DeveloperBillingResponses

> **GetApiV1DeveloperBillingResponses** = `object`

Defined in: [src/client/types.gen.ts:5603](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5603)

## Properties

### 200

> **200**: [`HandlersBillingHistoryResponse`](HandlersBillingHistoryResponse.md)

Defined in: [src/client/types.gen.ts:5607](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5607)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1DocsSwaggerJsonData

# GetApiV1DocsSwaggerJsonData

> **GetApiV1DocsSwaggerJsonData** = `object`

Defined in: [src/client/types.gen.ts:5612](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5612)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:5613](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5613)

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:5614](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5614)

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:5615](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5615)

***

### url

> **url**: `"/api/v1/docs/swagger.json"`

Defined in: [src/client/types.gen.ts:5616](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5616)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1DocsSwaggerJsonResponse

# GetApiV1DocsSwaggerJsonResponse

> **GetApiV1DocsSwaggerJsonResponse** = [`GetApiV1DocsSwaggerJsonResponses`](GetApiV1DocsSwaggerJsonResponses.md)\[keyof [`GetApiV1DocsSwaggerJsonResponses`](GetApiV1DocsSwaggerJsonResponses.md)]

Defined in: [src/client/types.gen.ts:5628](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5628)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1DocsSwaggerJsonResponses

# GetApiV1DocsSwaggerJsonResponses

> **GetApiV1DocsSwaggerJsonResponses** = `object`

Defined in: [src/client/types.gen.ts:5619](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5619)

## Properties

### 200

> **200**: `object`

Defined in: [src/client/types.gen.ts:5623](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5623)

OK

**Index Signature**

\[`key`: `string`]: `unknown`

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1GuestBootstrapData

# GetApiV1GuestBootstrapData

> **GetApiV1GuestBootstrapData** = `object`

Defined in: [src/client/types.gen.ts:5666](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5666)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:5667](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5667)

***

### headers

> **headers**: `object`

Defined in: [src/client/types.gen.ts:5668](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5668)

**X-Guest-ID**

> **X-Guest-ID**: `string`

Client-generated UUID v4 identifying the guest session

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:5674](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5674)

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:5675](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5675)

***

### url

> **url**: `"/api/v1/guest-bootstrap"`

Defined in: [src/client/types.gen.ts:5676](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5676)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1GuestBootstrapError

# GetApiV1GuestBootstrapError

> **GetApiV1GuestBootstrapError** = [`GetApiV1GuestBootstrapErrors`](GetApiV1GuestBootstrapErrors.md)\[keyof [`GetApiV1GuestBootstrapErrors`](GetApiV1GuestBootstrapErrors.md)]

Defined in: [src/client/types.gen.ts:5686](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5686)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1GuestBootstrapErrors

# GetApiV1GuestBootstrapErrors

> **GetApiV1GuestBootstrapErrors** = `object`

Defined in: [src/client/types.gen.ts:5679](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5679)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5683](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5683)

Bad Request

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1GuestBootstrapResponse

# GetApiV1GuestBootstrapResponse

> **GetApiV1GuestBootstrapResponse** = [`GetApiV1GuestBootstrapResponses`](GetApiV1GuestBootstrapResponses.md)\[keyof [`GetApiV1GuestBootstrapResponses`](GetApiV1GuestBootstrapResponses.md)]

Defined in: [src/client/types.gen.ts:5695](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5695)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1GuestBootstrapResponses

# GetApiV1GuestBootstrapResponses

> **GetApiV1GuestBootstrapResponses** = `object`

Defined in: [src/client/types.gen.ts:5688](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5688)

## Properties

### 200

> **200**: [`HandlersGuestBootstrapResponse`](HandlersGuestBootstrapResponse.md)

Defined in: [src/client/types.gen.ts:5692](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5692)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1ModelsData

# GetApiV1ModelsData

> **GetApiV1ModelsData** = `object`

Defined in: [src/client/types.gen.ts:5743](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5743)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:5744](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5744)

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:5745](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5745)

***

### query?

> `optional` **query**: `object`

Defined in: [src/client/types.gen.ts:5746](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5746)

**page\_size?**

> `optional` **page\_size**: `number`

Number of models to return per page

**page\_token?**

> `optional` **page\_token**: `string`

Token to get next page of results

**provider?**

> `optional` **provider**: `string`

Filter by provider (e.g., openai, anthropic)

***

### url

> **url**: `"/api/v1/models"`

Defined in: [src/client/types.gen.ts:5760](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5760)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1ModelsError

# GetApiV1ModelsError

> **GetApiV1ModelsError** = [`GetApiV1ModelsErrors`](GetApiV1ModelsErrors.md)\[keyof [`GetApiV1ModelsErrors`](GetApiV1ModelsErrors.md)]

Defined in: [src/client/types.gen.ts:5778](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5778)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1ModelsErrors

# GetApiV1ModelsErrors

> **GetApiV1ModelsErrors** = `object`

Defined in: [src/client/types.gen.ts:5763](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5763)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5767](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5767)

Bad Request

***

### 429

> **429**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5771](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5771)

Rate limit exceeded

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5775](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5775)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1ModelsResponse

# GetApiV1ModelsResponse

> **GetApiV1ModelsResponse** = [`GetApiV1ModelsResponses`](GetApiV1ModelsResponses.md)\[keyof [`GetApiV1ModelsResponses`](GetApiV1ModelsResponses.md)]

Defined in: [src/client/types.gen.ts:5787](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5787)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1ModelsResponses

# GetApiV1ModelsResponses

> **GetApiV1ModelsResponses** = `object`

Defined in: [src/client/types.gen.ts:5780](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5780)

## Properties

### 200

> **200**: [`LlmapiModelsListResponse`](LlmapiModelsListResponse.md)

Defined in: [src/client/types.gen.ts:5784](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5784)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1PersonasByIdData

# GetApiV1PersonasByIdData

> **GetApiV1PersonasByIdData** = `object`

Defined in: [src/client/types.gen.ts:5814](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5814)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:5815](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5815)

***

### path

> **path**: `object`

Defined in: [src/client/types.gen.ts:5816](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5816)

**id**

> **id**: `number`

Persona ID

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:5822](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5822)

***

### url

> **url**: `"/api/v1/personas/{id}"`

Defined in: [src/client/types.gen.ts:5823](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5823)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1PersonasByIdError

# GetApiV1PersonasByIdError

> **GetApiV1PersonasByIdError** = [`GetApiV1PersonasByIdErrors`](GetApiV1PersonasByIdErrors.md)\[keyof [`GetApiV1PersonasByIdErrors`](GetApiV1PersonasByIdErrors.md)]

Defined in: [src/client/types.gen.ts:5841](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5841)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1PersonasByIdErrors

# GetApiV1PersonasByIdErrors

> **GetApiV1PersonasByIdErrors** = `object`

Defined in: [src/client/types.gen.ts:5826](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5826)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5830](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5830)

Bad Request

***

### 404

> **404**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5834](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5834)

Not Found

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5838](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5838)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1PersonasByIdResponse

# GetApiV1PersonasByIdResponse

> **GetApiV1PersonasByIdResponse** = [`GetApiV1PersonasByIdResponses`](GetApiV1PersonasByIdResponses.md)\[keyof [`GetApiV1PersonasByIdResponses`](GetApiV1PersonasByIdResponses.md)]

Defined in: [src/client/types.gen.ts:5850](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5850)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1PersonasByIdResponses

# GetApiV1PersonasByIdResponses

> **GetApiV1PersonasByIdResponses** = `object`

Defined in: [src/client/types.gen.ts:5843](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5843)

## Properties

### 200

> **200**: [`HandlersPersonaResponse`](HandlersPersonaResponse.md)

Defined in: [src/client/types.gen.ts:5847](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5847)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1PersonasData

# GetApiV1PersonasData

> **GetApiV1PersonasData** = `object`

Defined in: [src/client/types.gen.ts:5789](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5789)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:5790](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5790)

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:5791](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5791)

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:5792](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5792)

***

### url

> **url**: `"/api/v1/personas"`

Defined in: [src/client/types.gen.ts:5793](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5793)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1PersonasError

# GetApiV1PersonasError

> **GetApiV1PersonasError** = [`GetApiV1PersonasErrors`](GetApiV1PersonasErrors.md)\[keyof [`GetApiV1PersonasErrors`](GetApiV1PersonasErrors.md)]

Defined in: [src/client/types.gen.ts:5803](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5803)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1PersonasErrors

# GetApiV1PersonasErrors

> **GetApiV1PersonasErrors** = `object`

Defined in: [src/client/types.gen.ts:5796](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5796)

## Properties

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5800](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5800)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1PersonasResponse

# GetApiV1PersonasResponse

> **GetApiV1PersonasResponse** = [`GetApiV1PersonasResponses`](GetApiV1PersonasResponses.md)\[keyof [`GetApiV1PersonasResponses`](GetApiV1PersonasResponses.md)]

Defined in: [src/client/types.gen.ts:5812](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5812)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1PersonasResponses

# GetApiV1PersonasResponses

> **GetApiV1PersonasResponses** = `object`

Defined in: [src/client/types.gen.ts:5805](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5805)

## Properties

### 200

> **200**: [`HandlersPersonaListResponse`](HandlersPersonaListResponse.md)

Defined in: [src/client/types.gen.ts:5809](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5809)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1PhoneCallsByCallIdData

# GetApiV1PhoneCallsByCallIdData

> **GetApiV1PhoneCallsByCallIdData** = `object`

Defined in: [src/client/types.gen.ts:5892](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5892)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:5893](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5893)

***

### path

> **path**: `object`

Defined in: [src/client/types.gen.ts:5894](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5894)

**call\_id**

> **call\_id**: `string`

Bland call ID

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:5900](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5900)

***

### url

> **url**: `"/api/v1/phone-calls/{call_id}"`

Defined in: [src/client/types.gen.ts:5901](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5901)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1PhoneCallsByCallIdError

# GetApiV1PhoneCallsByCallIdError

> **GetApiV1PhoneCallsByCallIdError** = [`GetApiV1PhoneCallsByCallIdErrors`](GetApiV1PhoneCallsByCallIdErrors.md)\[keyof [`GetApiV1PhoneCallsByCallIdErrors`](GetApiV1PhoneCallsByCallIdErrors.md)]

Defined in: [src/client/types.gen.ts:5927](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5927)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1PhoneCallsByCallIdErrors

# GetApiV1PhoneCallsByCallIdErrors

> **GetApiV1PhoneCallsByCallIdErrors** = `object`

Defined in: [src/client/types.gen.ts:5904](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5904)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5908](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5908)

Bad Request

***

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5912](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5912)

Unauthorized

***

### 404

> **404**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5916](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5916)

Not Found

***

### 502

> **502**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5920](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5920)

Bad Gateway

***

### 503

> **503**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5924](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5924)

Service Unavailable

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1PhoneCallsByCallIdResponse

# GetApiV1PhoneCallsByCallIdResponse

> **GetApiV1PhoneCallsByCallIdResponse** = [`GetApiV1PhoneCallsByCallIdResponses`](GetApiV1PhoneCallsByCallIdResponses.md)\[keyof [`GetApiV1PhoneCallsByCallIdResponses`](GetApiV1PhoneCallsByCallIdResponses.md)]

Defined in: [src/client/types.gen.ts:5936](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5936)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1PhoneCallsByCallIdResponses

# GetApiV1PhoneCallsByCallIdResponses

> **GetApiV1PhoneCallsByCallIdResponses** = `object`

Defined in: [src/client/types.gen.ts:5929](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5929)

## Properties

### 200

> **200**: [`HandlersPhoneCallResponse`](HandlersPhoneCallResponse.md)

Defined in: [src/client/types.gen.ts:5933](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5933)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1SubscriptionsPlansData

# GetApiV1SubscriptionsPlansData

> **GetApiV1SubscriptionsPlansData** = `object`

Defined in: [src/client/types.gen.ts:6128](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6128)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:6129](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6129)

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:6130](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6130)

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:6131](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6131)

***

### url

> **url**: `"/api/v1/subscriptions/plans"`

Defined in: [src/client/types.gen.ts:6132](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6132)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1SubscriptionsPlansError

# GetApiV1SubscriptionsPlansError

> **GetApiV1SubscriptionsPlansError** = [`GetApiV1SubscriptionsPlansErrors`](GetApiV1SubscriptionsPlansErrors.md)\[keyof [`GetApiV1SubscriptionsPlansErrors`](GetApiV1SubscriptionsPlansErrors.md)]

Defined in: [src/client/types.gen.ts:6142](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6142)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1SubscriptionsPlansErrors

# GetApiV1SubscriptionsPlansErrors

> **GetApiV1SubscriptionsPlansErrors** = `object`

Defined in: [src/client/types.gen.ts:6135](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6135)

## Properties

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6139](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6139)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1SubscriptionsPlansResponse

# GetApiV1SubscriptionsPlansResponse

> **GetApiV1SubscriptionsPlansResponse** = [`GetApiV1SubscriptionsPlansResponses`](GetApiV1SubscriptionsPlansResponses.md)\[keyof [`GetApiV1SubscriptionsPlansResponses`](GetApiV1SubscriptionsPlansResponses.md)]

Defined in: [src/client/types.gen.ts:6151](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6151)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1SubscriptionsPlansResponses

# GetApiV1SubscriptionsPlansResponses

> **GetApiV1SubscriptionsPlansResponses** = `object`

Defined in: [src/client/types.gen.ts:6144](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6144)

## Properties

### 200

> **200**: [`HandlersSubscriptionPlansResponse`](HandlersSubscriptionPlansResponse.md)

Defined in: [src/client/types.gen.ts:6148](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6148)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1SubscriptionsStatusData

# GetApiV1SubscriptionsStatusData

> **GetApiV1SubscriptionsStatusData** = `object`

Defined in: [src/client/types.gen.ts:6230](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6230)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:6231](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6231)

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:6232](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6232)

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:6233](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6233)

***

### url

> **url**: `"/api/v1/subscriptions/status"`

Defined in: [src/client/types.gen.ts:6234](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6234)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1SubscriptionsStatusError

# GetApiV1SubscriptionsStatusError

> **GetApiV1SubscriptionsStatusError** = [`GetApiV1SubscriptionsStatusErrors`](GetApiV1SubscriptionsStatusErrors.md)\[keyof [`GetApiV1SubscriptionsStatusErrors`](GetApiV1SubscriptionsStatusErrors.md)]

Defined in: [src/client/types.gen.ts:6248](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6248)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1SubscriptionsStatusErrors

# GetApiV1SubscriptionsStatusErrors

> **GetApiV1SubscriptionsStatusErrors** = `object`

Defined in: [src/client/types.gen.ts:6237](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6237)

## Properties

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6241](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6241)

Unauthorized

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6245](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6245)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1SubscriptionsStatusResponse

# GetApiV1SubscriptionsStatusResponse

> **GetApiV1SubscriptionsStatusResponse** = [`GetApiV1SubscriptionsStatusResponses`](GetApiV1SubscriptionsStatusResponses.md)\[keyof [`GetApiV1SubscriptionsStatusResponses`](GetApiV1SubscriptionsStatusResponses.md)]

Defined in: [src/client/types.gen.ts:6257](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6257)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1SubscriptionsStatusResponses

# GetApiV1SubscriptionsStatusResponses

> **GetApiV1SubscriptionsStatusResponses** = `object`

Defined in: [src/client/types.gen.ts:6250](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6250)

## Properties

### 200

> **200**: [`HandlersSubscriptionStatusResponse`](HandlersSubscriptionStatusResponse.md)

Defined in: [src/client/types.gen.ts:6254](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6254)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1TextByChannelLookupData

# GetApiV1TextByChannelLookupData

> **GetApiV1TextByChannelLookupData** = `object`

Defined in: [src/client/types.gen.ts:6342](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6342)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:6343](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6343)

***

### path

> **path**: `object`

Defined in: [src/client/types.gen.ts:6344](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6344)

**channel**

> **channel**: `string`

Text channel (sms, telegram)

***

### query

> **query**: `object`

Defined in: [src/client/types.gen.ts:6350](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6350)

**identifier**

> **identifier**: `string`

Channel identifier (e.g., E.164 phone number for SMS)

***

### url

> **url**: `"/api/v1/text/{channel}/lookup"`

Defined in: [src/client/types.gen.ts:6356](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6356)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1TextByChannelLookupError

# GetApiV1TextByChannelLookupError

> **GetApiV1TextByChannelLookupError** = [`GetApiV1TextByChannelLookupErrors`](GetApiV1TextByChannelLookupErrors.md)\[keyof [`GetApiV1TextByChannelLookupErrors`](GetApiV1TextByChannelLookupErrors.md)]

Defined in: [src/client/types.gen.ts:6374](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6374)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1TextByChannelLookupErrors

# GetApiV1TextByChannelLookupErrors

> **GetApiV1TextByChannelLookupErrors** = `object`

Defined in: [src/client/types.gen.ts:6359](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6359)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6363](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6363)

Invalid channel or identifier format

***

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6367](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6367)

Unauthorized

***

### 404

> **404**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6371](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6371)

No registration found

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1TextByChannelLookupResponse

# GetApiV1TextByChannelLookupResponse

> **GetApiV1TextByChannelLookupResponse** = [`GetApiV1TextByChannelLookupResponses`](GetApiV1TextByChannelLookupResponses.md)\[keyof [`GetApiV1TextByChannelLookupResponses`](GetApiV1TextByChannelLookupResponses.md)]

Defined in: [src/client/types.gen.ts:6383](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6383)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1TextByChannelLookupResponses

# GetApiV1TextByChannelLookupResponses

> **GetApiV1TextByChannelLookupResponses** = `object`

Defined in: [src/client/types.gen.ts:6376](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6376)

## Properties

### 200

> **200**: [`ModelsTextLookupResult`](ModelsTextLookupResult.md)

Defined in: [src/client/types.gen.ts:6380](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6380)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1TextByChannelStatusData

# GetApiV1TextByChannelStatusData

> **GetApiV1TextByChannelStatusData** = `object`

Defined in: [src/client/types.gen.ts:6430](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6430)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:6431](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6431)

***

### path

> **path**: `object`

Defined in: [src/client/types.gen.ts:6432](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6432)

**channel**

> **channel**: `string`

Text channel (sms, telegram)

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:6438](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6438)

***

### url

> **url**: `"/api/v1/text/{channel}/status"`

Defined in: [src/client/types.gen.ts:6439](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6439)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1TextByChannelStatusError

# GetApiV1TextByChannelStatusError

> **GetApiV1TextByChannelStatusError** = [`GetApiV1TextByChannelStatusErrors`](GetApiV1TextByChannelStatusErrors.md)\[keyof [`GetApiV1TextByChannelStatusErrors`](GetApiV1TextByChannelStatusErrors.md)]

Defined in: [src/client/types.gen.ts:6457](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6457)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1TextByChannelStatusErrors

# GetApiV1TextByChannelStatusErrors

> **GetApiV1TextByChannelStatusErrors** = `object`

Defined in: [src/client/types.gen.ts:6442](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6442)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6446](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6446)

Invalid channel

***

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6450](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6450)

Unauthorized

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6454](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6454)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1TextByChannelStatusResponse

# GetApiV1TextByChannelStatusResponse

> **GetApiV1TextByChannelStatusResponse** = [`GetApiV1TextByChannelStatusResponses`](GetApiV1TextByChannelStatusResponses.md)\[keyof [`GetApiV1TextByChannelStatusResponses`](GetApiV1TextByChannelStatusResponses.md)]

Defined in: [src/client/types.gen.ts:6466](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6466)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1TextByChannelStatusResponses

# GetApiV1TextByChannelStatusResponses

> **GetApiV1TextByChannelStatusResponses** = `object`

Defined in: [src/client/types.gen.ts:6459](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6459)

## Properties

### 200

> **200**: [`ModelsTextStatusResponse`](ModelsTextStatusResponse.md)

Defined in: [src/client/types.gen.ts:6463](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6463)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1ToolsData

# GetApiV1ToolsData

> **GetApiV1ToolsData** = `object`

Defined in: [src/client/types.gen.ts:6506](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6506)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:6507](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6507)

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:6508](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6508)

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:6509](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6509)

***

### url

> **url**: `"/api/v1/tools"`

Defined in: [src/client/types.gen.ts:6510](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6510)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1ToolsError

# GetApiV1ToolsError

> **GetApiV1ToolsError** = [`GetApiV1ToolsErrors`](GetApiV1ToolsErrors.md)\[keyof [`GetApiV1ToolsErrors`](GetApiV1ToolsErrors.md)]

Defined in: [src/client/types.gen.ts:6520](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6520)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1ToolsErrors

# GetApiV1ToolsErrors

> **GetApiV1ToolsErrors** = `object`

Defined in: [src/client/types.gen.ts:6513](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6513)

## Properties

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6517](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6517)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1ToolsResponse

# GetApiV1ToolsResponse

> **GetApiV1ToolsResponse** = [`GetApiV1ToolsResponses`](GetApiV1ToolsResponses.md)\[keyof [`GetApiV1ToolsResponses`](GetApiV1ToolsResponses.md)]

Defined in: [src/client/types.gen.ts:6529](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6529)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1ToolsResponses

# GetApiV1ToolsResponses

> **GetApiV1ToolsResponses** = `object`

Defined in: [src/client/types.gen.ts:6522](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6522)

## Properties

### 200

> **200**: [`HandlersGetToolsResponse`](HandlersGetToolsResponse.md)

Defined in: [src/client/types.gen.ts:6526](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6526)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1UsageByModalityData

# GetApiV1UsageByModalityData

> **GetApiV1UsageByModalityData** = `object`

Defined in: [src/client/types.gen.ts:6531](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6531)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:6532](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6532)

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:6533](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6533)

***

### query?

> `optional` **query**: `object`

Defined in: [src/client/types.gen.ts:6534](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6534)

**end?**

> `optional` **end**: `string`

End of date range in RFC 3339 format (e.g. 2024-01-31T23:59:59Z). Must be used with start. Takes precedence over period.

**period?**

> `optional` **period**: `string`

Time period. Day aliases: 7d, 30d, 90d, 180d, 365d. Durations: 10m, 30m, 1h, 6h, 12h, 24h, 72h. Default: 30d. Max: 365d.

**start?**

> `optional` **start**: `string`

Start of date range in RFC 3339 format (e.g. 2024-01-01T00:00:00Z). Must be used with end. Takes precedence over period.

***

### url

> **url**: `"/api/v1/usage/by-modality"`

Defined in: [src/client/types.gen.ts:6548](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6548)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1UsageByModalityError

# GetApiV1UsageByModalityError

> **GetApiV1UsageByModalityError** = [`GetApiV1UsageByModalityErrors`](GetApiV1UsageByModalityErrors.md)\[keyof [`GetApiV1UsageByModalityErrors`](GetApiV1UsageByModalityErrors.md)]

Defined in: [src/client/types.gen.ts:6566](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6566)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1UsageByModalityErrors

# GetApiV1UsageByModalityErrors

> **GetApiV1UsageByModalityErrors** = `object`

Defined in: [src/client/types.gen.ts:6551](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6551)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6555](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6555)

Invalid period

***

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6559](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6559)

Unauthorized

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6563](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6563)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1UsageByModalityResponse

# GetApiV1UsageByModalityResponse

> **GetApiV1UsageByModalityResponse** = [`GetApiV1UsageByModalityResponses`](GetApiV1UsageByModalityResponses.md)\[keyof [`GetApiV1UsageByModalityResponses`](GetApiV1UsageByModalityResponses.md)]

Defined in: [src/client/types.gen.ts:6575](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6575)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1UsageByModalityResponses

# GetApiV1UsageByModalityResponses

> **GetApiV1UsageByModalityResponses** = `object`

Defined in: [src/client/types.gen.ts:6568](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6568)

## Properties

### 200

> **200**: [`HandlersUsageByModalityResponse`](HandlersUsageByModalityResponse.md)

Defined in: [src/client/types.gen.ts:6572](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6572)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1UsageModelsData

# GetApiV1UsageModelsData

> **GetApiV1UsageModelsData** = `object`

Defined in: [src/client/types.gen.ts:6577](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6577)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:6578](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6578)

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:6579](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6579)

***

### query?

> `optional` **query**: `object`

Defined in: [src/client/types.gen.ts:6580](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6580)

**end?**

> `optional` **end**: `string`

End of date range in RFC 3339 format (e.g. 2024-01-31T23:59:59Z). Must be used with start. Takes precedence over period.

**period?**

> `optional` **period**: `string`

Time period. Day aliases: 7d, 30d, 90d, 180d, 365d. Durations: 10m, 30m, 1h, 6h, 12h, 24h, 72h. Default: 30d. Max: 365d.

**start?**

> `optional` **start**: `string`

Start of date range in RFC 3339 format (e.g. 2024-01-01T00:00:00Z). Must be used with end. Takes precedence over period.

***

### url

> **url**: `"/api/v1/usage/models"`

Defined in: [src/client/types.gen.ts:6594](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6594)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1UsageModelsError

# GetApiV1UsageModelsError

> **GetApiV1UsageModelsError** = [`GetApiV1UsageModelsErrors`](GetApiV1UsageModelsErrors.md)\[keyof [`GetApiV1UsageModelsErrors`](GetApiV1UsageModelsErrors.md)]

Defined in: [src/client/types.gen.ts:6612](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6612)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1UsageModelsErrors

# GetApiV1UsageModelsErrors

> **GetApiV1UsageModelsErrors** = `object`

Defined in: [src/client/types.gen.ts:6597](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6597)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6601](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6601)

Invalid period

***

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6605](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6605)

Unauthorized

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6609](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6609)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1UsageModelsResponse

# GetApiV1UsageModelsResponse

> **GetApiV1UsageModelsResponse** = [`GetApiV1UsageModelsResponses`](GetApiV1UsageModelsResponses.md)\[keyof [`GetApiV1UsageModelsResponses`](GetApiV1UsageModelsResponses.md)]

Defined in: [src/client/types.gen.ts:6621](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6621)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1UsageModelsResponses

# GetApiV1UsageModelsResponses

> **GetApiV1UsageModelsResponses** = `object`

Defined in: [src/client/types.gen.ts:6614](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6614)

## Properties

### 200

> **200**: [`HandlersUsageByModelResponse`](HandlersUsageByModelResponse.md)

Defined in: [src/client/types.gen.ts:6618](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6618)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1UserApiKeysData

# GetApiV1UserApiKeysData

> **GetApiV1UserApiKeysData** = `object`

Defined in: [src/client/types.gen.ts:6623](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6623)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:6624](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6624)

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:6625](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6625)

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:6626](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6626)

***

### url

> **url**: `"/api/v1/user/api-keys"`

Defined in: [src/client/types.gen.ts:6627](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6627)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1UserApiKeysError

# GetApiV1UserApiKeysError

> **GetApiV1UserApiKeysError** = [`GetApiV1UserApiKeysErrors`](GetApiV1UserApiKeysErrors.md)\[keyof [`GetApiV1UserApiKeysErrors`](GetApiV1UserApiKeysErrors.md)]

Defined in: [src/client/types.gen.ts:6641](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6641)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1UserApiKeysErrors

# GetApiV1UserApiKeysErrors

> **GetApiV1UserApiKeysErrors** = `object`

Defined in: [src/client/types.gen.ts:6630](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6630)

## Properties

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6634](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6634)

Unauthorized

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6638](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6638)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1UserApiKeysResponse

# GetApiV1UserApiKeysResponse

> **GetApiV1UserApiKeysResponse** = [`GetApiV1UserApiKeysResponses`](GetApiV1UserApiKeysResponses.md)\[keyof [`GetApiV1UserApiKeysResponses`](GetApiV1UserApiKeysResponses.md)]

Defined in: [src/client/types.gen.ts:6650](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6650)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1UserApiKeysResponses

# GetApiV1UserApiKeysResponses

> **GetApiV1UserApiKeysResponses** = `object`

Defined in: [src/client/types.gen.ts:6643](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6643)

## Properties

### 200

> **200**: [`HandlersListUserApiKeysResponse`](HandlersListUserApiKeysResponse.md)

Defined in: [src/client/types.gen.ts:6647](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6647)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1UserOauthGrantsData

# GetApiV1UserOauthGrantsData

> **GetApiV1UserOauthGrantsData** = `object`

Defined in: [src/client/types.gen.ts:6736](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6736)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:6737](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6737)

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:6738](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6738)

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:6739](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6739)

***

### url

> **url**: `"/api/v1/user/oauth/grants"`

Defined in: [src/client/types.gen.ts:6740](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6740)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1UserOauthGrantsError

# GetApiV1UserOauthGrantsError

> **GetApiV1UserOauthGrantsError** = [`GetApiV1UserOauthGrantsErrors`](GetApiV1UserOauthGrantsErrors.md)\[keyof [`GetApiV1UserOauthGrantsErrors`](GetApiV1UserOauthGrantsErrors.md)]

Defined in: [src/client/types.gen.ts:6754](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6754)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1UserOauthGrantsErrors

# GetApiV1UserOauthGrantsErrors

> **GetApiV1UserOauthGrantsErrors** = `object`

Defined in: [src/client/types.gen.ts:6743](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6743)

## Properties

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6747](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6747)

Unauthorized

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6751](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6751)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1UserOauthGrantsResponse

# GetApiV1UserOauthGrantsResponse

> **GetApiV1UserOauthGrantsResponse** = [`GetApiV1UserOauthGrantsResponses`](GetApiV1UserOauthGrantsResponses.md)\[keyof [`GetApiV1UserOauthGrantsResponses`](GetApiV1UserOauthGrantsResponses.md)]

Defined in: [src/client/types.gen.ts:6763](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6763)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetApiV1UserOauthGrantsResponses

# GetApiV1UserOauthGrantsResponses

> **GetApiV1UserOauthGrantsResponses** = `object`

Defined in: [src/client/types.gen.ts:6756](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6756)

## Properties

### 200

> **200**: [`HandlersGrantResponse`](HandlersGrantResponse.md)\[]

Defined in: [src/client/types.gen.ts:6760](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6760)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetHealthData

# GetHealthData

> **GetHealthData** = `object`

Defined in: [src/client/types.gen.ts:6990](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6990)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:6991](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6991)

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:6992](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6992)

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:6993](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6993)

***

### url

> **url**: `"/health"`

Defined in: [src/client/types.gen.ts:6994](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6994)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetHealthError

# GetHealthError

> **GetHealthError** = [`GetHealthErrors`](GetHealthErrors.md)\[keyof [`GetHealthErrors`](GetHealthErrors.md)]

Defined in: [src/client/types.gen.ts:7004](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#7004)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetHealthErrors

# GetHealthErrors

> **GetHealthErrors** = `object`

Defined in: [src/client/types.gen.ts:6997](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6997)

## Properties

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:7001](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#7001)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetHealthResponse

# GetHealthResponse

> **GetHealthResponse** = [`GetHealthResponses`](GetHealthResponses.md)\[keyof [`GetHealthResponses`](GetHealthResponses.md)]

Defined in: [src/client/types.gen.ts:7013](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#7013)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetHealthResponses

# GetHealthResponses

> **GetHealthResponses** = `object`

Defined in: [src/client/types.gen.ts:7006](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#7006)

## Properties

### 200

> **200**: [`HandlersHealthResponse`](HandlersHealthResponse.md)

Defined in: [src/client/types.gen.ts:7010](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#7010)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetOauthAuthorizeData

# GetOauthAuthorizeData

> **GetOauthAuthorizeData** = `object`

Defined in: [src/client/types.gen.ts:7015](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#7015)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:7016](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#7016)

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:7017](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#7017)

***

### query

> **query**: `object`

Defined in: [src/client/types.gen.ts:7018](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#7018)

**client\_id**

> **client\_id**: `string`

OAuth client ID

**code\_challenge**

> **code\_challenge**: `string`

PKCE code challenge

**code\_challenge\_method**

> **code\_challenge\_method**: `string`

PKCE method (must be 'S256')

**redirect\_uri**

> **redirect\_uri**: `string`

Callback URL (must be registered)

**response\_type**

> **response\_type**: `string`

Must be 'code'

**scope?**

> `optional` **scope**: `string`

Space-separated scopes

**state?**

> `optional` **state**: `string`

Opaque client state round-tripped to redirect\_uri

***

### url

> **url**: `"/oauth/authorize"`

Defined in: [src/client/types.gen.ts:7048](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#7048)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetOauthAuthorizeError

# GetOauthAuthorizeError

> **GetOauthAuthorizeError** = [`GetOauthAuthorizeErrors`](GetOauthAuthorizeErrors.md)\[keyof [`GetOauthAuthorizeErrors`](GetOauthAuthorizeErrors.md)]

Defined in: [src/client/types.gen.ts:7062](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#7062)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetOauthAuthorizeErrors

# GetOauthAuthorizeErrors

> **GetOauthAuthorizeErrors** = `object`

Defined in: [src/client/types.gen.ts:7051](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#7051)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:7055](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#7055)

Bad Request

***

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:7059](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#7059)

Unauthorized

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetOauthConsentData

# GetOauthConsentData

> **GetOauthConsentData** = `object`

Defined in: [src/client/types.gen.ts:7064](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#7064)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:7065](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#7065)

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:7066](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#7066)

***

### query

> **query**: `object`

Defined in: [src/client/types.gen.ts:7067](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#7067)

**client\_id**

> **client\_id**: `string`

OAuth client ID

**code\_challenge**

> **code\_challenge**: `string`

PKCE code challenge

**code\_challenge\_method**

> **code\_challenge\_method**: `string`

PKCE method (S256)

**reason?**

> `optional` **reason**: `string`

Consent reason (first\_grant, revoked, scope\_expansion)

**redirect\_uri**

> **redirect\_uri**: `string`

Callback URL

**scope?**

> `optional` **scope**: `string`

Space-separated scopes

**state?**

> `optional` **state**: `string`

Opaque client state

***

### url

> **url**: `"/oauth/consent"`

Defined in: [src/client/types.gen.ts:7097](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#7097)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetOauthConsentError

# GetOauthConsentError

> **GetOauthConsentError** = [`GetOauthConsentErrors`](GetOauthConsentErrors.md)\[keyof [`GetOauthConsentErrors`](GetOauthConsentErrors.md)]

Defined in: [src/client/types.gen.ts:7111](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#7111)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetOauthConsentErrors

# GetOauthConsentErrors

> **GetOauthConsentErrors** = `object`

Defined in: [src/client/types.gen.ts:7100](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#7100)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:7104](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#7104)

Bad Request

***

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:7108](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#7108)

Unauthorized

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetOauthConsentResponse

# GetOauthConsentResponse

> **GetOauthConsentResponse** = [`GetOauthConsentResponses`](GetOauthConsentResponses.md)\[keyof [`GetOauthConsentResponses`](GetOauthConsentResponses.md)]

Defined in: [src/client/types.gen.ts:7120](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#7120)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetOauthConsentResponses

# GetOauthConsentResponses

> **GetOauthConsentResponses** = `object`

Defined in: [src/client/types.gen.ts:7113](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#7113)

## Properties

### 200

> **200**: `string`

Defined in: [src/client/types.gen.ts:7117](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#7117)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetWellKnownJwksJsonData

# GetWellKnownJwksJsonData

> **GetWellKnownJwksJsonData** = `object`

Defined in: [src/client/types.gen.ts:2607](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2607)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:2608](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2608)

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:2609](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2609)

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:2610](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2610)

***

### url

> **url**: `"/.well-known/jwks.json"`

Defined in: [src/client/types.gen.ts:2611](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2611)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetWellKnownJwksJsonResponse

# GetWellKnownJwksJsonResponse

> **GetWellKnownJwksJsonResponse** = [`GetWellKnownJwksJsonResponses`](GetWellKnownJwksJsonResponses.md)\[keyof [`GetWellKnownJwksJsonResponses`](GetWellKnownJwksJsonResponses.md)]

Defined in: [src/client/types.gen.ts:2621](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2621)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/GetWellKnownJwksJsonResponses

# GetWellKnownJwksJsonResponses

> **GetWellKnownJwksJsonResponses** = `object`

Defined in: [src/client/types.gen.ts:2614](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2614)

## Properties

### 200

> **200**: [`AuthJwks`](AuthJwks.md)

Defined in: [src/client/types.gen.ts:2618](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2618)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersAddCreditsRequest

# HandlersAddCreditsRequest

> **HandlersAddCreditsRequest** = `object`

Defined in: [src/client/types.gen.ts:96](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#96)

## Properties

### app\_id?

> `optional` **app\_id**: `number`

Defined in: [src/client/types.gen.ts:100](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#100)

App ID to use

***

### credits?

> `optional` **credits**: `number`

Defined in: [src/client/types.gen.ts:104](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#104)

Number of credits to add (1 credit = 1 cent)

***

### user\_address?

> `optional` **user\_address**: `string`

Defined in: [src/client/types.gen.ts:105](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#105)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersAddCreditsResponse

# HandlersAddCreditsResponse

> **HandlersAddCreditsResponse** = `object`

Defined in: [src/client/types.gen.ts:108](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#108)

## Properties

### app\_id

> **app\_id**: `number`

Defined in: [src/client/types.gen.ts:112](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#112)

App ID used for the operation

***

### credits\_added

> **credits\_added**: `number`

Defined in: [src/client/types.gen.ts:113](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#113)

***

### message?

> `optional` **message**: `string`

Defined in: [src/client/types.gen.ts:114](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#114)

***

### success

> **success**: `boolean`

Defined in: [src/client/types.gen.ts:115](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#115)

***

### user\_address

> **user\_address**: `string`

Defined in: [src/client/types.gen.ts:116](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#116)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersAgentListItem

# HandlersAgentListItem

> **HandlersAgentListItem** = `object`

Defined in: [src/client/types.gen.ts:119](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#119)

## Properties

### agent\_server\_url?

> `optional` **agent\_server\_url**: `string`

Defined in: [src/client/types.gen.ts:123](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#123)

AgentServerURL is the URL of the agent's server runtime endpoint.

***

### category

> **category**: `string`

Defined in: [src/client/types.gen.ts:127](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#127)

Category groups agents by use case.

***

### color?

> `optional` **color**: `string`

Defined in: [src/client/types.gen.ts:131](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#131)

Color is a hex or CSS variable for agent theming.

***

### created\_at

> **created\_at**: `string`

Defined in: [src/client/types.gen.ts:135](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#135)

CreatedAt is when the agent was created.

***

### description

> **description**: `string`

Defined in: [src/client/types.gen.ts:139](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#139)

Description is a short description of the agent's purpose.

***

### display\_order?

> `optional` **display\_order**: `number`

Defined in: [src/client/types.gen.ts:143](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#143)

DisplayOrder controls the sort position in listing endpoints (lower = first).

***

### example\_conversations?

> `optional` **example\_conversations**: `object`\[]

Defined in: [src/client/types.gen.ts:147](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#147)

ExampleConversations is a list of sample Q\&A pairs for the marketplace.

**Index Signature**

\[`key`: `string`]: `string`

***

### features?

> `optional` **features**: `string`\[]

Defined in: [src/client/types.gen.ts:153](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#153)

Features is a list of user-facing capability descriptions.

***

### icon\_url?

> `optional` **icon\_url**: `string`

Defined in: [src/client/types.gen.ts:157](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#157)

IconURL is the URL to the agent's icon.

***

### id

> **id**: `number`

Defined in: [src/client/types.gen.ts:161](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#161)

ID is the unique identifier.

***

### is\_featured?

> `optional` **is\_featured**: `boolean`

Defined in: [src/client/types.gen.ts:165](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#165)

IsFeatured indicates whether to highlight the agent in the marketplace.

***

### model\_config?

> `optional` **model\_config**: `object`

Defined in: [src/client/types.gen.ts:169](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#169)

ModelConfig is the model whitelist, display names, and descriptions.

**Index Signature**

\[`key`: `string`]: `unknown`

***

### name

> **name**: `string`

Defined in: [src/client/types.gen.ts:175](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#175)

Name is the human-readable name.

***

### parent\_id?

> `optional` **parent\_id**: `number`

Defined in: [src/client/types.gen.ts:179](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#179)

ParentID is the optional parent agent ID for sub-agent relationships.

***

### phone\_number?

> `optional` **phone\_number**: `string`

Defined in: [src/client/types.gen.ts:183](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#183)

PhoneNumber is the SMS-reachable phone number for text-enabled agents.

***

### recommended\_model?

> `optional` **recommended\_model**: `string`

Defined in: [src/client/types.gen.ts:187](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#187)

RecommendedModel is the suggested default model.

***

### runtimes?

> `optional` **runtimes**: `string`\[]

Defined in: [src/client/types.gen.ts:191](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#191)

Runtimes is the list of runtime environments the agent supports (e.g., "client", "server").

***

### skills?

> `optional` **skills**: `string`\[]

Defined in: [src/client/types.gen.ts:195](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#195)

Skills is the list of skill identifiers bound to this agent.

***

### status

> **status**: `string`

Defined in: [src/client/types.gen.ts:199](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#199)

Status is the agent's availability: "active", "coming\_soon", or "disabled".

***

### tagline?

> `optional` **tagline**: `string`

Defined in: [src/client/types.gen.ts:203](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#203)

Tagline is a short one-liner for marketplace cards.

***

### updated\_at

> **updated\_at**: `string`

Defined in: [src/client/types.gen.ts:207](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#207)

UpdatedAt is when the agent was last updated.

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersAgentListResponse

# HandlersAgentListResponse

> **HandlersAgentListResponse** = `object`

Defined in: [src/client/types.gen.ts:210](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#210)

## Properties

### agents

> **agents**: [`HandlersAgentListItem`](HandlersAgentListItem.md)\[]

Defined in: [src/client/types.gen.ts:214](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#214)

Agents is the list of active agents.

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersAgentResponse

# HandlersAgentResponse

> **HandlersAgentResponse** = `object`

Defined in: [src/client/types.gen.ts:217](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#217)

## Properties

### agent\_server\_url?

> `optional` **agent\_server\_url**: `string`

Defined in: [src/client/types.gen.ts:221](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#221)

AgentServerURL is the URL of the agent's server runtime endpoint.

***

### category

> **category**: `string`

Defined in: [src/client/types.gen.ts:225](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#225)

Category groups agents by use case.

***

### color?

> `optional` **color**: `string`

Defined in: [src/client/types.gen.ts:229](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#229)

Color is a hex or CSS variable for agent theming.

***

### created\_at

> **created\_at**: `string`

Defined in: [src/client/types.gen.ts:233](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#233)

CreatedAt is when the agent was created.

***

### description

> **description**: `string`

Defined in: [src/client/types.gen.ts:237](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#237)

Description is a short description of the agent's purpose.

***

### display\_order?

> `optional` **display\_order**: `number`

Defined in: [src/client/types.gen.ts:241](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#241)

DisplayOrder controls the sort position in listing endpoints (lower = first).

***

### example\_conversations?

> `optional` **example\_conversations**: `object`\[]

Defined in: [src/client/types.gen.ts:245](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#245)

ExampleConversations is a list of sample Q\&A pairs for the marketplace.

**Index Signature**

\[`key`: `string`]: `string`

***

### features?

> `optional` **features**: `string`\[]

Defined in: [src/client/types.gen.ts:251](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#251)

Features is a list of user-facing capability descriptions.

***

### icon\_url?

> `optional` **icon\_url**: `string`

Defined in: [src/client/types.gen.ts:255](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#255)

IconURL is the URL to the agent's icon.

***

### id

> **id**: `number`

Defined in: [src/client/types.gen.ts:259](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#259)

ID is the unique identifier.

***

### is\_featured?

> `optional` **is\_featured**: `boolean`

Defined in: [src/client/types.gen.ts:263](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#263)

IsFeatured indicates whether to highlight the agent in the marketplace.

***

### model\_config?

> `optional` **model\_config**: `object`

Defined in: [src/client/types.gen.ts:267](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#267)

ModelConfig is the model whitelist, display names, and descriptions.

**Index Signature**

\[`key`: `string`]: `unknown`

***

### name

> **name**: `string`

Defined in: [src/client/types.gen.ts:273](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#273)

Name is the human-readable name.

***

### parent\_id?

> `optional` **parent\_id**: `number`

Defined in: [src/client/types.gen.ts:277](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#277)

ParentID is the optional parent agent ID for sub-agent relationships.

***

### phone\_number?

> `optional` **phone\_number**: `string`

Defined in: [src/client/types.gen.ts:281](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#281)

PhoneNumber is the SMS-reachable phone number for text-enabled agents.

***

### recommended\_model?

> `optional` **recommended\_model**: `string`

Defined in: [src/client/types.gen.ts:285](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#285)

RecommendedModel is the suggested default model.

***

### runtimes?

> `optional` **runtimes**: `string`\[]

Defined in: [src/client/types.gen.ts:289](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#289)

Runtimes is the list of runtime environments the agent supports (e.g., "client", "server").

***

### skills?

> `optional` **skills**: `string`\[]

Defined in: [src/client/types.gen.ts:293](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#293)

Skills is the list of skill identifiers bound to this agent.

***

### status

> **status**: `string`

Defined in: [src/client/types.gen.ts:297](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#297)

Status is the agent's availability: "active", "coming\_soon", or "disabled".

***

### system\_prompt?

> `optional` **system\_prompt**: `string`

Defined in: [src/client/types.gen.ts:301](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#301)

SystemPrompt is the curated system prompt.

***

### tagline?

> `optional` **tagline**: `string`

Defined in: [src/client/types.gen.ts:305](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#305)

Tagline is a short one-liner for marketplace cards.

***

### updated\_at

> **updated\_at**: `string`

Defined in: [src/client/types.gen.ts:309](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#309)

UpdatedAt is when the agent was last updated.

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersApiKeyResponse

# HandlersApiKeyResponse

> **HandlersApiKeyResponse** = `object`

Defined in: [src/client/types.gen.ts:67](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#67)

## Properties

### app\_id

> **app\_id**: `number`

Defined in: [src/client/types.gen.ts:68](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#68)

***

### created\_at

> **created\_at**: `string`

Defined in: [src/client/types.gen.ts:69](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#69)

***

### has\_key

> **has\_key**: `boolean`

Defined in: [src/client/types.gen.ts:73](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#73)

Indicates if key is set, but doesn't expose it

***

### id

> **id**: `number`

Defined in: [src/client/types.gen.ts:74](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#74)

***

### is\_active

> **is\_active**: `boolean`

Defined in: [src/client/types.gen.ts:75](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#75)

***

### name

> **name**: `string`

Defined in: [src/client/types.gen.ts:76](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#76)

***

### updated\_at

> **updated\_at**: `string`

Defined in: [src/client/types.gen.ts:77](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#77)

***

### wallet\_address

> **wallet\_address**: `string`

Defined in: [src/client/types.gen.ts:78](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#78)

***

### wallet\_details?

> `optional` **wallet\_details**: [`HandlersWalletDetails`](HandlersWalletDetails.md)

Defined in: [src/client/types.gen.ts:79](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#79)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersApiKeyWithKeyResponse

# HandlersApiKeyWithKeyResponse

> **HandlersApiKeyWithKeyResponse** = `object`

Defined in: [src/client/types.gen.ts:82](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#82)

## Properties

### api\_key

> **api\_key**: `string`

Defined in: [src/client/types.gen.ts:86](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#86)

Only included in create response

***

### app\_id

> **app\_id**: `number`

Defined in: [src/client/types.gen.ts:87](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#87)

***

### created\_at

> **created\_at**: `string`

Defined in: [src/client/types.gen.ts:88](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#88)

***

### id

> **id**: `number`

Defined in: [src/client/types.gen.ts:89](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#89)

***

### is\_active

> **is\_active**: `boolean`

Defined in: [src/client/types.gen.ts:90](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#90)

***

### name

> **name**: `string`

Defined in: [src/client/types.gen.ts:91](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#91)

***

### updated\_at

> **updated\_at**: `string`

Defined in: [src/client/types.gen.ts:92](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#92)

***

### wallet\_address

> **wallet\_address**: `string`

Defined in: [src/client/types.gen.ts:93](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#93)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersAppConfig

# HandlersAppConfig

> **HandlersAppConfig** = `object`

Defined in: [src/client/types.gen.ts:312](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#312)

## Properties

### name

> **name**: `string`

Defined in: [src/client/types.gen.ts:316](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#316)

Name is the human-readable name of the app

***

### phone\_call\_voice?

> `optional` **phone\_call\_voice**: `string`

Defined in: [src/client/types.gen.ts:320](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#320)

PhoneCallVoice is the configured default voice for phone calls

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersAppResponse

# HandlersAppResponse

> **HandlersAppResponse** = `object`

Defined in: [src/client/types.gen.ts:323](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#323)

## Properties

### app\_balance\_usd

> **app\_balance\_usd**: `number`

Defined in: [src/client/types.gen.ts:324](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#324)

***

### app\_uuid

> **app\_uuid**: `string`

Defined in: [src/client/types.gen.ts:325](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#325)

***

### created\_at

> **created\_at**: `string`

Defined in: [src/client/types.gen.ts:326](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#326)

***

### credit\_reset\_enabled

> **credit\_reset\_enabled**: `boolean`

Defined in: [src/client/types.gen.ts:327](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#327)

***

### credits\_token\_address?

> `optional` **credits\_token\_address**: `string`

Defined in: [src/client/types.gen.ts:328](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#328)

***

### default\_user\_cost\_limit\_usd

> **default\_user\_cost\_limit\_usd**: `number`

Defined in: [src/client/types.gen.ts:329](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#329)

***

### developer\_account\_id?

> `optional` **developer\_account\_id**: `number`

Defined in: [src/client/types.gen.ts:330](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#330)

***

### has\_privy\_verification\_key

> **has\_privy\_verification\_key**: `boolean`

Defined in: [src/client/types.gen.ts:334](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#334)

Indicates if key is set, but doesn't expose it

***

### id

> **id**: `number`

Defined in: [src/client/types.gen.ts:335](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#335)

***

### is\_active

> **is\_active**: `boolean`

Defined in: [src/client/types.gen.ts:336](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#336)

***

### name

> **name**: `string`

Defined in: [src/client/types.gen.ts:337](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#337)

***

### phone\_call\_voice?

> `optional` **phone\_call\_voice**: `string`

Defined in: [src/client/types.gen.ts:338](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#338)

***

### privy\_app\_id?

> `optional` **privy\_app\_id**: `string`

Defined in: [src/client/types.gen.ts:339](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#339)

***

### updated\_at

> **updated\_at**: `string`

Defined in: [src/client/types.gen.ts:340](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#340)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersAppUsageResponse

# HandlersAppUsageResponse

> **HandlersAppUsageResponse** = `object`

Defined in: [src/client/types.gen.ts:343](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#343)

## Properties

### app\_uuid

> **app\_uuid**: `string`

Defined in: [src/client/types.gen.ts:344](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#344)

***

### period

> **period**: [`HandlersUsagePeriod`](HandlersUsagePeriod.md)

Defined in: [src/client/types.gen.ts:345](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#345)

***

### timeseries

> **timeseries**: [`HandlersUsageTimeseriesPoint`](HandlersUsageTimeseriesPoint.md)\[]

Defined in: [src/client/types.gen.ts:346](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#346)

***

### total\_cost\_credits

> **total\_cost\_credits**: `number`

Defined in: [src/client/types.gen.ts:347](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#347)

***

### total\_request\_tokens

> **total\_request\_tokens**: `number`

Defined in: [src/client/types.gen.ts:348](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#348)

***

### total\_requests

> **total\_requests**: `number`

Defined in: [src/client/types.gen.ts:349](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#349)

***

### total\_response\_tokens

> **total\_response\_tokens**: `number`

Defined in: [src/client/types.gen.ts:350](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#350)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersAppUserUsageResponse

# HandlersAppUserUsageResponse

> **HandlersAppUserUsageResponse** = `object`

Defined in: [src/client/types.gen.ts:353](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#353)

## Properties

### pagination

> **pagination**: [`HandlersPaginationResponse`](HandlersPaginationResponse.md)

Defined in: [src/client/types.gen.ts:354](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#354)

***

### users

> **users**: [`HandlersUserUsageResponse`](HandlersUserUsageResponse.md)\[]

Defined in: [src/client/types.gen.ts:355](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#355)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersBillingHistoryResponse

# HandlersBillingHistoryResponse

> **HandlersBillingHistoryResponse** = `object`

Defined in: [src/client/types.gen.ts:358](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#358)

## Properties

### pagination

> **pagination**: [`HandlersPaginationResponse`](HandlersPaginationResponse.md)

Defined in: [src/client/types.gen.ts:359](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#359)

***

### payments

> **payments**: [`HandlersBillingRecordResponse`](HandlersBillingRecordResponse.md)\[]

Defined in: [src/client/types.gen.ts:360](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#360)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersBillingRecordResponse

# HandlersBillingRecordResponse

> **HandlersBillingRecordResponse** = `object`

Defined in: [src/client/types.gen.ts:363](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#363)

## Properties

### amount\_cents

> **amount\_cents**: `number`

Defined in: [src/client/types.gen.ts:364](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#364)

***

### app\_uuid

> **app\_uuid**: `string`

Defined in: [src/client/types.gen.ts:365](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#365)

***

### created\_at

> **created\_at**: `string`

Defined in: [src/client/types.gen.ts:366](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#366)

***

### credits

> **credits**: `number`

Defined in: [src/client/types.gen.ts:367](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#367)

***

### currency

> **currency**: `string`

Defined in: [src/client/types.gen.ts:368](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#368)

***

### id

> **id**: `number`

Defined in: [src/client/types.gen.ts:369](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#369)

***

### status

> **status**: `string`

Defined in: [src/client/types.gen.ts:370](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#370)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersBootstrapBuild

# HandlersBootstrapBuild

> **HandlersBootstrapBuild** = `object`

Defined in: [src/client/types.gen.ts:376](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#376)

Build is the server build metadata at the time of bootstrap.

## Properties

### env?

> `optional` **env**: `string`

Defined in: [src/client/types.gen.ts:380](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#380)

Env is the deployment environment (e.g., "dev", "prod").

***

### version?

> `optional` **version**: `string`

Defined in: [src/client/types.gen.ts:384](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#384)

Version is the server build version (set via ldflags at compile time).

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersBootstrapResponse

# HandlersBootstrapResponse

> **HandlersBootstrapResponse** = `object`

Defined in: [src/client/types.gen.ts:387](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#387)

## Properties

### build?

> `optional` **build**: [`HandlersBootstrapBuild`](HandlersBootstrapBuild.md)

Defined in: [src/client/types.gen.ts:388](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#388)

***

### flags?

> `optional` **flags**: `object`

Defined in: [src/client/types.gen.ts:393](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#393)

Flags maps registered feature-flag keys to the variant assigned to this user.
Variant values are typed by PostHog: bool for boolean flags, string for multivariate.

**Index Signature**

\[`key`: `string`]: `unknown`

***

### user?

> `optional` **user**: [`HandlersBootstrapUser`](HandlersBootstrapUser.md)

Defined in: [src/client/types.gen.ts:396](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#396)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersBootstrapUser

# HandlersBootstrapUser

> **HandlersBootstrapUser** = `object`

Defined in: [src/client/types.gen.ts:402](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#402)

User is the authenticated identity context.

## Properties

### subscription\_tier?

> `optional` **subscription\_tier**: `string`

Defined in: [src/client/types.gen.ts:406](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#406)

SubscriptionTier reflects the user's tier (e.g., "basic", "starter", "pro").

***

### user\_address?

> `optional` **user\_address**: `string`

Defined in: [src/client/types.gen.ts:410](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#410)

UserAddress is the EVM address resolved from the auth token.

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersCancelScheduledDowngradeResponse

# HandlersCancelScheduledDowngradeResponse

> **HandlersCancelScheduledDowngradeResponse** = `object`

Defined in: [src/client/types.gen.ts:413](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#413)

## Properties

### message

> **message**: `string`

Defined in: [src/client/types.gen.ts:414](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#414)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersCancelSubscriptionResponse

# HandlersCancelSubscriptionResponse

> **HandlersCancelSubscriptionResponse** = `object`

Defined in: [src/client/types.gen.ts:417](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#417)

## Properties

### cancel\_at?

> `optional` **cancel\_at**: `number`

Defined in: [src/client/types.gen.ts:418](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#418)

***

### current\_period\_end?

> `optional` **current\_period\_end**: `number`

Defined in: [src/client/types.gen.ts:419](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#419)

***

### message

> **message**: `string`

Defined in: [src/client/types.gen.ts:420](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#420)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersCheckoutSessionResponse

# HandlersCheckoutSessionResponse

> **HandlersCheckoutSessionResponse** = `object`

Defined in: [src/client/types.gen.ts:423](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#423)

## Properties

### url

> **url**: `string`

Defined in: [src/client/types.gen.ts:424](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#424)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersConfigResponse

# HandlersConfigResponse

> **HandlersConfigResponse** = `object`

Defined in: [src/client/types.gen.ts:427](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#427)

## Properties

### apps?

> `optional` **apps**: [`HandlersAppConfig`](HandlersAppConfig.md)\[]

Defined in: [src/client/types.gen.ts:431](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#431)

Apps is the list of active apps

***

### phone\_calls\_enabled?

> `optional` **phone\_calls\_enabled**: `boolean`

Defined in: [src/client/types.gen.ts:435](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#435)

PhoneCallsEnabled indicates whether Bland phone calling is available

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersConfigurePrivyRequest

# HandlersConfigurePrivyRequest

> **HandlersConfigurePrivyRequest** = `object`

Defined in: [src/client/types.gen.ts:438](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#438)

## Properties

### privy\_app\_id?

> `optional` **privy\_app\_id**: `string`

Defined in: [src/client/types.gen.ts:439](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#439)

***

### privy\_verification\_key?

> `optional` **privy\_verification\_key**: `string`

Defined in: [src/client/types.gen.ts:440](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#440)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersConsentApproveResponse

# HandlersConsentApproveResponse

> **HandlersConsentApproveResponse** = `object`

Defined in: [src/client/types.gen.ts:443](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#443)

## Properties

### code?

> `optional` **code**: `string`

Defined in: [src/client/types.gen.ts:444](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#444)

***

### redirect\_uri?

> `optional` **redirect\_uri**: `string`

Defined in: [src/client/types.gen.ts:445](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#445)

***

### state?

> `optional` **state**: `string`

Defined in: [src/client/types.gen.ts:446](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#446)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersCreateAgentRequest

# HandlersCreateAgentRequest

> **HandlersCreateAgentRequest** = `object`

Defined in: [src/client/types.gen.ts:459](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#459)

## Properties

### agent\_server\_url?

> `optional` **agent\_server\_url**: `string`

Defined in: [src/client/types.gen.ts:463](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#463)

AgentServerURL is the URL of the agent's server runtime endpoint.

***

### category?

> `optional` **category**: `string`

Defined in: [src/client/types.gen.ts:467](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#467)

Category groups agents by use case.

***

### color?

> `optional` **color**: `string`

Defined in: [src/client/types.gen.ts:471](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#471)

Color is a hex or CSS variable for agent theming.

***

### description?

> `optional` **description**: `string`

Defined in: [src/client/types.gen.ts:475](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#475)

Description is a short description of the agent's purpose.

***

### display\_order?

> `optional` **display\_order**: `number`

Defined in: [src/client/types.gen.ts:479](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#479)

DisplayOrder controls the sort position in listing endpoints (lower = first).

***

### example\_conversations?

> `optional` **example\_conversations**: `object`\[]

Defined in: [src/client/types.gen.ts:483](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#483)

ExampleConversations is a list of sample Q\&A pairs for the marketplace.

**Index Signature**

\[`key`: `string`]: `string`

***

### features?

> `optional` **features**: `string`\[]

Defined in: [src/client/types.gen.ts:489](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#489)

Features is a list of user-facing capability descriptions.

***

### icon\_url?

> `optional` **icon\_url**: `string`

Defined in: [src/client/types.gen.ts:493](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#493)

IconURL is the URL to the agent's icon.

***

### is\_featured?

> `optional` **is\_featured**: `boolean`

Defined in: [src/client/types.gen.ts:497](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#497)

IsFeatured indicates whether to highlight the agent in the marketplace.

***

### model\_config?

> `optional` **model\_config**: `object`

Defined in: [src/client/types.gen.ts:501](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#501)

ModelConfig is the model whitelist, display names, and descriptions.

**Index Signature**

\[`key`: `string`]: `unknown`

***

### name?

> `optional` **name**: `string`

Defined in: [src/client/types.gen.ts:507](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#507)

Name is the human-readable name of the agent.

***

### parent\_id?

> `optional` **parent\_id**: `number`

Defined in: [src/client/types.gen.ts:511](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#511)

ParentID is the optional parent agent ID for sub-agent relationships.

***

### recommended\_model?

> `optional` **recommended\_model**: `string`

Defined in: [src/client/types.gen.ts:515](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#515)

RecommendedModel is the suggested default model.

***

### runtimes?

> `optional` **runtimes**: `string`\[]

Defined in: [src/client/types.gen.ts:519](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#519)

Runtimes is the list of runtime environments the agent supports (e.g., "client", "server").

***

### skills?

> `optional` **skills**: `string`\[]

Defined in: [src/client/types.gen.ts:523](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#523)

Skills is the list of skill identifiers bound to this agent.

***

### status?

> `optional` **status**: `string`

Defined in: [src/client/types.gen.ts:527](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#527)

Status is the agent's availability: "active", "coming\_soon", or "disabled".

***

### system\_prompt?

> `optional` **system\_prompt**: `string`

Defined in: [src/client/types.gen.ts:531](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#531)

SystemPrompt is the curated system prompt.

***

### tagline?

> `optional` **tagline**: `string`

Defined in: [src/client/types.gen.ts:535](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#535)

Tagline is a short one-liner for marketplace cards.

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersCreateApiKeyRequest

# HandlersCreateApiKeyRequest

> **HandlersCreateApiKeyRequest** = `object`

Defined in: [src/client/types.gen.ts:449](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#449)

## Properties

### is\_active?

> `optional` **is\_active**: `boolean`

Defined in: [src/client/types.gen.ts:450](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#450)

***

### is\_test?

> `optional` **is\_test**: `boolean`

Defined in: [src/client/types.gen.ts:454](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#454)

If true, generates anuma\_test\_ prefix; otherwise anuma\_live\_

***

### name?

> `optional` **name**: `string`

Defined in: [src/client/types.gen.ts:455](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#455)

***

### wallet\_address?

> `optional` **wallet\_address**: `string`

Defined in: [src/client/types.gen.ts:456](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#456)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersCreateAppRequest

# HandlersCreateAppRequest

> **HandlersCreateAppRequest** = `object`

Defined in: [src/client/types.gen.ts:538](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#538)

## Properties

### credit\_reset\_enabled?

> `optional` **credit\_reset\_enabled**: `boolean`

Defined in: [src/client/types.gen.ts:539](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#539)

***

### credits\_token\_address?

> `optional` **credits\_token\_address**: `string`

Defined in: [src/client/types.gen.ts:540](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#540)

***

### is\_active?

> `optional` **is\_active**: `boolean`

Defined in: [src/client/types.gen.ts:541](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#541)

***

### name?

> `optional` **name**: `string`

Defined in: [src/client/types.gen.ts:542](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#542)

***

### phone\_call\_voice?

> `optional` **phone\_call\_voice**: `string`

Defined in: [src/client/types.gen.ts:543](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#543)

***

### privy\_app\_id?

> `optional` **privy\_app\_id**: `string`

Defined in: [src/client/types.gen.ts:544](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#544)

***

### privy\_verification\_key?

> `optional` **privy\_verification\_key**: `string`

Defined in: [src/client/types.gen.ts:545](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#545)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersCreateCheckoutSessionRequest

# HandlersCreateCheckoutSessionRequest

> **HandlersCreateCheckoutSessionRequest** = `object`

Defined in: [src/client/types.gen.ts:548](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#548)

## Properties

### cancel\_url?

> `optional` **cancel\_url**: `string`

Defined in: [src/client/types.gen.ts:549](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#549)

***

### interval?

> `optional` **interval**: `string`

Defined in: [src/client/types.gen.ts:553](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#553)

"month" or "year"

***

### price\_id?

> `optional` **price\_id**: `string`

Defined in: [src/client/types.gen.ts:554](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#554)

***

### referral?

> `optional` **referral**: `string`

Defined in: [src/client/types.gen.ts:558](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#558)

Rewardful referral ID for affiliate tracking

***

### success\_url?

> `optional` **success\_url**: `string`

Defined in: [src/client/types.gen.ts:559](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#559)

***

### tier?

> `optional` **tier**: `string`

Defined in: [src/client/types.gen.ts:563](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#563)

"starter" or "pro"

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersCreateCreditPackCheckoutRequest

# HandlersCreateCreditPackCheckoutRequest

> **HandlersCreateCreditPackCheckoutRequest** = `object`

Defined in: [src/client/types.gen.ts:566](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#566)

## Properties

### cancel\_url?

> `optional` **cancel\_url**: `string`

Defined in: [src/client/types.gen.ts:567](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#567)

***

### credits?

> `optional` **credits**: `number`

Defined in: [src/client/types.gen.ts:568](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#568)

***

### referral?

> `optional` **referral**: `string`

Defined in: [src/client/types.gen.ts:572](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#572)

Rewardful referral ID for affiliate tracking

***

### success\_url?

> `optional` **success\_url**: `string`

Defined in: [src/client/types.gen.ts:573](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#573)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersCreateCustomerPortalRequest

# HandlersCreateCustomerPortalRequest

> **HandlersCreateCustomerPortalRequest** = `object`

Defined in: [src/client/types.gen.ts:576](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#576)

## Properties

### return\_url?

> `optional` **return\_url**: `string`

Defined in: [src/client/types.gen.ts:577](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#577)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersCreateDeveloperAppRequest

# HandlersCreateDeveloperAppRequest

> **HandlersCreateDeveloperAppRequest** = `object`

Defined in: [src/client/types.gen.ts:580](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#580)

## Properties

### allowed\_origins?

> `optional` **allowed\_origins**: `string`\[]

Defined in: [src/client/types.gen.ts:584](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#584)

allowed CORS origins for API key requests

***

### app\_type?

> `optional` **app\_type**: `string`

Defined in: [src/client/types.gen.ts:588](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#588)

"standard" (default) or "pooled\_api"

***

### default\_user\_credits?

> `optional` **default\_user\_credits**: `number`

Defined in: [src/client/types.gen.ts:592](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#592)

credits per new user (1 credit = $0.01)

***

### name?

> `optional` **name**: `string`

Defined in: [src/client/types.gen.ts:593](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#593)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersCreateOAuthClientRequest

# HandlersCreateOAuthClientRequest

> **HandlersCreateOAuthClientRequest** = `object`

Defined in: [src/client/types.gen.ts:596](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#596)

## Properties

### agent\_server\_url?

> `optional` **agent\_server\_url**: `string`

Defined in: [src/client/types.gen.ts:597](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#597)

***

### allowed\_redirect\_uris?

> `optional` **allowed\_redirect\_uris**: `string`\[]

Defined in: [src/client/types.gen.ts:598](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#598)

***

### allowed\_scopes?

> `optional` **allowed\_scopes**: `string`\[]

Defined in: [src/client/types.gen.ts:599](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#599)

***

### client\_id?

> `optional` **client\_id**: `string`

Defined in: [src/client/types.gen.ts:600](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#600)

***

### is\_public\_client?

> `optional` **is\_public\_client**: `boolean`

Defined in: [src/client/types.gen.ts:601](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#601)

***

### name?

> `optional` **name**: `string`

Defined in: [src/client/types.gen.ts:602](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#602)

***

### owner\_org?

> `optional` **owner\_org**: `string`

Defined in: [src/client/types.gen.ts:603](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#603)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersCreateOAuthClientResponse

# HandlersCreateOAuthClientResponse

> **HandlersCreateOAuthClientResponse** = `object`

Defined in: [src/client/types.gen.ts:606](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#606)

## Properties

### agent\_server\_url?

> `optional` **agent\_server\_url**: `string`

Defined in: [src/client/types.gen.ts:607](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#607)

***

### allowed\_redirect\_uris?

> `optional` **allowed\_redirect\_uris**: `string`\[]

Defined in: [src/client/types.gen.ts:608](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#608)

***

### allowed\_scopes?

> `optional` **allowed\_scopes**: `string`\[]

Defined in: [src/client/types.gen.ts:609](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#609)

***

### client\_id?

> `optional` **client\_id**: `string`

Defined in: [src/client/types.gen.ts:610](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#610)

***

### client\_secret?

> `optional` **client\_secret**: `string`

Defined in: [src/client/types.gen.ts:611](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#611)

***

### created\_at?

> `optional` **created\_at**: `string`

Defined in: [src/client/types.gen.ts:612](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#612)

***

### is\_public\_client?

> `optional` **is\_public\_client**: `boolean`

Defined in: [src/client/types.gen.ts:613](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#613)

***

### name?

> `optional` **name**: `string`

Defined in: [src/client/types.gen.ts:614](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#614)

***

### owner\_org?

> `optional` **owner\_org**: `string`

Defined in: [src/client/types.gen.ts:615](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#615)

***

### status?

> `optional` **status**: `string`

Defined in: [src/client/types.gen.ts:616](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#616)

***

### updated\_at?

> `optional` **updated\_at**: `string`

Defined in: [src/client/types.gen.ts:617](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#617)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersCreatePersonaRequest

# HandlersCreatePersonaRequest

> **HandlersCreatePersonaRequest** = `object`

Defined in: [src/client/types.gen.ts:620](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#620)

## Properties

### config?

> `optional` **config**: `object`

Defined in: [src/client/types.gen.ts:624](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#624)

Config is the persona configuration JSON.

**Index Signature**

\[`key`: `string`]: `unknown`

***

### name?

> `optional` **name**: `string`

Defined in: [src/client/types.gen.ts:630](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#630)

Name is the unique persona name.

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersCreatePhoneCallRequest

# HandlersCreatePhoneCallRequest

> **HandlersCreatePhoneCallRequest** = `object`

Defined in: [src/client/types.gen.ts:633](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#633)

## Properties

### caller\_name?

> `optional` **caller\_name**: `string`

Defined in: [src/client/types.gen.ts:634](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#634)

***

### context?

> `optional` **context**: `string`

Defined in: [src/client/types.gen.ts:635](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#635)

***

### objective

> **objective**: `string`

Defined in: [src/client/types.gen.ts:636](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#636)

***

### phone\_number

> **phone\_number**: `string`

Defined in: [src/client/types.gen.ts:637](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#637)

***

### questions?

> `optional` **questions**: `string`\[]

Defined in: [src/client/types.gen.ts:638](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#638)

***

### recipient\_name?

> `optional` **recipient\_name**: `string`

Defined in: [src/client/types.gen.ts:639](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#639)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersCreditBalanceResponse

# HandlersCreditBalanceResponse

> **HandlersCreditBalanceResponse** = `object`

Defined in: [src/client/types.gen.ts:642](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#642)

## Properties

### available\_credits

> **available\_credits**: `number`

Defined in: [src/client/types.gen.ts:646](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#646)

Available credits (1 credit = $0.01)

***

### expiring\_credits?

> `optional` **expiring\_credits**: [`HandlersExpiringCredits`](HandlersExpiringCredits.md)\[]

Defined in: [src/client/types.gen.ts:650](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#650)

Upcoming credit expirations (soonest first)

***

### lifetime\_credits

> **lifetime\_credits**: `number`

Defined in: [src/client/types.gen.ts:654](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#654)

Total credits ever received (1 credit = $0.01)

***

### subscription\_tier

> **subscription\_tier**: `string`

Defined in: [src/client/types.gen.ts:658](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#658)

"basic" or "pro"

***

### total\_tokens\_redeemed?

> `optional` **total\_tokens\_redeemed**: `string`

Defined in: [src/client/types.gen.ts:662](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#662)

Sum of on-chain token amounts redeemed (raw units, format with token decimals)

***

### wallet\_address

> **wallet\_address**: `string`

Defined in: [src/client/types.gen.ts:663](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#663)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersCreditPack

# HandlersCreditPack

> **HandlersCreditPack** = `object`

Defined in: [src/client/types.gen.ts:666](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#666)

## Properties

### credits

> **credits**: `number`

Defined in: [src/client/types.gen.ts:667](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#667)

***

### currency

> **currency**: `string`

Defined in: [src/client/types.gen.ts:668](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#668)

***

### unit\_amount

> **unit\_amount**: `number`

Defined in: [src/client/types.gen.ts:669](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#669)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersCreditPacksResponse

# HandlersCreditPacksResponse

> **HandlersCreditPacksResponse** = `object`

Defined in: [src/client/types.gen.ts:672](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#672)

## Properties

### packs

> **packs**: [`HandlersCreditPack`](HandlersCreditPack.md)\[]

Defined in: [src/client/types.gen.ts:673](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#673)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersCustomerPortalResponse

# HandlersCustomerPortalResponse

> **HandlersCustomerPortalResponse** = `object`

Defined in: [src/client/types.gen.ts:676](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#676)

## Properties

### url

> **url**: `string`

Defined in: [src/client/types.gen.ts:677](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#677)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersDeleteUserResponse

# HandlersDeleteUserResponse

> **HandlersDeleteUserResponse** = `object`

Defined in: [src/client/types.gen.ts:680](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#680)

## Properties

### account\_id?

> `optional` **account\_id**: `number`

Defined in: [src/client/types.gen.ts:681](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#681)

***

### message?

> `optional` **message**: `string`

Defined in: [src/client/types.gen.ts:682](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#682)

***

### stripe\_cleanup\_succeeded?

> `optional` **stripe\_cleanup\_succeeded**: `boolean`

Defined in: [src/client/types.gen.ts:683](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#683)

***

### wallet\_address?

> `optional` **wallet\_address**: `string`

Defined in: [src/client/types.gen.ts:684](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#684)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersDeveloperApiKeyRequest

# HandlersDeveloperApiKeyRequest

> **HandlersDeveloperApiKeyRequest** = `object`

Defined in: [src/client/types.gen.ts:687](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#687)

## Properties

### name?

> `optional` **name**: `string`

Defined in: [src/client/types.gen.ts:688](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#688)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersDeveloperApiKeyResponse

# HandlersDeveloperApiKeyResponse

> **HandlersDeveloperApiKeyResponse** = `object`

Defined in: [src/client/types.gen.ts:691](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#691)

## Properties

### created\_at

> **created\_at**: `string`

Defined in: [src/client/types.gen.ts:692](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#692)

***

### id

> **id**: `number`

Defined in: [src/client/types.gen.ts:693](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#693)

***

### is\_active

> **is\_active**: `boolean`

Defined in: [src/client/types.gen.ts:694](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#694)

***

### name

> **name**: `string`

Defined in: [src/client/types.gen.ts:695](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#695)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersDeveloperApiKeyWithSecretResponse

# HandlersDeveloperApiKeyWithSecretResponse

> **HandlersDeveloperApiKeyWithSecretResponse** = `object`

Defined in: [src/client/types.gen.ts:698](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#698)

## Properties

### api\_key

> **api\_key**: `string`

Defined in: [src/client/types.gen.ts:702](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#702)

Full key, only shown once

***

### created\_at

> **created\_at**: `string`

Defined in: [src/client/types.gen.ts:703](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#703)

***

### id

> **id**: `number`

Defined in: [src/client/types.gen.ts:704](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#704)

***

### is\_active

> **is\_active**: `boolean`

Defined in: [src/client/types.gen.ts:705](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#705)

***

### name

> **name**: `string`

Defined in: [src/client/types.gen.ts:706](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#706)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersDeveloperAppResponse

# HandlersDeveloperAppResponse

> **HandlersDeveloperAppResponse** = `object`

Defined in: [src/client/types.gen.ts:709](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#709)

## Properties

### allowed\_origins

> **allowed\_origins**: `string`\[]

Defined in: [src/client/types.gen.ts:713](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#713)

allowed CORS origins (empty = unrestricted)

***

### app\_type

> **app\_type**: `string`

Defined in: [src/client/types.gen.ts:717](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#717)

"standard" or "pooled\_api"

***

### app\_uuid

> **app\_uuid**: `string`

Defined in: [src/client/types.gen.ts:718](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#718)

***

### balance

> **balance**: `number`

Defined in: [src/client/types.gen.ts:722](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#722)

available credits in app pool

***

### created\_at

> **created\_at**: `string`

Defined in: [src/client/types.gen.ts:723](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#723)

***

### default\_user\_credits

> **default\_user\_credits**: `number`

Defined in: [src/client/types.gen.ts:727](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#727)

credits per new user (1 credit = $0.01)

***

### has\_privy\_config

> **has\_privy\_config**: `boolean`

Defined in: [src/client/types.gen.ts:728](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#728)

***

### is\_active

> **is\_active**: `boolean`

Defined in: [src/client/types.gen.ts:729](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#729)

***

### name

> **name**: `string`

Defined in: [src/client/types.gen.ts:730](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#730)

***

### privy\_app\_id?

> `optional` **privy\_app\_id**: `string`

Defined in: [src/client/types.gen.ts:731](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#731)

***

### updated\_at

> **updated\_at**: `string`

Defined in: [src/client/types.gen.ts:732](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#732)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersDeveloperUserResponse

# HandlersDeveloperUserResponse

> **HandlersDeveloperUserResponse** = `object`

Defined in: [src/client/types.gen.ts:735](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#735)

## Properties

### address

> **address**: `string`

Defined in: [src/client/types.gen.ts:736](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#736)

***

### created\_at

> **created\_at**: `string`

Defined in: [src/client/types.gen.ts:737](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#737)

***

### credits

> **credits**: `number`

Defined in: [src/client/types.gen.ts:741](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#741)

available credits (1 credit = $0.01)

***

### lifetime\_credits

> **lifetime\_credits**: `number`

Defined in: [src/client/types.gen.ts:745](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#745)

total credits ever received

***

### subscription\_tier

> **subscription\_tier**: `string`

Defined in: [src/client/types.gen.ts:749](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#749)

basic/pro

***

### used\_credits

> **used\_credits**: `number`

Defined in: [src/client/types.gen.ts:753](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#753)

credits used/pending

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersDisableRequest

# HandlersDisableRequest

> **HandlersDisableRequest** = `object`

Defined in: [src/client/types.gen.ts:1657](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1657)

## Properties

### code?

> `optional` **code**: `string`

Defined in: [src/client/types.gen.ts:1658](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1658)

***

### method?

> `optional` **method**: `string`

Defined in: [src/client/types.gen.ts:1659](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1659)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersExchangeRequest

# HandlersExchangeRequest

> **HandlersExchangeRequest** = `object`

Defined in: [src/client/types.gen.ts:756](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#756)

## Properties

### code

> **code**: `string`

Defined in: [src/client/types.gen.ts:757](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#757)

***

### redirect\_uri?

> `optional` **redirect\_uri**: `string`

Defined in: [src/client/types.gen.ts:761](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#761)

Optional - uses config default if not provided

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersExpiringCredits

# HandlersExpiringCredits

> **HandlersExpiringCredits** = `object`

Defined in: [src/client/types.gen.ts:764](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#764)

## Properties

### credits?

> `optional` **credits**: `number`

Defined in: [src/client/types.gen.ts:768](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#768)

Number of credits expiring (1 credit = $0.01)

***

### expires\_at?

> `optional` **expires\_at**: `string`

Defined in: [src/client/types.gen.ts:772](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#772)

ISO8601 timestamp

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersFundDeveloperAppRequest

# HandlersFundDeveloperAppRequest

> **HandlersFundDeveloperAppRequest** = `object`

Defined in: [src/client/types.gen.ts:775](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#775)

## Properties

### cancel\_url?

> `optional` **cancel\_url**: `string`

Defined in: [src/client/types.gen.ts:779](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#779)

URL to redirect if payment is cancelled

***

### credits?

> `optional` **credits**: `number`

Defined in: [src/client/types.gen.ts:783](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#783)

Number of credits to purchase (1 credit = $0.01)

***

### referral?

> `optional` **referral**: `string`

Defined in: [src/client/types.gen.ts:787](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#787)

Rewardful referral ID for affiliate tracking

***

### success\_url?

> `optional` **success\_url**: `string`

Defined in: [src/client/types.gen.ts:791](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#791)

URL to redirect after successful payment

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersGeneratedApiKey

# HandlersGeneratedApiKey

> **HandlersGeneratedApiKey** = `object`

Defined in: [src/client/types.gen.ts:794](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#794)

## Properties

### api\_key

> **api\_key**: `string`

Defined in: [src/client/types.gen.ts:798](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#798)

Full HMAC key (anuma\_live\_\<key\_id>.<secret> or anuma\_test\_\<key\_id>.<secret>)

***

### name

> **name**: `string`

Defined in: [src/client/types.gen.ts:799](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#799)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersGetToolsResponse

# HandlersGetToolsResponse

> **HandlersGetToolsResponse** = `object`

Defined in: [src/client/types.gen.ts:802](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#802)

## Properties

### checksum

> **checksum**: `string`

Defined in: [src/client/types.gen.ts:803](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#803)

***

### tools

> **tools**: `object`

Defined in: [src/client/types.gen.ts:804](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#804)

**Index Signature**

\[`key`: `string`]: [`HandlersTool`](HandlersTool.md)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersGrantResponse

# HandlersGrantResponse

> **HandlersGrantResponse** = `object`

Defined in: [src/client/types.gen.ts:1662](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1662)

## Properties

### client\_id?

> `optional` **client\_id**: `string`

Defined in: [src/client/types.gen.ts:1663](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1663)

***

### created\_at?

> `optional` **created\_at**: `string`

Defined in: [src/client/types.gen.ts:1664](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1664)

***

### daily\_spend\_micro\_usd?

> `optional` **daily\_spend\_micro\_usd**: `number`

Defined in: [src/client/types.gen.ts:1665](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1665)

***

### id?

> `optional` **id**: `number`

Defined in: [src/client/types.gen.ts:1666](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1666)

***

### revoked\_at?

> `optional` **revoked\_at**: `string`

Defined in: [src/client/types.gen.ts:1667](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1667)

***

### scopes?

> `optional` **scopes**: `string`\[]

Defined in: [src/client/types.gen.ts:1668](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1668)

***

### spending\_cap\_daily\_micro\_usd?

> `optional` **spending\_cap\_daily\_micro\_usd**: `number`

Defined in: [src/client/types.gen.ts:1669](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1669)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersGuestBootstrapResponse

# HandlersGuestBootstrapResponse

> **HandlersGuestBootstrapResponse** = `object`

Defined in: [src/client/types.gen.ts:809](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#809)

## Properties

### build?

> `optional` **build**: [`HandlersBootstrapBuild`](HandlersBootstrapBuild.md)

Defined in: [src/client/types.gen.ts:810](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#810)

***

### flags?

> `optional` **flags**: `object`

Defined in: [src/client/types.gen.ts:814](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#814)

Flags maps registered feature-flag keys to variants assigned to this guest.

**Index Signature**

\[`key`: `string`]: `unknown`

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersGuestChatResponse

# HandlersGuestChatResponse

> **HandlersGuestChatResponse** = `object`

Defined in: [src/client/types.gen.ts:819](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#819)

## Properties

### choices?

> `optional` **choices**: [`LlmapiChoice`](LlmapiChoice.md)\[]

Defined in: [src/client/types.gen.ts:823](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#823)

Choices contains the completion choices

***

### client\_injected\_tools?

> `optional` **client\_injected\_tools**: `string`\[]

Defined in: [src/client/types.gen.ts:827](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#827)

ClientInjectedTools are tool names the client provided in the original request.

***

### extra\_fields?

> `optional` **extra\_fields**: [`LlmapiChatCompletionExtraFields`](LlmapiChatCompletionExtraFields.md)

Defined in: [src/client/types.gen.ts:828](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#828)

***

### id?

> `optional` **id**: `string`

Defined in: [src/client/types.gen.ts:832](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#832)

ID is the completion ID

***

### image\_model?

> `optional` **image\_model**: `string`

Defined in: [src/client/types.gen.ts:838](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#838)

ImageModel is set when an image generation tool was called during the request.
This allows the client to detect that the response contains generated images
and render them appropriately, even when the orchestrating model is a text model.

***

### inference\_id?

> `optional` **inference\_id**: `string`

Defined in: [src/client/types.gen.ts:842](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#842)

InferenceID is the unique identifier for this inference request

***

### messages?

> `optional` **messages**: [`LlmapiMessage`](LlmapiMessage.md)\[]

Defined in: [src/client/types.gen.ts:849](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#849)

Messages contains the full conversation history when local tools need execution.
This is populated when the model requests tools that are not MCP tools (local/client-side tools).
The client should execute these tools and send a new request with this message history
plus the tool results appended.

***

### messages\_remaining?

> `optional` **messages\_remaining**: `number`

Defined in: [src/client/types.gen.ts:850](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#850)

***

### model?

> `optional` **model**: `string`

Defined in: [src/client/types.gen.ts:854](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#854)

Model is the model used

***

### portal\_injected\_tools?

> `optional` **portal\_injected\_tools**: `string`\[]

Defined in: [src/client/types.gen.ts:858](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#858)

PortalInjectedTools are tool names the portal's classifier added to the request.

***

### tool\_call\_events?

> `optional` **tool\_call\_events**: [`LlmapiToolCallEvent`](LlmapiToolCallEvent.md)\[]

Defined in: [src/client/types.gen.ts:862](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#862)

ToolCallEvents is an array of tool call events.

***

### tools\_checksum?

> `optional` **tools\_checksum**: `string`

Defined in: [src/client/types.gen.ts:866](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#866)

ToolsChecksum is the checksum of the tool schemas used by the AI Portal.

***

### usage?

> `optional` **usage**: [`LlmapiChatCompletionUsage`](LlmapiChatCompletionUsage.md)

Defined in: [src/client/types.gen.ts:867](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#867)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersGuestLimitResponse

# HandlersGuestLimitResponse

> **HandlersGuestLimitResponse** = `object`

Defined in: [src/client/types.gen.ts:870](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#870)

## Properties

### auth\_prompt?

> `optional` **auth\_prompt**: `string`

Defined in: [src/client/types.gen.ts:871](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#871)

***

### error?

> `optional` **error**: `string`

Defined in: [src/client/types.gen.ts:872](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#872)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersHealthResponse

# HandlersHealthResponse

> **HandlersHealthResponse** = `object`

Defined in: [src/client/types.gen.ts:875](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#875)

## Properties

### status

> **status**: `string`

Defined in: [src/client/types.gen.ts:879](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#879)

Status indicates the service health status

***

### timestamp

> **timestamp**: `number`

Defined in: [src/client/types.gen.ts:883](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#883)

Timestamp is the Unix timestamp of the response

***

### version

> **version**: `string`

Defined in: [src/client/types.gen.ts:887](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#887)

Version is the current API version

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersListApiKeysResponse

# HandlersListApiKeysResponse

> **HandlersListApiKeysResponse** = `object`

Defined in: [src/client/types.gen.ts:890](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#890)

## Properties

### api\_keys

> **api\_keys**: [`HandlersApiKeyResponse`](HandlersApiKeyResponse.md)\[]

Defined in: [src/client/types.gen.ts:891](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#891)

***

### pagination

> **pagination**: [`HandlersPaginationResponse`](HandlersPaginationResponse.md)

Defined in: [src/client/types.gen.ts:892](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#892)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersListAppsResponse

# HandlersListAppsResponse

> **HandlersListAppsResponse** = `object`

Defined in: [src/client/types.gen.ts:895](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#895)

## Properties

### apps

> **apps**: [`HandlersAppResponse`](HandlersAppResponse.md)\[]

Defined in: [src/client/types.gen.ts:896](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#896)

***

### pagination

> **pagination**: [`HandlersPaginationResponse`](HandlersPaginationResponse.md)

Defined in: [src/client/types.gen.ts:897](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#897)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersListDeveloperApiKeysResponse

# HandlersListDeveloperApiKeysResponse

> **HandlersListDeveloperApiKeysResponse** = `object`

Defined in: [src/client/types.gen.ts:900](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#900)

## Properties

### api\_keys

> **api\_keys**: [`HandlersDeveloperApiKeyResponse`](HandlersDeveloperApiKeyResponse.md)\[]

Defined in: [src/client/types.gen.ts:901](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#901)

***

### pagination

> **pagination**: [`HandlersPaginationResponse`](HandlersPaginationResponse.md)

Defined in: [src/client/types.gen.ts:902](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#902)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersListDeveloperAppsResponse

# HandlersListDeveloperAppsResponse

> **HandlersListDeveloperAppsResponse** = `object`

Defined in: [src/client/types.gen.ts:905](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#905)

## Properties

### apps

> **apps**: [`HandlersDeveloperAppResponse`](HandlersDeveloperAppResponse.md)\[]

Defined in: [src/client/types.gen.ts:906](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#906)

***

### pagination

> **pagination**: [`HandlersPaginationResponse`](HandlersPaginationResponse.md)

Defined in: [src/client/types.gen.ts:907](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#907)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersListOAuthClientsResponse

# HandlersListOAuthClientsResponse

> **HandlersListOAuthClientsResponse** = `object`

Defined in: [src/client/types.gen.ts:910](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#910)

## Properties

### clients?

> `optional` **clients**: [`HandlersOAuthClientResponse`](HandlersOAuthClientResponse.md)\[]

Defined in: [src/client/types.gen.ts:911](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#911)

***

### pagination?

> `optional` **pagination**: [`HandlersPaginationResponse`](HandlersPaginationResponse.md)

Defined in: [src/client/types.gen.ts:912](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#912)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersListUserApiKeysResponse

# HandlersListUserApiKeysResponse

> **HandlersListUserApiKeysResponse** = `object`

Defined in: [src/client/types.gen.ts:915](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#915)

## Properties

### api\_keys

> **api\_keys**: [`HandlersUserApiKeyResponse`](HandlersUserApiKeyResponse.md)\[]

Defined in: [src/client/types.gen.ts:916](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#916)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersListUsersResponse

# HandlersListUsersResponse

> **HandlersListUsersResponse** = `object`

Defined in: [src/client/types.gen.ts:919](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#919)

## Properties

### pagination

> **pagination**: [`HandlersPaginationResponse`](HandlersPaginationResponse.md)

Defined in: [src/client/types.gen.ts:920](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#920)

***

### users

> **users**: [`HandlersDeveloperUserResponse`](HandlersDeveloperUserResponse.md)\[]

Defined in: [src/client/types.gen.ts:921](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#921)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersMfaSessionResponse

# HandlersMfaSessionResponse

> **HandlersMfaSessionResponse** = `object`

Defined in: [src/client/types.gen.ts:1672](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1672)

## Properties

### expires\_at?

> `optional` **expires\_at**: `string`

Defined in: [src/client/types.gen.ts:1673](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1673)

***

### mfa\_session\_token?

> `optional` **mfa\_session\_token**: `string`

Defined in: [src/client/types.gen.ts:1674](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1674)

***

### recovery\_codes?

> `optional` **recovery\_codes**: `string`\[]

Defined in: [src/client/types.gen.ts:1675](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1675)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersMfaStatusResponse

# HandlersMfaStatusResponse

> **HandlersMfaStatusResponse** = `object`

Defined in: [src/client/types.gen.ts:924](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#924)

## Properties

### enabled?

> `optional` **enabled**: `boolean`

Defined in: [src/client/types.gen.ts:925](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#925)

***

### enrolled\_at?

> `optional` **enrolled\_at**: `string`

Defined in: [src/client/types.gen.ts:926](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#926)

***

### methods?

> `optional` **methods**: `string`\[]

Defined in: [src/client/types.gen.ts:927](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#927)

***

### passkey\_credentials?

> `optional` **passkey\_credentials**: [`HandlersPasskeyCredentialDto`](HandlersPasskeyCredentialDto.md)\[]

Defined in: [src/client/types.gen.ts:928](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#928)

***

### recovery\_codes\_remaining?

> `optional` **recovery\_codes\_remaining**: `number`

Defined in: [src/client/types.gen.ts:929](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#929)

***

### sms?

> `optional` **sms**: [`HandlersSmsStatusDto`](HandlersSmsStatusDto.md)

Defined in: [src/client/types.gen.ts:930](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#930)

***

### sms\_eligible\_for\_enrollment?

> `optional` **sms\_eligible\_for\_enrollment**: `boolean`

Defined in: [src/client/types.gen.ts:931](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#931)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersModalityUsageItem

# HandlersModalityUsageItem

> **HandlersModalityUsageItem** = `object`

Defined in: [src/client/types.gen.ts:934](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#934)

## Properties

### cost\_usd

> **cost\_usd**: `number`

Defined in: [src/client/types.gen.ts:935](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#935)

***

### credits

> **credits**: `number`

Defined in: [src/client/types.gen.ts:936](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#936)

***

### modality

> **modality**: `string`

Defined in: [src/client/types.gen.ts:937](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#937)

***

### request\_count

> **request\_count**: `number`

Defined in: [src/client/types.gen.ts:938](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#938)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersModelToolUsageItem

# HandlersModelToolUsageItem

> **HandlersModelToolUsageItem** = `object`

Defined in: [src/client/types.gen.ts:941](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#941)

## Properties

### call\_count

> **call\_count**: `number`

Defined in: [src/client/types.gen.ts:942](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#942)

***

### cost\_usd

> **cost\_usd**: `number`

Defined in: [src/client/types.gen.ts:943](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#943)

***

### model

> **model**: `string`

Defined in: [src/client/types.gen.ts:944](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#944)

***

### tools

> **tools**: [`HandlersToolCallDetailItem`](HandlersToolCallDetailItem.md)\[]

Defined in: [src/client/types.gen.ts:945](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#945)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersModelUsageItem

# HandlersModelUsageItem

> **HandlersModelUsageItem** = `object`

Defined in: [src/client/types.gen.ts:948](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#948)

## Properties

### cost\_usd

> **cost\_usd**: `number`

Defined in: [src/client/types.gen.ts:949](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#949)

***

### model

> **model**: `string`

Defined in: [src/client/types.gen.ts:950](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#950)

***

### request\_count

> **request\_count**: `number`

Defined in: [src/client/types.gen.ts:951](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#951)

***

### request\_tokens

> **request\_tokens**: `number`

Defined in: [src/client/types.gen.ts:952](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#952)

***

### response\_tokens

> **response\_tokens**: `number`

Defined in: [src/client/types.gen.ts:953](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#953)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersOAuthClientResponse

# HandlersOAuthClientResponse

> **HandlersOAuthClientResponse** = `object`

Defined in: [src/client/types.gen.ts:956](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#956)

## Properties

### agent\_server\_url?

> `optional` **agent\_server\_url**: `string`

Defined in: [src/client/types.gen.ts:957](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#957)

***

### allowed\_redirect\_uris?

> `optional` **allowed\_redirect\_uris**: `string`\[]

Defined in: [src/client/types.gen.ts:958](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#958)

***

### allowed\_scopes?

> `optional` **allowed\_scopes**: `string`\[]

Defined in: [src/client/types.gen.ts:959](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#959)

***

### client\_id?

> `optional` **client\_id**: `string`

Defined in: [src/client/types.gen.ts:960](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#960)

***

### created\_at?

> `optional` **created\_at**: `string`

Defined in: [src/client/types.gen.ts:961](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#961)

***

### is\_public\_client?

> `optional` **is\_public\_client**: `boolean`

Defined in: [src/client/types.gen.ts:962](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#962)

***

### name?

> `optional` **name**: `string`

Defined in: [src/client/types.gen.ts:963](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#963)

***

### owner\_org?

> `optional` **owner\_org**: `string`

Defined in: [src/client/types.gen.ts:964](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#964)

***

### status?

> `optional` **status**: `string`

Defined in: [src/client/types.gen.ts:965](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#965)

***

### updated\_at?

> `optional` **updated\_at**: `string`

Defined in: [src/client/types.gen.ts:966](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#966)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersOauthTokenError

# HandlersOauthTokenError

> **HandlersOauthTokenError** = `object`

Defined in: [src/client/types.gen.ts:1678](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1678)

## Properties

### error?

> `optional` **error**: `string`

Defined in: [src/client/types.gen.ts:1679](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1679)

***

### error\_description?

> `optional` **error\_description**: `string`

Defined in: [src/client/types.gen.ts:1680](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1680)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersOAuthTokenResponse

# HandlersOAuthTokenResponse

> **HandlersOAuthTokenResponse** = `object`

Defined in: [src/client/types.gen.ts:969](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#969)

## Properties

### access\_token?

> `optional` **access\_token**: `string`

Defined in: [src/client/types.gen.ts:970](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#970)

***

### expires\_in?

> `optional` **expires\_in**: `number`

Defined in: [src/client/types.gen.ts:971](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#971)

***

### refresh\_token?

> `optional` **refresh\_token**: `string`

Defined in: [src/client/types.gen.ts:972](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#972)

***

### scope?

> `optional` **scope**: `string`

Defined in: [src/client/types.gen.ts:973](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#973)

***

### token\_type?

> `optional` **token\_type**: `string`

Defined in: [src/client/types.gen.ts:974](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#974)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersPaginationResponse

# HandlersPaginationResponse

> **HandlersPaginationResponse** = `object`

Defined in: [src/client/types.gen.ts:977](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#977)

## Properties

### limit

> **limit**: `number`

Defined in: [src/client/types.gen.ts:978](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#978)

***

### offset

> **offset**: `number`

Defined in: [src/client/types.gen.ts:979](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#979)

***

### total

> **total**: `number`

Defined in: [src/client/types.gen.ts:980](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#980)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersPasskeyCredentialDto

# HandlersPasskeyCredentialDto

> **HandlersPasskeyCredentialDto** = `object`

Defined in: [src/client/types.gen.ts:1683](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1683)

## Properties

### created\_at?

> `optional` **created\_at**: `string`

Defined in: [src/client/types.gen.ts:1684](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1684)

***

### id?

> `optional` **id**: `string`

Defined in: [src/client/types.gen.ts:1685](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1685)

***

### label?

> `optional` **label**: `string`

Defined in: [src/client/types.gen.ts:1686](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1686)

***

### last\_used\_at?

> `optional` **last\_used\_at**: `string`

Defined in: [src/client/types.gen.ts:1687](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1687)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersPasskeyDeleteResponse

# HandlersPasskeyDeleteResponse

> **HandlersPasskeyDeleteResponse** = `object`

Defined in: [src/client/types.gen.ts:1690](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1690)

## Properties

### remaining\_credentials?

> `optional` **remaining\_credentials**: [`HandlersPasskeyCredentialDto`](HandlersPasskeyCredentialDto.md)\[]

Defined in: [src/client/types.gen.ts:1691](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1691)

***

### removed?

> `optional` **removed**: `boolean`

Defined in: [src/client/types.gen.ts:1692](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1692)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersPasskeyEnrollFinishRequest

# HandlersPasskeyEnrollFinishRequest

> **HandlersPasskeyEnrollFinishRequest** = `object`

Defined in: [src/client/types.gen.ts:1695](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1695)

## Index Signature

\[`key`: `string`]: `unknown`

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersPasskeyEnrollFinishResponse

# HandlersPasskeyEnrollFinishResponse

> **HandlersPasskeyEnrollFinishResponse** = `object`

Defined in: [src/client/types.gen.ts:1699](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1699)

## Properties

### credential\_id?

> `optional` **credential\_id**: `string`

Defined in: [src/client/types.gen.ts:1700](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1700)

***

### expires\_at?

> `optional` **expires\_at**: `string`

Defined in: [src/client/types.gen.ts:1701](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1701)

***

### label?

> `optional` **label**: `string`

Defined in: [src/client/types.gen.ts:1702](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1702)

***

### mfa\_session\_token?

> `optional` **mfa\_session\_token**: `string`

Defined in: [src/client/types.gen.ts:1703](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1703)

***

### recovery\_codes?

> `optional` **recovery\_codes**: `string`\[]

Defined in: [src/client/types.gen.ts:1704](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1704)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersPasskeyVerifyFinishRequest

# HandlersPasskeyVerifyFinishRequest

> **HandlersPasskeyVerifyFinishRequest** = `object`

Defined in: [src/client/types.gen.ts:1707](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1707)

## Index Signature

\[`key`: `string`]: `unknown`

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersPersonaListResponse

# HandlersPersonaListResponse

> **HandlersPersonaListResponse** = `object`

Defined in: [src/client/types.gen.ts:983](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#983)

## Properties

### personas

> **personas**: [`HandlersPersonaResponse`](HandlersPersonaResponse.md)\[]

Defined in: [src/client/types.gen.ts:984](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#984)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersPersonaResponse

# HandlersPersonaResponse

> **HandlersPersonaResponse** = `object`

Defined in: [src/client/types.gen.ts:987](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#987)

## Properties

### config

> **config**: `object`

Defined in: [src/client/types.gen.ts:988](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#988)

**Index Signature**

\[`key`: `string`]: `unknown`

***

### created\_at

> **created\_at**: `string`

Defined in: [src/client/types.gen.ts:991](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#991)

***

### id

> **id**: `number`

Defined in: [src/client/types.gen.ts:992](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#992)

***

### name

> **name**: `string`

Defined in: [src/client/types.gen.ts:993](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#993)

***

### updated\_at

> **updated\_at**: `string`

Defined in: [src/client/types.gen.ts:994](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#994)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersPhoneCallResponse

# HandlersPhoneCallResponse

> **HandlersPhoneCallResponse** = `object`

Defined in: [src/client/types.gen.ts:997](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#997)

## Properties

### answered\_by?

> `optional` **answered\_by**: `string`

Defined in: [src/client/types.gen.ts:998](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#998)

***

### call\_ended\_by?

> `optional` **call\_ended\_by**: `string`

Defined in: [src/client/types.gen.ts:999](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#999)

***

### call\_id

> **call\_id**: `string`

Defined in: [src/client/types.gen.ts:1000](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1000)

***

### completed?

> `optional` **completed**: `boolean`

Defined in: [src/client/types.gen.ts:1001](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1001)

***

### concatenated\_transcript?

> `optional` **concatenated\_transcript**: `string`

Defined in: [src/client/types.gen.ts:1002](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1002)

***

### created\_at?

> `optional` **created\_at**: `string`

Defined in: [src/client/types.gen.ts:1003](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1003)

***

### end\_reason?

> `optional` **end\_reason**: `string`

Defined in: [src/client/types.gen.ts:1004](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1004)

***

### ended\_at?

> `optional` **ended\_at**: `string`

Defined in: [src/client/types.gen.ts:1005](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1005)

***

### error\_message?

> `optional` **error\_message**: `string`

Defined in: [src/client/types.gen.ts:1006](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1006)

***

### phone\_number?

> `optional` **phone\_number**: `string`

Defined in: [src/client/types.gen.ts:1007](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1007)

***

### queue\_status?

> `optional` **queue\_status**: `string`

Defined in: [src/client/types.gen.ts:1008](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1008)

***

### recipient\_name?

> `optional` **recipient\_name**: `string`

Defined in: [src/client/types.gen.ts:1009](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1009)

***

### started\_at?

> `optional` **started\_at**: `string`

Defined in: [src/client/types.gen.ts:1010](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1010)

***

### status?

> `optional` **status**: `string`

Defined in: [src/client/types.gen.ts:1011](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1011)

***

### summary?

> `optional` **summary**: `string`

Defined in: [src/client/types.gen.ts:1012](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1012)

***

### transcripts?

> `optional` **transcripts**: [`HandlersPhoneCallTranscriptEntry`](HandlersPhoneCallTranscriptEntry.md)\[]

Defined in: [src/client/types.gen.ts:1013](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1013)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersPhoneCallTranscriptEntry

# HandlersPhoneCallTranscriptEntry

> **HandlersPhoneCallTranscriptEntry** = `object`

Defined in: [src/client/types.gen.ts:1016](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1016)

## Properties

### created\_at?

> `optional` **created\_at**: `string`

Defined in: [src/client/types.gen.ts:1017](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1017)

***

### speaker?

> `optional` **speaker**: `string`

Defined in: [src/client/types.gen.ts:1018](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1018)

***

### text?

> `optional` **text**: `string`

Defined in: [src/client/types.gen.ts:1019](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1019)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersPrivyIdentifierAuditEntry

# HandlersPrivyIdentifierAuditEntry

> **HandlersPrivyIdentifierAuditEntry** = `object`

Defined in: [src/client/types.gen.ts:1022](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1022)

## Properties

### account\_id?

> `optional` **account\_id**: `number`

Defined in: [src/client/types.gen.ts:1023](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1023)

***

### current\_address?

> `optional` **current\_address**: `string`

Defined in: [src/client/types.gen.ts:1024](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1024)

***

### embedded\_address?

> `optional` **embedded\_address**: `string`

Defined in: [src/client/types.gen.ts:1025](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1025)

***

### privy\_did?

> `optional` **privy\_did**: `string`

Defined in: [src/client/types.gen.ts:1026](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1026)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersPrivyIdentifierAuditResponse

# HandlersPrivyIdentifierAuditResponse

> **HandlersPrivyIdentifierAuditResponse** = `object`

Defined in: [src/client/types.gen.ts:1029](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1029)

## Properties

### already\_ok?

> `optional` **already\_ok**: `number`

Defined in: [src/client/types.gen.ts:1033](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1033)

current identifier already matches embedded

***

### api\_errors?

> `optional` **api\_errors**: `number`

Defined in: [src/client/types.gen.ts:1037](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1037)

transient Privy API failures

***

### entries?

> `optional` **entries**: [`HandlersPrivyIdentifierAuditEntry`](HandlersPrivyIdentifierAuditEntry.md)\[]

Defined in: [src/client/types.gen.ts:1041](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1041)

only includes WillChange entries

***

### limit?

> `optional` **limit**: `number`

Defined in: [src/client/types.gen.ts:1045](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1045)

limit applied to this request

***

### next\_offset?

> `optional` **next\_offset**: `number`

Defined in: [src/client/types.gen.ts:1049](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1049)

offset to pass next call; -1 when no more accounts remain

***

### no\_embedded?

> `optional` **no\_embedded**: `number`

Defined in: [src/client/types.gen.ts:1053](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1053)

user exists but has no embedded wallet

***

### no\_privy\_user?

> `optional` **no\_privy\_user**: `number`

Defined in: [src/client/types.gen.ts:1057](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1057)

Privy API 404 for this DID

***

### offset?

> `optional` **offset**: `number`

Defined in: [src/client/types.gen.ts:1061](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1061)

offset applied to this request

***

### total?

> `optional` **total**: `number`

Defined in: [src/client/types.gen.ts:1065](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1065)

accounts processed in this batch

***

### will\_change?

> `optional` **will\_change**: `number`

Defined in: [src/client/types.gen.ts:1069](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1069)

stored identifier differs from embedded (case-insensitive)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersPrivyIdentifierMigrateFailure

# HandlersPrivyIdentifierMigrateFailure

> **HandlersPrivyIdentifierMigrateFailure** = `object`

Defined in: [src/client/types.gen.ts:1072](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1072)

## Properties

### account\_id?

> `optional` **account\_id**: `number`

Defined in: [src/client/types.gen.ts:1073](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1073)

***

### privy\_did?

> `optional` **privy\_did**: `string`

Defined in: [src/client/types.gen.ts:1074](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1074)

***

### reason?

> `optional` **reason**: `string`

Defined in: [src/client/types.gen.ts:1075](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1075)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersPrivyIdentifierMigrateResponse

# HandlersPrivyIdentifierMigrateResponse

> **HandlersPrivyIdentifierMigrateResponse** = `object`

Defined in: [src/client/types.gen.ts:1078](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1078)

## Properties

### changes?

> `optional` **changes**: [`HandlersPrivyIdentifierAuditEntry`](HandlersPrivyIdentifierAuditEntry.md)\[]

Defined in: [src/client/types.gen.ts:1082](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1082)

accounts whose identifier was rewritten

***

### failed?

> `optional` **failed**: `number`

Defined in: [src/client/types.gen.ts:1086](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1086)

DB update or constraint failure

***

### failures?

> `optional` **failures**: [`HandlersPrivyIdentifierMigrateFailure`](HandlersPrivyIdentifierMigrateFailure.md)\[]

Defined in: [src/client/types.gen.ts:1087](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1087)

***

### limit?

> `optional` **limit**: `number`

Defined in: [src/client/types.gen.ts:1088](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1088)

***

### migrated?

> `optional` **migrated**: `number`

Defined in: [src/client/types.gen.ts:1089](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1089)

***

### next\_offset?

> `optional` **next\_offset**: `number`

Defined in: [src/client/types.gen.ts:1090](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1090)

***

### offset?

> `optional` **offset**: `number`

Defined in: [src/client/types.gen.ts:1091](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1091)

***

### skipped?

> `optional` **skipped**: `number`

Defined in: [src/client/types.gen.ts:1095](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1095)

already correct, no embedded, or Privy API miss

***

### total?

> `optional` **total**: `number`

Defined in: [src/client/types.gen.ts:1096](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1096)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersRedeemTokensRequest

# HandlersRedeemTokensRequest

> **HandlersRedeemTokensRequest** = `object`

Defined in: [src/client/types.gen.ts:1099](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1099)

## Properties

### amount?

> `optional` **amount**: `string`

Defined in: [src/client/types.gen.ts:1103](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1103)

Amount is the number of Anuma Tokens to burn (as a decimal string to handle large values).

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersRedeemTokensResponse

# HandlersRedeemTokensResponse

> **HandlersRedeemTokensResponse** = `object`

Defined in: [src/client/types.gen.ts:1106](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1106)

## Properties

### burn\_tx\_hash?

> `optional` **burn\_tx\_hash**: `string`

Defined in: [src/client/types.gen.ts:1107](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1107)

***

### credits\_awarded?

> `optional` **credits\_awarded**: `number`

Defined in: [src/client/types.gen.ts:1108](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1108)

***

### message?

> `optional` **message**: `string`

Defined in: [src/client/types.gen.ts:1109](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1109)

***

### redemption\_id?

> `optional` **redemption\_id**: `number`

Defined in: [src/client/types.gen.ts:1110](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1110)

***

### success?

> `optional` **success**: `boolean`

Defined in: [src/client/types.gen.ts:1111](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1111)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersRefreshRequest

# HandlersRefreshRequest

> **HandlersRefreshRequest** = `object`

Defined in: [src/client/types.gen.ts:1114](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1114)

## Properties

### refresh\_token

> **refresh\_token**: `string`

Defined in: [src/client/types.gen.ts:1115](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1115)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersRegisterTextResponse

# HandlersRegisterTextResponse

> **HandlersRegisterTextResponse** = `object`

Defined in: [src/client/types.gen.ts:1118](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1118)

## Properties

### status

> **status**: `string`

Defined in: [src/client/types.gen.ts:1119](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1119)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersRenewSubscriptionResponse

# HandlersRenewSubscriptionResponse

> **HandlersRenewSubscriptionResponse** = `object`

Defined in: [src/client/types.gen.ts:1122](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1122)

## Properties

### current\_period\_end?

> `optional` **current\_period\_end**: `number`

Defined in: [src/client/types.gen.ts:1123](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1123)

***

### message

> **message**: `string`

Defined in: [src/client/types.gen.ts:1124](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1124)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersRevokeRequest

# HandlersRevokeRequest

> **HandlersRevokeRequest** = `object`

Defined in: [src/client/types.gen.ts:1127](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1127)

## Properties

### token

> **token**: `string`

Defined in: [src/client/types.gen.ts:1128](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1128)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersScheduleDowngradeRequest

# HandlersScheduleDowngradeRequest

> **HandlersScheduleDowngradeRequest** = `object`

Defined in: [src/client/types.gen.ts:1131](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1131)

## Properties

### interval?

> `optional` **interval**: `string`

Defined in: [src/client/types.gen.ts:1135](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1135)

"month" or "year"; defaults to current interval

***

### tier?

> `optional` **tier**: `string`

Defined in: [src/client/types.gen.ts:1139](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1139)

target tier, e.g. "starter"

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersScheduleDowngradeResponse

# HandlersScheduleDowngradeResponse

> **HandlersScheduleDowngradeResponse** = `object`

Defined in: [src/client/types.gen.ts:1142](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1142)

## Properties

### current\_period\_end?

> `optional` **current\_period\_end**: `number`

Defined in: [src/client/types.gen.ts:1143](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1143)

***

### message

> **message**: `string`

Defined in: [src/client/types.gen.ts:1144](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1144)

***

### scheduled\_interval?

> `optional` **scheduled\_interval**: `string`

Defined in: [src/client/types.gen.ts:1148](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1148)

"month" or "year"

***

### scheduled\_plan

> **scheduled\_plan**: `string`

Defined in: [src/client/types.gen.ts:1149](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1149)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersSeedApiKeyInput

# HandlersSeedApiKeyInput

> **HandlersSeedApiKeyInput** = `object`

Defined in: [src/client/types.gen.ts:1152](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1152)

## Properties

### is\_active?

> `optional` **is\_active**: `boolean`

Defined in: [src/client/types.gen.ts:1153](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1153)

***

### is\_test?

> `optional` **is\_test**: `boolean`

Defined in: [src/client/types.gen.ts:1157](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1157)

If true, generates anuma\_test\_ prefix; otherwise anuma\_live\_

***

### name?

> `optional` **name**: `string`

Defined in: [src/client/types.gen.ts:1158](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1158)

***

### wallet\_address?

> `optional` **wallet\_address**: `string`

Defined in: [src/client/types.gen.ts:1159](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1159)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersSeedAppInput

# HandlersSeedAppInput

> **HandlersSeedAppInput** = `object`

Defined in: [src/client/types.gen.ts:1162](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1162)

## Properties

### api\_keys?

> `optional` **api\_keys**: [`HandlersSeedApiKeyInput`](HandlersSeedApiKeyInput.md)\[]

Defined in: [src/client/types.gen.ts:1163](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1163)

***

### app\_balance\_usd?

> `optional` **app\_balance\_usd**: `number`

Defined in: [src/client/types.gen.ts:1167](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1167)

Developer app balance in micro-USD

***

### credit\_reset\_enabled?

> `optional` **credit\_reset\_enabled**: `boolean`

Defined in: [src/client/types.gen.ts:1168](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1168)

***

### credits\_token\_address?

> `optional` **credits\_token\_address**: `string`

Defined in: [src/client/types.gen.ts:1172](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1172)

Per-app ERC20 credits token address

***

### default\_user\_cost\_limit\_usd?

> `optional` **default\_user\_cost\_limit\_usd**: `number`

Defined in: [src/client/types.gen.ts:1176](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1176)

Default credits for auto-enrollment in micro-USD

***

### developer\_account\_id?

> `optional` **developer\_account\_id**: `number`

Defined in: [src/client/types.gen.ts:1180](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1180)

Developer account ID (makes app developer-owned)

***

### developer\_wallet\_address?

> `optional` **developer\_wallet\_address**: `string`

Defined in: [src/client/types.gen.ts:1184](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1184)

Developer wallet (auto-creates account if not exists)

***

### is\_active?

> `optional` **is\_active**: `boolean`

Defined in: [src/client/types.gen.ts:1185](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1185)

***

### name?

> `optional` **name**: `string`

Defined in: [src/client/types.gen.ts:1186](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1186)

***

### phone\_call\_voice?

> `optional` **phone\_call\_voice**: `string`

Defined in: [src/client/types.gen.ts:1187](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1187)

***

### privy\_app\_id?

> `optional` **privy\_app\_id**: `string`

Defined in: [src/client/types.gen.ts:1188](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1188)

***

### privy\_verification\_key?

> `optional` **privy\_verification\_key**: `string`

Defined in: [src/client/types.gen.ts:1189](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1189)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersSeedAppsRequest

# HandlersSeedAppsRequest

> **HandlersSeedAppsRequest** = `object`

Defined in: [src/client/types.gen.ts:1192](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1192)

## Properties

### apps?

> `optional` **apps**: [`HandlersSeedAppInput`](HandlersSeedAppInput.md)\[]

Defined in: [src/client/types.gen.ts:1193](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1193)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersSeedAppsResponse

# HandlersSeedAppsResponse

> **HandlersSeedAppsResponse** = `object`

Defined in: [src/client/types.gen.ts:1196](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1196)

## Properties

### apps\_seeded

> **apps\_seeded**: `number`

Defined in: [src/client/types.gen.ts:1197](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1197)

***

### generated\_keys?

> `optional` **generated\_keys**: `object`

Defined in: [src/client/types.gen.ts:1201](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1201)

Map of app name to generated keys

**Index Signature**

\[`key`: `string`]: [`HandlersGeneratedApiKey`](HandlersGeneratedApiKey.md)\[]

***

### keys\_seeded

> **keys\_seeded**: `number`

Defined in: [src/client/types.gen.ts:1204](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1204)

***

### message?

> `optional` **message**: `string`

Defined in: [src/client/types.gen.ts:1205](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1205)

***

### success

> **success**: `boolean`

Defined in: [src/client/types.gen.ts:1206](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1206)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersSetSubscriptionTierRequest

# HandlersSetSubscriptionTierRequest

> **HandlersSetSubscriptionTierRequest** = `object`

Defined in: [src/client/types.gen.ts:1209](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1209)

## Properties

### app\_id?

> `optional` **app\_id**: `number`

Defined in: [src/client/types.gen.ts:1213](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1213)

Required to identify which app enrollment to update

***

### tier?

> `optional` **tier**: `string`

Defined in: [src/client/types.gen.ts:1217](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1217)

"basic" or "pro"

***

### user\_address?

> `optional` **user\_address**: `string`

Defined in: [src/client/types.gen.ts:1218](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1218)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersSetSubscriptionTierResponse

# HandlersSetSubscriptionTierResponse

> **HandlersSetSubscriptionTierResponse** = `object`

Defined in: [src/client/types.gen.ts:1221](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1221)

## Properties

### message?

> `optional` **message**: `string`

Defined in: [src/client/types.gen.ts:1222](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1222)

***

### success

> **success**: `boolean`

Defined in: [src/client/types.gen.ts:1223](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1223)

***

### tier

> **tier**: `string`

Defined in: [src/client/types.gen.ts:1224](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1224)

***

### user\_address

> **user\_address**: `string`

Defined in: [src/client/types.gen.ts:1225](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1225)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersSetUserAgentPreferenceRequest

# HandlersSetUserAgentPreferenceRequest

> **HandlersSetUserAgentPreferenceRequest** = `object`

Defined in: [src/client/types.gen.ts:1228](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1228)

## Properties

### preferred\_model?

> `optional` **preferred\_model**: `string`

Defined in: [src/client/types.gen.ts:1232](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1232)

PreferredModel is the model to use for this agent.

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersSmsStatusDto

# HandlersSmsStatusDto

> **HandlersSmsStatusDto** = `object`

Defined in: [src/client/types.gen.ts:1711](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1711)

## Properties

### enrolled?

> `optional` **enrolled**: `boolean`

Defined in: [src/client/types.gen.ts:1712](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1712)

***

### enrolled\_at?

> `optional` **enrolled\_at**: `string`

Defined in: [src/client/types.gen.ts:1713](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1713)

***

### phone\_e164\_masked?

> `optional` **phone\_e164\_masked**: `string`

Defined in: [src/client/types.gen.ts:1714](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1714)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersSubscriptionPlan

# HandlersSubscriptionPlan

> **HandlersSubscriptionPlan** = `object`

Defined in: [src/client/types.gen.ts:1235](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1235)

## Properties

### annual\_credits

> **annual\_credits**: `number`

Defined in: [src/client/types.gen.ts:1236](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1236)

***

### annual\_price

> **annual\_price**: `number`

Defined in: [src/client/types.gen.ts:1237](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1237)

***

### currency

> **currency**: `string`

Defined in: [src/client/types.gen.ts:1238](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1238)

***

### monthly\_credits

> **monthly\_credits**: `number`

Defined in: [src/client/types.gen.ts:1239](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1239)

***

### monthly\_price

> **monthly\_price**: `number`

Defined in: [src/client/types.gen.ts:1240](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1240)

***

### tier

> **tier**: `string`

Defined in: [src/client/types.gen.ts:1241](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1241)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersSubscriptionPlansResponse

# HandlersSubscriptionPlansResponse

> **HandlersSubscriptionPlansResponse** = `object`

Defined in: [src/client/types.gen.ts:1244](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1244)

## Properties

### plans

> **plans**: [`HandlersSubscriptionPlan`](HandlersSubscriptionPlan.md)\[]

Defined in: [src/client/types.gen.ts:1245](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1245)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersSubscriptionStatusResponse

# HandlersSubscriptionStatusResponse

> **HandlersSubscriptionStatusResponse** = `object`

Defined in: [src/client/types.gen.ts:1248](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1248)

## Properties

### cancel\_at\_period\_end

> **cancel\_at\_period\_end**: `boolean`

Defined in: [src/client/types.gen.ts:1252](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1252)

true if scheduled to cancel

***

### current\_period\_end?

> `optional` **current\_period\_end**: `number`

Defined in: [src/client/types.gen.ts:1256](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1256)

Unix timestamp, only present if subscribed

***

### interval?

> `optional` **interval**: `string`

Defined in: [src/client/types.gen.ts:1260](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1260)

"month" | "year", only present if subscribed

***

### payment\_provider?

> `optional` **payment\_provider**: `string`

Defined in: [src/client/types.gen.ts:1264](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1264)

"stripe" | "revenuecat" | "staking" — tells the client how to manage subscription (no portal for "staking"; manage on-chain)

***

### plan

> **plan**: `string`

Defined in: [src/client/types.gen.ts:1268](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1268)

"free" | "starter" | "pro"

***

### scheduled\_interval?

> `optional` **scheduled\_interval**: `string`

Defined in: [src/client/types.gen.ts:1272](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1272)

billing interval of the scheduled plan

***

### scheduled\_plan?

> `optional` **scheduled\_plan**: `string`

Defined in: [src/client/types.gen.ts:1276](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1276)

tier user will switch to at period end

***

### status

> **status**: `string`

Defined in: [src/client/types.gen.ts:1280](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1280)

"none" | "active" | "canceling" | "past\_due" | "canceled"

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersTokenResponse

# HandlersTokenResponse

> **HandlersTokenResponse** = `object`

Defined in: [src/client/types.gen.ts:1283](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1283)

## Properties

### access\_token

> **access\_token**: `string`

Defined in: [src/client/types.gen.ts:1284](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1284)

***

### expires\_in

> **expires\_in**: `number`

Defined in: [src/client/types.gen.ts:1288](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1288)

Seconds until expiration

***

### refresh\_token?

> `optional` **refresh\_token**: `string`

Defined in: [src/client/types.gen.ts:1292](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1292)

May not be present on refresh

***

### scope?

> `optional` **scope**: `string`

Defined in: [src/client/types.gen.ts:1296](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1296)

Granted scopes

***

### token\_type

> **token\_type**: `string`

Defined in: [src/client/types.gen.ts:1300](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1300)

Usually "Bearer"

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersTool

# HandlersTool

> **HandlersTool** = `object`

Defined in: [src/client/types.gen.ts:1303](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1303)

## Properties

### cost

> **cost**: `number`

Defined in: [src/client/types.gen.ts:1304](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1304)

***

### embedding

> **embedding**: `number`\[]

Defined in: [src/client/types.gen.ts:1305](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1305)

***

### name

> **name**: `string`

Defined in: [src/client/types.gen.ts:1306](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1306)

***

### schema

> **schema**: [`McpToolSchema`](McpToolSchema.md)

Defined in: [src/client/types.gen.ts:1307](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1307)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersToolCallDetailItem

# HandlersToolCallDetailItem

> **HandlersToolCallDetailItem** = `object`

Defined in: [src/client/types.gen.ts:1310](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1310)

## Properties

### call\_count

> **call\_count**: `number`

Defined in: [src/client/types.gen.ts:1311](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1311)

***

### cost\_usd

> **cost\_usd**: `number`

Defined in: [src/client/types.gen.ts:1312](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1312)

***

### tool

> **tool**: `string`

Defined in: [src/client/types.gen.ts:1313](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1313)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersTopUpUserRequest

# HandlersTopUpUserRequest

> **HandlersTopUpUserRequest** = `object`

Defined in: [src/client/types.gen.ts:1316](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1316)

## Properties

### credits?

> `optional` **credits**: `number`

Defined in: [src/client/types.gen.ts:1320](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1320)

credits to add (1 credit = $0.01)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersTotpEnrollInitResponse

# HandlersTotpEnrollInitResponse

> **HandlersTotpEnrollInitResponse** = `object`

Defined in: [src/client/types.gen.ts:1717](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1717)

## Properties

### otpauth\_uri?

> `optional` **otpauth\_uri**: `string`

Defined in: [src/client/types.gen.ts:1718](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1718)

***

### secret\_base32?

> `optional` **secret\_base32**: `string`

Defined in: [src/client/types.gen.ts:1719](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1719)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersTotpVerifyRequest

# HandlersTotpVerifyRequest

> **HandlersTotpVerifyRequest** = `object`

Defined in: [src/client/types.gen.ts:1722](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1722)

## Properties

### code?

> `optional` **code**: `string`

Defined in: [src/client/types.gen.ts:1723](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1723)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersUnregisterTextResponse

# HandlersUnregisterTextResponse

> **HandlersUnregisterTextResponse** = `object`

Defined in: [src/client/types.gen.ts:1323](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1323)

## Properties

### status

> **status**: `string`

Defined in: [src/client/types.gen.ts:1324](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1324)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersUpdateAgentRequest

# HandlersUpdateAgentRequest

> **HandlersUpdateAgentRequest** = `object`

Defined in: [src/client/types.gen.ts:1334](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1334)

## Properties

### agent\_server\_url?

> `optional` **agent\_server\_url**: `string`

Defined in: [src/client/types.gen.ts:1338](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1338)

AgentServerURL is the URL of the agent's server runtime endpoint.

***

### category?

> `optional` **category**: `string`

Defined in: [src/client/types.gen.ts:1342](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1342)

Category groups agents by use case.

***

### color?

> `optional` **color**: `string`

Defined in: [src/client/types.gen.ts:1346](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1346)

Color is a hex or CSS variable for agent theming.

***

### description?

> `optional` **description**: `string`

Defined in: [src/client/types.gen.ts:1350](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1350)

Description is a short description of the agent's purpose.

***

### display\_order?

> `optional` **display\_order**: `number`

Defined in: [src/client/types.gen.ts:1354](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1354)

DisplayOrder controls the sort position in listing endpoints (lower = first).

***

### example\_conversations?

> `optional` **example\_conversations**: `object`\[]

Defined in: [src/client/types.gen.ts:1358](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1358)

ExampleConversations is a list of sample Q\&A pairs for the marketplace.

**Index Signature**

\[`key`: `string`]: `string`

***

### features?

> `optional` **features**: `string`\[]

Defined in: [src/client/types.gen.ts:1364](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1364)

Features is a list of user-facing capability descriptions.

***

### icon\_url?

> `optional` **icon\_url**: `string`

Defined in: [src/client/types.gen.ts:1368](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1368)

IconURL is the URL to the agent's icon.

***

### is\_featured?

> `optional` **is\_featured**: `boolean`

Defined in: [src/client/types.gen.ts:1372](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1372)

IsFeatured indicates whether to highlight the agent in the marketplace.

***

### model\_config?

> `optional` **model\_config**: `object`

Defined in: [src/client/types.gen.ts:1376](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1376)

ModelConfig is the model whitelist, display names, and descriptions.

**Index Signature**

\[`key`: `string`]: `unknown`

***

### name?

> `optional` **name**: `string`

Defined in: [src/client/types.gen.ts:1382](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1382)

Name is the human-readable name of the agent.

***

### parent\_id?

> `optional` **parent\_id**: `number`

Defined in: [src/client/types.gen.ts:1386](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1386)

ParentID is the optional parent agent ID for sub-agent relationships.

***

### recommended\_model?

> `optional` **recommended\_model**: `string`

Defined in: [src/client/types.gen.ts:1390](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1390)

RecommendedModel is the suggested default model.

***

### runtimes?

> `optional` **runtimes**: `string`\[]

Defined in: [src/client/types.gen.ts:1394](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1394)

Runtimes is the list of runtime environments the agent supports (e.g., "client", "server").

***

### skills?

> `optional` **skills**: `string`\[]

Defined in: [src/client/types.gen.ts:1398](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1398)

Skills is the list of skill identifiers bound to this agent.

***

### status?

> `optional` **status**: `string`

Defined in: [src/client/types.gen.ts:1402](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1402)

Status is the agent's availability: "active", "coming\_soon", or "disabled".

***

### system\_prompt?

> `optional` **system\_prompt**: `string`

Defined in: [src/client/types.gen.ts:1406](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1406)

SystemPrompt is the curated system prompt.

***

### tagline?

> `optional` **tagline**: `string`

Defined in: [src/client/types.gen.ts:1410](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1410)

Tagline is a short one-liner for marketplace cards.

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersUpdateApiKeyRequest

# HandlersUpdateApiKeyRequest

> **HandlersUpdateApiKeyRequest** = `object`

Defined in: [src/client/types.gen.ts:1327](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1327)

## Properties

### app\_id?

> `optional` **app\_id**: `number`

Defined in: [src/client/types.gen.ts:1328](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1328)

***

### is\_active?

> `optional` **is\_active**: `boolean`

Defined in: [src/client/types.gen.ts:1329](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1329)

***

### name?

> `optional` **name**: `string`

Defined in: [src/client/types.gen.ts:1330](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1330)

***

### wallet\_address?

> `optional` **wallet\_address**: `string`

Defined in: [src/client/types.gen.ts:1331](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1331)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersUpdateAppRequest

# HandlersUpdateAppRequest

> **HandlersUpdateAppRequest** = `object`

Defined in: [src/client/types.gen.ts:1413](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1413)

## Properties

### app\_balance\_usd?

> `optional` **app\_balance\_usd**: `number`

Defined in: [src/client/types.gen.ts:1414](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1414)

***

### credit\_reset\_enabled?

> `optional` **credit\_reset\_enabled**: `boolean`

Defined in: [src/client/types.gen.ts:1415](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1415)

***

### credits\_token\_address?

> `optional` **credits\_token\_address**: `string`

Defined in: [src/client/types.gen.ts:1416](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1416)

***

### default\_user\_cost\_limit\_usd?

> `optional` **default\_user\_cost\_limit\_usd**: `number`

Defined in: [src/client/types.gen.ts:1417](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1417)

***

### is\_active?

> `optional` **is\_active**: `boolean`

Defined in: [src/client/types.gen.ts:1418](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1418)

***

### name?

> `optional` **name**: `string`

Defined in: [src/client/types.gen.ts:1419](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1419)

***

### phone\_call\_voice?

> `optional` **phone\_call\_voice**: `string`

Defined in: [src/client/types.gen.ts:1420](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1420)

***

### privy\_app\_id?

> `optional` **privy\_app\_id**: `string`

Defined in: [src/client/types.gen.ts:1421](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1421)

***

### privy\_verification\_key?

> `optional` **privy\_verification\_key**: `string`

Defined in: [src/client/types.gen.ts:1422](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1422)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersUpdateDeveloperAppRequest

# HandlersUpdateDeveloperAppRequest

> **HandlersUpdateDeveloperAppRequest** = `object`

Defined in: [src/client/types.gen.ts:1425](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1425)

## Properties

### allowed\_origins?

> `optional` **allowed\_origins**: `string`\[]

Defined in: [src/client/types.gen.ts:1429](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1429)

nil=skip, \[]=clear, populated=set

***

### default\_user\_credits?

> `optional` **default\_user\_credits**: `number`

Defined in: [src/client/types.gen.ts:1433](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1433)

credits per new user (1 credit = $0.01)

***

### name?

> `optional` **name**: `string`

Defined in: [src/client/types.gen.ts:1434](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1434)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersUpdateGrantRequest

# HandlersUpdateGrantRequest

> **HandlersUpdateGrantRequest** = `object`

Defined in: [src/client/types.gen.ts:1726](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1726)

## Properties

### spending\_cap\_daily\_micro\_usd?

> `optional` **spending\_cap\_daily\_micro\_usd**: `number`

Defined in: [src/client/types.gen.ts:1727](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1727)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersUpdateOAuthClientRequest

# HandlersUpdateOAuthClientRequest

> **HandlersUpdateOAuthClientRequest** = `object`

Defined in: [src/client/types.gen.ts:1437](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1437)

## Properties

### agent\_server\_url?

> `optional` **agent\_server\_url**: `string`

Defined in: [src/client/types.gen.ts:1438](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1438)

***

### allowed\_redirect\_uris?

> `optional` **allowed\_redirect\_uris**: `string`\[]

Defined in: [src/client/types.gen.ts:1439](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1439)

***

### allowed\_scopes?

> `optional` **allowed\_scopes**: `string`\[]

Defined in: [src/client/types.gen.ts:1440](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1440)

***

### name?

> `optional` **name**: `string`

Defined in: [src/client/types.gen.ts:1441](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1441)

***

### status?

> `optional` **status**: `string`

Defined in: [src/client/types.gen.ts:1442](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1442)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersUpdatePersonaRequest

# HandlersUpdatePersonaRequest

> **HandlersUpdatePersonaRequest** = `object`

Defined in: [src/client/types.gen.ts:1445](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1445)

## Properties

### config?

> `optional` **config**: `object`

Defined in: [src/client/types.gen.ts:1449](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1449)

Config is the new persona configuration JSON.

**Index Signature**

\[`key`: `string`]: `unknown`

***

### name?

> `optional` **name**: `string`

Defined in: [src/client/types.gen.ts:1455](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1455)

Name is the new persona name.

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersUpdateUserLimitRequest

# HandlersUpdateUserLimitRequest

> **HandlersUpdateUserLimitRequest** = `object`

Defined in: [src/client/types.gen.ts:1458](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1458)

## Properties

### credits?

> `optional` **credits**: `number`

Defined in: [src/client/types.gen.ts:1462](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1462)

credit limit (1 credit = $0.01)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersUpgradeSubscriptionRequest

# HandlersUpgradeSubscriptionRequest

> **HandlersUpgradeSubscriptionRequest** = `object`

Defined in: [src/client/types.gen.ts:1465](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1465)

## Properties

### interval?

> `optional` **interval**: `string`

Defined in: [src/client/types.gen.ts:1469](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1469)

Optional: "month" or "year" (defaults to current)

***

### tier?

> `optional` **tier**: `string`

Defined in: [src/client/types.gen.ts:1473](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1473)

Required: "starter" or "pro"

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersUpgradeSubscriptionResponse

# HandlersUpgradeSubscriptionResponse

> **HandlersUpgradeSubscriptionResponse** = `object`

Defined in: [src/client/types.gen.ts:1476](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1476)

## Properties

### message

> **message**: `string`

Defined in: [src/client/types.gen.ts:1477](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1477)

***

### new\_interval

> **new\_interval**: `string`

Defined in: [src/client/types.gen.ts:1478](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1478)

***

### new\_plan

> **new\_plan**: `string`

Defined in: [src/client/types.gen.ts:1479](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1479)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersUsageByModalityResponse

# HandlersUsageByModalityResponse

> **HandlersUsageByModalityResponse** = `object`

Defined in: [src/client/types.gen.ts:1482](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1482)

## Properties

### modalities

> **modalities**: [`HandlersModalityUsageItem`](HandlersModalityUsageItem.md)\[]

Defined in: [src/client/types.gen.ts:1483](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1483)

***

### period

> **period**: [`HandlersUsagePeriod`](HandlersUsagePeriod.md)

Defined in: [src/client/types.gen.ts:1484](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1484)

***

### totals

> **totals**: [`HandlersUsageByModalityTotals`](HandlersUsageByModalityTotals.md)

Defined in: [src/client/types.gen.ts:1485](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1485)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersUsageByModalityTotals

# HandlersUsageByModalityTotals

> **HandlersUsageByModalityTotals** = `object`

Defined in: [src/client/types.gen.ts:1488](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1488)

## Properties

### cost\_usd

> **cost\_usd**: `number`

Defined in: [src/client/types.gen.ts:1489](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1489)

***

### credits

> **credits**: `number`

Defined in: [src/client/types.gen.ts:1490](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1490)

***

### request\_count

> **request\_count**: `number`

Defined in: [src/client/types.gen.ts:1491](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1491)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersUsageByModelResponse

# HandlersUsageByModelResponse

> **HandlersUsageByModelResponse** = `object`

Defined in: [src/client/types.gen.ts:1494](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1494)

## Properties

### models

> **models**: [`HandlersModelUsageItem`](HandlersModelUsageItem.md)\[]

Defined in: [src/client/types.gen.ts:1495](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1495)

***

### period

> **period**: [`HandlersUsagePeriod`](HandlersUsagePeriod.md)

Defined in: [src/client/types.gen.ts:1496](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1496)

***

### tool\_usage

> **tool\_usage**: [`HandlersModelToolUsageItem`](HandlersModelToolUsageItem.md)\[]

Defined in: [src/client/types.gen.ts:1497](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1497)

***

### totals

> **totals**: [`HandlersUsageTotals`](HandlersUsageTotals.md)

Defined in: [src/client/types.gen.ts:1498](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1498)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersUsagePeriod

# HandlersUsagePeriod

> **HandlersUsagePeriod** = `object`

Defined in: [src/client/types.gen.ts:1501](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1501)

## Properties

### end

> **end**: `string`

Defined in: [src/client/types.gen.ts:1502](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1502)

***

### start

> **start**: `string`

Defined in: [src/client/types.gen.ts:1503](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1503)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersUsageTimeseriesPoint

# HandlersUsageTimeseriesPoint

> **HandlersUsageTimeseriesPoint** = `object`

Defined in: [src/client/types.gen.ts:1506](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1506)

## Properties

### cost\_credits

> **cost\_credits**: `number`

Defined in: [src/client/types.gen.ts:1507](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1507)

***

### request\_count

> **request\_count**: `number`

Defined in: [src/client/types.gen.ts:1508](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1508)

***

### request\_tokens

> **request\_tokens**: `number`

Defined in: [src/client/types.gen.ts:1509](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1509)

***

### response\_tokens

> **response\_tokens**: `number`

Defined in: [src/client/types.gen.ts:1510](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1510)

***

### timestamp

> **timestamp**: `string`

Defined in: [src/client/types.gen.ts:1511](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1511)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersUsageTotals

# HandlersUsageTotals

> **HandlersUsageTotals** = `object`

Defined in: [src/client/types.gen.ts:1514](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1514)

## Properties

### cost\_usd

> **cost\_usd**: `number`

Defined in: [src/client/types.gen.ts:1515](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1515)

***

### request\_count

> **request\_count**: `number`

Defined in: [src/client/types.gen.ts:1516](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1516)

***

### tool\_call\_count

> **tool\_call\_count**: `number`

Defined in: [src/client/types.gen.ts:1517](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1517)

***

### tool\_cost\_usd

> **tool\_cost\_usd**: `number`

Defined in: [src/client/types.gen.ts:1518](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1518)

***

### total\_tokens

> **total\_tokens**: `number`

Defined in: [src/client/types.gen.ts:1519](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1519)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersUserAgentPreferenceResponse

# HandlersUserAgentPreferenceResponse

> **HandlersUserAgentPreferenceResponse** = `object`

Defined in: [src/client/types.gen.ts:1544](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1544)

## Properties

### agent\_id

> **agent\_id**: `number`

Defined in: [src/client/types.gen.ts:1548](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1548)

AgentID is the agent this preference applies to.

***

### preferred\_model

> **preferred\_model**: `string`

Defined in: [src/client/types.gen.ts:1552](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1552)

PreferredModel is the model the user chose for this agent.

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersUserAgentPreferencesListResponse

# HandlersUserAgentPreferencesListResponse

> **HandlersUserAgentPreferencesListResponse** = `object`

Defined in: [src/client/types.gen.ts:1555](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1555)

## Properties

### preferences

> **preferences**: [`HandlersUserAgentPreferenceResponse`](HandlersUserAgentPreferenceResponse.md)\[]

Defined in: [src/client/types.gen.ts:1559](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1559)

Preferences is the list of user agent preferences.

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersUserApiKeyRequest

# HandlersUserApiKeyRequest

> **HandlersUserApiKeyRequest** = `object`

Defined in: [src/client/types.gen.ts:1522](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1522)

## Properties

### name?

> `optional` **name**: `string`

Defined in: [src/client/types.gen.ts:1523](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1523)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersUserApiKeyResponse

# HandlersUserApiKeyResponse

> **HandlersUserApiKeyResponse** = `object`

Defined in: [src/client/types.gen.ts:1526](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1526)

## Properties

### created\_at

> **created\_at**: `string`

Defined in: [src/client/types.gen.ts:1527](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1527)

***

### id

> **id**: `number`

Defined in: [src/client/types.gen.ts:1528](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1528)

***

### is\_active

> **is\_active**: `boolean`

Defined in: [src/client/types.gen.ts:1529](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1529)

***

### name

> **name**: `string`

Defined in: [src/client/types.gen.ts:1530](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1530)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersUserApiKeyWithSecretResponse

# HandlersUserApiKeyWithSecretResponse

> **HandlersUserApiKeyWithSecretResponse** = `object`

Defined in: [src/client/types.gen.ts:1533](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1533)

## Properties

### api\_key

> **api\_key**: `string`

Defined in: [src/client/types.gen.ts:1537](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1537)

Full key, only shown once

***

### created\_at

> **created\_at**: `string`

Defined in: [src/client/types.gen.ts:1538](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1538)

***

### id

> **id**: `number`

Defined in: [src/client/types.gen.ts:1539](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1539)

***

### is\_active

> **is\_active**: `boolean`

Defined in: [src/client/types.gen.ts:1540](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1540)

***

### name

> **name**: `string`

Defined in: [src/client/types.gen.ts:1541](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1541)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersUserLookupAccount

# HandlersUserLookupAccount

> **HandlersUserLookupAccount** = `object`

Defined in: [src/client/types.gen.ts:1562](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1562)

## Properties

### created\_at?

> `optional` **created\_at**: `string`

Defined in: [src/client/types.gen.ts:1563](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1563)

***

### fraud\_flag?

> `optional` **fraud\_flag**: `string`

Defined in: [src/client/types.gen.ts:1564](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1564)

***

### fraud\_flag\_updated\_at?

> `optional` **fraud\_flag\_updated\_at**: `string`

Defined in: [src/client/types.gen.ts:1565](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1565)

***

### fraud\_notes?

> `optional` **fraud\_notes**: `string`

Defined in: [src/client/types.gen.ts:1566](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1566)

***

### id?

> `optional` **id**: `number`

Defined in: [src/client/types.gen.ts:1567](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1567)

***

### identifier?

> `optional` **identifier**: `string`

Defined in: [src/client/types.gen.ts:1568](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1568)

***

### stripe\_customer\_id?

> `optional` **stripe\_customer\_id**: `string`

Defined in: [src/client/types.gen.ts:1569](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1569)

***

### type?

> `optional` **type**: `string`

Defined in: [src/client/types.gen.ts:1570](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1570)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersUserLookupEnrollment

# HandlersUserLookupEnrollment

> **HandlersUserLookupEnrollment** = `object`

Defined in: [src/client/types.gen.ts:1573](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1573)

## Properties

### app\_id?

> `optional` **app\_id**: `number`

Defined in: [src/client/types.gen.ts:1574](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1574)

***

### app\_name?

> `optional` **app\_name**: `string`

Defined in: [src/client/types.gen.ts:1575](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1575)

***

### balance\_updated\_at?

> `optional` **balance\_updated\_at**: `string`

Defined in: [src/client/types.gen.ts:1576](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1576)

***

### cached\_balance\_usd?

> `optional` **cached\_balance\_usd**: `number`

Defined in: [src/client/types.gen.ts:1577](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1577)

***

### created\_at?

> `optional` **created\_at**: `string`

Defined in: [src/client/types.gen.ts:1578](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1578)

***

### id?

> `optional` **id**: `number`

Defined in: [src/client/types.gen.ts:1579](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1579)

***

### lifetime\_credits?

> `optional` **lifetime\_credits**: `number`

Defined in: [src/client/types.gen.ts:1580](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1580)

***

### pending\_cost\_usd?

> `optional` **pending\_cost\_usd**: `number`

Defined in: [src/client/types.gen.ts:1581](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1581)

***

### pro\_activated\_at?

> `optional` **pro\_activated\_at**: `string`

Defined in: [src/client/types.gen.ts:1582](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1582)

***

### starter\_activated\_at?

> `optional` **starter\_activated\_at**: `string`

Defined in: [src/client/types.gen.ts:1583](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1583)

***

### subscription\_tier?

> `optional` **subscription\_tier**: `string`

Defined in: [src/client/types.gen.ts:1584](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1584)

***

### updated\_at?

> `optional` **updated\_at**: `string`

Defined in: [src/client/types.gen.ts:1585](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1585)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersUserLookupResponse

# HandlersUserLookupResponse

> **HandlersUserLookupResponse** = `object`

Defined in: [src/client/types.gen.ts:1588](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1588)

## Properties

### account?

> `optional` **account**: [`HandlersUserLookupAccount`](HandlersUserLookupAccount.md)

Defined in: [src/client/types.gen.ts:1589](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1589)

***

### enrollments?

> `optional` **enrollments**: [`HandlersUserLookupEnrollment`](HandlersUserLookupEnrollment.md)\[]

Defined in: [src/client/types.gen.ts:1590](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1590)

***

### text\_registrations?

> `optional` **text\_registrations**: [`HandlersUserLookupTextReg`](HandlersUserLookupTextReg.md)\[]

Defined in: [src/client/types.gen.ts:1591](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1591)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersUserLookupTextReg

# HandlersUserLookupTextReg

> **HandlersUserLookupTextReg** = `object`

Defined in: [src/client/types.gen.ts:1594](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1594)

## Properties

### app\_id?

> `optional` **app\_id**: `number`

Defined in: [src/client/types.gen.ts:1595](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1595)

***

### channel?

> `optional` **channel**: `string`

Defined in: [src/client/types.gen.ts:1596](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1596)

***

### created\_at?

> `optional` **created\_at**: `string`

Defined in: [src/client/types.gen.ts:1597](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1597)

***

### id?

> `optional` **id**: `number`

Defined in: [src/client/types.gen.ts:1598](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1598)

***

### identifier?

> `optional` **identifier**: `string`

Defined in: [src/client/types.gen.ts:1599](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1599)

***

### is\_active?

> `optional` **is\_active**: `boolean`

Defined in: [src/client/types.gen.ts:1600](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1600)

***

### preferred\_model?

> `optional` **preferred\_model**: `string`

Defined in: [src/client/types.gen.ts:1601](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1601)

***

### updated\_at?

> `optional` **updated\_at**: `string`

Defined in: [src/client/types.gen.ts:1602](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1602)

***

### verified?

> `optional` **verified**: `boolean`

Defined in: [src/client/types.gen.ts:1603](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1603)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersUserUsageResponse

# HandlersUserUsageResponse

> **HandlersUserUsageResponse** = `object`

Defined in: [src/client/types.gen.ts:1606](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1606)

## Properties

### address

> **address**: `string`

Defined in: [src/client/types.gen.ts:1607](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1607)

***

### cost\_credits

> **cost\_credits**: `number`

Defined in: [src/client/types.gen.ts:1608](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1608)

***

### credits

> **credits**: `number`

Defined in: [src/client/types.gen.ts:1612](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1612)

available credits (remaining balance)

***

### request\_count

> **request\_count**: `number`

Defined in: [src/client/types.gen.ts:1613](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1613)

***

### request\_tokens

> **request\_tokens**: `number`

Defined in: [src/client/types.gen.ts:1614](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1614)

***

### response\_tokens

> **response\_tokens**: `number`

Defined in: [src/client/types.gen.ts:1615](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1615)

***

### used\_credits

> **used\_credits**: `number`

Defined in: [src/client/types.gen.ts:1619](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1619)

credits pending/in-flight

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersVerifyRequest

# HandlersVerifyRequest

> **HandlersVerifyRequest** = `object`

Defined in: [src/client/types.gen.ts:1730](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1730)

## Properties

### code?

> `optional` **code**: `string`

Defined in: [src/client/types.gen.ts:1731](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1731)

***

### method?

> `optional` **method**: `string`

Defined in: [src/client/types.gen.ts:1732](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1732)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/HandlersWalletDetails

# HandlersWalletDetails

> **HandlersWalletDetails** = `object`

Defined in: [src/client/types.gen.ts:1625](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1625)

Wallet account details

## Properties

### account\_created\_at?

> `optional` **account\_created\_at**: `string`

Defined in: [src/client/types.gen.ts:1629](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1629)

When account was first created

***

### account\_id?

> `optional` **account\_id**: `number`

Defined in: [src/client/types.gen.ts:1630](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1630)

***

### balance\_updated\_at?

> `optional` **balance\_updated\_at**: `string`

Defined in: [src/client/types.gen.ts:1634](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1634)

When balance was last synced from chain

***

### cached\_balance\_usd

> **cached\_balance\_usd**: `number`

Defined in: [src/client/types.gen.ts:1638](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1638)

Balance in micro-dollars (USD \* 1,000,000)

***

### pending\_cost\_usd

> **pending\_cost\_usd**: `number`

Defined in: [src/client/types.gen.ts:1642](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1642)

In-flight request holds in micro-dollars

***

### pro\_activated\_at?

> `optional` **pro\_activated\_at**: `string`

Defined in: [src/client/types.gen.ts:1646](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1646)

When user became Pro subscriber

***

### starter\_activated\_at?

> `optional` **starter\_activated\_at**: `string`

Defined in: [src/client/types.gen.ts:1650](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1650)

When user first became Starter subscriber

***

### subscription\_tier

> **subscription\_tier**: `string`

Defined in: [src/client/types.gen.ts:1654](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1654)

"basic", "starter", or "pro"

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/LlmapiChatCompletionExtraFields

# LlmapiChatCompletionExtraFields

> **LlmapiChatCompletionExtraFields** = `object`

Defined in: [src/client/types.gen.ts:1738](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1738)

ExtraFields contains additional metadata

## Properties

### latency?

> `optional` **latency**: `number`

Defined in: [src/client/types.gen.ts:1742](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1742)

Latency is the request latency in milliseconds

***

### model\_requested?

> `optional` **model\_requested**: `string`

Defined in: [src/client/types.gen.ts:1746](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1746)

ModelRequested is the model that was requested

***

### provider?

> `optional` **provider**: `string`

Defined in: [src/client/types.gen.ts:1750](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1750)

Provider is the LLM provider used (e.g., "openai", "anthropic")

***

### request\_type?

> `optional` **request\_type**: `string`

Defined in: [src/client/types.gen.ts:1754](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1754)

RequestType is always "chat\_completion"

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/LlmapiChatCompletionRequest

# LlmapiChatCompletionRequest

> **LlmapiChatCompletionRequest** = `object`

Defined in: [src/client/types.gen.ts:1757](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1757)

## Properties

### conversation\_id?

> `optional` **conversation\_id**: `string`

Defined in: [src/client/types.gen.ts:1762](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1762)

ConversationID groups requests belonging to the same conversation for observability.
Pass-through only — not forwarded to the LLM provider.

***

### image\_model?

> `optional` **image\_model**: `string`

Defined in: [src/client/types.gen.ts:1767](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1767)

ImageModel is the user-selected image generation model.
When set, the portal overrides the model field in image tool call arguments.

***

### messages

> **messages**: [`LlmapiMessage`](LlmapiMessage.md)\[]

Defined in: [src/client/types.gen.ts:1771](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1771)

Messages is the conversation history

***

### model

> **model**: `string`

Defined in: [src/client/types.gen.ts:1775](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1775)

Model is the model identifier

***

### stream?

> `optional` **stream**: `boolean`

Defined in: [src/client/types.gen.ts:1779](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1779)

Stream indicates if response should be streamed

***

### tool\_choice?

> `optional` **tool\_choice**: [`LlmapiChatCompletionToolChoice`](LlmapiChatCompletionToolChoice.md)

Defined in: [src/client/types.gen.ts:1780](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1780)

***

### tools?

> `optional` **tools**: [`LlmapiChatCompletionTool`](LlmapiChatCompletionTool.md)\[]

Defined in: [src/client/types.gen.ts:1784](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1784)

Tools is an array of tool schemas describing which tools the model can use

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/LlmapiChatCompletionResponse

# LlmapiChatCompletionResponse

> **LlmapiChatCompletionResponse** = `object`

Defined in: [src/client/types.gen.ts:1787](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1787)

## Properties

### choices?

> `optional` **choices**: [`LlmapiChoice`](LlmapiChoice.md)\[]

Defined in: [src/client/types.gen.ts:1791](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1791)

Choices contains the completion choices

***

### client\_injected\_tools?

> `optional` **client\_injected\_tools**: `string`\[]

Defined in: [src/client/types.gen.ts:1795](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1795)

ClientInjectedTools are tool names the client provided in the original request.

***

### extra\_fields?

> `optional` **extra\_fields**: [`LlmapiChatCompletionExtraFields`](LlmapiChatCompletionExtraFields.md)

Defined in: [src/client/types.gen.ts:1796](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1796)

***

### id?

> `optional` **id**: `string`

Defined in: [src/client/types.gen.ts:1800](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1800)

ID is the completion ID

***

### image\_model?

> `optional` **image\_model**: `string`

Defined in: [src/client/types.gen.ts:1806](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1806)

ImageModel is set when an image generation tool was called during the request.
This allows the client to detect that the response contains generated images
and render them appropriately, even when the orchestrating model is a text model.

***

### inference\_id?

> `optional` **inference\_id**: `string`

Defined in: [src/client/types.gen.ts:1810](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1810)

InferenceID is the unique identifier for this inference request

***

### messages?

> `optional` **messages**: [`LlmapiMessage`](LlmapiMessage.md)\[]

Defined in: [src/client/types.gen.ts:1817](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1817)

Messages contains the full conversation history when local tools need execution.
This is populated when the model requests tools that are not MCP tools (local/client-side tools).
The client should execute these tools and send a new request with this message history
plus the tool results appended.

***

### model?

> `optional` **model**: `string`

Defined in: [src/client/types.gen.ts:1821](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1821)

Model is the model used

***

### portal\_injected\_tools?

> `optional` **portal\_injected\_tools**: `string`\[]

Defined in: [src/client/types.gen.ts:1825](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1825)

PortalInjectedTools are tool names the portal's classifier added to the request.

***

### tool\_call\_events?

> `optional` **tool\_call\_events**: [`LlmapiToolCallEvent`](LlmapiToolCallEvent.md)\[]

Defined in: [src/client/types.gen.ts:1829](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1829)

ToolCallEvents is an array of tool call events.

***

### tools\_checksum?

> `optional` **tools\_checksum**: `string`

Defined in: [src/client/types.gen.ts:1833](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1833)

ToolsChecksum is the checksum of the tool schemas used by the AI Portal.

***

### usage?

> `optional` **usage**: [`LlmapiChatCompletionUsage`](LlmapiChatCompletionUsage.md)

Defined in: [src/client/types.gen.ts:1834](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1834)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/LlmapiChatCompletionTool

# LlmapiChatCompletionTool

> **LlmapiChatCompletionTool** = `object`

Defined in: [src/client/types.gen.ts:1837](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1837)

## Index Signature

\[`key`: `string`]: `unknown`

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/LlmapiChatCompletionToolChoice

# LlmapiChatCompletionToolChoice

> **LlmapiChatCompletionToolChoice** = `object`

Defined in: [src/client/types.gen.ts:1844](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1844)

ToolChoice controls tool usage

## Index Signature

\[`key`: `string`]: `unknown`

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/LlmapiChatCompletionUsage

# LlmapiChatCompletionUsage

> **LlmapiChatCompletionUsage** = `object`

Defined in: [src/client/types.gen.ts:1851](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1851)

Usage contains token usage information

## Properties

### completion\_tokens?

> `optional` **completion\_tokens**: `number`

Defined in: [src/client/types.gen.ts:1855](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1855)

CompletionTokens is the number of tokens in the completion

***

### cost\_micro\_usd?

> `optional` **cost\_micro\_usd**: `number`

Defined in: [src/client/types.gen.ts:1859](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1859)

CostMicroUSD is the cost of this completion in micro-dollars (USD × 1,000,000)

***

### credits\_used?

> `optional` **credits\_used**: `number`

Defined in: [src/client/types.gen.ts:1863](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1863)

CreditsUsed is the number of credits consumed by this completion (ceiling of cost / MicroUSDPerCredit)

***

### init\_completion\_tokens?

> `optional` **init\_completion\_tokens**: `number`

Defined in: [src/client/types.gen.ts:1867](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1867)

InitCompletionTokens is the completion token count from the first LLM call before the MCP tool loop

***

### init\_prompt\_tokens?

> `optional` **init\_prompt\_tokens**: `number`

Defined in: [src/client/types.gen.ts:1871](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1871)

InitPromptTokens is the prompt token count from the first LLM call before the MCP tool loop

***

### pricing\_source?

> `optional` **pricing\_source**: `string`

Defined in: [src/client/types.gen.ts:1875](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1875)

PricingSource identifies which lookup produced CostMicroUSD; see internal/pricing/source.go.

***

### prompt\_tokens?

> `optional` **prompt\_tokens**: `number`

Defined in: [src/client/types.gen.ts:1879](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1879)

PromptTokens is the number of tokens in the prompt

***

### provider\_cost\_micro\_usd?

> `optional` **provider\_cost\_micro\_usd**: `number`

Defined in: [src/client/types.gen.ts:1884](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1884)

ProviderCostMicroUSD is what we believe the provider charged us in micro-USD.
Today equals CostMicroUSD (no markup); kept distinct so future per-tier pricing preserves history.

***

### tool\_cost\_micro\_usd?

> `optional` **tool\_cost\_micro\_usd**: `number`

Defined in: [src/client/types.gen.ts:1888](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1888)

ToolCostMicroUSD is the cost of MCP tool calls in micro-dollars (subset of CostMicroUSD)

***

### total\_tokens?

> `optional` **total\_tokens**: `number`

Defined in: [src/client/types.gen.ts:1892](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1892)

TotalTokens is the total number of tokens used

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/LlmapiChoice

# LlmapiChoice

> **LlmapiChoice** = `object`

Defined in: [src/client/types.gen.ts:1895](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1895)

## Properties

### finish\_reason?

> `optional` **finish\_reason**: `string`

Defined in: [src/client/types.gen.ts:1899](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1899)

FinishReason indicates why the completion stopped

***

### index?

> `optional` **index**: `number`

Defined in: [src/client/types.gen.ts:1903](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1903)

Index is the choice index

***

### message?

> `optional` **message**: [`LlmapiMessage`](LlmapiMessage.md)

Defined in: [src/client/types.gen.ts:1904](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1904)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/LlmapiEmbeddingData

# LlmapiEmbeddingData

> **LlmapiEmbeddingData** = `object`

Defined in: [src/client/types.gen.ts:1907](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1907)

## Properties

### embedding?

> `optional` **embedding**: `number`\[]

Defined in: [src/client/types.gen.ts:1911](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1911)

Embedding vector

***

### index?

> `optional` **index**: `number`

Defined in: [src/client/types.gen.ts:1915](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1915)

Index of the embedding

***

### object?

> `optional` **object**: `string`

Defined in: [src/client/types.gen.ts:1919](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1919)

Object type identifier

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/LlmapiEmbeddingExtraFields

# LlmapiEmbeddingExtraFields

> **LlmapiEmbeddingExtraFields** = `object`

Defined in: [src/client/types.gen.ts:1925](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1925)

ExtraFields contains additional metadata

## Properties

### chunk\_index?

> `optional` **chunk\_index**: `number`

Defined in: [src/client/types.gen.ts:1929](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1929)

ChunkIndex is the chunk index (0 for single requests)

***

### latency?

> `optional` **latency**: `number`

Defined in: [src/client/types.gen.ts:1933](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1933)

Latency is the request latency in milliseconds

***

### model\_requested?

> `optional` **model\_requested**: `string`

Defined in: [src/client/types.gen.ts:1937](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1937)

ModelRequested is the model that was requested

***

### provider?

> `optional` **provider**: `string`

Defined in: [src/client/types.gen.ts:1941](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1941)

Provider is the LLM provider used (e.g., "openai", "anthropic")

***

### request\_type?

> `optional` **request\_type**: `string`

Defined in: [src/client/types.gen.ts:1945](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1945)

RequestType is always "embedding"

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/LlmapiEmbeddingRequest

# LlmapiEmbeddingRequest

> **LlmapiEmbeddingRequest** = `object`

Defined in: [src/client/types.gen.ts:1948](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1948)

## Properties

### conversation\_id?

> `optional` **conversation\_id**: `string`

Defined in: [src/client/types.gen.ts:1953](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1953)

ConversationID groups requests belonging to the same conversation for observability.
Pass-through only — not forwarded to the LLM provider.

***

### dimensions?

> `optional` **dimensions**: `number`

Defined in: [src/client/types.gen.ts:1957](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1957)

Dimensions is the number of dimensions the resulting output embeddings should have (optional)

***

### encoding\_format?

> `optional` **encoding\_format**: `string`

Defined in: [src/client/types.gen.ts:1961](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1961)

EncodingFormat is the format to return the embeddings in (optional: "float" or "base64")

***

### input

> **input**: `unknown`

Defined in: [src/client/types.gen.ts:1965](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1965)

Input text or tokens to embed (can be string, \[]string, \[]int, or \[]\[]int)

***

### model

> **model**: `string`

Defined in: [src/client/types.gen.ts:1969](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1969)

Model identifier in 'provider/model' format

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/LlmapiEmbeddingResponse

# LlmapiEmbeddingResponse

> **LlmapiEmbeddingResponse** = `object`

Defined in: [src/client/types.gen.ts:1972](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1972)

## Properties

### data?

> `optional` **data**: [`LlmapiEmbeddingData`](LlmapiEmbeddingData.md)\[]

Defined in: [src/client/types.gen.ts:1976](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1976)

Data contains the embeddings

***

### extra\_fields?

> `optional` **extra\_fields**: [`LlmapiEmbeddingExtraFields`](LlmapiEmbeddingExtraFields.md)

Defined in: [src/client/types.gen.ts:1977](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1977)

***

### inference\_id?

> `optional` **inference\_id**: `string`

Defined in: [src/client/types.gen.ts:1981](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1981)

InferenceID is the unique identifier for this inference request

***

### model?

> `optional` **model**: `string`

Defined in: [src/client/types.gen.ts:1985](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1985)

Model is the model used

***

### object?

> `optional` **object**: `string`

Defined in: [src/client/types.gen.ts:1989](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1989)

Object is always "list"

***

### usage?

> `optional` **usage**: [`LlmapiEmbeddingUsage`](LlmapiEmbeddingUsage.md)

Defined in: [src/client/types.gen.ts:1990](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1990)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/LlmapiEmbeddingUsage

# LlmapiEmbeddingUsage

> **LlmapiEmbeddingUsage** = `object`

Defined in: [src/client/types.gen.ts:1996](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#1996)

Usage contains token usage information

## Properties

### cost\_micro\_usd?

> `optional` **cost\_micro\_usd**: `number`

Defined in: [src/client/types.gen.ts:2000](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2000)

CostMicroUSD is the inference cost for this embedding request

***

### credits\_used?

> `optional` **credits\_used**: `number`

Defined in: [src/client/types.gen.ts:2004](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2004)

CreditsUsed is the number of credits consumed by this embedding request

***

### pricing\_source?

> `optional` **pricing\_source**: `string`

Defined in: [src/client/types.gen.ts:2008](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2008)

PricingSource identifies which lookup produced CostMicroUSD; see internal/pricing/source.go.

***

### prompt\_tokens?

> `optional` **prompt\_tokens**: `number`

Defined in: [src/client/types.gen.ts:2012](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2012)

PromptTokens is the number of tokens in the prompt

***

### provider\_cost\_micro\_usd?

> `optional` **provider\_cost\_micro\_usd**: `number`

Defined in: [src/client/types.gen.ts:2017](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2017)

ProviderCostMicroUSD is what we believe the provider charged us in micro-USD.
Today equals CostMicroUSD (no markup); kept distinct so future per-tier pricing preserves history.

***

### total\_tokens?

> `optional` **total\_tokens**: `number`

Defined in: [src/client/types.gen.ts:2021](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2021)

TotalTokens is the total number of tokens used

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/LlmapiMcpTool

# LlmapiMcpTool

> **LlmapiMcpTool** = `object`

Defined in: [src/client/types.gen.ts:2024](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2024)

## Properties

### description?

> `optional` **description**: `string`

Defined in: [src/client/types.gen.ts:2028](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2028)

Description is the description of the tool

***

### input\_schema?

> `optional` **input\_schema**: `unknown`

Defined in: [src/client/types.gen.ts:2032](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2032)

InputSchema is the JSON schema describing the tool's input

***

### name?

> `optional` **name**: `string`

Defined in: [src/client/types.gen.ts:2036](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2036)

Name is the name of the tool

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/LlmapiMessage

# LlmapiMessage

> **LlmapiMessage** = `object`

Defined in: [src/client/types.gen.ts:2042](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2042)

Message is the generated message

## Properties

### content?

> `optional` **content**: [`LlmapiMessageContentPart`](LlmapiMessageContentPart.md)\[]

Defined in: [src/client/types.gen.ts:2046](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2046)

Content is the message content

***

### role?

> `optional` **role**: [`LlmapiRole`](LlmapiRole.md)

Defined in: [src/client/types.gen.ts:2047](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2047)

***

### tool\_call\_id?

> `optional` **tool\_call\_id**: `string`

Defined in: [src/client/types.gen.ts:2051](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2051)

ToolCallID is the ID of the tool call this message is responding to (only for tool role)

***

### tool\_calls?

> `optional` **tool\_calls**: [`LlmapiToolCall`](LlmapiToolCall.md)\[]

Defined in: [src/client/types.gen.ts:2055](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2055)

ToolCalls contains tool/function calls made by the assistant (only for assistant role)

***

### type?

> `optional` **type**: `string`

Defined in: [src/client/types.gen.ts:2059](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2059)

Type is the message type (for Responses API: "message")

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/LlmapiMessageContentFile

# LlmapiMessageContentFile

> **LlmapiMessageContentFile** = `object`

Defined in: [src/client/types.gen.ts:2065](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2065)

File is used when Type=input\_file (for Responses API)

## Properties

### file\_data?

> `optional` **file\_data**: `string`

Defined in: [src/client/types.gen.ts:2069](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2069)

FileData is the base64-encoded file content

***

### file\_id?

> `optional` **file\_id**: `string`

Defined in: [src/client/types.gen.ts:2073](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2073)

FileID is the ID of an uploaded file

***

### file\_url?

> `optional` **file\_url**: `string`

Defined in: [src/client/types.gen.ts:2077](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2077)

FileURL is the URL to the file

***

### filename?

> `optional` **filename**: `string`

Defined in: [src/client/types.gen.ts:2081](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2081)

Filename is the name of the file

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/LlmapiMessageContentImage

# LlmapiMessageContentImage

> **LlmapiMessageContentImage** = `object`

Defined in: [src/client/types.gen.ts:2087](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2087)

ImageURL is used when Type=image\_url or Type=input\_image

## Properties

### detail?

> `optional` **detail**: `string`

Defined in: [src/client/types.gen.ts:2091](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2091)

Detail is the OpenAI detail hint (auto|low|high)

***

### url?

> `optional` **url**: `string`

Defined in: [src/client/types.gen.ts:2095](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2095)

URL is the image URL or data URI

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/LlmapiMessageContentPart

# LlmapiMessageContentPart

> **LlmapiMessageContentPart** = `object`

Defined in: [src/client/types.gen.ts:2098](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2098)

## Properties

### file?

> `optional` **file**: [`LlmapiMessageContentFile`](LlmapiMessageContentFile.md)

Defined in: [src/client/types.gen.ts:2099](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2099)

***

### image\_url?

> `optional` **image\_url**: [`LlmapiMessageContentImage`](LlmapiMessageContentImage.md)

Defined in: [src/client/types.gen.ts:2100](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2100)

***

### text?

> `optional` **text**: `string`

Defined in: [src/client/types.gen.ts:2104](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2104)

Text holds the text content when Type=text or Type=input\_text

***

### type?

> `optional` **type**: `string`

Defined in: [src/client/types.gen.ts:2108](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2108)

Type is the block type (`text`, `image_url`, or `input_file`)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/LlmapiModel

# LlmapiModel

> **LlmapiModel** = `object`

Defined in: [src/client/types.gen.ts:2111](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2111)

## Properties

### architecture?

> `optional` **architecture**: [`LlmapiModelArchitecture`](LlmapiModelArchitecture.md)

Defined in: [src/client/types.gen.ts:2112](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2112)

***

### canonical\_slug?

> `optional` **canonical\_slug**: `string`

Defined in: [src/client/types.gen.ts:2116](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2116)

CanonicalSlug is the canonical slug for the model

***

### context\_length?

> `optional` **context\_length**: `number`

Defined in: [src/client/types.gen.ts:2120](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2120)

ContextLength is the maximum context length in tokens

***

### created?

> `optional` **created**: `number`

Defined in: [src/client/types.gen.ts:2124](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2124)

Created is the Unix timestamp of when the model was created

***

### default\_parameters?

> `optional` **default\_parameters**: `object`

Defined in: [src/client/types.gen.ts:2128](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2128)

DefaultParameters contains default parameter values

**Index Signature**

\[`key`: `string`]: `unknown`

***

### description?

> `optional` **description**: `string`

Defined in: [src/client/types.gen.ts:2134](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2134)

Description describes the model and its capabilities

***

### hugging\_face\_id?

> `optional` **hugging\_face\_id**: `string`

Defined in: [src/client/types.gen.ts:2138](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2138)

HuggingFaceID is the Hugging Face model identifier

***

### id?

> `optional` **id**: `string`

Defined in: [src/client/types.gen.ts:2142](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2142)

ID is the model identifier (e.g., "openai/gpt-4")

***

### max\_input\_tokens?

> `optional` **max\_input\_tokens**: `number`

Defined in: [src/client/types.gen.ts:2146](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2146)

MaxInputTokens is the maximum input tokens

***

### max\_output\_tokens?

> `optional` **max\_output\_tokens**: `number`

Defined in: [src/client/types.gen.ts:2150](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2150)

MaxOutputTokens is the maximum output tokens

***

### modalities?

> `optional` **modalities**: `string`\[]

Defined in: [src/client/types.gen.ts:2154](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2154)

Modalities is a list of supported modalities (e.g., \["llm", "vision"])

***

### name?

> `optional` **name**: `string`

Defined in: [src/client/types.gen.ts:2158](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2158)

Name is the human-readable model name (optional)

***

### owned\_by?

> `optional` **owned\_by**: `string`

Defined in: [src/client/types.gen.ts:2162](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2162)

OwnedBy is the organization that owns the model

***

### per\_request\_limits?

> `optional` **per\_request\_limits**: [`LlmapiModelPerRequestLimits`](LlmapiModelPerRequestLimits.md)

Defined in: [src/client/types.gen.ts:2163](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2163)

***

### pricing?

> `optional` **pricing**: [`LlmapiModelPricing`](LlmapiModelPricing.md)

Defined in: [src/client/types.gen.ts:2164](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2164)

***

### supported\_methods?

> `optional` **supported\_methods**: `string`\[]

Defined in: [src/client/types.gen.ts:2168](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2168)

SupportedMethods is a list of supported API methods

***

### supported\_parameters?

> `optional` **supported\_parameters**: `string`\[]

Defined in: [src/client/types.gen.ts:2172](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2172)

SupportedParameters is a list of supported parameter names

***

### top\_provider?

> `optional` **top\_provider**: [`LlmapiModelTopProvider`](LlmapiModelTopProvider.md)

Defined in: [src/client/types.gen.ts:2173](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2173)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/LlmapiModelArchitecture

# LlmapiModelArchitecture

> **LlmapiModelArchitecture** = `object`

Defined in: [src/client/types.gen.ts:2179](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2179)

Architecture describes the model's technical capabilities

## Properties

### instruct\_type?

> `optional` **instruct\_type**: `string`

Defined in: [src/client/types.gen.ts:2180](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2180)

***

### modality?

> `optional` **modality**: `string`

Defined in: [src/client/types.gen.ts:2181](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2181)

***

### prompt\_formatting?

> `optional` **prompt\_formatting**: `string`

Defined in: [src/client/types.gen.ts:2182](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2182)

***

### tokenizer?

> `optional` **tokenizer**: `string`

Defined in: [src/client/types.gen.ts:2183](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2183)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/LlmapiModelPerRequestLimits

# LlmapiModelPerRequestLimits

> **LlmapiModelPerRequestLimits** = `object`

Defined in: [src/client/types.gen.ts:2189](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2189)

PerRequestLimits contains rate limiting information

## Properties

### completion\_tokens?

> `optional` **completion\_tokens**: `number`

Defined in: [src/client/types.gen.ts:2190](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2190)

***

### prompt\_tokens?

> `optional` **prompt\_tokens**: `number`

Defined in: [src/client/types.gen.ts:2191](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2191)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/LlmapiModelPricing

# LlmapiModelPricing

> **LlmapiModelPricing** = `object`

Defined in: [src/client/types.gen.ts:2197](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2197)

Pricing contains the pricing structure for using this model

## Properties

### completion?

> `optional` **completion**: `string`

Defined in: [src/client/types.gen.ts:2198](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2198)

***

### image?

> `optional` **image**: `string`

Defined in: [src/client/types.gen.ts:2199](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2199)

***

### prompt?

> `optional` **prompt**: `string`

Defined in: [src/client/types.gen.ts:2200](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2200)

***

### request?

> `optional` **request**: `string`

Defined in: [src/client/types.gen.ts:2201](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2201)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/LlmapiModelsListExtraFields

# LlmapiModelsListExtraFields

> **LlmapiModelsListExtraFields** = `object`

Defined in: [src/client/types.gen.ts:2216](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2216)

ExtraFields contains additional metadata

## Properties

### chunk\_index?

> `optional` **chunk\_index**: `number`

Defined in: [src/client/types.gen.ts:2220](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2220)

ChunkIndex is the chunk index (0 for single requests)

***

### latency?

> `optional` **latency**: `number`

Defined in: [src/client/types.gen.ts:2224](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2224)

Latency is the request latency in milliseconds

***

### request\_type?

> `optional` **request\_type**: `string`

Defined in: [src/client/types.gen.ts:2228](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2228)

RequestType is always "list\_models"

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/LlmapiModelsListResponse

# LlmapiModelsListResponse

> **LlmapiModelsListResponse** = `object`

Defined in: [src/client/types.gen.ts:2231](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2231)

## Properties

### data?

> `optional` **data**: [`LlmapiModel`](LlmapiModel.md)\[]

Defined in: [src/client/types.gen.ts:2235](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2235)

Data contains the list of available models

***

### extra\_fields?

> `optional` **extra\_fields**: [`LlmapiModelsListExtraFields`](LlmapiModelsListExtraFields.md)

Defined in: [src/client/types.gen.ts:2236](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2236)

***

### next\_page\_token?

> `optional` **next\_page\_token**: `string`

Defined in: [src/client/types.gen.ts:2240](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2240)

NextPageToken is the token to retrieve the next page of results (omitted if no more pages)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/LlmapiModelTopProvider

# LlmapiModelTopProvider

> **LlmapiModelTopProvider** = `object`

Defined in: [src/client/types.gen.ts:2207](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2207)

TopProvider contains configuration details for the primary provider

## Properties

### context\_length?

> `optional` **context\_length**: `number`

Defined in: [src/client/types.gen.ts:2208](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2208)

***

### is\_moderated?

> `optional` **is\_moderated**: `boolean`

Defined in: [src/client/types.gen.ts:2209](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2209)

***

### max\_completion\_tokens?

> `optional` **max\_completion\_tokens**: `number`

Defined in: [src/client/types.gen.ts:2210](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2210)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/LlmapiResponseExtraFields

# LlmapiResponseExtraFields

> **LlmapiResponseExtraFields** = `object`

Defined in: [src/client/types.gen.ts:2246](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2246)

ExtraFields contains additional metadata

## Properties

### latency?

> `optional` **latency**: `number`

Defined in: [src/client/types.gen.ts:2250](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2250)

Latency is the request latency in milliseconds

***

### model\_requested?

> `optional` **model\_requested**: `string`

Defined in: [src/client/types.gen.ts:2254](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2254)

ModelRequested is the model that was requested

***

### provider?

> `optional` **provider**: `string`

Defined in: [src/client/types.gen.ts:2258](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2258)

Provider is the LLM provider used (e.g., "openai", "anthropic")

***

### request\_type?

> `optional` **request\_type**: `string`

Defined in: [src/client/types.gen.ts:2262](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2262)

RequestType is always "responses"

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/LlmapiResponseInput

# LlmapiResponseInput

> **LlmapiResponseInput** = `object`

Defined in: [src/client/types.gen.ts:2269](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2269)

Input can be a simple text string or an array of messages for multi-turn conversations.
When continuing after client tool calls, pass the messages array from the previous response.

## Properties

### messages?

> `optional` **messages**: [`LlmapiMessage`](LlmapiMessage.md)\[]

Defined in: [src/client/types.gen.ts:2273](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2273)

Messages is set when input is an array of messages (for multi-turn/tool continuations)

***

### text?

> `optional` **text**: `string`

Defined in: [src/client/types.gen.ts:2277](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2277)

Text is set when input is a simple string

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/LlmapiResponseOutputContent

# LlmapiResponseOutputContent

> **LlmapiResponseOutputContent** = `object`

Defined in: [src/client/types.gen.ts:2280](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2280)

## Properties

### text?

> `optional` **text**: `string`

Defined in: [src/client/types.gen.ts:2284](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2284)

Text is the text content

***

### type?

> `optional` **type**: `string`

Defined in: [src/client/types.gen.ts:2288](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2288)

Type is the content type (e.g., "output\_text")

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/LlmapiResponseOutputItem

# LlmapiResponseOutputItem

> **LlmapiResponseOutputItem** = `object`

Defined in: [src/client/types.gen.ts:2291](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2291)

## Properties

### arguments?

> `optional` **arguments**: `string`

Defined in: [src/client/types.gen.ts:2295](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2295)

Arguments is the function arguments for function\_call and mcp\_call types

***

### call\_id?

> `optional` **call\_id**: `string`

Defined in: [src/client/types.gen.ts:2299](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2299)

CallID is the call ID for function\_call and mcp\_call types

***

### content?

> `optional` **content**: [`LlmapiResponseOutputContent`](LlmapiResponseOutputContent.md)\[]

Defined in: [src/client/types.gen.ts:2303](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2303)

Content is the content array for message and reasoning types

***

### error?

> `optional` **error**: `string`

Defined in: [src/client/types.gen.ts:2307](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2307)

Error is the MCP error message for mcp\_call types

***

### id?

> `optional` **id**: `string`

Defined in: [src/client/types.gen.ts:2311](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2311)

ID is the unique identifier for this output item

***

### name?

> `optional` **name**: `string`

Defined in: [src/client/types.gen.ts:2315](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2315)

Name is the function name for function\_call and mcp\_call types

***

### output?

> `optional` **output**: `string`

Defined in: [src/client/types.gen.ts:2319](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2319)

Output is the MCP tool output for mcp\_call types

***

### role?

> `optional` **role**: `string`

Defined in: [src/client/types.gen.ts:2323](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2323)

Role is the role for message types (e.g., "assistant")

***

### server\_label?

> `optional` **server\_label**: `string`

Defined in: [src/client/types.gen.ts:2327](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2327)

ServerLabel is the MCP server label for mcp\_call and mcp\_list\_tools types

***

### status?

> `optional` **status**: `string`

Defined in: [src/client/types.gen.ts:2331](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2331)

Status is the status of this output item (e.g., "completed")

***

### summary?

> `optional` **summary**: [`LlmapiResponseOutputContent`](LlmapiResponseOutputContent.md)\[]

Defined in: [src/client/types.gen.ts:2335](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2335)

Summary is the reasoning summary for reasoning types

***

### tools?

> `optional` **tools**: [`LlmapiMcpTool`](LlmapiMcpTool.md)\[]

Defined in: [src/client/types.gen.ts:2339](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2339)

Tools is the list of available tools for mcp\_list\_tools types

***

### type?

> `optional` **type**: `string`

Defined in: [src/client/types.gen.ts:2343](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2343)

Type is the output item type (e.g., "message", "function\_call", "reasoning", "mcp\_call")

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/LlmapiResponseReasoning

# LlmapiResponseReasoning

> **LlmapiResponseReasoning** = `object`

Defined in: [src/client/types.gen.ts:2349](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2349)

Reasoning configures reasoning for o-series and other reasoning models

## Properties

### effort?

> `optional` **effort**: `string`

Defined in: [src/client/types.gen.ts:2353](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2353)

Effort controls reasoning effort: "low", "medium", or "high"

***

### summary?

> `optional` **summary**: `string`

Defined in: [src/client/types.gen.ts:2357](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2357)

Summary controls reasoning summary: "auto", "concise", or "detailed"

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/LlmapiResponseRequest

# LlmapiResponseRequest

> **LlmapiResponseRequest** = `object`

Defined in: [src/client/types.gen.ts:2360](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2360)

## Properties

### background?

> `optional` **background**: `boolean`

Defined in: [src/client/types.gen.ts:2364](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2364)

Background indicates if request should be processed in background

***

### conversation\_id?

> `optional` **conversation\_id**: `string`

Defined in: [src/client/types.gen.ts:2369](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2369)

ConversationID groups requests belonging to the same conversation for observability.
Pass-through only — not forwarded to the LLM provider.

***

### image\_model?

> `optional` **image\_model**: `string`

Defined in: [src/client/types.gen.ts:2374](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2374)

ImageModel is the user-selected image generation model.
When set, the portal overrides the model field in image tool call arguments.

***

### input

> **input**: [`LlmapiResponseInput`](LlmapiResponseInput.md)

Defined in: [src/client/types.gen.ts:2375](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2375)

***

### max\_output\_tokens?

> `optional` **max\_output\_tokens**: `number`

Defined in: [src/client/types.gen.ts:2379](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2379)

MaxOutputTokens is the maximum number of tokens to generate

***

### model

> **model**: `string`

Defined in: [src/client/types.gen.ts:2383](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2383)

Model is the model identifier in 'provider/model' format

***

### reasoning?

> `optional` **reasoning**: [`LlmapiResponseReasoning`](LlmapiResponseReasoning.md)

Defined in: [src/client/types.gen.ts:2384](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2384)

***

### stream?

> `optional` **stream**: `boolean`

Defined in: [src/client/types.gen.ts:2388](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2388)

Stream indicates if response should be streamed

***

### temperature?

> `optional` **temperature**: `number`

Defined in: [src/client/types.gen.ts:2392](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2392)

Temperature controls randomness (0.0 to 2.0)

***

### thinking?

> `optional` **thinking**: [`LlmapiThinkingOptions`](LlmapiThinkingOptions.md)

Defined in: [src/client/types.gen.ts:2393](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2393)

***

### tool\_choice?

> `optional` **tool\_choice**: [`LlmapiResponseToolChoice`](LlmapiResponseToolChoice.md)

Defined in: [src/client/types.gen.ts:2394](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2394)

***

### tools?

> `optional` **tools**: [`LlmapiResponseTool`](LlmapiResponseTool.md)\[]

Defined in: [src/client/types.gen.ts:2398](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2398)

Tools is an array of tool schemas describing which tools the model can use

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/LlmapiResponseResponse

# LlmapiResponseResponse

> **LlmapiResponseResponse** = `object`

Defined in: [src/client/types.gen.ts:2401](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2401)

## Properties

### client\_injected\_tools?

> `optional` **client\_injected\_tools**: `string`\[]

Defined in: [src/client/types.gen.ts:2405](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2405)

ClientInjectedTools are tool names the client provided in the original request.

***

### created\_at?

> `optional` **created\_at**: `number`

Defined in: [src/client/types.gen.ts:2409](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2409)

Created is the Unix timestamp of creation (created\_at in OpenAI format)

***

### extra\_fields?

> `optional` **extra\_fields**: [`LlmapiResponseExtraFields`](LlmapiResponseExtraFields.md)

Defined in: [src/client/types.gen.ts:2410](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2410)

***

### id?

> `optional` **id**: `string`

Defined in: [src/client/types.gen.ts:2414](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2414)

ID is the unique response identifier

***

### image\_model?

> `optional` **image\_model**: `string`

Defined in: [src/client/types.gen.ts:2420](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2420)

ImageModel is set when an image generation tool was called during the request.
This allows the client to detect that the response contains generated images
and render them appropriately, even when the orchestrating model is a text model.

***

### messages?

> `optional` **messages**: [`LlmapiMessage`](LlmapiMessage.md)\[]

Defined in: [src/client/types.gen.ts:2427](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2427)

Messages contains the full conversation history when local tools need execution.
This is populated when the model requests tools that are not MCP tools (local/client-side tools).
The client should execute these tools and send a new request with this message history
plus the tool results appended.

***

### model?

> `optional` **model**: `string`

Defined in: [src/client/types.gen.ts:2431](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2431)

Model is the model used for generation

***

### object?

> `optional` **object**: `string`

Defined in: [src/client/types.gen.ts:2435](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2435)

Object is the response type (e.g., "response")

***

### output?

> `optional` **output**: [`LlmapiResponseOutputItem`](LlmapiResponseOutputItem.md)\[]

Defined in: [src/client/types.gen.ts:2439](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2439)

Output is the array of output items (OpenAI Responses API format)

***

### portal\_injected\_tools?

> `optional` **portal\_injected\_tools**: `string`\[]

Defined in: [src/client/types.gen.ts:2443](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2443)

PortalInjectedTools are tool names the portal's classifier added to the request.

***

### tool\_call\_events?

> `optional` **tool\_call\_events**: [`LlmapiToolCallEvent`](LlmapiToolCallEvent.md)\[]

Defined in: [src/client/types.gen.ts:2447](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2447)

ToolCallEvents is an array of tool call events.

***

### tools\_checksum?

> `optional` **tools\_checksum**: `string`

Defined in: [src/client/types.gen.ts:2451](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2451)

ToolsChecksum is the checksum of the tool schemas used by the AI Portal.

***

### usage?

> `optional` **usage**: [`LlmapiResponseUsage`](LlmapiResponseUsage.md)

Defined in: [src/client/types.gen.ts:2452](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2452)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/LlmapiResponseTool

# LlmapiResponseTool

> **LlmapiResponseTool** = `object`

Defined in: [src/client/types.gen.ts:2455](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2455)

## Index Signature

\[`key`: `string`]: `unknown`

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/LlmapiResponseToolChoice

# LlmapiResponseToolChoice

> **LlmapiResponseToolChoice** = `object`

Defined in: [src/client/types.gen.ts:2462](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2462)

ToolChoice controls tool usage

## Index Signature

\[`key`: `string`]: `unknown`

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/LlmapiResponseUsage

# LlmapiResponseUsage

> **LlmapiResponseUsage** = `object`

Defined in: [src/client/types.gen.ts:2469](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2469)

Usage contains token usage information

## Properties

### completion\_tokens?

> `optional` **completion\_tokens**: `number`

Defined in: [src/client/types.gen.ts:2473](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2473)

CompletionTokens is the number of tokens in the completion

***

### cost\_micro\_usd?

> `optional` **cost\_micro\_usd**: `number`

Defined in: [src/client/types.gen.ts:2477](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2477)

CostMicroUSD is the cost of this response in micro-dollars (USD × 1,000,000)

***

### credits\_used?

> `optional` **credits\_used**: `number`

Defined in: [src/client/types.gen.ts:2481](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2481)

CreditsUsed is the number of credits consumed by this response

***

### init\_completion\_tokens?

> `optional` **init\_completion\_tokens**: `number`

Defined in: [src/client/types.gen.ts:2485](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2485)

InitCompletionTokens is the completion token count from the first LLM call before the MCP tool loop

***

### init\_prompt\_tokens?

> `optional` **init\_prompt\_tokens**: `number`

Defined in: [src/client/types.gen.ts:2489](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2489)

InitPromptTokens is the prompt token count from the first LLM call before the MCP tool loop

***

### pricing\_source?

> `optional` **pricing\_source**: `string`

Defined in: [src/client/types.gen.ts:2493](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2493)

PricingSource identifies which lookup produced CostMicroUSD; see internal/pricing/source.go.

***

### prompt\_tokens?

> `optional` **prompt\_tokens**: `number`

Defined in: [src/client/types.gen.ts:2497](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2497)

PromptTokens is the number of tokens in the prompt

***

### provider\_cost\_micro\_usd?

> `optional` **provider\_cost\_micro\_usd**: `number`

Defined in: [src/client/types.gen.ts:2502](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2502)

ProviderCostMicroUSD is what we believe the provider charged us in micro-USD.
Today equals CostMicroUSD (no markup); kept distinct so future per-tier pricing preserves history.

***

### tool\_cost\_micro\_usd?

> `optional` **tool\_cost\_micro\_usd**: `number`

Defined in: [src/client/types.gen.ts:2506](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2506)

ToolCostMicroUSD is the cost of MCP tool calls in micro-dollars (subset of CostMicroUSD)

***

### total\_tokens?

> `optional` **total\_tokens**: `number`

Defined in: [src/client/types.gen.ts:2510](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2510)

TotalTokens is the total number of tokens used

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/LlmapiRole

# LlmapiRole

> **LlmapiRole** = `string`

Defined in: [src/client/types.gen.ts:2516](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2516)

Role is the message role (system, user, assistant, tool)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/LlmapiThinkingOptions

# LlmapiThinkingOptions

> **LlmapiThinkingOptions** = `object`

Defined in: [src/client/types.gen.ts:2521](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2521)

Thinking configures extended thinking for Anthropic models

## Properties

### budget\_tokens?

> `optional` **budget\_tokens**: `number`

Defined in: [src/client/types.gen.ts:2525](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2525)

BudgetTokens is the token budget for thinking

***

### type?

> `optional` **type**: `string`

Defined in: [src/client/types.gen.ts:2529](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2529)

Type indicates if thinking is enabled: "enabled" or "disabled"

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/LlmapiToolCall

# LlmapiToolCall

> **LlmapiToolCall** = `object`

Defined in: [src/client/types.gen.ts:2532](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2532)

## Properties

### function?

> `optional` **function**: [`LlmapiToolCallFunction`](LlmapiToolCallFunction.md)

Defined in: [src/client/types.gen.ts:2533](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2533)

***

### id?

> `optional` **id**: `string`

Defined in: [src/client/types.gen.ts:2537](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2537)

ID is the unique identifier for this tool call

***

### type?

> `optional` **type**: `string`

Defined in: [src/client/types.gen.ts:2541](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2541)

Type is the type of tool call (always "function" for now)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/LlmapiToolCallEvent

# LlmapiToolCallEvent

> **LlmapiToolCallEvent** = `object`

Defined in: [src/client/types.gen.ts:2544](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2544)

## Properties

### arguments?

> `optional` **arguments**: `string`

Defined in: [src/client/types.gen.ts:2545](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2545)

***

### cost\_micro\_usd?

> `optional` **cost\_micro\_usd**: `number`

Defined in: [src/client/types.gen.ts:2546](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2546)

***

### id?

> `optional` **id**: `string`

Defined in: [src/client/types.gen.ts:2547](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2547)

***

### name?

> `optional` **name**: `string`

Defined in: [src/client/types.gen.ts:2548](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2548)

***

### output?

> `optional` **output**: `string`

Defined in: [src/client/types.gen.ts:2549](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2549)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/LlmapiToolCallFunction

# LlmapiToolCallFunction

> **LlmapiToolCallFunction** = `object`

Defined in: [src/client/types.gen.ts:2555](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2555)

Function contains the function call details

## Properties

### arguments?

> `optional` **arguments**: `string`

Defined in: [src/client/types.gen.ts:2559](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2559)

Arguments is the JSON string of arguments to pass to the function

***

### name?

> `optional` **name**: `string`

Defined in: [src/client/types.gen.ts:2563](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2563)

Name is the name of the function to call

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/McpToolSchema

# McpToolSchema

> **McpToolSchema** = `object`

Defined in: [src/client/types.gen.ts:2566](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2566)

## Properties

### description?

> `optional` **description**: `string`

Defined in: [src/client/types.gen.ts:2567](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2567)

***

### name?

> `optional` **name**: `string`

Defined in: [src/client/types.gen.ts:2568](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2568)

***

### parameters?

> `optional` **parameters**: `unknown`

Defined in: [src/client/types.gen.ts:2569](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2569)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/ModelsRegisterTextRequest

# ModelsRegisterTextRequest

> **ModelsRegisterTextRequest** = `object`

Defined in: [src/client/types.gen.ts:2572](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2572)

## Properties

### identifier

> **identifier**: `string`

Defined in: [src/client/types.gen.ts:2573](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2573)

***

### preferred\_model?

> `optional` **preferred\_model**: `string`

Defined in: [src/client/types.gen.ts:2574](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2574)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/ModelsTextChannel

# ModelsTextChannel

> **ModelsTextChannel** = `string`

Defined in: [src/client/types.gen.ts:2577](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2577)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/ModelsTextLookupResult

# ModelsTextLookupResult

> **ModelsTextLookupResult** = `object`

Defined in: [src/client/types.gen.ts:2579](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2579)

## Properties

### account\_id?

> `optional` **account\_id**: `number`

Defined in: [src/client/types.gen.ts:2580](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2580)

***

### app\_id?

> `optional` **app\_id**: `number`

Defined in: [src/client/types.gen.ts:2581](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2581)

***

### channel?

> `optional` **channel**: `string`

Defined in: [src/client/types.gen.ts:2582](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2582)

***

### credits?

> `optional` **credits**: `number`

Defined in: [src/client/types.gen.ts:2583](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2583)

***

### identifier?

> `optional` **identifier**: `string`

Defined in: [src/client/types.gen.ts:2584](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2584)

***

### linq\_chat\_id?

> `optional` **linq\_chat\_id**: `string`

Defined in: [src/client/types.gen.ts:2585](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2585)

***

### preferred\_model?

> `optional` **preferred\_model**: `string`

Defined in: [src/client/types.gen.ts:2586](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2586)

***

### wallet\_address?

> `optional` **wallet\_address**: `string`

Defined in: [src/client/types.gen.ts:2587](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2587)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/ModelsTextStatusResponse

# ModelsTextStatusResponse

> **ModelsTextStatusResponse** = `object`

Defined in: [src/client/types.gen.ts:2590](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2590)

## Properties

### channel?

> `optional` **channel**: [`ModelsTextChannel`](ModelsTextChannel.md)

Defined in: [src/client/types.gen.ts:2591](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2591)

***

### created\_at?

> `optional` **created\_at**: `string`

Defined in: [src/client/types.gen.ts:2592](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2592)

***

### identifier?

> `optional` **identifier**: `string`

Defined in: [src/client/types.gen.ts:2593](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2593)

***

### preferred\_model?

> `optional` **preferred\_model**: `string`

Defined in: [src/client/types.gen.ts:2594](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2594)

***

### registered

> **registered**: `boolean`

Defined in: [src/client/types.gen.ts:2595](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2595)

***

### verified?

> `optional` **verified**: `boolean`

Defined in: [src/client/types.gen.ts:2596](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2596)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/Options

# Options\<TData, ThrowOnError>

> **Options**<`TData`, `ThrowOnError`> = `Options2`<`TData`, `ThrowOnError`> & `object`

Defined in: [src/client/sdk.gen.ts:7](https://github.com/anuma-ai/sdk/blob/main/src/client/sdk.gen.ts#7)

## Type Declaration

### client?

> `optional` **client**: `Client`

You can provide a client instance returned by `createClient()` instead of
individual options. This might be also useful if you want to implement a
custom client.

### meta?

> `optional` **meta**: `Record`<`string`, `unknown`>

You can pass arbitrary values through the `meta` object. This can be
used to access values that aren't defined as part of the SDK function.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`TData` *extends* `TDataShape`

</td>
<td>

`TDataShape`

</td>
</tr>
<tr>
<td>

`ThrowOnError` *extends* `boolean`

</td>
<td>

`boolean`

</td>
</tr>
</tbody>
</table>

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PatchApiV1AdminOauthClientsByClientIdData

# PatchApiV1AdminOauthClientsByClientIdData

> **PatchApiV1AdminOauthClientsByClientIdData** = `object`

Defined in: [src/client/types.gen.ts:3484](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3484)

## Properties

### body

> **body**: [`HandlersUpdateOAuthClientRequest`](HandlersUpdateOAuthClientRequest.md)

Defined in: [src/client/types.gen.ts:3488](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3488)

Updates

***

### headers

> **headers**: `object`

Defined in: [src/client/types.gen.ts:3489](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3489)

**X-Admin-API-Key**

> **X-Admin-API-Key**: `string`

Admin API key

***

### path

> **path**: `object`

Defined in: [src/client/types.gen.ts:3495](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3495)

**client\_id**

> **client\_id**: `string`

OAuth client ID

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:3501](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3501)

***

### url

> **url**: `"/api/v1/admin/oauth/clients/{client_id}"`

Defined in: [src/client/types.gen.ts:3502](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3502)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PatchApiV1AdminOauthClientsByClientIdError

# PatchApiV1AdminOauthClientsByClientIdError

> **PatchApiV1AdminOauthClientsByClientIdError** = [`PatchApiV1AdminOauthClientsByClientIdErrors`](PatchApiV1AdminOauthClientsByClientIdErrors.md)\[keyof [`PatchApiV1AdminOauthClientsByClientIdErrors`](PatchApiV1AdminOauthClientsByClientIdErrors.md)]

Defined in: [src/client/types.gen.ts:3512](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3512)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PatchApiV1AdminOauthClientsByClientIdErrors

# PatchApiV1AdminOauthClientsByClientIdErrors

> **PatchApiV1AdminOauthClientsByClientIdErrors** = `object`

Defined in: [src/client/types.gen.ts:3505](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3505)

## Properties

### 404

> **404**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:3509](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3509)

Not Found

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PatchApiV1AdminOauthClientsByClientIdResponse

# PatchApiV1AdminOauthClientsByClientIdResponse

> **PatchApiV1AdminOauthClientsByClientIdResponse** = [`PatchApiV1AdminOauthClientsByClientIdResponses`](PatchApiV1AdminOauthClientsByClientIdResponses.md)\[keyof [`PatchApiV1AdminOauthClientsByClientIdResponses`](PatchApiV1AdminOauthClientsByClientIdResponses.md)]

Defined in: [src/client/types.gen.ts:3521](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3521)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PatchApiV1AdminOauthClientsByClientIdResponses

# PatchApiV1AdminOauthClientsByClientIdResponses

> **PatchApiV1AdminOauthClientsByClientIdResponses** = `object`

Defined in: [src/client/types.gen.ts:3514](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3514)

## Properties

### 200

> **200**: [`HandlersOAuthClientResponse`](HandlersOAuthClientResponse.md)

Defined in: [src/client/types.gen.ts:3518](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3518)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PatchApiV1DeveloperAppsByAppUuidData

# PatchApiV1DeveloperAppsByAppUuidData

> **PatchApiV1DeveloperAppsByAppUuidData** = `object`

Defined in: [src/client/types.gen.ts:4904](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4904)

## Properties

### body

> **body**: [`HandlersUpdateDeveloperAppRequest`](HandlersUpdateDeveloperAppRequest.md)

Defined in: [src/client/types.gen.ts:4908](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4908)

Update app request

***

### path

> **path**: `object`

Defined in: [src/client/types.gen.ts:4909](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4909)

**app\_uuid**

> **app\_uuid**: `string`

App UUID

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:4915](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4915)

***

### url

> **url**: `"/api/v1/developer/apps/{app_uuid}"`

Defined in: [src/client/types.gen.ts:4916](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4916)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PatchApiV1DeveloperAppsByAppUuidError

# PatchApiV1DeveloperAppsByAppUuidError

> **PatchApiV1DeveloperAppsByAppUuidError** = [`PatchApiV1DeveloperAppsByAppUuidErrors`](PatchApiV1DeveloperAppsByAppUuidErrors.md)\[keyof [`PatchApiV1DeveloperAppsByAppUuidErrors`](PatchApiV1DeveloperAppsByAppUuidErrors.md)]

Defined in: [src/client/types.gen.ts:4942](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4942)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PatchApiV1DeveloperAppsByAppUuidErrors

# PatchApiV1DeveloperAppsByAppUuidErrors

> **PatchApiV1DeveloperAppsByAppUuidErrors** = `object`

Defined in: [src/client/types.gen.ts:4919](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4919)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4923](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4923)

Bad Request

***

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4927](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4927)

Unauthorized

***

### 403

> **403**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4931](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4931)

Forbidden

***

### 404

> **404**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4935](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4935)

Not Found

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4939](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4939)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PatchApiV1DeveloperAppsByAppUuidResponse

# PatchApiV1DeveloperAppsByAppUuidResponse

> **PatchApiV1DeveloperAppsByAppUuidResponse** = [`PatchApiV1DeveloperAppsByAppUuidResponses`](PatchApiV1DeveloperAppsByAppUuidResponses.md)\[keyof [`PatchApiV1DeveloperAppsByAppUuidResponses`](PatchApiV1DeveloperAppsByAppUuidResponses.md)]

Defined in: [src/client/types.gen.ts:4951](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4951)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PatchApiV1DeveloperAppsByAppUuidResponses

# PatchApiV1DeveloperAppsByAppUuidResponses

> **PatchApiV1DeveloperAppsByAppUuidResponses** = `object`

Defined in: [src/client/types.gen.ts:4944](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4944)

## Properties

### 200

> **200**: [`HandlersDeveloperAppResponse`](HandlersDeveloperAppResponse.md)

Defined in: [src/client/types.gen.ts:4948](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4948)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PatchApiV1DeveloperAppsByAppUuidUsersByAddressData

# PatchApiV1DeveloperAppsByAppUuidUsersByAddressData

> **PatchApiV1DeveloperAppsByAppUuidUsersByAddressData** = `object`

Defined in: [src/client/types.gen.ts:5464](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5464)

## Properties

### body

> **body**: [`HandlersUpdateUserLimitRequest`](HandlersUpdateUserLimitRequest.md)

Defined in: [src/client/types.gen.ts:5468](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5468)

Update limit request

***

### path

> **path**: `object`

Defined in: [src/client/types.gen.ts:5469](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5469)

**address**

> **address**: `string`

User wallet address

**app\_uuid**

> **app\_uuid**: `string`

App UUID

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:5479](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5479)

***

### url

> **url**: `"/api/v1/developer/apps/{app_uuid}/users/{address}"`

Defined in: [src/client/types.gen.ts:5480](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5480)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PatchApiV1DeveloperAppsByAppUuidUsersByAddressError

# PatchApiV1DeveloperAppsByAppUuidUsersByAddressError

> **PatchApiV1DeveloperAppsByAppUuidUsersByAddressError** = [`PatchApiV1DeveloperAppsByAppUuidUsersByAddressErrors`](PatchApiV1DeveloperAppsByAppUuidUsersByAddressErrors.md)\[keyof [`PatchApiV1DeveloperAppsByAppUuidUsersByAddressErrors`](PatchApiV1DeveloperAppsByAppUuidUsersByAddressErrors.md)]

Defined in: [src/client/types.gen.ts:5506](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5506)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PatchApiV1DeveloperAppsByAppUuidUsersByAddressErrors

# PatchApiV1DeveloperAppsByAppUuidUsersByAddressErrors

> **PatchApiV1DeveloperAppsByAppUuidUsersByAddressErrors** = `object`

Defined in: [src/client/types.gen.ts:5483](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5483)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5487](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5487)

Bad Request

***

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5491](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5491)

Unauthorized

***

### 403

> **403**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5495](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5495)

Forbidden

***

### 404

> **404**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5499](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5499)

Not Found

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5503](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5503)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PatchApiV1DeveloperAppsByAppUuidUsersByAddressResponse

# PatchApiV1DeveloperAppsByAppUuidUsersByAddressResponse

> **PatchApiV1DeveloperAppsByAppUuidUsersByAddressResponse** = [`PatchApiV1DeveloperAppsByAppUuidUsersByAddressResponses`](PatchApiV1DeveloperAppsByAppUuidUsersByAddressResponses.md)\[keyof [`PatchApiV1DeveloperAppsByAppUuidUsersByAddressResponses`](PatchApiV1DeveloperAppsByAppUuidUsersByAddressResponses.md)]

Defined in: [src/client/types.gen.ts:5515](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5515)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PatchApiV1DeveloperAppsByAppUuidUsersByAddressResponses

# PatchApiV1DeveloperAppsByAppUuidUsersByAddressResponses

> **PatchApiV1DeveloperAppsByAppUuidUsersByAddressResponses** = `object`

Defined in: [src/client/types.gen.ts:5508](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5508)

## Properties

### 200

> **200**: [`HandlersDeveloperUserResponse`](HandlersDeveloperUserResponse.md)

Defined in: [src/client/types.gen.ts:5512](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5512)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PatchApiV1UserOauthGrantsByIdData

# PatchApiV1UserOauthGrantsByIdData

> **PatchApiV1UserOauthGrantsByIdData** = `object`

Defined in: [src/client/types.gen.ts:6801](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6801)

## Properties

### body

> **body**: [`HandlersUpdateGrantRequest`](HandlersUpdateGrantRequest.md)

Defined in: [src/client/types.gen.ts:6805](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6805)

Update body

***

### path

> **path**: `object`

Defined in: [src/client/types.gen.ts:6806](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6806)

**id**

> **id**: `number`

Grant ID

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:6812](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6812)

***

### url

> **url**: `"/api/v1/user/oauth/grants/{id}"`

Defined in: [src/client/types.gen.ts:6813](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6813)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PatchApiV1UserOauthGrantsByIdError

# PatchApiV1UserOauthGrantsByIdError

> **PatchApiV1UserOauthGrantsByIdError** = [`PatchApiV1UserOauthGrantsByIdErrors`](PatchApiV1UserOauthGrantsByIdErrors.md)\[keyof [`PatchApiV1UserOauthGrantsByIdErrors`](PatchApiV1UserOauthGrantsByIdErrors.md)]

Defined in: [src/client/types.gen.ts:6831](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6831)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PatchApiV1UserOauthGrantsByIdErrors

# PatchApiV1UserOauthGrantsByIdErrors

> **PatchApiV1UserOauthGrantsByIdErrors** = `object`

Defined in: [src/client/types.gen.ts:6816](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6816)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6820](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6820)

Bad Request

***

### 403

> **403**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6824](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6824)

Forbidden

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6828](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6828)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PatchApiV1UserOauthGrantsByIdResponse

# PatchApiV1UserOauthGrantsByIdResponse

> **PatchApiV1UserOauthGrantsByIdResponse** = [`PatchApiV1UserOauthGrantsByIdResponses`](PatchApiV1UserOauthGrantsByIdResponses.md)\[keyof [`PatchApiV1UserOauthGrantsByIdResponses`](PatchApiV1UserOauthGrantsByIdResponses.md)]

Defined in: [src/client/types.gen.ts:6842](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6842)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PatchApiV1UserOauthGrantsByIdResponses

# PatchApiV1UserOauthGrantsByIdResponses

> **PatchApiV1UserOauthGrantsByIdResponses** = `object`

Defined in: [src/client/types.gen.ts:6833](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6833)

## Properties

### 200

> **200**: `object`

Defined in: [src/client/types.gen.ts:6837](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6837)

OK

**Index Signature**

\[`key`: `string`]: `string`

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AdminAddCreditsData

# PostApiV1AdminAddCreditsData

> **PostApiV1AdminAddCreditsData** = `object`

Defined in: [src/client/types.gen.ts:2658](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2658)

## Properties

### body

> **body**: [`HandlersAddCreditsRequest`](HandlersAddCreditsRequest.md)

Defined in: [src/client/types.gen.ts:2662](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2662)

Add credits request

***

### headers

> **headers**: `object`

Defined in: [src/client/types.gen.ts:2663](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2663)

**X-Admin-API-Key**

> **X-Admin-API-Key**: `string`

Admin API key

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:2669](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2669)

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:2670](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2670)

***

### url

> **url**: `"/api/v1/admin/add-credits"`

Defined in: [src/client/types.gen.ts:2671](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2671)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AdminAddCreditsError

# PostApiV1AdminAddCreditsError

> **PostApiV1AdminAddCreditsError** = [`PostApiV1AdminAddCreditsErrors`](PostApiV1AdminAddCreditsErrors.md)\[keyof [`PostApiV1AdminAddCreditsErrors`](PostApiV1AdminAddCreditsErrors.md)]

Defined in: [src/client/types.gen.ts:2693](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2693)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AdminAddCreditsErrors

# PostApiV1AdminAddCreditsErrors

> **PostApiV1AdminAddCreditsErrors** = `object`

Defined in: [src/client/types.gen.ts:2674](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2674)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:2678](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2678)

Bad Request

***

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:2682](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2682)

Unauthorized

***

### 404

> **404**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:2686](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2686)

Not Found

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:2690](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2690)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AdminAddCreditsResponse

# PostApiV1AdminAddCreditsResponse

> **PostApiV1AdminAddCreditsResponse** = [`PostApiV1AdminAddCreditsResponses`](PostApiV1AdminAddCreditsResponses.md)\[keyof [`PostApiV1AdminAddCreditsResponses`](PostApiV1AdminAddCreditsResponses.md)]

Defined in: [src/client/types.gen.ts:2702](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2702)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AdminAddCreditsResponses

# PostApiV1AdminAddCreditsResponses

> **PostApiV1AdminAddCreditsResponses** = `object`

Defined in: [src/client/types.gen.ts:2695](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2695)

## Properties

### 200

> **200**: [`HandlersAddCreditsResponse`](HandlersAddCreditsResponse.md)

Defined in: [src/client/types.gen.ts:2699](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2699)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AdminAgentsData

# PostApiV1AdminAgentsData

> **PostApiV1AdminAgentsData** = `object`

Defined in: [src/client/types.gen.ts:2704](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2704)

## Properties

### body

> **body**: [`HandlersCreateAgentRequest`](HandlersCreateAgentRequest.md)

Defined in: [src/client/types.gen.ts:2708](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2708)

Create agent request

***

### headers

> **headers**: `object`

Defined in: [src/client/types.gen.ts:2709](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2709)

**X-Admin-API-Key**

> **X-Admin-API-Key**: `string`

Admin API key

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:2715](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2715)

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:2716](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2716)

***

### url

> **url**: `"/api/v1/admin/agents"`

Defined in: [src/client/types.gen.ts:2717](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2717)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AdminAgentsError

# PostApiV1AdminAgentsError

> **PostApiV1AdminAgentsError** = [`PostApiV1AdminAgentsErrors`](PostApiV1AdminAgentsErrors.md)\[keyof [`PostApiV1AdminAgentsErrors`](PostApiV1AdminAgentsErrors.md)]

Defined in: [src/client/types.gen.ts:2735](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2735)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AdminAgentsErrors

# PostApiV1AdminAgentsErrors

> **PostApiV1AdminAgentsErrors** = `object`

Defined in: [src/client/types.gen.ts:2720](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2720)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:2724](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2724)

Bad Request

***

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:2728](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2728)

Unauthorized

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:2732](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2732)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AdminAgentsResponse

# PostApiV1AdminAgentsResponse

> **PostApiV1AdminAgentsResponse** = [`PostApiV1AdminAgentsResponses`](PostApiV1AdminAgentsResponses.md)\[keyof [`PostApiV1AdminAgentsResponses`](PostApiV1AdminAgentsResponses.md)]

Defined in: [src/client/types.gen.ts:2744](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2744)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AdminAgentsResponses

# PostApiV1AdminAgentsResponses

> **PostApiV1AdminAgentsResponses** = `object`

Defined in: [src/client/types.gen.ts:2737](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2737)

## Properties

### 201

> **201**: [`HandlersAgentResponse`](HandlersAgentResponse.md)

Defined in: [src/client/types.gen.ts:2741](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2741)

Created

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AdminAppsByAppIdApiKeysData

# PostApiV1AdminAppsByAppIdApiKeysData

> **PostApiV1AdminAppsByAppIdApiKeysData** = `object`

Defined in: [src/client/types.gen.ts:2994](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2994)

## Properties

### body

> **body**: [`HandlersCreateApiKeyRequest`](HandlersCreateApiKeyRequest.md)

Defined in: [src/client/types.gen.ts:2998](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2998)

Create API key request

***

### headers

> **headers**: `object`

Defined in: [src/client/types.gen.ts:2999](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2999)

**X-Admin-API-Key**

> **X-Admin-API-Key**: `string`

Admin API key

***

### path

> **path**: `object`

Defined in: [src/client/types.gen.ts:3005](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3005)

**app\_id**

> **app\_id**: `number`

App ID

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:3011](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3011)

***

### url

> **url**: `"/api/v1/admin/apps/{app_id}/api-keys"`

Defined in: [src/client/types.gen.ts:3012](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3012)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AdminAppsByAppIdApiKeysError

# PostApiV1AdminAppsByAppIdApiKeysError

> **PostApiV1AdminAppsByAppIdApiKeysError** = [`PostApiV1AdminAppsByAppIdApiKeysErrors`](PostApiV1AdminAppsByAppIdApiKeysErrors.md)\[keyof [`PostApiV1AdminAppsByAppIdApiKeysErrors`](PostApiV1AdminAppsByAppIdApiKeysErrors.md)]

Defined in: [src/client/types.gen.ts:3034](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3034)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AdminAppsByAppIdApiKeysErrors

# PostApiV1AdminAppsByAppIdApiKeysErrors

> **PostApiV1AdminAppsByAppIdApiKeysErrors** = `object`

Defined in: [src/client/types.gen.ts:3015](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3015)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:3019](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3019)

Bad Request

***

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:3023](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3023)

Unauthorized

***

### 404

> **404**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:3027](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3027)

Not Found

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:3031](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3031)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AdminAppsByAppIdApiKeysResponse

# PostApiV1AdminAppsByAppIdApiKeysResponse

> **PostApiV1AdminAppsByAppIdApiKeysResponse** = [`PostApiV1AdminAppsByAppIdApiKeysResponses`](PostApiV1AdminAppsByAppIdApiKeysResponses.md)\[keyof [`PostApiV1AdminAppsByAppIdApiKeysResponses`](PostApiV1AdminAppsByAppIdApiKeysResponses.md)]

Defined in: [src/client/types.gen.ts:3043](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3043)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AdminAppsByAppIdApiKeysResponses

# PostApiV1AdminAppsByAppIdApiKeysResponses

> **PostApiV1AdminAppsByAppIdApiKeysResponses** = `object`

Defined in: [src/client/types.gen.ts:3036](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3036)

## Properties

### 201

> **201**: [`HandlersApiKeyWithKeyResponse`](HandlersApiKeyWithKeyResponse.md)

Defined in: [src/client/types.gen.ts:3040](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3040)

Created

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AdminAppsData

# PostApiV1AdminAppsData

> **PostApiV1AdminAppsData** = `object`

Defined in: [src/client/types.gen.ts:2895](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2895)

## Properties

### body

> **body**: [`HandlersCreateAppRequest`](HandlersCreateAppRequest.md)

Defined in: [src/client/types.gen.ts:2899](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2899)

Create app request

***

### headers

> **headers**: `object`

Defined in: [src/client/types.gen.ts:2900](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2900)

**X-Admin-API-Key**

> **X-Admin-API-Key**: `string`

Admin API key

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:2906](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2906)

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:2907](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2907)

***

### url

> **url**: `"/api/v1/admin/apps"`

Defined in: [src/client/types.gen.ts:2908](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2908)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AdminAppsError

# PostApiV1AdminAppsError

> **PostApiV1AdminAppsError** = [`PostApiV1AdminAppsErrors`](PostApiV1AdminAppsErrors.md)\[keyof [`PostApiV1AdminAppsErrors`](PostApiV1AdminAppsErrors.md)]

Defined in: [src/client/types.gen.ts:2926](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2926)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AdminAppsErrors

# PostApiV1AdminAppsErrors

> **PostApiV1AdminAppsErrors** = `object`

Defined in: [src/client/types.gen.ts:2911](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2911)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:2915](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2915)

Bad Request

***

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:2919](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2919)

Unauthorized

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:2923](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2923)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AdminAppsResponse

# PostApiV1AdminAppsResponse

> **PostApiV1AdminAppsResponse** = [`PostApiV1AdminAppsResponses`](PostApiV1AdminAppsResponses.md)\[keyof [`PostApiV1AdminAppsResponses`](PostApiV1AdminAppsResponses.md)]

Defined in: [src/client/types.gen.ts:2935](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2935)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AdminAppsResponses

# PostApiV1AdminAppsResponses

> **PostApiV1AdminAppsResponses** = `object`

Defined in: [src/client/types.gen.ts:2928](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2928)

## Properties

### 201

> **201**: [`HandlersAppResponse`](HandlersAppResponse.md)

Defined in: [src/client/types.gen.ts:2932](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2932)

Created

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AdminOauthClientsData

# PostApiV1AdminOauthClientsData

> **PostApiV1AdminOauthClientsData** = `object`

Defined in: [src/client/types.gen.ts:3370](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3370)

## Properties

### body

> **body**: [`HandlersCreateOAuthClientRequest`](HandlersCreateOAuthClientRequest.md)

Defined in: [src/client/types.gen.ts:3374](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3374)

Client registration request

***

### headers

> **headers**: `object`

Defined in: [src/client/types.gen.ts:3375](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3375)

**X-Admin-API-Key**

> **X-Admin-API-Key**: `string`

Admin API key

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:3381](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3381)

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:3382](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3382)

***

### url

> **url**: `"/api/v1/admin/oauth/clients"`

Defined in: [src/client/types.gen.ts:3383](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3383)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AdminOauthClientsError

# PostApiV1AdminOauthClientsError

> **PostApiV1AdminOauthClientsError** = [`PostApiV1AdminOauthClientsErrors`](PostApiV1AdminOauthClientsErrors.md)\[keyof [`PostApiV1AdminOauthClientsErrors`](PostApiV1AdminOauthClientsErrors.md)]

Defined in: [src/client/types.gen.ts:3401](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3401)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AdminOauthClientsErrors

# PostApiV1AdminOauthClientsErrors

> **PostApiV1AdminOauthClientsErrors** = `object`

Defined in: [src/client/types.gen.ts:3386](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3386)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:3390](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3390)

Bad Request

***

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:3394](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3394)

Unauthorized

***

### 409

> **409**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:3398](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3398)

Conflict

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AdminOauthClientsResponse

# PostApiV1AdminOauthClientsResponse

> **PostApiV1AdminOauthClientsResponse** = [`PostApiV1AdminOauthClientsResponses`](PostApiV1AdminOauthClientsResponses.md)\[keyof [`PostApiV1AdminOauthClientsResponses`](PostApiV1AdminOauthClientsResponses.md)]

Defined in: [src/client/types.gen.ts:3410](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3410)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AdminOauthClientsResponses

# PostApiV1AdminOauthClientsResponses

> **PostApiV1AdminOauthClientsResponses** = `object`

Defined in: [src/client/types.gen.ts:3403](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3403)

## Properties

### 201

> **201**: [`HandlersCreateOAuthClientResponse`](HandlersCreateOAuthClientResponse.md)

Defined in: [src/client/types.gen.ts:3407](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3407)

Created

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AdminPersonasData

# PostApiV1AdminPersonasData

> **PostApiV1AdminPersonasData** = `object`

Defined in: [src/client/types.gen.ts:3523](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3523)

## Properties

### body

> **body**: [`HandlersCreatePersonaRequest`](HandlersCreatePersonaRequest.md)

Defined in: [src/client/types.gen.ts:3527](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3527)

Create persona request

***

### headers

> **headers**: `object`

Defined in: [src/client/types.gen.ts:3528](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3528)

**X-Admin-API-Key**

> **X-Admin-API-Key**: `string`

Admin API key

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:3534](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3534)

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:3535](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3535)

***

### url

> **url**: `"/api/v1/admin/personas"`

Defined in: [src/client/types.gen.ts:3536](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3536)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AdminPersonasError

# PostApiV1AdminPersonasError

> **PostApiV1AdminPersonasError** = [`PostApiV1AdminPersonasErrors`](PostApiV1AdminPersonasErrors.md)\[keyof [`PostApiV1AdminPersonasErrors`](PostApiV1AdminPersonasErrors.md)]

Defined in: [src/client/types.gen.ts:3554](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3554)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AdminPersonasErrors

# PostApiV1AdminPersonasErrors

> **PostApiV1AdminPersonasErrors** = `object`

Defined in: [src/client/types.gen.ts:3539](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3539)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:3543](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3543)

Bad Request

***

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:3547](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3547)

Unauthorized

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:3551](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3551)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AdminPersonasResponse

# PostApiV1AdminPersonasResponse

> **PostApiV1AdminPersonasResponse** = [`PostApiV1AdminPersonasResponses`](PostApiV1AdminPersonasResponses.md)\[keyof [`PostApiV1AdminPersonasResponses`](PostApiV1AdminPersonasResponses.md)]

Defined in: [src/client/types.gen.ts:3563](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3563)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AdminPersonasResponses

# PostApiV1AdminPersonasResponses

> **PostApiV1AdminPersonasResponses** = `object`

Defined in: [src/client/types.gen.ts:3556](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3556)

## Properties

### 201

> **201**: [`HandlersPersonaResponse`](HandlersPersonaResponse.md)

Defined in: [src/client/types.gen.ts:3560](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3560)

Created

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AdminPrivyIdentifiersMigrateData

# PostApiV1AdminPrivyIdentifiersMigrateData

> **PostApiV1AdminPrivyIdentifiersMigrateData** = `object`

Defined in: [src/client/types.gen.ts:3701](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3701)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:3702](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3702)

***

### headers

> **headers**: `object`

Defined in: [src/client/types.gen.ts:3703](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3703)

**X-Admin-API-Key**

> **X-Admin-API-Key**: `string`

Admin API key

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:3709](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3709)

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:3710](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3710)

***

### url

> **url**: `"/api/v1/admin/privy-identifiers/migrate"`

Defined in: [src/client/types.gen.ts:3711](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3711)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AdminPrivyIdentifiersMigrateError

# PostApiV1AdminPrivyIdentifiersMigrateError

> **PostApiV1AdminPrivyIdentifiersMigrateError** = [`PostApiV1AdminPrivyIdentifiersMigrateErrors`](PostApiV1AdminPrivyIdentifiersMigrateErrors.md)\[keyof [`PostApiV1AdminPrivyIdentifiersMigrateErrors`](PostApiV1AdminPrivyIdentifiersMigrateErrors.md)]

Defined in: [src/client/types.gen.ts:3725](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3725)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AdminPrivyIdentifiersMigrateErrors

# PostApiV1AdminPrivyIdentifiersMigrateErrors

> **PostApiV1AdminPrivyIdentifiersMigrateErrors** = `object`

Defined in: [src/client/types.gen.ts:3714](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3714)

## Properties

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:3718](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3718)

Unauthorized

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:3722](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3722)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AdminPrivyIdentifiersMigrateResponse

# PostApiV1AdminPrivyIdentifiersMigrateResponse

> **PostApiV1AdminPrivyIdentifiersMigrateResponse** = [`PostApiV1AdminPrivyIdentifiersMigrateResponses`](PostApiV1AdminPrivyIdentifiersMigrateResponses.md)\[keyof [`PostApiV1AdminPrivyIdentifiersMigrateResponses`](PostApiV1AdminPrivyIdentifiersMigrateResponses.md)]

Defined in: [src/client/types.gen.ts:3734](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3734)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AdminPrivyIdentifiersMigrateResponses

# PostApiV1AdminPrivyIdentifiersMigrateResponses

> **PostApiV1AdminPrivyIdentifiersMigrateResponses** = `object`

Defined in: [src/client/types.gen.ts:3727](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3727)

## Properties

### 200

> **200**: [`HandlersPrivyIdentifierMigrateResponse`](HandlersPrivyIdentifierMigrateResponse.md)

Defined in: [src/client/types.gen.ts:3731](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3731)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AdminSeedAppsData

# PostApiV1AdminSeedAppsData

> **PostApiV1AdminSeedAppsData** = `object`

Defined in: [src/client/types.gen.ts:3736](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3736)

## Properties

### body

> **body**: [`HandlersSeedAppsRequest`](HandlersSeedAppsRequest.md)

Defined in: [src/client/types.gen.ts:3740](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3740)

Seed apps request

***

### headers

> **headers**: `object`

Defined in: [src/client/types.gen.ts:3741](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3741)

**X-Admin-API-Key**

> **X-Admin-API-Key**: `string`

Admin API key

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:3747](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3747)

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:3748](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3748)

***

### url

> **url**: `"/api/v1/admin/seed-apps"`

Defined in: [src/client/types.gen.ts:3749](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3749)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AdminSeedAppsError

# PostApiV1AdminSeedAppsError

> **PostApiV1AdminSeedAppsError** = [`PostApiV1AdminSeedAppsErrors`](PostApiV1AdminSeedAppsErrors.md)\[keyof [`PostApiV1AdminSeedAppsErrors`](PostApiV1AdminSeedAppsErrors.md)]

Defined in: [src/client/types.gen.ts:3767](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3767)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AdminSeedAppsErrors

# PostApiV1AdminSeedAppsErrors

> **PostApiV1AdminSeedAppsErrors** = `object`

Defined in: [src/client/types.gen.ts:3752](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3752)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:3756](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3756)

Bad Request

***

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:3760](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3760)

Unauthorized

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:3764](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3764)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AdminSeedAppsResponse

# PostApiV1AdminSeedAppsResponse

> **PostApiV1AdminSeedAppsResponse** = [`PostApiV1AdminSeedAppsResponses`](PostApiV1AdminSeedAppsResponses.md)\[keyof [`PostApiV1AdminSeedAppsResponses`](PostApiV1AdminSeedAppsResponses.md)]

Defined in: [src/client/types.gen.ts:3776](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3776)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AdminSeedAppsResponses

# PostApiV1AdminSeedAppsResponses

> **PostApiV1AdminSeedAppsResponses** = `object`

Defined in: [src/client/types.gen.ts:3769](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3769)

## Properties

### 200

> **200**: [`HandlersSeedAppsResponse`](HandlersSeedAppsResponse.md)

Defined in: [src/client/types.gen.ts:3773](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3773)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AdminSubscriptionTierData

# PostApiV1AdminSubscriptionTierData

> **PostApiV1AdminSubscriptionTierData** = `object`

Defined in: [src/client/types.gen.ts:3778](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3778)

## Properties

### body

> **body**: [`HandlersSetSubscriptionTierRequest`](HandlersSetSubscriptionTierRequest.md)

Defined in: [src/client/types.gen.ts:3782](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3782)

Set subscription tier request

***

### headers

> **headers**: `object`

Defined in: [src/client/types.gen.ts:3783](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3783)

**X-Admin-API-Key**

> **X-Admin-API-Key**: `string`

Admin API key

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:3789](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3789)

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:3790](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3790)

***

### url

> **url**: `"/api/v1/admin/subscription-tier"`

Defined in: [src/client/types.gen.ts:3791](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3791)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AdminSubscriptionTierError

# PostApiV1AdminSubscriptionTierError

> **PostApiV1AdminSubscriptionTierError** = [`PostApiV1AdminSubscriptionTierErrors`](PostApiV1AdminSubscriptionTierErrors.md)\[keyof [`PostApiV1AdminSubscriptionTierErrors`](PostApiV1AdminSubscriptionTierErrors.md)]

Defined in: [src/client/types.gen.ts:3813](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3813)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AdminSubscriptionTierErrors

# PostApiV1AdminSubscriptionTierErrors

> **PostApiV1AdminSubscriptionTierErrors** = `object`

Defined in: [src/client/types.gen.ts:3794](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3794)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:3798](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3798)

Bad Request

***

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:3802](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3802)

Unauthorized

***

### 404

> **404**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:3806](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3806)

Not Found

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:3810](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3810)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AdminSubscriptionTierResponse

# PostApiV1AdminSubscriptionTierResponse

> **PostApiV1AdminSubscriptionTierResponse** = [`PostApiV1AdminSubscriptionTierResponses`](PostApiV1AdminSubscriptionTierResponses.md)\[keyof [`PostApiV1AdminSubscriptionTierResponses`](PostApiV1AdminSubscriptionTierResponses.md)]

Defined in: [src/client/types.gen.ts:3822](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3822)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AdminSubscriptionTierResponses

# PostApiV1AdminSubscriptionTierResponses

> **PostApiV1AdminSubscriptionTierResponses** = `object`

Defined in: [src/client/types.gen.ts:3815](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3815)

## Properties

### 200

> **200**: [`HandlersSetSubscriptionTierResponse`](HandlersSetSubscriptionTierResponse.md)

Defined in: [src/client/types.gen.ts:3819](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3819)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AuthMfaDisableData

# PostApiV1AuthMfaDisableData

> **PostApiV1AuthMfaDisableData** = `object`

Defined in: [src/client/types.gen.ts:4131](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4131)

## Properties

### body

> **body**: [`HandlersDisableRequest`](HandlersDisableRequest.md)

Defined in: [src/client/types.gen.ts:4135](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4135)

method (+ code for recovery\_code)

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:4136](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4136)

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:4137](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4137)

***

### url

> **url**: `"/api/v1/auth/mfa/disable"`

Defined in: [src/client/types.gen.ts:4138](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4138)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AuthMfaDisableError

# PostApiV1AuthMfaDisableError

> **PostApiV1AuthMfaDisableError** = [`PostApiV1AuthMfaDisableErrors`](PostApiV1AuthMfaDisableErrors.md)\[keyof [`PostApiV1AuthMfaDisableErrors`](PostApiV1AuthMfaDisableErrors.md)]

Defined in: [src/client/types.gen.ts:4156](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4156)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AuthMfaDisableErrors

# PostApiV1AuthMfaDisableErrors

> **PostApiV1AuthMfaDisableErrors** = `object`

Defined in: [src/client/types.gen.ts:4141](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4141)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4145](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4145)

Bad Request

***

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4149](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4149)

Unauthorized

***

### 423

> **423**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4153](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4153)

Locked

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AuthMfaDisableResponse

# PostApiV1AuthMfaDisableResponse

> **PostApiV1AuthMfaDisableResponse** = [`PostApiV1AuthMfaDisableResponses`](PostApiV1AuthMfaDisableResponses.md)\[keyof [`PostApiV1AuthMfaDisableResponses`](PostApiV1AuthMfaDisableResponses.md)]

Defined in: [src/client/types.gen.ts:4167](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4167)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AuthMfaDisableResponses

# PostApiV1AuthMfaDisableResponses

> **PostApiV1AuthMfaDisableResponses** = `object`

Defined in: [src/client/types.gen.ts:4158](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4158)

## Properties

### 200

> **200**: `object`

Defined in: [src/client/types.gen.ts:4162](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4162)

OK

**Index Signature**

\[`key`: `string`]: `boolean`

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AuthMfaPasskeyEnrollBeginData

# PostApiV1AuthMfaPasskeyEnrollBeginData

> **PostApiV1AuthMfaPasskeyEnrollBeginData** = `object`

Defined in: [src/client/types.gen.ts:4203](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4203)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:4204](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4204)

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:4205](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4205)

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:4206](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4206)

***

### url

> **url**: `"/api/v1/auth/mfa/passkey/enroll/begin"`

Defined in: [src/client/types.gen.ts:4207](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4207)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AuthMfaPasskeyEnrollBeginError

# PostApiV1AuthMfaPasskeyEnrollBeginError

> **PostApiV1AuthMfaPasskeyEnrollBeginError** = [`PostApiV1AuthMfaPasskeyEnrollBeginErrors`](PostApiV1AuthMfaPasskeyEnrollBeginErrors.md)\[keyof [`PostApiV1AuthMfaPasskeyEnrollBeginErrors`](PostApiV1AuthMfaPasskeyEnrollBeginErrors.md)]

Defined in: [src/client/types.gen.ts:4217](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4217)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AuthMfaPasskeyEnrollBeginErrors

# PostApiV1AuthMfaPasskeyEnrollBeginErrors

> **PostApiV1AuthMfaPasskeyEnrollBeginErrors** = `object`

Defined in: [src/client/types.gen.ts:4210](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4210)

## Properties

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4214](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4214)

Unauthorized

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AuthMfaPasskeyEnrollBeginResponse

# PostApiV1AuthMfaPasskeyEnrollBeginResponse

> **PostApiV1AuthMfaPasskeyEnrollBeginResponse** = [`PostApiV1AuthMfaPasskeyEnrollBeginResponses`](PostApiV1AuthMfaPasskeyEnrollBeginResponses.md)\[keyof [`PostApiV1AuthMfaPasskeyEnrollBeginResponses`](PostApiV1AuthMfaPasskeyEnrollBeginResponses.md)]

Defined in: [src/client/types.gen.ts:4228](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4228)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AuthMfaPasskeyEnrollBeginResponses

# PostApiV1AuthMfaPasskeyEnrollBeginResponses

> **PostApiV1AuthMfaPasskeyEnrollBeginResponses** = `object`

Defined in: [src/client/types.gen.ts:4219](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4219)

## Properties

### 200

> **200**: `object`

Defined in: [src/client/types.gen.ts:4223](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4223)

OK

**Index Signature**

\[`key`: `string`]: `unknown`

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AuthMfaPasskeyEnrollFinishData

# PostApiV1AuthMfaPasskeyEnrollFinishData

> **PostApiV1AuthMfaPasskeyEnrollFinishData** = `object`

Defined in: [src/client/types.gen.ts:4230](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4230)

## Properties

### body

> **body**: [`HandlersPasskeyEnrollFinishRequest`](HandlersPasskeyEnrollFinishRequest.md)

Defined in: [src/client/types.gen.ts:4234](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4234)

credential + label

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:4235](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4235)

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:4236](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4236)

***

### url

> **url**: `"/api/v1/auth/mfa/passkey/enroll/finish"`

Defined in: [src/client/types.gen.ts:4237](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4237)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AuthMfaPasskeyEnrollFinishError

# PostApiV1AuthMfaPasskeyEnrollFinishError

> **PostApiV1AuthMfaPasskeyEnrollFinishError** = [`PostApiV1AuthMfaPasskeyEnrollFinishErrors`](PostApiV1AuthMfaPasskeyEnrollFinishErrors.md)\[keyof [`PostApiV1AuthMfaPasskeyEnrollFinishErrors`](PostApiV1AuthMfaPasskeyEnrollFinishErrors.md)]

Defined in: [src/client/types.gen.ts:4251](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4251)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AuthMfaPasskeyEnrollFinishErrors

# PostApiV1AuthMfaPasskeyEnrollFinishErrors

> **PostApiV1AuthMfaPasskeyEnrollFinishErrors** = `object`

Defined in: [src/client/types.gen.ts:4240](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4240)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4244](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4244)

Bad Request

***

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4248](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4248)

Unauthorized

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AuthMfaPasskeyEnrollFinishResponse

# PostApiV1AuthMfaPasskeyEnrollFinishResponse

> **PostApiV1AuthMfaPasskeyEnrollFinishResponse** = [`PostApiV1AuthMfaPasskeyEnrollFinishResponses`](PostApiV1AuthMfaPasskeyEnrollFinishResponses.md)\[keyof [`PostApiV1AuthMfaPasskeyEnrollFinishResponses`](PostApiV1AuthMfaPasskeyEnrollFinishResponses.md)]

Defined in: [src/client/types.gen.ts:4260](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4260)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AuthMfaPasskeyEnrollFinishResponses

# PostApiV1AuthMfaPasskeyEnrollFinishResponses

> **PostApiV1AuthMfaPasskeyEnrollFinishResponses** = `object`

Defined in: [src/client/types.gen.ts:4253](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4253)

## Properties

### 200

> **200**: [`HandlersPasskeyEnrollFinishResponse`](HandlersPasskeyEnrollFinishResponse.md)

Defined in: [src/client/types.gen.ts:4257](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4257)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AuthMfaPasskeyVerifyBeginData

# PostApiV1AuthMfaPasskeyVerifyBeginData

> **PostApiV1AuthMfaPasskeyVerifyBeginData** = `object`

Defined in: [src/client/types.gen.ts:4262](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4262)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:4263](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4263)

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:4264](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4264)

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:4265](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4265)

***

### url

> **url**: `"/api/v1/auth/mfa/passkey/verify/begin"`

Defined in: [src/client/types.gen.ts:4266](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4266)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AuthMfaPasskeyVerifyBeginError

# PostApiV1AuthMfaPasskeyVerifyBeginError

> **PostApiV1AuthMfaPasskeyVerifyBeginError** = [`PostApiV1AuthMfaPasskeyVerifyBeginErrors`](PostApiV1AuthMfaPasskeyVerifyBeginErrors.md)\[keyof [`PostApiV1AuthMfaPasskeyVerifyBeginErrors`](PostApiV1AuthMfaPasskeyVerifyBeginErrors.md)]

Defined in: [src/client/types.gen.ts:4280](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4280)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AuthMfaPasskeyVerifyBeginErrors

# PostApiV1AuthMfaPasskeyVerifyBeginErrors

> **PostApiV1AuthMfaPasskeyVerifyBeginErrors** = `object`

Defined in: [src/client/types.gen.ts:4269](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4269)

## Properties

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4273](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4273)

Unauthorized

***

### 404

> **404**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4277](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4277)

Not Found

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AuthMfaPasskeyVerifyBeginResponse

# PostApiV1AuthMfaPasskeyVerifyBeginResponse

> **PostApiV1AuthMfaPasskeyVerifyBeginResponse** = [`PostApiV1AuthMfaPasskeyVerifyBeginResponses`](PostApiV1AuthMfaPasskeyVerifyBeginResponses.md)\[keyof [`PostApiV1AuthMfaPasskeyVerifyBeginResponses`](PostApiV1AuthMfaPasskeyVerifyBeginResponses.md)]

Defined in: [src/client/types.gen.ts:4291](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4291)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AuthMfaPasskeyVerifyBeginResponses

# PostApiV1AuthMfaPasskeyVerifyBeginResponses

> **PostApiV1AuthMfaPasskeyVerifyBeginResponses** = `object`

Defined in: [src/client/types.gen.ts:4282](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4282)

## Properties

### 200

> **200**: `object`

Defined in: [src/client/types.gen.ts:4286](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4286)

OK

**Index Signature**

\[`key`: `string`]: `unknown`

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AuthMfaPasskeyVerifyFinishData

# PostApiV1AuthMfaPasskeyVerifyFinishData

> **PostApiV1AuthMfaPasskeyVerifyFinishData** = `object`

Defined in: [src/client/types.gen.ts:4293](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4293)

## Properties

### body

> **body**: [`HandlersPasskeyVerifyFinishRequest`](HandlersPasskeyVerifyFinishRequest.md)

Defined in: [src/client/types.gen.ts:4297](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4297)

credential

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:4298](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4298)

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:4299](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4299)

***

### url

> **url**: `"/api/v1/auth/mfa/passkey/verify/finish"`

Defined in: [src/client/types.gen.ts:4300](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4300)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AuthMfaPasskeyVerifyFinishError

# PostApiV1AuthMfaPasskeyVerifyFinishError

> **PostApiV1AuthMfaPasskeyVerifyFinishError** = [`PostApiV1AuthMfaPasskeyVerifyFinishErrors`](PostApiV1AuthMfaPasskeyVerifyFinishErrors.md)\[keyof [`PostApiV1AuthMfaPasskeyVerifyFinishErrors`](PostApiV1AuthMfaPasskeyVerifyFinishErrors.md)]

Defined in: [src/client/types.gen.ts:4318](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4318)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AuthMfaPasskeyVerifyFinishErrors

# PostApiV1AuthMfaPasskeyVerifyFinishErrors

> **PostApiV1AuthMfaPasskeyVerifyFinishErrors** = `object`

Defined in: [src/client/types.gen.ts:4303](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4303)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4307](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4307)

Bad Request

***

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4311](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4311)

Unauthorized

***

### 423

> **423**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4315](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4315)

Locked

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AuthMfaPasskeyVerifyFinishResponse

# PostApiV1AuthMfaPasskeyVerifyFinishResponse

> **PostApiV1AuthMfaPasskeyVerifyFinishResponse** = [`PostApiV1AuthMfaPasskeyVerifyFinishResponses`](PostApiV1AuthMfaPasskeyVerifyFinishResponses.md)\[keyof [`PostApiV1AuthMfaPasskeyVerifyFinishResponses`](PostApiV1AuthMfaPasskeyVerifyFinishResponses.md)]

Defined in: [src/client/types.gen.ts:4327](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4327)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AuthMfaPasskeyVerifyFinishResponses

# PostApiV1AuthMfaPasskeyVerifyFinishResponses

> **PostApiV1AuthMfaPasskeyVerifyFinishResponses** = `object`

Defined in: [src/client/types.gen.ts:4320](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4320)

## Properties

### 200

> **200**: [`HandlersMfaSessionResponse`](HandlersMfaSessionResponse.md)

Defined in: [src/client/types.gen.ts:4324](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4324)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AuthMfaRecoveryCodesRegenerateData

# PostApiV1AuthMfaRecoveryCodesRegenerateData

> **PostApiV1AuthMfaRecoveryCodesRegenerateData** = `object`

Defined in: [src/client/types.gen.ts:4329](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4329)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:4330](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4330)

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:4331](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4331)

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:4332](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4332)

***

### url

> **url**: `"/api/v1/auth/mfa/recovery-codes/regenerate"`

Defined in: [src/client/types.gen.ts:4333](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4333)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AuthMfaRecoveryCodesRegenerateError

# PostApiV1AuthMfaRecoveryCodesRegenerateError

> **PostApiV1AuthMfaRecoveryCodesRegenerateError** = [`PostApiV1AuthMfaRecoveryCodesRegenerateErrors`](PostApiV1AuthMfaRecoveryCodesRegenerateErrors.md)\[keyof [`PostApiV1AuthMfaRecoveryCodesRegenerateErrors`](PostApiV1AuthMfaRecoveryCodesRegenerateErrors.md)]

Defined in: [src/client/types.gen.ts:4343](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4343)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AuthMfaRecoveryCodesRegenerateErrors

# PostApiV1AuthMfaRecoveryCodesRegenerateErrors

> **PostApiV1AuthMfaRecoveryCodesRegenerateErrors** = `object`

Defined in: [src/client/types.gen.ts:4336](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4336)

## Properties

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4340](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4340)

Unauthorized

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AuthMfaRecoveryCodesRegenerateResponse

# PostApiV1AuthMfaRecoveryCodesRegenerateResponse

> **PostApiV1AuthMfaRecoveryCodesRegenerateResponse** = [`PostApiV1AuthMfaRecoveryCodesRegenerateResponses`](PostApiV1AuthMfaRecoveryCodesRegenerateResponses.md)\[keyof [`PostApiV1AuthMfaRecoveryCodesRegenerateResponses`](PostApiV1AuthMfaRecoveryCodesRegenerateResponses.md)]

Defined in: [src/client/types.gen.ts:4354](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4354)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AuthMfaRecoveryCodesRegenerateResponses

# PostApiV1AuthMfaRecoveryCodesRegenerateResponses

> **PostApiV1AuthMfaRecoveryCodesRegenerateResponses** = `object`

Defined in: [src/client/types.gen.ts:4345](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4345)

## Properties

### 200

> **200**: `object`

Defined in: [src/client/types.gen.ts:4349](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4349)

OK

**Index Signature**

\[`key`: `string`]: `string`\[]

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AuthMfaTotpEnrollInitData

# PostApiV1AuthMfaTotpEnrollInitData

> **PostApiV1AuthMfaTotpEnrollInitData** = `object`

Defined in: [src/client/types.gen.ts:4381](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4381)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:4382](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4382)

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:4383](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4383)

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:4384](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4384)

***

### url

> **url**: `"/api/v1/auth/mfa/totp/enroll/init"`

Defined in: [src/client/types.gen.ts:4385](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4385)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AuthMfaTotpEnrollInitError

# PostApiV1AuthMfaTotpEnrollInitError

> **PostApiV1AuthMfaTotpEnrollInitError** = [`PostApiV1AuthMfaTotpEnrollInitErrors`](PostApiV1AuthMfaTotpEnrollInitErrors.md)\[keyof [`PostApiV1AuthMfaTotpEnrollInitErrors`](PostApiV1AuthMfaTotpEnrollInitErrors.md)]

Defined in: [src/client/types.gen.ts:4395](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4395)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AuthMfaTotpEnrollInitErrors

# PostApiV1AuthMfaTotpEnrollInitErrors

> **PostApiV1AuthMfaTotpEnrollInitErrors** = `object`

Defined in: [src/client/types.gen.ts:4388](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4388)

## Properties

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4392](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4392)

Unauthorized

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AuthMfaTotpEnrollInitResponse

# PostApiV1AuthMfaTotpEnrollInitResponse

> **PostApiV1AuthMfaTotpEnrollInitResponse** = [`PostApiV1AuthMfaTotpEnrollInitResponses`](PostApiV1AuthMfaTotpEnrollInitResponses.md)\[keyof [`PostApiV1AuthMfaTotpEnrollInitResponses`](PostApiV1AuthMfaTotpEnrollInitResponses.md)]

Defined in: [src/client/types.gen.ts:4404](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4404)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AuthMfaTotpEnrollInitResponses

# PostApiV1AuthMfaTotpEnrollInitResponses

> **PostApiV1AuthMfaTotpEnrollInitResponses** = `object`

Defined in: [src/client/types.gen.ts:4397](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4397)

## Properties

### 200

> **200**: [`HandlersTotpEnrollInitResponse`](HandlersTotpEnrollInitResponse.md)

Defined in: [src/client/types.gen.ts:4401](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4401)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AuthMfaTotpEnrollVerifyData

# PostApiV1AuthMfaTotpEnrollVerifyData

> **PostApiV1AuthMfaTotpEnrollVerifyData** = `object`

Defined in: [src/client/types.gen.ts:4406](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4406)

## Properties

### body

> **body**: [`HandlersTotpVerifyRequest`](HandlersTotpVerifyRequest.md)

Defined in: [src/client/types.gen.ts:4410](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4410)

code

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:4411](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4411)

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:4412](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4412)

***

### url

> **url**: `"/api/v1/auth/mfa/totp/enroll/verify"`

Defined in: [src/client/types.gen.ts:4413](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4413)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AuthMfaTotpEnrollVerifyError

# PostApiV1AuthMfaTotpEnrollVerifyError

> **PostApiV1AuthMfaTotpEnrollVerifyError** = [`PostApiV1AuthMfaTotpEnrollVerifyErrors`](PostApiV1AuthMfaTotpEnrollVerifyErrors.md)\[keyof [`PostApiV1AuthMfaTotpEnrollVerifyErrors`](PostApiV1AuthMfaTotpEnrollVerifyErrors.md)]

Defined in: [src/client/types.gen.ts:4431](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4431)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AuthMfaTotpEnrollVerifyErrors

# PostApiV1AuthMfaTotpEnrollVerifyErrors

> **PostApiV1AuthMfaTotpEnrollVerifyErrors** = `object`

Defined in: [src/client/types.gen.ts:4416](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4416)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4420](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4420)

Bad Request

***

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4424](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4424)

Unauthorized

***

### 423

> **423**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4428](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4428)

Locked

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AuthMfaTotpEnrollVerifyResponse

# PostApiV1AuthMfaTotpEnrollVerifyResponse

> **PostApiV1AuthMfaTotpEnrollVerifyResponse** = [`PostApiV1AuthMfaTotpEnrollVerifyResponses`](PostApiV1AuthMfaTotpEnrollVerifyResponses.md)\[keyof [`PostApiV1AuthMfaTotpEnrollVerifyResponses`](PostApiV1AuthMfaTotpEnrollVerifyResponses.md)]

Defined in: [src/client/types.gen.ts:4440](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4440)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AuthMfaTotpEnrollVerifyResponses

# PostApiV1AuthMfaTotpEnrollVerifyResponses

> **PostApiV1AuthMfaTotpEnrollVerifyResponses** = `object`

Defined in: [src/client/types.gen.ts:4433](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4433)

## Properties

### 200

> **200**: [`HandlersMfaSessionResponse`](HandlersMfaSessionResponse.md)

Defined in: [src/client/types.gen.ts:4437](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4437)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AuthMfaVerifyData

# PostApiV1AuthMfaVerifyData

> **PostApiV1AuthMfaVerifyData** = `object`

Defined in: [src/client/types.gen.ts:4442](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4442)

## Properties

### body

> **body**: [`HandlersVerifyRequest`](HandlersVerifyRequest.md)

Defined in: [src/client/types.gen.ts:4446](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4446)

method + code

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:4447](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4447)

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:4448](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4448)

***

### url

> **url**: `"/api/v1/auth/mfa/verify"`

Defined in: [src/client/types.gen.ts:4449](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4449)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AuthMfaVerifyError

# PostApiV1AuthMfaVerifyError

> **PostApiV1AuthMfaVerifyError** = [`PostApiV1AuthMfaVerifyErrors`](PostApiV1AuthMfaVerifyErrors.md)\[keyof [`PostApiV1AuthMfaVerifyErrors`](PostApiV1AuthMfaVerifyErrors.md)]

Defined in: [src/client/types.gen.ts:4467](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4467)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AuthMfaVerifyErrors

# PostApiV1AuthMfaVerifyErrors

> **PostApiV1AuthMfaVerifyErrors** = `object`

Defined in: [src/client/types.gen.ts:4452](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4452)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4456](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4456)

Bad Request

***

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4460](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4460)

Unauthorized

***

### 423

> **423**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4464](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4464)

Locked

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AuthMfaVerifyResponse

# PostApiV1AuthMfaVerifyResponse

> **PostApiV1AuthMfaVerifyResponse** = [`PostApiV1AuthMfaVerifyResponses`](PostApiV1AuthMfaVerifyResponses.md)\[keyof [`PostApiV1AuthMfaVerifyResponses`](PostApiV1AuthMfaVerifyResponses.md)]

Defined in: [src/client/types.gen.ts:4476](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4476)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1AuthMfaVerifyResponses

# PostApiV1AuthMfaVerifyResponses

> **PostApiV1AuthMfaVerifyResponses** = `object`

Defined in: [src/client/types.gen.ts:4469](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4469)

## Properties

### 200

> **200**: [`HandlersMfaSessionResponse`](HandlersMfaSessionResponse.md)

Defined in: [src/client/types.gen.ts:4473](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4473)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1ChatCompletionsData

# PostApiV1ChatCompletionsData

> **PostApiV1ChatCompletionsData** = `object`

Defined in: [src/client/types.gen.ts:4503](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4503)

## Properties

### body

> **body**: [`LlmapiChatCompletionRequest`](LlmapiChatCompletionRequest.md)

Defined in: [src/client/types.gen.ts:4507](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4507)

Chat completion request

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:4508](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4508)

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:4509](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4509)

***

### url

> **url**: `"/api/v1/chat/completions"`

Defined in: [src/client/types.gen.ts:4510](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4510)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1ChatCompletionsError

# PostApiV1ChatCompletionsError

> **PostApiV1ChatCompletionsError** = [`PostApiV1ChatCompletionsErrors`](PostApiV1ChatCompletionsErrors.md)\[keyof [`PostApiV1ChatCompletionsErrors`](PostApiV1ChatCompletionsErrors.md)]

Defined in: [src/client/types.gen.ts:4536](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4536)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1ChatCompletionsErrors

# PostApiV1ChatCompletionsErrors

> **PostApiV1ChatCompletionsErrors** = `object`

Defined in: [src/client/types.gen.ts:4513](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4513)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4517](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4517)

Bad Request

***

### 402

> **402**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4521](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4521)

Insufficient balance or spending cap exceeded

***

### 403

> **403**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4525](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4525)

Model not available on current subscription tier

***

### 429

> **429**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4529](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4529)

Model provider rate limit exceeded

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4533](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4533)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1ChatCompletionsResponse

# PostApiV1ChatCompletionsResponse

> **PostApiV1ChatCompletionsResponse** = [`PostApiV1ChatCompletionsResponses`](PostApiV1ChatCompletionsResponses.md)\[keyof [`PostApiV1ChatCompletionsResponses`](PostApiV1ChatCompletionsResponses.md)]

Defined in: [src/client/types.gen.ts:4545](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4545)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1ChatCompletionsResponses

# PostApiV1ChatCompletionsResponses

> **PostApiV1ChatCompletionsResponses** = `object`

Defined in: [src/client/types.gen.ts:4538](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4538)

## Properties

### 200

> **200**: [`LlmapiChatCompletionResponse`](LlmapiChatCompletionResponse.md) | `string`

Defined in: [src/client/types.gen.ts:4542](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4542)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1CreditsPurchaseData

# PostApiV1CreditsPurchaseData

> **PostApiV1CreditsPurchaseData** = `object`

Defined in: [src/client/types.gen.ts:4644](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4644)

## Properties

### body

> **body**: [`HandlersCreateCreditPackCheckoutRequest`](HandlersCreateCreditPackCheckoutRequest.md)

Defined in: [src/client/types.gen.ts:4648](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4648)

Credit pack checkout request

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:4649](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4649)

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:4650](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4650)

***

### url

> **url**: `"/api/v1/credits/purchase"`

Defined in: [src/client/types.gen.ts:4651](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4651)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1CreditsPurchaseError

# PostApiV1CreditsPurchaseError

> **PostApiV1CreditsPurchaseError** = [`PostApiV1CreditsPurchaseErrors`](PostApiV1CreditsPurchaseErrors.md)\[keyof [`PostApiV1CreditsPurchaseErrors`](PostApiV1CreditsPurchaseErrors.md)]

Defined in: [src/client/types.gen.ts:4673](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4673)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1CreditsPurchaseErrors

# PostApiV1CreditsPurchaseErrors

> **PostApiV1CreditsPurchaseErrors** = `object`

Defined in: [src/client/types.gen.ts:4654](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4654)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4658](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4658)

Bad Request

***

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4662](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4662)

Unauthorized

***

### 403

> **403**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4666](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4666)

Forbidden

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4670](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4670)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1CreditsPurchaseResponse

# PostApiV1CreditsPurchaseResponse

> **PostApiV1CreditsPurchaseResponse** = [`PostApiV1CreditsPurchaseResponses`](PostApiV1CreditsPurchaseResponses.md)\[keyof [`PostApiV1CreditsPurchaseResponses`](PostApiV1CreditsPurchaseResponses.md)]

Defined in: [src/client/types.gen.ts:4682](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4682)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1CreditsPurchaseResponses

# PostApiV1CreditsPurchaseResponses

> **PostApiV1CreditsPurchaseResponses** = `object`

Defined in: [src/client/types.gen.ts:4675](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4675)

## Properties

### 200

> **200**: [`HandlersCheckoutSessionResponse`](HandlersCheckoutSessionResponse.md)

Defined in: [src/client/types.gen.ts:4679](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4679)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1CreditsRedeemTokensData

# PostApiV1CreditsRedeemTokensData

> **PostApiV1CreditsRedeemTokensData** = `object`

Defined in: [src/client/types.gen.ts:4684](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4684)

## Properties

### body

> **body**: [`HandlersRedeemTokensRequest`](HandlersRedeemTokensRequest.md)

Defined in: [src/client/types.gen.ts:4688](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4688)

Redemption request

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:4689](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4689)

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:4690](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4690)

***

### url

> **url**: `"/api/v1/credits/redeem-tokens"`

Defined in: [src/client/types.gen.ts:4691](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4691)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1CreditsRedeemTokensError

# PostApiV1CreditsRedeemTokensError

> **PostApiV1CreditsRedeemTokensError** = [`PostApiV1CreditsRedeemTokensErrors`](PostApiV1CreditsRedeemTokensErrors.md)\[keyof [`PostApiV1CreditsRedeemTokensErrors`](PostApiV1CreditsRedeemTokensErrors.md)]

Defined in: [src/client/types.gen.ts:4713](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4713)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1CreditsRedeemTokensErrors

# PostApiV1CreditsRedeemTokensErrors

> **PostApiV1CreditsRedeemTokensErrors** = `object`

Defined in: [src/client/types.gen.ts:4694](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4694)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4698](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4698)

Bad Request

***

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4702](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4702)

Unauthorized

***

### 409

> **409**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4706](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4706)

Conflict

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4710](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4710)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1CreditsRedeemTokensResponse

# PostApiV1CreditsRedeemTokensResponse

> **PostApiV1CreditsRedeemTokensResponse** = [`PostApiV1CreditsRedeemTokensResponses`](PostApiV1CreditsRedeemTokensResponses.md)\[keyof [`PostApiV1CreditsRedeemTokensResponses`](PostApiV1CreditsRedeemTokensResponses.md)]

Defined in: [src/client/types.gen.ts:4722](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4722)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1CreditsRedeemTokensResponses

# PostApiV1CreditsRedeemTokensResponses

> **PostApiV1CreditsRedeemTokensResponses** = `object`

Defined in: [src/client/types.gen.ts:4715](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4715)

## Properties

### 200

> **200**: [`HandlersRedeemTokensResponse`](HandlersRedeemTokensResponse.md)

Defined in: [src/client/types.gen.ts:4719](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4719)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1DeveloperAppsByAppUuidApiKeysData

# PostApiV1DeveloperAppsByAppUuidApiKeysData

> **PostApiV1DeveloperAppsByAppUuidApiKeysData** = `object`

Defined in: [src/client/types.gen.ts:5008](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5008)

## Properties

### body

> **body**: [`HandlersDeveloperApiKeyRequest`](HandlersDeveloperApiKeyRequest.md)

Defined in: [src/client/types.gen.ts:5012](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5012)

API key request

***

### path

> **path**: `object`

Defined in: [src/client/types.gen.ts:5013](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5013)

**app\_uuid**

> **app\_uuid**: `string`

App UUID

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:5019](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5019)

***

### url

> **url**: `"/api/v1/developer/apps/{app_uuid}/api-keys"`

Defined in: [src/client/types.gen.ts:5020](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5020)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1DeveloperAppsByAppUuidApiKeysError

# PostApiV1DeveloperAppsByAppUuidApiKeysError

> **PostApiV1DeveloperAppsByAppUuidApiKeysError** = [`PostApiV1DeveloperAppsByAppUuidApiKeysErrors`](PostApiV1DeveloperAppsByAppUuidApiKeysErrors.md)\[keyof [`PostApiV1DeveloperAppsByAppUuidApiKeysErrors`](PostApiV1DeveloperAppsByAppUuidApiKeysErrors.md)]

Defined in: [src/client/types.gen.ts:5046](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5046)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1DeveloperAppsByAppUuidApiKeysErrors

# PostApiV1DeveloperAppsByAppUuidApiKeysErrors

> **PostApiV1DeveloperAppsByAppUuidApiKeysErrors** = `object`

Defined in: [src/client/types.gen.ts:5023](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5023)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5027](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5027)

Bad Request

***

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5031](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5031)

Unauthorized

***

### 403

> **403**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5035](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5035)

Forbidden

***

### 404

> **404**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5039](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5039)

Not Found

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5043](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5043)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1DeveloperAppsByAppUuidApiKeysResponse

# PostApiV1DeveloperAppsByAppUuidApiKeysResponse

> **PostApiV1DeveloperAppsByAppUuidApiKeysResponse** = [`PostApiV1DeveloperAppsByAppUuidApiKeysResponses`](PostApiV1DeveloperAppsByAppUuidApiKeysResponses.md)\[keyof [`PostApiV1DeveloperAppsByAppUuidApiKeysResponses`](PostApiV1DeveloperAppsByAppUuidApiKeysResponses.md)]

Defined in: [src/client/types.gen.ts:5055](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5055)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1DeveloperAppsByAppUuidApiKeysResponses

# PostApiV1DeveloperAppsByAppUuidApiKeysResponses

> **PostApiV1DeveloperAppsByAppUuidApiKeysResponses** = `object`

Defined in: [src/client/types.gen.ts:5048](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5048)

## Properties

### 201

> **201**: [`HandlersDeveloperApiKeyWithSecretResponse`](HandlersDeveloperApiKeyWithSecretResponse.md)

Defined in: [src/client/types.gen.ts:5052](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5052)

Created

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1DeveloperAppsByAppUuidFundData

# PostApiV1DeveloperAppsByAppUuidFundData

> **PostApiV1DeveloperAppsByAppUuidFundData** = `object`

Defined in: [src/client/types.gen.ts:5105](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5105)

## Properties

### body

> **body**: [`HandlersFundDeveloperAppRequest`](HandlersFundDeveloperAppRequest.md)

Defined in: [src/client/types.gen.ts:5109](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5109)

Fund request

***

### path

> **path**: `object`

Defined in: [src/client/types.gen.ts:5110](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5110)

**app\_uuid**

> **app\_uuid**: `string`

App UUID

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:5116](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5116)

***

### url

> **url**: `"/api/v1/developer/apps/{app_uuid}/fund"`

Defined in: [src/client/types.gen.ts:5117](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5117)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1DeveloperAppsByAppUuidFundError

# PostApiV1DeveloperAppsByAppUuidFundError

> **PostApiV1DeveloperAppsByAppUuidFundError** = [`PostApiV1DeveloperAppsByAppUuidFundErrors`](PostApiV1DeveloperAppsByAppUuidFundErrors.md)\[keyof [`PostApiV1DeveloperAppsByAppUuidFundErrors`](PostApiV1DeveloperAppsByAppUuidFundErrors.md)]

Defined in: [src/client/types.gen.ts:5143](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5143)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1DeveloperAppsByAppUuidFundErrors

# PostApiV1DeveloperAppsByAppUuidFundErrors

> **PostApiV1DeveloperAppsByAppUuidFundErrors** = `object`

Defined in: [src/client/types.gen.ts:5120](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5120)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5124](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5124)

Bad Request

***

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5128](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5128)

Unauthorized

***

### 403

> **403**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5132](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5132)

Forbidden

***

### 404

> **404**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5136](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5136)

Not Found

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5140](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5140)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1DeveloperAppsByAppUuidFundResponse

# PostApiV1DeveloperAppsByAppUuidFundResponse

> **PostApiV1DeveloperAppsByAppUuidFundResponse** = [`PostApiV1DeveloperAppsByAppUuidFundResponses`](PostApiV1DeveloperAppsByAppUuidFundResponses.md)\[keyof [`PostApiV1DeveloperAppsByAppUuidFundResponses`](PostApiV1DeveloperAppsByAppUuidFundResponses.md)]

Defined in: [src/client/types.gen.ts:5152](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5152)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1DeveloperAppsByAppUuidFundResponses

# PostApiV1DeveloperAppsByAppUuidFundResponses

> **PostApiV1DeveloperAppsByAppUuidFundResponses** = `object`

Defined in: [src/client/types.gen.ts:5145](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5145)

## Properties

### 200

> **200**: [`HandlersCheckoutSessionResponse`](HandlersCheckoutSessionResponse.md)

Defined in: [src/client/types.gen.ts:5149](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5149)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1DeveloperAppsByAppUuidPrivyData

# PostApiV1DeveloperAppsByAppUuidPrivyData

> **PostApiV1DeveloperAppsByAppUuidPrivyData** = `object`

Defined in: [src/client/types.gen.ts:5196](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5196)

## Properties

### body

> **body**: [`HandlersConfigurePrivyRequest`](HandlersConfigurePrivyRequest.md)

Defined in: [src/client/types.gen.ts:5200](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5200)

Privy configuration

***

### path

> **path**: `object`

Defined in: [src/client/types.gen.ts:5201](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5201)

**app\_uuid**

> **app\_uuid**: `string`

App UUID

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:5207](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5207)

***

### url

> **url**: `"/api/v1/developer/apps/{app_uuid}/privy"`

Defined in: [src/client/types.gen.ts:5208](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5208)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1DeveloperAppsByAppUuidPrivyError

# PostApiV1DeveloperAppsByAppUuidPrivyError

> **PostApiV1DeveloperAppsByAppUuidPrivyError** = [`PostApiV1DeveloperAppsByAppUuidPrivyErrors`](PostApiV1DeveloperAppsByAppUuidPrivyErrors.md)\[keyof [`PostApiV1DeveloperAppsByAppUuidPrivyErrors`](PostApiV1DeveloperAppsByAppUuidPrivyErrors.md)]

Defined in: [src/client/types.gen.ts:5234](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5234)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1DeveloperAppsByAppUuidPrivyErrors

# PostApiV1DeveloperAppsByAppUuidPrivyErrors

> **PostApiV1DeveloperAppsByAppUuidPrivyErrors** = `object`

Defined in: [src/client/types.gen.ts:5211](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5211)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5215](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5215)

Bad Request

***

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5219](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5219)

Unauthorized

***

### 403

> **403**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5223](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5223)

Forbidden

***

### 404

> **404**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5227](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5227)

Not Found

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5231](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5231)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1DeveloperAppsByAppUuidPrivyResponse

# PostApiV1DeveloperAppsByAppUuidPrivyResponse

> **PostApiV1DeveloperAppsByAppUuidPrivyResponse** = [`PostApiV1DeveloperAppsByAppUuidPrivyResponses`](PostApiV1DeveloperAppsByAppUuidPrivyResponses.md)\[keyof [`PostApiV1DeveloperAppsByAppUuidPrivyResponses`](PostApiV1DeveloperAppsByAppUuidPrivyResponses.md)]

Defined in: [src/client/types.gen.ts:5243](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5243)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1DeveloperAppsByAppUuidPrivyResponses

# PostApiV1DeveloperAppsByAppUuidPrivyResponses

> **PostApiV1DeveloperAppsByAppUuidPrivyResponses** = `object`

Defined in: [src/client/types.gen.ts:5236](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5236)

## Properties

### 200

> **200**: [`HandlersDeveloperAppResponse`](HandlersDeveloperAppResponse.md)

Defined in: [src/client/types.gen.ts:5240](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5240)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1DeveloperAppsByAppUuidUsersByAddressTopUpData

# PostApiV1DeveloperAppsByAppUuidUsersByAddressTopUpData

> **PostApiV1DeveloperAppsByAppUuidUsersByAddressTopUpData** = `object`

Defined in: [src/client/types.gen.ts:5517](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5517)

## Properties

### body

> **body**: [`HandlersTopUpUserRequest`](HandlersTopUpUserRequest.md)

Defined in: [src/client/types.gen.ts:5521](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5521)

Top-up request

***

### path

> **path**: `object`

Defined in: [src/client/types.gen.ts:5522](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5522)

**address**

> **address**: `string`

User wallet address

**app\_uuid**

> **app\_uuid**: `string`

App UUID

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:5532](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5532)

***

### url

> **url**: `"/api/v1/developer/apps/{app_uuid}/users/{address}/top-up"`

Defined in: [src/client/types.gen.ts:5533](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5533)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1DeveloperAppsByAppUuidUsersByAddressTopUpError

# PostApiV1DeveloperAppsByAppUuidUsersByAddressTopUpError

> **PostApiV1DeveloperAppsByAppUuidUsersByAddressTopUpError** = [`PostApiV1DeveloperAppsByAppUuidUsersByAddressTopUpErrors`](PostApiV1DeveloperAppsByAppUuidUsersByAddressTopUpErrors.md)\[keyof [`PostApiV1DeveloperAppsByAppUuidUsersByAddressTopUpErrors`](PostApiV1DeveloperAppsByAppUuidUsersByAddressTopUpErrors.md)]

Defined in: [src/client/types.gen.ts:5559](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5559)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1DeveloperAppsByAppUuidUsersByAddressTopUpErrors

# PostApiV1DeveloperAppsByAppUuidUsersByAddressTopUpErrors

> **PostApiV1DeveloperAppsByAppUuidUsersByAddressTopUpErrors** = `object`

Defined in: [src/client/types.gen.ts:5536](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5536)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5540](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5540)

Bad Request

***

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5544](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5544)

Unauthorized

***

### 403

> **403**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5548](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5548)

Forbidden

***

### 404

> **404**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5552](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5552)

Not Found

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5556](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5556)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1DeveloperAppsByAppUuidUsersByAddressTopUpResponse

# PostApiV1DeveloperAppsByAppUuidUsersByAddressTopUpResponse

> **PostApiV1DeveloperAppsByAppUuidUsersByAddressTopUpResponse** = [`PostApiV1DeveloperAppsByAppUuidUsersByAddressTopUpResponses`](PostApiV1DeveloperAppsByAppUuidUsersByAddressTopUpResponses.md)\[keyof [`PostApiV1DeveloperAppsByAppUuidUsersByAddressTopUpResponses`](PostApiV1DeveloperAppsByAppUuidUsersByAddressTopUpResponses.md)]

Defined in: [src/client/types.gen.ts:5568](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5568)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1DeveloperAppsByAppUuidUsersByAddressTopUpResponses

# PostApiV1DeveloperAppsByAppUuidUsersByAddressTopUpResponses

> **PostApiV1DeveloperAppsByAppUuidUsersByAddressTopUpResponses** = `object`

Defined in: [src/client/types.gen.ts:5561](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5561)

## Properties

### 200

> **200**: [`HandlersDeveloperUserResponse`](HandlersDeveloperUserResponse.md)

Defined in: [src/client/types.gen.ts:5565](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5565)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1DeveloperAppsData

# PostApiV1DeveloperAppsData

> **PostApiV1DeveloperAppsData** = `object`

Defined in: [src/client/types.gen.ts:4782](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4782)

## Properties

### body

> **body**: [`HandlersCreateDeveloperAppRequest`](HandlersCreateDeveloperAppRequest.md)

Defined in: [src/client/types.gen.ts:4786](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4786)

Create app request

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:4787](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4787)

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:4788](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4788)

***

### url

> **url**: `"/api/v1/developer/apps"`

Defined in: [src/client/types.gen.ts:4789](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4789)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1DeveloperAppsError

# PostApiV1DeveloperAppsError

> **PostApiV1DeveloperAppsError** = [`PostApiV1DeveloperAppsErrors`](PostApiV1DeveloperAppsErrors.md)\[keyof [`PostApiV1DeveloperAppsErrors`](PostApiV1DeveloperAppsErrors.md)]

Defined in: [src/client/types.gen.ts:4807](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4807)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1DeveloperAppsErrors

# PostApiV1DeveloperAppsErrors

> **PostApiV1DeveloperAppsErrors** = `object`

Defined in: [src/client/types.gen.ts:4792](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4792)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4796](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4796)

Bad Request

***

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4800](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4800)

Unauthorized

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4804](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4804)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1DeveloperAppsResponse

# PostApiV1DeveloperAppsResponse

> **PostApiV1DeveloperAppsResponse** = [`PostApiV1DeveloperAppsResponses`](PostApiV1DeveloperAppsResponses.md)\[keyof [`PostApiV1DeveloperAppsResponses`](PostApiV1DeveloperAppsResponses.md)]

Defined in: [src/client/types.gen.ts:4816](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4816)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1DeveloperAppsResponses

# PostApiV1DeveloperAppsResponses

> **PostApiV1DeveloperAppsResponses** = `object`

Defined in: [src/client/types.gen.ts:4809](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4809)

## Properties

### 201

> **201**: [`HandlersDeveloperAppResponse`](HandlersDeveloperAppResponse.md)

Defined in: [src/client/types.gen.ts:4813](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4813)

Created

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1EmbeddingsData

# PostApiV1EmbeddingsData

> **PostApiV1EmbeddingsData** = `object`

Defined in: [src/client/types.gen.ts:5630](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5630)

## Properties

### body

> **body**: [`LlmapiEmbeddingRequest`](LlmapiEmbeddingRequest.md)

Defined in: [src/client/types.gen.ts:5634](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5634)

Embedding request

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:5635](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5635)

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:5636](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5636)

***

### url

> **url**: `"/api/v1/embeddings"`

Defined in: [src/client/types.gen.ts:5637](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5637)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1EmbeddingsError

# PostApiV1EmbeddingsError

> **PostApiV1EmbeddingsError** = [`PostApiV1EmbeddingsErrors`](PostApiV1EmbeddingsErrors.md)\[keyof [`PostApiV1EmbeddingsErrors`](PostApiV1EmbeddingsErrors.md)]

Defined in: [src/client/types.gen.ts:5655](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5655)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1EmbeddingsErrors

# PostApiV1EmbeddingsErrors

> **PostApiV1EmbeddingsErrors** = `object`

Defined in: [src/client/types.gen.ts:5640](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5640)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5644](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5644)

Bad Request

***

### 429

> **429**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5648](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5648)

Model provider rate limit exceeded

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5652](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5652)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1EmbeddingsResponse

# PostApiV1EmbeddingsResponse

> **PostApiV1EmbeddingsResponse** = [`PostApiV1EmbeddingsResponses`](PostApiV1EmbeddingsResponses.md)\[keyof [`PostApiV1EmbeddingsResponses`](PostApiV1EmbeddingsResponses.md)]

Defined in: [src/client/types.gen.ts:5664](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5664)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1EmbeddingsResponses

# PostApiV1EmbeddingsResponses

> **PostApiV1EmbeddingsResponses** = `object`

Defined in: [src/client/types.gen.ts:5657](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5657)

## Properties

### 200

> **200**: [`LlmapiEmbeddingResponse`](LlmapiEmbeddingResponse.md)

Defined in: [src/client/types.gen.ts:5661](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5661)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1GuestChatCompletionsData

# PostApiV1GuestChatCompletionsData

> **PostApiV1GuestChatCompletionsData** = `object`

Defined in: [src/client/types.gen.ts:5697](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5697)

## Properties

### body

> **body**: [`LlmapiChatCompletionRequest`](LlmapiChatCompletionRequest.md)

Defined in: [src/client/types.gen.ts:5701](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5701)

Chat request (model/tools/stream fields are ignored server-side)

***

### headers

> **headers**: `object`

Defined in: [src/client/types.gen.ts:5702](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5702)

**X-Guest-ID**

> **X-Guest-ID**: `string`

Client-generated UUID v4 identifying the guest session

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:5708](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5708)

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:5709](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5709)

***

### url

> **url**: `"/api/v1/guest/chat/completions"`

Defined in: [src/client/types.gen.ts:5710](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5710)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1GuestChatCompletionsError

# PostApiV1GuestChatCompletionsError

> **PostApiV1GuestChatCompletionsError** = [`PostApiV1GuestChatCompletionsErrors`](PostApiV1GuestChatCompletionsErrors.md)\[keyof [`PostApiV1GuestChatCompletionsErrors`](PostApiV1GuestChatCompletionsErrors.md)]

Defined in: [src/client/types.gen.ts:5732](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5732)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1GuestChatCompletionsErrors

# PostApiV1GuestChatCompletionsErrors

> **PostApiV1GuestChatCompletionsErrors** = `object`

Defined in: [src/client/types.gen.ts:5713](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5713)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5717](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5717)

Bad Request

***

### 402

> **402**: [`HandlersGuestLimitResponse`](HandlersGuestLimitResponse.md)

Defined in: [src/client/types.gen.ts:5721](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5721)

Payment Required

***

### 429

> **429**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5725](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5725)

Too Many Requests

***

### 503

> **503**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5729](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5729)

Service Unavailable

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1GuestChatCompletionsResponse

# PostApiV1GuestChatCompletionsResponse

> **PostApiV1GuestChatCompletionsResponse** = [`PostApiV1GuestChatCompletionsResponses`](PostApiV1GuestChatCompletionsResponses.md)\[keyof [`PostApiV1GuestChatCompletionsResponses`](PostApiV1GuestChatCompletionsResponses.md)]

Defined in: [src/client/types.gen.ts:5741](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5741)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1GuestChatCompletionsResponses

# PostApiV1GuestChatCompletionsResponses

> **PostApiV1GuestChatCompletionsResponses** = `object`

Defined in: [src/client/types.gen.ts:5734](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5734)

## Properties

### 200

> **200**: [`HandlersGuestChatResponse`](HandlersGuestChatResponse.md)

Defined in: [src/client/types.gen.ts:5738](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5738)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1PhoneCallsData

# PostApiV1PhoneCallsData

> **PostApiV1PhoneCallsData** = `object`

Defined in: [src/client/types.gen.ts:5852](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5852)

## Properties

### body

> **body**: [`HandlersCreatePhoneCallRequest`](HandlersCreatePhoneCallRequest.md)

Defined in: [src/client/types.gen.ts:5856](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5856)

Phone call request

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:5857](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5857)

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:5858](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5858)

***

### url

> **url**: `"/api/v1/phone-calls"`

Defined in: [src/client/types.gen.ts:5859](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5859)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1PhoneCallsError

# PostApiV1PhoneCallsError

> **PostApiV1PhoneCallsError** = [`PostApiV1PhoneCallsErrors`](PostApiV1PhoneCallsErrors.md)\[keyof [`PostApiV1PhoneCallsErrors`](PostApiV1PhoneCallsErrors.md)]

Defined in: [src/client/types.gen.ts:5881](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5881)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1PhoneCallsErrors

# PostApiV1PhoneCallsErrors

> **PostApiV1PhoneCallsErrors** = `object`

Defined in: [src/client/types.gen.ts:5862](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5862)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5866](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5866)

Bad Request

***

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5870](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5870)

Unauthorized

***

### 502

> **502**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5874](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5874)

Bad Gateway

***

### 503

> **503**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5878](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5878)

Service Unavailable

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1PhoneCallsResponse

# PostApiV1PhoneCallsResponse

> **PostApiV1PhoneCallsResponse** = [`PostApiV1PhoneCallsResponses`](PostApiV1PhoneCallsResponses.md)\[keyof [`PostApiV1PhoneCallsResponses`](PostApiV1PhoneCallsResponses.md)]

Defined in: [src/client/types.gen.ts:5890](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5890)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1PhoneCallsResponses

# PostApiV1PhoneCallsResponses

> **PostApiV1PhoneCallsResponses** = `object`

Defined in: [src/client/types.gen.ts:5883](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5883)

## Properties

### 200

> **200**: [`HandlersPhoneCallResponse`](HandlersPhoneCallResponse.md)

Defined in: [src/client/types.gen.ts:5887](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5887)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1ResponsesData

# PostApiV1ResponsesData

> **PostApiV1ResponsesData** = `object`

Defined in: [src/client/types.gen.ts:5938](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5938)

## Properties

### body

> **body**: [`LlmapiResponseRequest`](LlmapiResponseRequest.md)

Defined in: [src/client/types.gen.ts:5942](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5942)

Response request

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:5943](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5943)

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:5944](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5944)

***

### url

> **url**: `"/api/v1/responses"`

Defined in: [src/client/types.gen.ts:5945](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5945)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1ResponsesError

# PostApiV1ResponsesError

> **PostApiV1ResponsesError** = [`PostApiV1ResponsesErrors`](PostApiV1ResponsesErrors.md)\[keyof [`PostApiV1ResponsesErrors`](PostApiV1ResponsesErrors.md)]

Defined in: [src/client/types.gen.ts:5971](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5971)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1ResponsesErrors

# PostApiV1ResponsesErrors

> **PostApiV1ResponsesErrors** = `object`

Defined in: [src/client/types.gen.ts:5948](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5948)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5952](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5952)

Bad Request

***

### 402

> **402**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5956](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5956)

Insufficient balance or spending cap exceeded

***

### 403

> **403**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5960](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5960)

Model not available on current subscription tier

***

### 429

> **429**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5964](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5964)

Model provider rate limit exceeded

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5968](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5968)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1ResponsesResponse

# PostApiV1ResponsesResponse

> **PostApiV1ResponsesResponse** = [`PostApiV1ResponsesResponses`](PostApiV1ResponsesResponses.md)\[keyof [`PostApiV1ResponsesResponses`](PostApiV1ResponsesResponses.md)]

Defined in: [src/client/types.gen.ts:5980](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5980)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1ResponsesResponses

# PostApiV1ResponsesResponses

> **PostApiV1ResponsesResponses** = `object`

Defined in: [src/client/types.gen.ts:5973](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5973)

## Properties

### 200

> **200**: [`LlmapiResponseResponse`](LlmapiResponseResponse.md) | `string`

Defined in: [src/client/types.gen.ts:5977](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5977)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1SubscriptionsCancelData

# PostApiV1SubscriptionsCancelData

> **PostApiV1SubscriptionsCancelData** = `object`

Defined in: [src/client/types.gen.ts:5982](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5982)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:5983](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5983)

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:5984](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5984)

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:5985](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5985)

***

### url

> **url**: `"/api/v1/subscriptions/cancel"`

Defined in: [src/client/types.gen.ts:5986](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5986)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1SubscriptionsCancelError

# PostApiV1SubscriptionsCancelError

> **PostApiV1SubscriptionsCancelError** = [`PostApiV1SubscriptionsCancelErrors`](PostApiV1SubscriptionsCancelErrors.md)\[keyof [`PostApiV1SubscriptionsCancelErrors`](PostApiV1SubscriptionsCancelErrors.md)]

Defined in: [src/client/types.gen.ts:6004](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6004)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1SubscriptionsCancelErrors

# PostApiV1SubscriptionsCancelErrors

> **PostApiV1SubscriptionsCancelErrors** = `object`

Defined in: [src/client/types.gen.ts:5989](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5989)

## Properties

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5993](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5993)

Unauthorized

***

### 404

> **404**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:5997](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#5997)

Not Found

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6001](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6001)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1SubscriptionsCancelResponse

# PostApiV1SubscriptionsCancelResponse

> **PostApiV1SubscriptionsCancelResponse** = [`PostApiV1SubscriptionsCancelResponses`](PostApiV1SubscriptionsCancelResponses.md)\[keyof [`PostApiV1SubscriptionsCancelResponses`](PostApiV1SubscriptionsCancelResponses.md)]

Defined in: [src/client/types.gen.ts:6013](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6013)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1SubscriptionsCancelResponses

# PostApiV1SubscriptionsCancelResponses

> **PostApiV1SubscriptionsCancelResponses** = `object`

Defined in: [src/client/types.gen.ts:6006](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6006)

## Properties

### 200

> **200**: [`HandlersCancelSubscriptionResponse`](HandlersCancelSubscriptionResponse.md)

Defined in: [src/client/types.gen.ts:6010](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6010)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1SubscriptionsCancelScheduledDowngradeData

# PostApiV1SubscriptionsCancelScheduledDowngradeData

> **PostApiV1SubscriptionsCancelScheduledDowngradeData** = `object`

Defined in: [src/client/types.gen.ts:6015](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6015)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:6016](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6016)

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:6017](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6017)

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:6018](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6018)

***

### url

> **url**: `"/api/v1/subscriptions/cancel-scheduled-downgrade"`

Defined in: [src/client/types.gen.ts:6019](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6019)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1SubscriptionsCancelScheduledDowngradeError

# PostApiV1SubscriptionsCancelScheduledDowngradeError

> **PostApiV1SubscriptionsCancelScheduledDowngradeError** = [`PostApiV1SubscriptionsCancelScheduledDowngradeErrors`](PostApiV1SubscriptionsCancelScheduledDowngradeErrors.md)\[keyof [`PostApiV1SubscriptionsCancelScheduledDowngradeErrors`](PostApiV1SubscriptionsCancelScheduledDowngradeErrors.md)]

Defined in: [src/client/types.gen.ts:6037](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6037)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1SubscriptionsCancelScheduledDowngradeErrors

# PostApiV1SubscriptionsCancelScheduledDowngradeErrors

> **PostApiV1SubscriptionsCancelScheduledDowngradeErrors** = `object`

Defined in: [src/client/types.gen.ts:6022](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6022)

## Properties

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6026](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6026)

Unauthorized

***

### 404

> **404**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6030](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6030)

Not Found

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6034](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6034)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1SubscriptionsCancelScheduledDowngradeResponse

# PostApiV1SubscriptionsCancelScheduledDowngradeResponse

> **PostApiV1SubscriptionsCancelScheduledDowngradeResponse** = [`PostApiV1SubscriptionsCancelScheduledDowngradeResponses`](PostApiV1SubscriptionsCancelScheduledDowngradeResponses.md)\[keyof [`PostApiV1SubscriptionsCancelScheduledDowngradeResponses`](PostApiV1SubscriptionsCancelScheduledDowngradeResponses.md)]

Defined in: [src/client/types.gen.ts:6046](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6046)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1SubscriptionsCancelScheduledDowngradeResponses

# PostApiV1SubscriptionsCancelScheduledDowngradeResponses

> **PostApiV1SubscriptionsCancelScheduledDowngradeResponses** = `object`

Defined in: [src/client/types.gen.ts:6039](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6039)

## Properties

### 200

> **200**: [`HandlersCancelScheduledDowngradeResponse`](HandlersCancelScheduledDowngradeResponse.md)

Defined in: [src/client/types.gen.ts:6043](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6043)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1SubscriptionsCreateCheckoutSessionData

# PostApiV1SubscriptionsCreateCheckoutSessionData

> **PostApiV1SubscriptionsCreateCheckoutSessionData** = `object`

Defined in: [src/client/types.gen.ts:6048](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6048)

## Properties

### body

> **body**: [`HandlersCreateCheckoutSessionRequest`](HandlersCreateCheckoutSessionRequest.md)

Defined in: [src/client/types.gen.ts:6052](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6052)

Checkout session request with redirect URLs

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:6053](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6053)

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:6054](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6054)

***

### url

> **url**: `"/api/v1/subscriptions/create-checkout-session"`

Defined in: [src/client/types.gen.ts:6055](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6055)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1SubscriptionsCreateCheckoutSessionError

# PostApiV1SubscriptionsCreateCheckoutSessionError

> **PostApiV1SubscriptionsCreateCheckoutSessionError** = [`PostApiV1SubscriptionsCreateCheckoutSessionErrors`](PostApiV1SubscriptionsCreateCheckoutSessionErrors.md)\[keyof [`PostApiV1SubscriptionsCreateCheckoutSessionErrors`](PostApiV1SubscriptionsCreateCheckoutSessionErrors.md)]

Defined in: [src/client/types.gen.ts:6077](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6077)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1SubscriptionsCreateCheckoutSessionErrors

# PostApiV1SubscriptionsCreateCheckoutSessionErrors

> **PostApiV1SubscriptionsCreateCheckoutSessionErrors** = `object`

Defined in: [src/client/types.gen.ts:6058](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6058)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6062](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6062)

Bad Request

***

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6066](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6066)

Unauthorized

***

### 403

> **403**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6070](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6070)

Forbidden

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6074](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6074)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1SubscriptionsCreateCheckoutSessionResponse

# PostApiV1SubscriptionsCreateCheckoutSessionResponse

> **PostApiV1SubscriptionsCreateCheckoutSessionResponse** = [`PostApiV1SubscriptionsCreateCheckoutSessionResponses`](PostApiV1SubscriptionsCreateCheckoutSessionResponses.md)\[keyof [`PostApiV1SubscriptionsCreateCheckoutSessionResponses`](PostApiV1SubscriptionsCreateCheckoutSessionResponses.md)]

Defined in: [src/client/types.gen.ts:6086](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6086)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1SubscriptionsCreateCheckoutSessionResponses

# PostApiV1SubscriptionsCreateCheckoutSessionResponses

> **PostApiV1SubscriptionsCreateCheckoutSessionResponses** = `object`

Defined in: [src/client/types.gen.ts:6079](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6079)

## Properties

### 200

> **200**: [`HandlersCheckoutSessionResponse`](HandlersCheckoutSessionResponse.md)

Defined in: [src/client/types.gen.ts:6083](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6083)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1SubscriptionsCustomerPortalData

# PostApiV1SubscriptionsCustomerPortalData

> **PostApiV1SubscriptionsCustomerPortalData** = `object`

Defined in: [src/client/types.gen.ts:6088](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6088)

## Properties

### body

> **body**: [`HandlersCreateCustomerPortalRequest`](HandlersCreateCustomerPortalRequest.md)

Defined in: [src/client/types.gen.ts:6092](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6092)

Customer portal request with return URL

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:6093](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6093)

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:6094](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6094)

***

### url

> **url**: `"/api/v1/subscriptions/customer-portal"`

Defined in: [src/client/types.gen.ts:6095](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6095)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1SubscriptionsCustomerPortalError

# PostApiV1SubscriptionsCustomerPortalError

> **PostApiV1SubscriptionsCustomerPortalError** = [`PostApiV1SubscriptionsCustomerPortalErrors`](PostApiV1SubscriptionsCustomerPortalErrors.md)\[keyof [`PostApiV1SubscriptionsCustomerPortalErrors`](PostApiV1SubscriptionsCustomerPortalErrors.md)]

Defined in: [src/client/types.gen.ts:6117](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6117)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1SubscriptionsCustomerPortalErrors

# PostApiV1SubscriptionsCustomerPortalErrors

> **PostApiV1SubscriptionsCustomerPortalErrors** = `object`

Defined in: [src/client/types.gen.ts:6098](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6098)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6102](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6102)

Bad Request

***

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6106](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6106)

Unauthorized

***

### 404

> **404**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6110](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6110)

Not Found

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6114](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6114)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1SubscriptionsCustomerPortalResponse

# PostApiV1SubscriptionsCustomerPortalResponse

> **PostApiV1SubscriptionsCustomerPortalResponse** = [`PostApiV1SubscriptionsCustomerPortalResponses`](PostApiV1SubscriptionsCustomerPortalResponses.md)\[keyof [`PostApiV1SubscriptionsCustomerPortalResponses`](PostApiV1SubscriptionsCustomerPortalResponses.md)]

Defined in: [src/client/types.gen.ts:6126](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6126)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1SubscriptionsCustomerPortalResponses

# PostApiV1SubscriptionsCustomerPortalResponses

> **PostApiV1SubscriptionsCustomerPortalResponses** = `object`

Defined in: [src/client/types.gen.ts:6119](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6119)

## Properties

### 200

> **200**: [`HandlersCustomerPortalResponse`](HandlersCustomerPortalResponse.md)

Defined in: [src/client/types.gen.ts:6123](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6123)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1SubscriptionsRenewData

# PostApiV1SubscriptionsRenewData

> **PostApiV1SubscriptionsRenewData** = `object`

Defined in: [src/client/types.gen.ts:6153](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6153)

## Properties

### body?

> `optional` **body**: `never`

Defined in: [src/client/types.gen.ts:6154](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6154)

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:6155](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6155)

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:6156](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6156)

***

### url

> **url**: `"/api/v1/subscriptions/renew"`

Defined in: [src/client/types.gen.ts:6157](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6157)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1SubscriptionsRenewError

# PostApiV1SubscriptionsRenewError

> **PostApiV1SubscriptionsRenewError** = [`PostApiV1SubscriptionsRenewErrors`](PostApiV1SubscriptionsRenewErrors.md)\[keyof [`PostApiV1SubscriptionsRenewErrors`](PostApiV1SubscriptionsRenewErrors.md)]

Defined in: [src/client/types.gen.ts:6179](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6179)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1SubscriptionsRenewErrors

# PostApiV1SubscriptionsRenewErrors

> **PostApiV1SubscriptionsRenewErrors** = `object`

Defined in: [src/client/types.gen.ts:6160](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6160)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6164](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6164)

Bad Request

***

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6168](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6168)

Unauthorized

***

### 404

> **404**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6172](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6172)

Not Found

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6176](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6176)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1SubscriptionsRenewResponse

# PostApiV1SubscriptionsRenewResponse

> **PostApiV1SubscriptionsRenewResponse** = [`PostApiV1SubscriptionsRenewResponses`](PostApiV1SubscriptionsRenewResponses.md)\[keyof [`PostApiV1SubscriptionsRenewResponses`](PostApiV1SubscriptionsRenewResponses.md)]

Defined in: [src/client/types.gen.ts:6188](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6188)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1SubscriptionsRenewResponses

# PostApiV1SubscriptionsRenewResponses

> **PostApiV1SubscriptionsRenewResponses** = `object`

Defined in: [src/client/types.gen.ts:6181](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6181)

## Properties

### 200

> **200**: [`HandlersRenewSubscriptionResponse`](HandlersRenewSubscriptionResponse.md)

Defined in: [src/client/types.gen.ts:6185](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6185)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1SubscriptionsScheduleDowngradeData

# PostApiV1SubscriptionsScheduleDowngradeData

> **PostApiV1SubscriptionsScheduleDowngradeData** = `object`

Defined in: [src/client/types.gen.ts:6190](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6190)

## Properties

### body

> **body**: [`HandlersScheduleDowngradeRequest`](HandlersScheduleDowngradeRequest.md)

Defined in: [src/client/types.gen.ts:6194](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6194)

Downgrade request with target tier and optional interval

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:6195](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6195)

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:6196](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6196)

***

### url

> **url**: `"/api/v1/subscriptions/schedule-downgrade"`

Defined in: [src/client/types.gen.ts:6197](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6197)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1SubscriptionsScheduleDowngradeError

# PostApiV1SubscriptionsScheduleDowngradeError

> **PostApiV1SubscriptionsScheduleDowngradeError** = [`PostApiV1SubscriptionsScheduleDowngradeErrors`](PostApiV1SubscriptionsScheduleDowngradeErrors.md)\[keyof [`PostApiV1SubscriptionsScheduleDowngradeErrors`](PostApiV1SubscriptionsScheduleDowngradeErrors.md)]

Defined in: [src/client/types.gen.ts:6219](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6219)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1SubscriptionsScheduleDowngradeErrors

# PostApiV1SubscriptionsScheduleDowngradeErrors

> **PostApiV1SubscriptionsScheduleDowngradeErrors** = `object`

Defined in: [src/client/types.gen.ts:6200](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6200)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6204](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6204)

Bad Request

***

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6208](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6208)

Unauthorized

***

### 404

> **404**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6212](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6212)

Not Found

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6216](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6216)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1SubscriptionsScheduleDowngradeResponse

# PostApiV1SubscriptionsScheduleDowngradeResponse

> **PostApiV1SubscriptionsScheduleDowngradeResponse** = [`PostApiV1SubscriptionsScheduleDowngradeResponses`](PostApiV1SubscriptionsScheduleDowngradeResponses.md)\[keyof [`PostApiV1SubscriptionsScheduleDowngradeResponses`](PostApiV1SubscriptionsScheduleDowngradeResponses.md)]

Defined in: [src/client/types.gen.ts:6228](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6228)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1SubscriptionsScheduleDowngradeResponses

# PostApiV1SubscriptionsScheduleDowngradeResponses

> **PostApiV1SubscriptionsScheduleDowngradeResponses** = `object`

Defined in: [src/client/types.gen.ts:6221](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6221)

## Properties

### 200

> **200**: [`HandlersScheduleDowngradeResponse`](HandlersScheduleDowngradeResponse.md)

Defined in: [src/client/types.gen.ts:6225](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6225)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1SubscriptionsUpgradeData

# PostApiV1SubscriptionsUpgradeData

> **PostApiV1SubscriptionsUpgradeData** = `object`

Defined in: [src/client/types.gen.ts:6259](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6259)

## Properties

### body

> **body**: [`HandlersUpgradeSubscriptionRequest`](HandlersUpgradeSubscriptionRequest.md)

Defined in: [src/client/types.gen.ts:6263](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6263)

Upgrade request with target tier and optional interval

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:6264](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6264)

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:6265](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6265)

***

### url

> **url**: `"/api/v1/subscriptions/upgrade"`

Defined in: [src/client/types.gen.ts:6266](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6266)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1SubscriptionsUpgradeError

# PostApiV1SubscriptionsUpgradeError

> **PostApiV1SubscriptionsUpgradeError** = [`PostApiV1SubscriptionsUpgradeErrors`](PostApiV1SubscriptionsUpgradeErrors.md)\[keyof [`PostApiV1SubscriptionsUpgradeErrors`](PostApiV1SubscriptionsUpgradeErrors.md)]

Defined in: [src/client/types.gen.ts:6296](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6296)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1SubscriptionsUpgradeErrors

# PostApiV1SubscriptionsUpgradeErrors

> **PostApiV1SubscriptionsUpgradeErrors** = `object`

Defined in: [src/client/types.gen.ts:6269](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6269)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6273](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6273)

Bad Request

***

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6277](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6277)

Unauthorized

***

### 403

> **403**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6281](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6281)

Forbidden

***

### 404

> **404**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6285](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6285)

Not Found

***

### 429

> **429**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6289](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6289)

Too Many Requests

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6293](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6293)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1SubscriptionsUpgradeResponse

# PostApiV1SubscriptionsUpgradeResponse

> **PostApiV1SubscriptionsUpgradeResponse** = [`PostApiV1SubscriptionsUpgradeResponses`](PostApiV1SubscriptionsUpgradeResponses.md)\[keyof [`PostApiV1SubscriptionsUpgradeResponses`](PostApiV1SubscriptionsUpgradeResponses.md)]

Defined in: [src/client/types.gen.ts:6305](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6305)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1SubscriptionsUpgradeResponses

# PostApiV1SubscriptionsUpgradeResponses

> **PostApiV1SubscriptionsUpgradeResponses** = `object`

Defined in: [src/client/types.gen.ts:6298](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6298)

## Properties

### 200

> **200**: [`HandlersUpgradeSubscriptionResponse`](HandlersUpgradeSubscriptionResponse.md)

Defined in: [src/client/types.gen.ts:6302](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6302)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1SubscriptionsWebhookData

# PostApiV1SubscriptionsWebhookData

> **PostApiV1SubscriptionsWebhookData** = `object`

Defined in: [src/client/types.gen.ts:6307](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6307)

## Properties

### body?

> `optional` **body**: `object`

Defined in: [src/client/types.gen.ts:6308](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6308)

**Index Signature**

\[`key`: `string`]: `unknown`

***

### headers

> **headers**: `object`

Defined in: [src/client/types.gen.ts:6311](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6311)

**Stripe-Signature**

> **Stripe-Signature**: `string`

Stripe webhook signature

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:6317](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6317)

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:6318](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6318)

***

### url

> **url**: `"/api/v1/subscriptions/webhook"`

Defined in: [src/client/types.gen.ts:6319](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6319)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1SubscriptionsWebhookError

# PostApiV1SubscriptionsWebhookError

> **PostApiV1SubscriptionsWebhookError** = [`PostApiV1SubscriptionsWebhookErrors`](PostApiV1SubscriptionsWebhookErrors.md)\[keyof [`PostApiV1SubscriptionsWebhookErrors`](PostApiV1SubscriptionsWebhookErrors.md)]

Defined in: [src/client/types.gen.ts:6329](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6329)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1SubscriptionsWebhookErrors

# PostApiV1SubscriptionsWebhookErrors

> **PostApiV1SubscriptionsWebhookErrors** = `object`

Defined in: [src/client/types.gen.ts:6322](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6322)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6326](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6326)

Bad Request

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1SubscriptionsWebhookResponse

# PostApiV1SubscriptionsWebhookResponse

> **PostApiV1SubscriptionsWebhookResponse** = [`PostApiV1SubscriptionsWebhookResponses`](PostApiV1SubscriptionsWebhookResponses.md)\[keyof [`PostApiV1SubscriptionsWebhookResponses`](PostApiV1SubscriptionsWebhookResponses.md)]

Defined in: [src/client/types.gen.ts:6340](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6340)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1SubscriptionsWebhookResponses

# PostApiV1SubscriptionsWebhookResponses

> **PostApiV1SubscriptionsWebhookResponses** = `object`

Defined in: [src/client/types.gen.ts:6331](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6331)

## Properties

### 200

> **200**: `object`

Defined in: [src/client/types.gen.ts:6335](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6335)

OK

**Index Signature**

\[`key`: `string`]: `string`

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1TextByChannelRegisterData

# PostApiV1TextByChannelRegisterData

> **PostApiV1TextByChannelRegisterData** = `object`

Defined in: [src/client/types.gen.ts:6385](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6385)

## Properties

### body

> **body**: [`ModelsRegisterTextRequest`](ModelsRegisterTextRequest.md)

Defined in: [src/client/types.gen.ts:6389](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6389)

Registration data

***

### path

> **path**: `object`

Defined in: [src/client/types.gen.ts:6390](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6390)

**channel**

> **channel**: `string`

Text channel (sms, telegram)

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:6396](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6396)

***

### url

> **url**: `"/api/v1/text/{channel}/register"`

Defined in: [src/client/types.gen.ts:6397](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6397)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1TextByChannelRegisterError

# PostApiV1TextByChannelRegisterError

> **PostApiV1TextByChannelRegisterError** = [`PostApiV1TextByChannelRegisterErrors`](PostApiV1TextByChannelRegisterErrors.md)\[keyof [`PostApiV1TextByChannelRegisterErrors`](PostApiV1TextByChannelRegisterErrors.md)]

Defined in: [src/client/types.gen.ts:6419](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6419)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1TextByChannelRegisterErrors

# PostApiV1TextByChannelRegisterErrors

> **PostApiV1TextByChannelRegisterErrors** = `object`

Defined in: [src/client/types.gen.ts:6400](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6400)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6404](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6404)

Invalid channel, identifier, or identifier not in linked accounts

***

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6408](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6408)

Unauthorized

***

### 409

> **409**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6412](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6412)

Identifier registered to another account

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6416](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6416)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1TextByChannelRegisterResponse

# PostApiV1TextByChannelRegisterResponse

> **PostApiV1TextByChannelRegisterResponse** = [`PostApiV1TextByChannelRegisterResponses`](PostApiV1TextByChannelRegisterResponses.md)\[keyof [`PostApiV1TextByChannelRegisterResponses`](PostApiV1TextByChannelRegisterResponses.md)]

Defined in: [src/client/types.gen.ts:6428](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6428)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1TextByChannelRegisterResponses

# PostApiV1TextByChannelRegisterResponses

> **PostApiV1TextByChannelRegisterResponses** = `object`

Defined in: [src/client/types.gen.ts:6421](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6421)

## Properties

### 200

> **200**: [`HandlersRegisterTextResponse`](HandlersRegisterTextResponse.md)

Defined in: [src/client/types.gen.ts:6425](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6425)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1UserApiKeysData

# PostApiV1UserApiKeysData

> **PostApiV1UserApiKeysData** = `object`

Defined in: [src/client/types.gen.ts:6652](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6652)

## Properties

### body

> **body**: [`HandlersUserApiKeyRequest`](HandlersUserApiKeyRequest.md)

Defined in: [src/client/types.gen.ts:6656](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6656)

API key request

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:6657](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6657)

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:6658](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6658)

***

### url

> **url**: `"/api/v1/user/api-keys"`

Defined in: [src/client/types.gen.ts:6659](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6659)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1UserApiKeysError

# PostApiV1UserApiKeysError

> **PostApiV1UserApiKeysError** = [`PostApiV1UserApiKeysErrors`](PostApiV1UserApiKeysErrors.md)\[keyof [`PostApiV1UserApiKeysErrors`](PostApiV1UserApiKeysErrors.md)]

Defined in: [src/client/types.gen.ts:6681](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6681)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1UserApiKeysErrors

# PostApiV1UserApiKeysErrors

> **PostApiV1UserApiKeysErrors** = `object`

Defined in: [src/client/types.gen.ts:6662](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6662)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6666](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6666)

Bad Request

***

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6670](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6670)

Unauthorized

***

### 403

> **403**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6674](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6674)

Forbidden

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6678](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6678)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1UserApiKeysResponse

# PostApiV1UserApiKeysResponse

> **PostApiV1UserApiKeysResponse** = [`PostApiV1UserApiKeysResponses`](PostApiV1UserApiKeysResponses.md)\[keyof [`PostApiV1UserApiKeysResponses`](PostApiV1UserApiKeysResponses.md)]

Defined in: [src/client/types.gen.ts:6690](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6690)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1UserApiKeysResponses

# PostApiV1UserApiKeysResponses

> **PostApiV1UserApiKeysResponses** = `object`

Defined in: [src/client/types.gen.ts:6683](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6683)

## Properties

### 201

> **201**: [`HandlersUserApiKeyWithSecretResponse`](HandlersUserApiKeyWithSecretResponse.md)

Defined in: [src/client/types.gen.ts:6687](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6687)

Created

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1WebhooksRevenuecatData

# PostApiV1WebhooksRevenuecatData

> **PostApiV1WebhooksRevenuecatData** = `object`

Defined in: [src/client/types.gen.ts:6844](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6844)

## Properties

### body?

> `optional` **body**: `object`

Defined in: [src/client/types.gen.ts:6845](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6845)

**Index Signature**

\[`key`: `string`]: `unknown`

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:6848](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6848)

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:6849](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6849)

***

### url

> **url**: `"/api/v1/webhooks/revenuecat"`

Defined in: [src/client/types.gen.ts:6850](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6850)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1WebhooksRevenuecatError

# PostApiV1WebhooksRevenuecatError

> **PostApiV1WebhooksRevenuecatError** = [`PostApiV1WebhooksRevenuecatErrors`](PostApiV1WebhooksRevenuecatErrors.md)\[keyof [`PostApiV1WebhooksRevenuecatErrors`](PostApiV1WebhooksRevenuecatErrors.md)]

Defined in: [src/client/types.gen.ts:6864](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6864)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1WebhooksRevenuecatErrors

# PostApiV1WebhooksRevenuecatErrors

> **PostApiV1WebhooksRevenuecatErrors** = `object`

Defined in: [src/client/types.gen.ts:6853](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6853)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6857](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6857)

Bad Request

***

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6861](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6861)

Unauthorized

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1WebhooksRevenuecatResponse

# PostApiV1WebhooksRevenuecatResponse

> **PostApiV1WebhooksRevenuecatResponse** = [`PostApiV1WebhooksRevenuecatResponses`](PostApiV1WebhooksRevenuecatResponses.md)\[keyof [`PostApiV1WebhooksRevenuecatResponses`](PostApiV1WebhooksRevenuecatResponses.md)]

Defined in: [src/client/types.gen.ts:6875](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6875)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostApiV1WebhooksRevenuecatResponses

# PostApiV1WebhooksRevenuecatResponses

> **PostApiV1WebhooksRevenuecatResponses** = `object`

Defined in: [src/client/types.gen.ts:6866](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6866)

## Properties

### 200

> **200**: `object`

Defined in: [src/client/types.gen.ts:6870](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6870)

OK

**Index Signature**

\[`key`: `string`]: `string`

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostAuthOauthByProviderExchangeData

# PostAuthOauthByProviderExchangeData

> **PostAuthOauthByProviderExchangeData** = `object`

Defined in: [src/client/types.gen.ts:6877](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6877)

## Properties

### body

> **body**: [`HandlersExchangeRequest`](HandlersExchangeRequest.md)

Defined in: [src/client/types.gen.ts:6881](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6881)

Exchange request

***

### path

> **path**: `object`

Defined in: [src/client/types.gen.ts:6882](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6882)

**provider**

> **provider**: `string`

OAuth provider (google-drive, dropbox)

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:6888](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6888)

***

### url

> **url**: `"/auth/oauth/{provider}/exchange"`

Defined in: [src/client/types.gen.ts:6889](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6889)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostAuthOauthByProviderExchangeError

# PostAuthOauthByProviderExchangeError

> **PostAuthOauthByProviderExchangeError** = [`PostAuthOauthByProviderExchangeErrors`](PostAuthOauthByProviderExchangeErrors.md)\[keyof [`PostAuthOauthByProviderExchangeErrors`](PostAuthOauthByProviderExchangeErrors.md)]

Defined in: [src/client/types.gen.ts:6903](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6903)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostAuthOauthByProviderExchangeErrors

# PostAuthOauthByProviderExchangeErrors

> **PostAuthOauthByProviderExchangeErrors** = `object`

Defined in: [src/client/types.gen.ts:6892](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6892)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6896](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6896)

Bad Request

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6900](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6900)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostAuthOauthByProviderExchangeResponse

# PostAuthOauthByProviderExchangeResponse

> **PostAuthOauthByProviderExchangeResponse** = [`PostAuthOauthByProviderExchangeResponses`](PostAuthOauthByProviderExchangeResponses.md)\[keyof [`PostAuthOauthByProviderExchangeResponses`](PostAuthOauthByProviderExchangeResponses.md)]

Defined in: [src/client/types.gen.ts:6912](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6912)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostAuthOauthByProviderExchangeResponses

# PostAuthOauthByProviderExchangeResponses

> **PostAuthOauthByProviderExchangeResponses** = `object`

Defined in: [src/client/types.gen.ts:6905](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6905)

## Properties

### 200

> **200**: [`HandlersTokenResponse`](HandlersTokenResponse.md)

Defined in: [src/client/types.gen.ts:6909](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6909)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostAuthOauthByProviderRefreshData

# PostAuthOauthByProviderRefreshData

> **PostAuthOauthByProviderRefreshData** = `object`

Defined in: [src/client/types.gen.ts:6914](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6914)

## Properties

### body

> **body**: [`HandlersRefreshRequest`](HandlersRefreshRequest.md)

Defined in: [src/client/types.gen.ts:6918](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6918)

Refresh request

***

### path

> **path**: `object`

Defined in: [src/client/types.gen.ts:6919](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6919)

**provider**

> **provider**: `string`

OAuth provider (google-drive, dropbox)

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:6925](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6925)

***

### url

> **url**: `"/auth/oauth/{provider}/refresh"`

Defined in: [src/client/types.gen.ts:6926](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6926)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostAuthOauthByProviderRefreshError

# PostAuthOauthByProviderRefreshError

> **PostAuthOauthByProviderRefreshError** = [`PostAuthOauthByProviderRefreshErrors`](PostAuthOauthByProviderRefreshErrors.md)\[keyof [`PostAuthOauthByProviderRefreshErrors`](PostAuthOauthByProviderRefreshErrors.md)]

Defined in: [src/client/types.gen.ts:6940](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6940)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostAuthOauthByProviderRefreshErrors

# PostAuthOauthByProviderRefreshErrors

> **PostAuthOauthByProviderRefreshErrors** = `object`

Defined in: [src/client/types.gen.ts:6929](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6929)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6933](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6933)

Bad Request

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6937](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6937)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostAuthOauthByProviderRefreshResponse

# PostAuthOauthByProviderRefreshResponse

> **PostAuthOauthByProviderRefreshResponse** = [`PostAuthOauthByProviderRefreshResponses`](PostAuthOauthByProviderRefreshResponses.md)\[keyof [`PostAuthOauthByProviderRefreshResponses`](PostAuthOauthByProviderRefreshResponses.md)]

Defined in: [src/client/types.gen.ts:6949](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6949)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostAuthOauthByProviderRefreshResponses

# PostAuthOauthByProviderRefreshResponses

> **PostAuthOauthByProviderRefreshResponses** = `object`

Defined in: [src/client/types.gen.ts:6942](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6942)

## Properties

### 200

> **200**: [`HandlersTokenResponse`](HandlersTokenResponse.md)

Defined in: [src/client/types.gen.ts:6946](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6946)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostAuthOauthByProviderRevokeData

# PostAuthOauthByProviderRevokeData

> **PostAuthOauthByProviderRevokeData** = `object`

Defined in: [src/client/types.gen.ts:6951](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6951)

## Properties

### body

> **body**: [`HandlersRevokeRequest`](HandlersRevokeRequest.md)

Defined in: [src/client/types.gen.ts:6955](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6955)

Revoke request

***

### path

> **path**: `object`

Defined in: [src/client/types.gen.ts:6956](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6956)

**provider**

> **provider**: `string`

OAuth provider (google-drive, dropbox)

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:6962](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6962)

***

### url

> **url**: `"/auth/oauth/{provider}/revoke"`

Defined in: [src/client/types.gen.ts:6963](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6963)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostAuthOauthByProviderRevokeError

# PostAuthOauthByProviderRevokeError

> **PostAuthOauthByProviderRevokeError** = [`PostAuthOauthByProviderRevokeErrors`](PostAuthOauthByProviderRevokeErrors.md)\[keyof [`PostAuthOauthByProviderRevokeErrors`](PostAuthOauthByProviderRevokeErrors.md)]

Defined in: [src/client/types.gen.ts:6977](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6977)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostAuthOauthByProviderRevokeErrors

# PostAuthOauthByProviderRevokeErrors

> **PostAuthOauthByProviderRevokeErrors** = `object`

Defined in: [src/client/types.gen.ts:6966](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6966)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6970](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6970)

Bad Request

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:6974](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6974)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostAuthOauthByProviderRevokeResponse

# PostAuthOauthByProviderRevokeResponse

> **PostAuthOauthByProviderRevokeResponse** = [`PostAuthOauthByProviderRevokeResponses`](PostAuthOauthByProviderRevokeResponses.md)\[keyof [`PostAuthOauthByProviderRevokeResponses`](PostAuthOauthByProviderRevokeResponses.md)]

Defined in: [src/client/types.gen.ts:6988](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6988)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostAuthOauthByProviderRevokeResponses

# PostAuthOauthByProviderRevokeResponses

> **PostAuthOauthByProviderRevokeResponses** = `object`

Defined in: [src/client/types.gen.ts:6979](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6979)

## Properties

### 200

> **200**: `object`

Defined in: [src/client/types.gen.ts:6983](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#6983)

Empty object on success

**Index Signature**

\[`key`: `string`]: `unknown`

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostOauthConsentData

# PostOauthConsentData

> **PostOauthConsentData** = `object`

Defined in: [src/client/types.gen.ts:7122](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#7122)

## Properties

### body?

> `optional` **body**: `number`

Defined in: [src/client/types.gen.ts:7126](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#7126)

Daily spending cap in USD

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:7127](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#7127)

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:7128](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#7128)

***

### url

> **url**: `"/oauth/consent"`

Defined in: [src/client/types.gen.ts:7129](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#7129)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostOauthConsentError

# PostOauthConsentError

> **PostOauthConsentError** = [`PostOauthConsentErrors`](PostOauthConsentErrors.md)\[keyof [`PostOauthConsentErrors`](PostOauthConsentErrors.md)]

Defined in: [src/client/types.gen.ts:7143](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#7143)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostOauthConsentErrors

# PostOauthConsentErrors

> **PostOauthConsentErrors** = `object`

Defined in: [src/client/types.gen.ts:7132](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#7132)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:7136](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#7136)

Bad Request

***

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:7140](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#7140)

Unauthorized

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostOauthConsentResponse

# PostOauthConsentResponse

> **PostOauthConsentResponse** = [`PostOauthConsentResponses`](PostOauthConsentResponses.md)\[keyof [`PostOauthConsentResponses`](PostOauthConsentResponses.md)]

Defined in: [src/client/types.gen.ts:7152](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#7152)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostOauthConsentResponses

# PostOauthConsentResponses

> **PostOauthConsentResponses** = `object`

Defined in: [src/client/types.gen.ts:7145](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#7145)

## Properties

### 200

> **200**: [`HandlersConsentApproveResponse`](HandlersConsentApproveResponse.md)

Defined in: [src/client/types.gen.ts:7149](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#7149)

Approve response when Accept: application/json (deny returns ConsentDenyResponse)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostOauthRevokeData

# PostOauthRevokeData

> **PostOauthRevokeData** = `object`

Defined in: [src/client/types.gen.ts:7154](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#7154)

## Properties

### body?

> `optional` **body**: `string`

Defined in: [src/client/types.gen.ts:7158](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#7158)

Client secret (if not using HTTP Basic auth)

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:7159](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#7159)

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:7160](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#7160)

***

### url

> **url**: `"/oauth/revoke"`

Defined in: [src/client/types.gen.ts:7161](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#7161)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostOauthRevokeError

# PostOauthRevokeError

> **PostOauthRevokeError** = [`PostOauthRevokeErrors`](PostOauthRevokeErrors.md)\[keyof [`PostOauthRevokeErrors`](PostOauthRevokeErrors.md)]

Defined in: [src/client/types.gen.ts:7171](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#7171)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostOauthRevokeErrors

# PostOauthRevokeErrors

> **PostOauthRevokeErrors** = `object`

Defined in: [src/client/types.gen.ts:7164](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#7164)

## Properties

### 401

> **401**: [`HandlersOauthTokenError`](HandlersOauthTokenError.md)

Defined in: [src/client/types.gen.ts:7168](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#7168)

Unauthorized

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostOauthRevokeResponse

# PostOauthRevokeResponse

> **PostOauthRevokeResponse** = [`PostOauthRevokeResponses`](PostOauthRevokeResponses.md)\[keyof [`PostOauthRevokeResponses`](PostOauthRevokeResponses.md)]

Defined in: [src/client/types.gen.ts:7182](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#7182)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostOauthRevokeResponses

# PostOauthRevokeResponses

> **PostOauthRevokeResponses** = `object`

Defined in: [src/client/types.gen.ts:7173](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#7173)

## Properties

### 200

> **200**: `object`

Defined in: [src/client/types.gen.ts:7177](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#7177)

OK

**Index Signature**

\[`key`: `string`]: `unknown`

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostOauthTokenData

# PostOauthTokenData

> **PostOauthTokenData** = `object`

Defined in: [src/client/types.gen.ts:7184](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#7184)

## Properties

### body?

> `optional` **body**: `string`

Defined in: [src/client/types.gen.ts:7188](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#7188)

Narrowed scope (refresh\_token grant)

***

### path?

> `optional` **path**: `never`

Defined in: [src/client/types.gen.ts:7189](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#7189)

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:7190](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#7190)

***

### url

> **url**: `"/oauth/token"`

Defined in: [src/client/types.gen.ts:7191](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#7191)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostOauthTokenError

# PostOauthTokenError

> **PostOauthTokenError** = [`PostOauthTokenErrors`](PostOauthTokenErrors.md)\[keyof [`PostOauthTokenErrors`](PostOauthTokenErrors.md)]

Defined in: [src/client/types.gen.ts:7205](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#7205)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostOauthTokenErrors

# PostOauthTokenErrors

> **PostOauthTokenErrors** = `object`

Defined in: [src/client/types.gen.ts:7194](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#7194)

## Properties

### 400

> **400**: [`HandlersOauthTokenError`](HandlersOauthTokenError.md)

Defined in: [src/client/types.gen.ts:7198](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#7198)

Bad Request

***

### 401

> **401**: [`HandlersOauthTokenError`](HandlersOauthTokenError.md)

Defined in: [src/client/types.gen.ts:7202](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#7202)

Unauthorized

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostOauthTokenResponse

# PostOauthTokenResponse

> **PostOauthTokenResponse** = [`PostOauthTokenResponses`](PostOauthTokenResponses.md)\[keyof [`PostOauthTokenResponses`](PostOauthTokenResponses.md)]

Defined in: [src/client/types.gen.ts:7214](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#7214)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PostOauthTokenResponses

# PostOauthTokenResponses

> **PostOauthTokenResponses** = `object`

Defined in: [src/client/types.gen.ts:7207](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#7207)

## Properties

### 200

> **200**: [`HandlersOAuthTokenResponse`](HandlersOAuthTokenResponse.md)

Defined in: [src/client/types.gen.ts:7211](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#7211)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PutApiV1AdminAgentsByIdData

# PutApiV1AdminAgentsByIdData

> **PutApiV1AdminAgentsByIdData** = `object`

Defined in: [src/client/types.gen.ts:2796](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2796)

## Properties

### body

> **body**: [`HandlersUpdateAgentRequest`](HandlersUpdateAgentRequest.md)

Defined in: [src/client/types.gen.ts:2800](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2800)

Update agent request

***

### headers

> **headers**: `object`

Defined in: [src/client/types.gen.ts:2801](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2801)

**X-Admin-API-Key**

> **X-Admin-API-Key**: `string`

Admin API key

***

### path

> **path**: `object`

Defined in: [src/client/types.gen.ts:2807](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2807)

**id**

> **id**: `number`

Agent ID

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:2813](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2813)

***

### url

> **url**: `"/api/v1/admin/agents/{id}"`

Defined in: [src/client/types.gen.ts:2814](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2814)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PutApiV1AdminAgentsByIdError

# PutApiV1AdminAgentsByIdError

> **PutApiV1AdminAgentsByIdError** = [`PutApiV1AdminAgentsByIdErrors`](PutApiV1AdminAgentsByIdErrors.md)\[keyof [`PutApiV1AdminAgentsByIdErrors`](PutApiV1AdminAgentsByIdErrors.md)]

Defined in: [src/client/types.gen.ts:2836](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2836)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PutApiV1AdminAgentsByIdErrors

# PutApiV1AdminAgentsByIdErrors

> **PutApiV1AdminAgentsByIdErrors** = `object`

Defined in: [src/client/types.gen.ts:2817](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2817)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:2821](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2821)

Bad Request

***

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:2825](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2825)

Unauthorized

***

### 404

> **404**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:2829](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2829)

Not Found

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:2833](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2833)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PutApiV1AdminAgentsByIdResponse

# PutApiV1AdminAgentsByIdResponse

> **PutApiV1AdminAgentsByIdResponse** = [`PutApiV1AdminAgentsByIdResponses`](PutApiV1AdminAgentsByIdResponses.md)\[keyof [`PutApiV1AdminAgentsByIdResponses`](PutApiV1AdminAgentsByIdResponses.md)]

Defined in: [src/client/types.gen.ts:2845](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2845)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PutApiV1AdminAgentsByIdResponses

# PutApiV1AdminAgentsByIdResponses

> **PutApiV1AdminAgentsByIdResponses** = `object`

Defined in: [src/client/types.gen.ts:2838](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2838)

## Properties

### 200

> **200**: [`HandlersAgentResponse`](HandlersAgentResponse.md)

Defined in: [src/client/types.gen.ts:2842](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2842)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PutApiV1AdminAppsByAppIdApiKeysByIdData

# PutApiV1AdminAppsByAppIdApiKeysByIdData

> **PutApiV1AdminAppsByAppIdApiKeysByIdData** = `object`

Defined in: [src/client/types.gen.ts:3143](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3143)

## Properties

### body

> **body**: [`HandlersUpdateApiKeyRequest`](HandlersUpdateApiKeyRequest.md)

Defined in: [src/client/types.gen.ts:3147](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3147)

Update API key request

***

### headers

> **headers**: `object`

Defined in: [src/client/types.gen.ts:3148](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3148)

**X-Admin-API-Key**

> **X-Admin-API-Key**: `string`

Admin API key

***

### path

> **path**: `object`

Defined in: [src/client/types.gen.ts:3154](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3154)

**app\_id**

> **app\_id**: `number`

App ID

**id**

> **id**: `number`

API Key ID

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:3164](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3164)

***

### url

> **url**: `"/api/v1/admin/apps/{app_id}/api-keys/{id}"`

Defined in: [src/client/types.gen.ts:3165](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3165)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PutApiV1AdminAppsByAppIdApiKeysByIdError

# PutApiV1AdminAppsByAppIdApiKeysByIdError

> **PutApiV1AdminAppsByAppIdApiKeysByIdError** = [`PutApiV1AdminAppsByAppIdApiKeysByIdErrors`](PutApiV1AdminAppsByAppIdApiKeysByIdErrors.md)\[keyof [`PutApiV1AdminAppsByAppIdApiKeysByIdErrors`](PutApiV1AdminAppsByAppIdApiKeysByIdErrors.md)]

Defined in: [src/client/types.gen.ts:3187](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3187)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PutApiV1AdminAppsByAppIdApiKeysByIdErrors

# PutApiV1AdminAppsByAppIdApiKeysByIdErrors

> **PutApiV1AdminAppsByAppIdApiKeysByIdErrors** = `object`

Defined in: [src/client/types.gen.ts:3168](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3168)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:3172](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3172)

Bad Request

***

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:3176](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3176)

Unauthorized

***

### 404

> **404**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:3180](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3180)

Not Found

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:3184](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3184)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PutApiV1AdminAppsByAppIdApiKeysByIdResponse

# PutApiV1AdminAppsByAppIdApiKeysByIdResponse

> **PutApiV1AdminAppsByAppIdApiKeysByIdResponse** = [`PutApiV1AdminAppsByAppIdApiKeysByIdResponses`](PutApiV1AdminAppsByAppIdApiKeysByIdResponses.md)\[keyof [`PutApiV1AdminAppsByAppIdApiKeysByIdResponses`](PutApiV1AdminAppsByAppIdApiKeysByIdResponses.md)]

Defined in: [src/client/types.gen.ts:3196](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3196)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PutApiV1AdminAppsByAppIdApiKeysByIdResponses

# PutApiV1AdminAppsByAppIdApiKeysByIdResponses

> **PutApiV1AdminAppsByAppIdApiKeysByIdResponses** = `object`

Defined in: [src/client/types.gen.ts:3189](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3189)

## Properties

### 200

> **200**: [`HandlersApiKeyResponse`](HandlersApiKeyResponse.md)

Defined in: [src/client/types.gen.ts:3193](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3193)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PutApiV1AdminAppsByIdData

# PutApiV1AdminAppsByIdData

> **PutApiV1AdminAppsByIdData** = `object`

Defined in: [src/client/types.gen.ts:3288](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3288)

## Properties

### body

> **body**: [`HandlersUpdateAppRequest`](HandlersUpdateAppRequest.md)

Defined in: [src/client/types.gen.ts:3292](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3292)

Update app request

***

### headers

> **headers**: `object`

Defined in: [src/client/types.gen.ts:3293](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3293)

**X-Admin-API-Key**

> **X-Admin-API-Key**: `string`

Admin API key

***

### path

> **path**: `object`

Defined in: [src/client/types.gen.ts:3299](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3299)

**id**

> **id**: `string`

App ID (numeric) or App UUID

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:3305](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3305)

***

### url

> **url**: `"/api/v1/admin/apps/{id}"`

Defined in: [src/client/types.gen.ts:3306](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3306)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PutApiV1AdminAppsByIdError

# PutApiV1AdminAppsByIdError

> **PutApiV1AdminAppsByIdError** = [`PutApiV1AdminAppsByIdErrors`](PutApiV1AdminAppsByIdErrors.md)\[keyof [`PutApiV1AdminAppsByIdErrors`](PutApiV1AdminAppsByIdErrors.md)]

Defined in: [src/client/types.gen.ts:3328](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3328)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PutApiV1AdminAppsByIdErrors

# PutApiV1AdminAppsByIdErrors

> **PutApiV1AdminAppsByIdErrors** = `object`

Defined in: [src/client/types.gen.ts:3309](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3309)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:3313](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3313)

Bad Request

***

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:3317](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3317)

Unauthorized

***

### 404

> **404**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:3321](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3321)

Not Found

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:3325](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3325)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PutApiV1AdminAppsByIdResponse

# PutApiV1AdminAppsByIdResponse

> **PutApiV1AdminAppsByIdResponse** = [`PutApiV1AdminAppsByIdResponses`](PutApiV1AdminAppsByIdResponses.md)\[keyof [`PutApiV1AdminAppsByIdResponses`](PutApiV1AdminAppsByIdResponses.md)]

Defined in: [src/client/types.gen.ts:3337](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3337)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PutApiV1AdminAppsByIdResponses

# PutApiV1AdminAppsByIdResponses

> **PutApiV1AdminAppsByIdResponses** = `object`

Defined in: [src/client/types.gen.ts:3330](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3330)

## Properties

### 200

> **200**: [`HandlersAppResponse`](HandlersAppResponse.md)

Defined in: [src/client/types.gen.ts:3334](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3334)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PutApiV1AdminPersonasByIdData

# PutApiV1AdminPersonasByIdData

> **PutApiV1AdminPersonasByIdData** = `object`

Defined in: [src/client/types.gen.ts:3615](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3615)

## Properties

### body

> **body**: [`HandlersUpdatePersonaRequest`](HandlersUpdatePersonaRequest.md)

Defined in: [src/client/types.gen.ts:3619](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3619)

Update persona request

***

### headers

> **headers**: `object`

Defined in: [src/client/types.gen.ts:3620](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3620)

**X-Admin-API-Key**

> **X-Admin-API-Key**: `string`

Admin API key

***

### path

> **path**: `object`

Defined in: [src/client/types.gen.ts:3626](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3626)

**id**

> **id**: `number`

Persona ID

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:3632](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3632)

***

### url

> **url**: `"/api/v1/admin/personas/{id}"`

Defined in: [src/client/types.gen.ts:3633](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3633)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PutApiV1AdminPersonasByIdError

# PutApiV1AdminPersonasByIdError

> **PutApiV1AdminPersonasByIdError** = [`PutApiV1AdminPersonasByIdErrors`](PutApiV1AdminPersonasByIdErrors.md)\[keyof [`PutApiV1AdminPersonasByIdErrors`](PutApiV1AdminPersonasByIdErrors.md)]

Defined in: [src/client/types.gen.ts:3655](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3655)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PutApiV1AdminPersonasByIdErrors

# PutApiV1AdminPersonasByIdErrors

> **PutApiV1AdminPersonasByIdErrors** = `object`

Defined in: [src/client/types.gen.ts:3636](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3636)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:3640](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3640)

Bad Request

***

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:3644](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3644)

Unauthorized

***

### 404

> **404**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:3648](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3648)

Not Found

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:3652](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3652)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PutApiV1AdminPersonasByIdResponse

# PutApiV1AdminPersonasByIdResponse

> **PutApiV1AdminPersonasByIdResponse** = [`PutApiV1AdminPersonasByIdResponses`](PutApiV1AdminPersonasByIdResponses.md)\[keyof [`PutApiV1AdminPersonasByIdResponses`](PutApiV1AdminPersonasByIdResponses.md)]

Defined in: [src/client/types.gen.ts:3664](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3664)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PutApiV1AdminPersonasByIdResponses

# PutApiV1AdminPersonasByIdResponses

> **PutApiV1AdminPersonasByIdResponses** = `object`

Defined in: [src/client/types.gen.ts:3657](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3657)

## Properties

### 200

> **200**: [`HandlersPersonaResponse`](HandlersPersonaResponse.md)

Defined in: [src/client/types.gen.ts:3661](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#3661)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PutApiV1AgentsByIdPreferenceData

# PutApiV1AgentsByIdPreferenceData

> **PutApiV1AgentsByIdPreferenceData** = `object`

Defined in: [src/client/types.gen.ts:4086](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4086)

## Properties

### body

> **body**: [`HandlersSetUserAgentPreferenceRequest`](HandlersSetUserAgentPreferenceRequest.md)

Defined in: [src/client/types.gen.ts:4090](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4090)

Preference

***

### path

> **path**: `object`

Defined in: [src/client/types.gen.ts:4091](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4091)

**id**

> **id**: `number`

Agent ID

***

### query?

> `optional` **query**: `never`

Defined in: [src/client/types.gen.ts:4097](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4097)

***

### url

> **url**: `"/api/v1/agents/{id}/preference"`

Defined in: [src/client/types.gen.ts:4098](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4098)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PutApiV1AgentsByIdPreferenceError

# PutApiV1AgentsByIdPreferenceError

> **PutApiV1AgentsByIdPreferenceError** = [`PutApiV1AgentsByIdPreferenceErrors`](PutApiV1AgentsByIdPreferenceErrors.md)\[keyof [`PutApiV1AgentsByIdPreferenceErrors`](PutApiV1AgentsByIdPreferenceErrors.md)]

Defined in: [src/client/types.gen.ts:4120](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4120)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PutApiV1AgentsByIdPreferenceErrors

# PutApiV1AgentsByIdPreferenceErrors

> **PutApiV1AgentsByIdPreferenceErrors** = `object`

Defined in: [src/client/types.gen.ts:4101](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4101)

## Properties

### 400

> **400**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4105](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4105)

Bad Request

***

### 401

> **401**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4109](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4109)

Unauthorized

***

### 404

> **404**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4113](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4113)

Not Found

***

### 500

> **500**: [`ResponseErrorResponse`](ResponseErrorResponse.md)

Defined in: [src/client/types.gen.ts:4117](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4117)

Internal Server Error

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PutApiV1AgentsByIdPreferenceResponse

# PutApiV1AgentsByIdPreferenceResponse

> **PutApiV1AgentsByIdPreferenceResponse** = [`PutApiV1AgentsByIdPreferenceResponses`](PutApiV1AgentsByIdPreferenceResponses.md)\[keyof [`PutApiV1AgentsByIdPreferenceResponses`](PutApiV1AgentsByIdPreferenceResponses.md)]

Defined in: [src/client/types.gen.ts:4129](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4129)

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/PutApiV1AgentsByIdPreferenceResponses

# PutApiV1AgentsByIdPreferenceResponses

> **PutApiV1AgentsByIdPreferenceResponses** = `object`

Defined in: [src/client/types.gen.ts:4122](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4122)

## Properties

### 200

> **200**: [`HandlersUserAgentPreferenceResponse`](HandlersUserAgentPreferenceResponse.md)

Defined in: [src/client/types.gen.ts:4126](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#4126)

OK

---
Source: https://docs.anuma.ai/sdk/client/Internal/type-aliases/ResponseErrorResponse

# ResponseErrorResponse

> **ResponseErrorResponse** = `object`

Defined in: [src/client/types.gen.ts:2599](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2599)

## Properties

### code?

> `optional` **code**: `string`

Defined in: [src/client/types.gen.ts:2600](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2600)

***

### error

> **error**: `string`

Defined in: [src/client/types.gen.ts:2601](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2601)

***

### request\_id?

> `optional` **request\_id**: `string`

Defined in: [src/client/types.gen.ts:2602](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2602)

***

### trace\_id?

> `optional` **trace\_id**: `string`

Defined in: [src/client/types.gen.ts:2603](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2603)

***

### type?

> `optional` **type**: `string`

Defined in: [src/client/types.gen.ts:2604](https://github.com/anuma-ai/sdk/blob/main/src/client/types.gen.ts#2604)

---
Source: https://docs.anuma.ai/sdk/expo

# Overview

React Native hooks for building AI-powered mobile applications.

The `@anuma/sdk/expo` package provides React hooks optimized for
Expo and React Native environments. These hooks exclude web-only
dependencies (like pdfjs-dist) that aren't compatible with React Native.

## Installation & Setup

Before using this package, you must set up polyfills for React Native compatibility.
See the polyfills module documentation for complete setup instructions.

Quick setup summary:

```bash
pnpm install @anuma/sdk@next web-streams-polyfill react-native-get-random-values @ethersproject/shims buffer
```

Then create an entrypoint file with all required polyfills. See
[ai-example-expo](https://github.com/zeta-chain/ai-example-expo) for a complete
working example.

## Differences from React Package

The Expo package is a lightweight subset of `@anuma/sdk/react`:

* No PDF text extraction (pdfjs-dist is web-only)
* Uses XMLHttpRequest for streaming (fetch streaming isn't supported in RN)

## Authentication

Use `@privy-io/expo` for authentication in React Native:

```typescript
import { PrivyProvider, usePrivy } from "@privy-io/expo";
import { useIdentityToken } from "@privy-io/expo";

// Wrap your app with PrivyProvider
<PrivyProvider appId="your-app-id" clientId="your-client-id">
  <App />
</PrivyProvider>;

// Get identity token for API calls
const { getIdentityToken } = useIdentityToken();
```

## Quick Start

```tsx
import { useIdentityToken } from "@privy-io/expo";
import { useChat } from "@anuma/sdk/expo";

function ChatScreen() {
  const { getIdentityToken } = useIdentityToken();

  const { isLoading, sendMessage, stop } = useChat({
    getToken: getIdentityToken,
    baseUrl: "https://portal.anuma-dev.ai",
    onData: (chunk) => {
      // Handle streaming chunks
      const content =
        typeof chunk === "string"
          ? chunk
          : chunk.choices?.[0]?.delta?.content || "";
      console.log("Received:", content);
    },
    onFinish: () => console.log("Stream finished"),
    onError: (error) => console.error("Error:", error),
  });

  const handleSend = async () => {
    await sendMessage({
      messages: [{ role: "user", content: [{ type: "text", text: "Hello!" }] }],
      model: "fireworks/accounts/fireworks/models/kimi-k2p5",
    });
  };

  return (
    <View>
      <Button onPress={handleSend} disabled={isLoading} title="Send" />
      {isLoading && <Button onPress={stop} title="Stop" />}
    </View>
  );
}
```

## Hooks

| Function | Description |
| ------ | ------ |
| [useChat](Hooks/useChat.md) | A React hook for managing chat completions with authentication. |
| [useChatStorage](Hooks/useChatStorage.md) | A React hook that wraps useChat with automatic message persistence using WatermelonDB. |

## Other

### CachedServerTools

Re-exports [CachedServerTools](../react/Internal/interfaces/CachedServerTools.md)

***

### ChatConversation

Re-exports [ChatConversation](../react/Internal/classes/ChatConversation.md)

***

### ChatMessage

Re-exports [ChatMessage](../react/Internal/classes/ChatMessage.md)

***

### ChatRole

Re-exports [ChatRole](../react/Internal/type-aliases/ChatRole.md)

***

### chatStorageMigrations

Re-exports [chatStorageMigrations](../react/Internal/variables/chatStorageMigrations.md)

***

### chatStorageSchema

Re-exports [chatStorageSchema](../react/Internal/variables/chatStorageSchema.md)

***

### clearAllEncryptionKeys

Re-exports [clearAllEncryptionKeys](../react/Internal/functions/clearAllEncryptionKeys.md)

***

### clearAllEncryptionState

Re-exports [clearAllEncryptionState](../react/Internal/functions/clearAllEncryptionState.md)

***

### clearEncryptionKey

Re-exports [clearEncryptionKey](../react/Internal/functions/clearEncryptionKey.md)

***

### clearLazyTitleCache

Re-exports [clearLazyTitleCache](../react/Internal/functions/clearLazyTitleCache.md)

***

### clearServerToolsCache

Re-exports [clearServerToolsCache](../react/Internal/functions/clearServerToolsCache.md)

***

### cosineInt8

Re-exports [cosineInt8](../react/Internal/functions/cosineInt8.md)

***

### CreateConversationOptions

Re-exports [CreateConversationOptions](../react/Internal/interfaces/CreateConversationOptions.md)

***

### createMemoryEngineTool

Re-exports [createMemoryEngineTool](../react/Internal/functions/createMemoryEngineTool.md)

***

### createMemoryVaultTool

Re-exports [createMemoryVaultTool](../react/Internal/functions/createMemoryVaultTool.md)

***

### CreateMessageOptions

Re-exports [CreateMessageOptions](../react/Internal/interfaces/CreateMessageOptions.md)

***

### createVaultFolderOp

Re-exports [createVaultFolderOp](../react/Internal/functions/createVaultFolderOp.md)

***

### CreateVaultFolderOptions

Re-exports [CreateVaultFolderOptions](../react/Internal/interfaces/CreateVaultFolderOptions.md)

***

### createVaultMemoriesBatchOp

Re-exports [createVaultMemoriesBatchOp](../react/Internal/functions/createVaultMemoriesBatchOp.md)

***

### createVaultMemoryOp

Re-exports [createVaultMemoryOp](../react/Internal/functions/createVaultMemoryOp.md)

***

### CreateVaultMemoryOptions

Re-exports [CreateVaultMemoryOptions](../react/Internal/interfaces/CreateVaultMemoryOptions.md)

***

### DatabaseManager

Re-exports [DatabaseManager](../react/Internal/classes/DatabaseManager.md)

***

### DatabaseManagerLogger

Re-exports [DatabaseManagerLogger](../react/Internal/interfaces/DatabaseManagerLogger.md)

***

### DatabaseManagerOptions

Re-exports [DatabaseManagerOptions](../react/Internal/interfaces/DatabaseManagerOptions.md)

***

### decryptConversationTitle

Re-exports [decryptConversationTitle](../react/Internal/functions/decryptConversationTitle.md)

***

### DEFAULT\_CACHE\_EXPIRATION\_MS

Re-exports [DEFAULT\_CACHE\_EXPIRATION\_MS](../react/Internal/variables/DEFAULT_CACHE_EXPIRATION_MS.md)

***

### deleteAllVaultMemoriesForUserOp

Re-exports [deleteAllVaultMemoriesForUserOp](../react/Internal/functions/deleteAllVaultMemoriesForUserOp.md)

***

### deleteVaultFolderOp

Re-exports [deleteVaultFolderOp](../react/Internal/functions/deleteVaultFolderOp.md)

***

### deleteVaultMemoryOp

Re-exports [deleteVaultMemoryOp](../react/Internal/functions/deleteVaultMemoryOp.md)

***

### dequantizeEmbedding

Re-exports [dequantizeEmbedding](../react/Internal/functions/dequantizeEmbedding.md)

***

### embedAllMessages

Re-exports [embedAllMessages](../react/Internal/functions/embedAllMessages.md)

***

### EmbeddedWalletSignerFn

Re-exports [EmbeddedWalletSignerFn](../react/Internal/type-aliases/EmbeddedWalletSignerFn.md)

***

### embedMessage

Re-exports [embedMessage](../react/Internal/functions/embedMessage.md)

***

### ensureDefaultFoldersOp

Re-exports [ensureDefaultFoldersOp](../react/Internal/functions/ensureDefaultFoldersOp.md)

***

### FileMetadata

Re-exports [FileMetadata](../react/Internal/interfaces/FileMetadata.md)

***

### FlushResult

Re-exports [FlushResult](../react/Internal/interfaces/FlushResult.md)

***

### generateConversationId

Re-exports [generateConversationId](../react/Internal/functions/generateConversationId.md)

***

### generateEmbedding

Re-exports [generateEmbedding](../react/Internal/functions/generateEmbedding.md)

***

### generateEmbeddings

Re-exports [generateEmbeddings](../react/Internal/functions/generateEmbeddings.md)

***

### getAllVaultFoldersOp

Re-exports [getAllVaultFoldersOp](../react/Internal/functions/getAllVaultFoldersOp.md)

***

### getAllVaultMemoriesOp

Re-exports [getAllVaultMemoriesOp](../react/Internal/functions/getAllVaultMemoriesOp.md)

***

### getAllVaultMemoryContentsOp

Re-exports [getAllVaultMemoryContentsOp](../react/Internal/functions/getAllVaultMemoryContentsOp.md)

***

### getCachedServerTools

Re-exports [getCachedServerTools](../react/Internal/functions/getCachedServerTools.md)

***

### getConversationsByProjectLazyOp

Re-exports [getConversationsByProjectLazyOp](../react/Internal/functions/getConversationsByProjectLazyOp.md)

***

### getConversationsLazyOp

Re-exports [getConversationsLazyOp](../react/Internal/functions/getConversationsLazyOp.md)

***

### getServerTools

Re-exports [getServerTools](../react/Internal/functions/getServerTools.md)

***

### getUnfiledVaultMemoriesOp

Re-exports [getUnfiledVaultMemoriesOp](../react/Internal/functions/getUnfiledVaultMemoriesOp.md)

***

### getVaultFolderMemoryCountOp

Re-exports [getVaultFolderMemoryCountOp](../react/Internal/functions/getVaultFolderMemoryCountOp.md)

***

### getVaultMemoryOp

Re-exports [getVaultMemoryOp](../react/Internal/functions/getVaultMemoryOp.md)

***

### hasEncryptionKey

Re-exports [hasEncryptionKey](../react/Internal/functions/hasEncryptionKey.md)

***

### LazyStoredConversation

Re-exports [LazyStoredConversation](../react/Internal/interfaces/LazyStoredConversation.md)

***

### MemoryEngineEmbeddingOptions

Re-exports [MemoryEngineEmbeddingOptions](../react/Internal/interfaces/MemoryEngineEmbeddingOptions.md)

***

### MemoryEngineResult

Re-exports [MemoryEngineResult](../react/Internal/interfaces/MemoryEngineResult.md)

***

### MemoryEngineSearchOptions

Re-exports [MemoryEngineSearchOptions](../react/Internal/interfaces/MemoryEngineSearchOptions.md)

***

### MemoryVaultToolOptions

Re-exports [MemoryVaultToolOptions](../react/Internal/interfaces/MemoryVaultToolOptions.md)

***

### moveMemoriesToFolderOp

Re-exports [moveMemoriesToFolderOp](../react/Internal/functions/moveMemoriesToFolderOp.md)

***

### onKeyAvailable

Re-exports [onKeyAvailable](../react/Internal/functions/onKeyAvailable.md)

***

### PlatformStorage

Re-exports [PlatformStorage](../react/Internal/interfaces/PlatformStorage.md)

***

### QuantizedEmbedding

Re-exports [QuantizedEmbedding](../react/Internal/interfaces/QuantizedEmbedding.md)

***

### quantizeEmbedding

Re-exports [quantizeEmbedding](../react/Internal/functions/quantizeEmbedding.md)

***

### queueManager

Re-exports [queueManager](../react/Internal/variables/queueManager.md)

***

### QueueManager

Re-exports [QueueManager](../react/Internal/classes/QueueManager.md)

***

### QueueStatus

Re-exports [QueueStatus](../react/Internal/interfaces/QueueStatus.md)

***

### requestEncryptionKey

Re-exports [requestEncryptionKey](../react/Internal/functions/requestEncryptionKey.md)

***

### SDK\_SCHEMA\_VERSION

Re-exports [SDK\_SCHEMA\_VERSION](../react/Internal/variables/SDK_SCHEMA_VERSION.md)

***

### sdkMigrations

Re-exports [sdkMigrations](../react/Internal/variables/sdkMigrations.md)

***

### sdkModelClasses

Re-exports [sdkModelClasses](../react/Internal/variables/sdkModelClasses.md)

***

### sdkSchema

Re-exports [sdkSchema](../react/Internal/variables/sdkSchema.md)

***

### SearchSource

Re-exports [SearchSource](../react/Internal/interfaces/SearchSource.md)

***

### ServerToolsOptions

Re-exports [ServerToolsOptions](../react/Internal/interfaces/ServerToolsOptions.md)

***

### ServerToolsResponse

Re-exports [ServerToolsResponse](../react/Internal/type-aliases/ServerToolsResponse.md)

***

### SignMessageFn

Re-exports [SignMessageFn](../react/Internal/type-aliases/SignMessageFn.md)

***

### StoredChatCompletionUsage

Re-exports [StoredChatCompletionUsage](../react/Internal/interfaces/StoredChatCompletionUsage.md)

***

### StoredConversation

Re-exports [StoredConversation](../react/Internal/interfaces/StoredConversation.md)

***

### StoredMessage

Re-exports [StoredMessage](../react/Internal/interfaces/StoredMessage.md)

***

### StoredMessageWithSimilarity

Re-exports [StoredMessageWithSimilarity](../react/Internal/interfaces/StoredMessageWithSimilarity.md)

***

### StoredVaultFolder

Re-exports [StoredVaultFolder](../react/Internal/interfaces/StoredVaultFolder.md)

***

### StoredVaultFolderModel

Re-exports [StoredVaultFolderModel](../react/Internal/classes/StoredVaultFolderModel.md)

***

### StoredVaultMemory

Re-exports [StoredVaultMemory](../react/Internal/interfaces/StoredVaultMemory.md)

***

### StoredVaultMemoryModel

Re-exports [StoredVaultMemoryModel](../react/Internal/classes/StoredVaultMemoryModel.md)

***

### updateVaultFolderContextOp

Re-exports [updateVaultFolderContextOp](../react/Internal/functions/updateVaultFolderContextOp.md)

***

### updateVaultFolderOp

Re-exports [updateVaultFolderOp](../react/Internal/functions/updateVaultFolderOp.md)

***

### UpdateVaultFolderOptions

Re-exports [UpdateVaultFolderOptions](../react/Internal/interfaces/UpdateVaultFolderOptions.md)

***

### updateVaultMemoryEmbeddingOp

Re-exports [updateVaultMemoryEmbeddingOp](../react/Internal/functions/updateVaultMemoryEmbeddingOp.md)

***

### updateVaultMemoryOp

Re-exports [updateVaultMemoryOp](../react/Internal/functions/updateVaultMemoryOp.md)

***

### UpdateVaultMemoryOptions

Re-exports [UpdateVaultMemoryOptions](../react/Internal/interfaces/UpdateVaultMemoryOptions.md)

***

### useCredits

Re-exports [useCredits](../react/Hooks/useCredits.md)

***

### UseCreditsOptions

Re-exports [UseCreditsOptions](../react/Internal/type-aliases/UseCreditsOptions.md)

***

### UseCreditsResult

Re-exports [UseCreditsResult](../react/Internal/type-aliases/UseCreditsResult.md)

***

### useEncryption

Re-exports [useEncryption](../react/Hooks/useEncryption.md)

***

### useModels

Re-exports [useModels](../react/Hooks/useModels.md)

***

### UseModelsResult

Re-exports [UseModelsResult](../react/Internal/type-aliases/UseModelsResult.md)

***

### VaultFolderOperationsContext

Re-exports [VaultFolderOperationsContext](../react/Internal/interfaces/VaultFolderOperationsContext.md)

***

### VaultMemoryOperationsContext

Re-exports [VaultMemoryOperationsContext](../react/Internal/interfaces/VaultMemoryOperationsContext.md)

***

### VaultSaveOperation

Re-exports [VaultSaveOperation](../react/Internal/interfaces/VaultSaveOperation.md)

***

### WalletPoller

Re-exports [WalletPoller](../react/Internal/classes/WalletPoller.md)

---
Source: https://docs.anuma.ai/sdk/expo/Hooks/useChat

# useChat

> **useChat**(`options?`: `object`): `UseChatResult`

Defined in: [src/expo/useChat.ts:120](https://github.com/anuma-ai/sdk/blob/main/src/expo/useChat.ts#120)

A React hook for managing chat completions with authentication.

**React Native version** — Uses XMLHttpRequest for streaming since
`fetch` response body streaming isn't available in React Native.
Delegates all tool loop logic to the shared `runToolLoop`.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options?`

</td>
<td>

`object`

</td>
<td>

Optional configuration object

</td>
</tr>
<tr>
<td>

`options.apiType?`

</td>
<td>

`ApiType`

</td>
<td>

Which API endpoint to use. Default: "auto"

* "auto": automatically selects the best API based on model support
* "responses": OpenAI Responses API (supports thinking, reasoning, conversations)
* "completions": OpenAI Chat Completions API (wider model compatibility)

</td>
</tr>
<tr>
<td>

`options.baseUrl?`

</td>
<td>

`string`

</td>
<td>

Optional base URL for the API requests.

</td>
</tr>
<tr>
<td>

`options.getToken?`

</td>
<td>

() => `Promise`<`string` | `null`>

</td>
<td>

An async function that returns an authentication token.

</td>
</tr>
<tr>
<td>

`options.onData?`

</td>
<td>

(`chunk`: `string`) => `void`

</td>
<td>

Callback function to be called when a new data chunk is received.

</td>
</tr>
<tr>
<td>

`options.onError?`

</td>
<td>

(`error`: `Error`) => `void`

</td>
<td>

Callback function to be called when an unexpected error is encountered.

**Note:** This callback is NOT called for aborted requests (via `stop()` or
component unmount). Aborts are intentional actions and are not considered
errors. To detect aborts, check the `error` field in the `sendMessage` result:
`result.error === "Request aborted"`.

</td>
</tr>
<tr>
<td>

`options.onFinish?`

</td>
<td>

(`response`: `ApiResponse`) => `void`

</td>
<td>

Callback function to be called when the chat completion finishes successfully.
Receives raw API response - either Responses API or Completions API format.

</td>
</tr>
<tr>
<td>

`options.onServerToolCall?`

</td>
<td>

(`toolCall`: `ServerToolCallEvent`) => `void`

</td>
<td>

Callback function to be called when a server-side tool (MCP) is invoked during streaming.
Use this to show activity indicators like "Searching..." in the UI.

</td>
</tr>
<tr>
<td>

`options.onStepFinish?`

</td>
<td>

(`event`: [`StepFinishEvent`](../../react/Internal/type-aliases/StepFinishEvent.md)) => `void`

</td>
<td>

Called after each tool execution round completes.
Receives the round index, model content, tool calls, results, and token usage.
Useful for progress indicators, cost tracking, and custom early-exit logic.

</td>
</tr>
<tr>
<td>

`options.onThinking?`

</td>
<td>

(`chunk`: `string`) => `void`

</td>
<td>

Callback function to be called when thinking/reasoning content is received.
This is called with delta chunks as the model "thinks" through a problem.

</td>
</tr>
<tr>
<td>

`options.onToolCall?`

</td>
<td>

(`toolCall`: [`LlmapiToolCall`](../../client/Internal/type-aliases/LlmapiToolCall.md)) => `void`

</td>
<td>

Callback function to be called when a tool call is requested by the LLM
but no executor is registered for it (e.g. server-side tools).

</td>
</tr>
<tr>
<td>

`options.onToolCallArgumentsDelta?`

</td>
<td>

(`event`: [`ToolCallArgumentsDeltaEvent`](../../react/Internal/type-aliases/ToolCallArgumentsDeltaEvent.md)) => `void`

</td>
<td>

Called with partial tool call arguments as they stream in.
Use for live preview of artifacts (HTML, slides) being generated.

</td>
</tr>
<tr>
<td>

`options.preProcessors?`

</td>
<td>

`PromptPreProcessor`\[]

</td>
<td>

Pre-processors run after the last user message is received but before the
first LLM request. Each receives the prompt text and a shared embedding
(computed once per request) and may return messages to enrich the
conversation. See `createWebSearchPreProcessor`,
`createCryptoPricePreProcessor`, `createStockPricePreProcessor`,
`createWeatherPreProcessor`, or write a custom one matching
`PromptPreProcessor`.

</td>
</tr>
<tr>
<td>

`options.smoothing?`

</td>
<td>

`boolean` | `StreamSmoothingConfig`

</td>
<td>

Controls adaptive output smoothing for streaming responses.
Fast models can return text faster than is comfortable to read — smoothing
buffers incoming chunks and releases them at a consistent, adaptive pace.

* `true` or omitted: enabled with defaults (200→400 chars/sec over 3s)
* `false`: disabled, callbacks fire immediately with raw chunks
* `StreamSmoothingConfig`: custom speed/ramp configuration

**Default**

```ts
true
```

</td>
</tr>
</tbody>
</table>

## Returns

`UseChatResult`

An object containing:

* `isLoading`: A boolean indicating whether a request is currently in progress
* `sendMessage`: An async function to send chat messages
* `stop`: A function to abort the current request

## Example

```tsx
const { isLoading, sendMessage, stop } = useChat({
  getToken: async () => await getAuthToken(),
  onFinish: (response) => console.log("Chat finished:", response),
  onError: (error) => console.error("Chat error:", error)
});

const handleSend = async () => {
  const result = await sendMessage({
    messages: [{ role: 'user', content: [{ type: 'text', text: 'Hello!' }] }],
    model: 'fireworks/accounts/fireworks/models/kimi-k2p5'
  });
};
```

---
Source: https://docs.anuma.ai/sdk/expo/Hooks/useChatStorage

# useChatStorage

> **useChatStorage**(`options`: `object`): [`UseChatStorageResult`](../Internal/interfaces/UseChatStorageResult.md)

Defined in: [src/expo/useChatStorage.ts:350](https://github.com/anuma-ai/sdk/blob/main/src/expo/useChatStorage.ts#350)

A React hook that wraps useChat with automatic message persistence using WatermelonDB.

**Expo/React Native version** - This is a lightweight version that only supports
API-based chat completions. Local chat and client-side tools are not available.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

`object`

</td>
<td>

Configuration options

</td>
</tr>
<tr>
<td>

`options.apiType?`

</td>
<td>

`ApiType`

</td>
<td>

Which API endpoint to use. Default: "responses"

* "responses": OpenAI Responses API (supports thinking, reasoning, conversations)
* "completions": OpenAI Chat Completions API (wider model compatibility)

</td>
</tr>
<tr>
<td>

`options.autoCreateConversation?`

</td>
<td>

`boolean`

</td>
<td>

Automatically create a new conversation if none is set (default: true)

</td>
</tr>
<tr>
<td>

`options.autoEmbedMessages?`

</td>
<td>

`boolean`

</td>
<td>

Automatically generate embeddings for messages after saving.
Enables semantic search over past conversations via searchMessages().

**Default**

```ts
true
```

</td>
</tr>
<tr>
<td>

`options.autoFlushOnKeyAvailable?`

</td>
<td>

`boolean`

</td>
<td>

Auto-flush queued operations when key becomes available.

**Default**

```ts
true
```

</td>
</tr>
<tr>
<td>

`options.baseUrl?`

</td>
<td>

`string`

</td>
<td>

Base URL for the chat API endpoint

</td>
</tr>
<tr>
<td>

`options.conversationId?`

</td>
<td>

`string`

</td>
<td>

ID of an existing conversation to load and continue

</td>
</tr>
<tr>
<td>

`options.database`

</td>
<td>

`Database`

</td>
<td>

WatermelonDB database instance for storing conversations and messages

</td>
</tr>
<tr>
<td>

`options.defaultConversationTitle?`

</td>
<td>

`string`

</td>
<td>

Title for auto-created conversations (default: "New conversation")

</td>
</tr>
<tr>
<td>

`options.embeddedWalletSigner?`

</td>
<td>

[`EmbeddedWalletSignerFn`](../../react/Internal/type-aliases/EmbeddedWalletSignerFn.md)

</td>
<td>

Function for silent signing with Privy embedded wallets.

</td>
</tr>
<tr>
<td>

`options.embeddingModel?`

</td>
<td>

`string`

</td>
<td>

Embedding model to use when autoEmbedMessages is enabled.

**Default**

```ts
DEFAULT_API_EMBEDDING_MODEL
```

</td>
</tr>
<tr>
<td>

`options.enableQueue?`

</td>
<td>

`boolean`

</td>
<td>

Enable the in-memory write queue.

**Default**

```ts
true
```

</td>
</tr>
<tr>
<td>

`options.fileProcessingOptions?`

</td>
<td>

{ `keepOriginalFiles?`: `boolean`; `maxFileSizeBytes?`: `number`; `onError?`: (`fileName`: `string`, `error`: `Error`) => `void`; `onProgress?`: (`current`: `number`, `total`: `number`, `fileName`: `string`) => `void`; }

</td>
<td>

Options for file preprocessing behavior

</td>
</tr>
<tr>
<td>

`options.fileProcessingOptions.keepOriginalFiles?`

</td>
<td>

`boolean`

</td>
<td>

Whether to keep original file attachments (default: true)

</td>
</tr>
<tr>
<td>

`options.fileProcessingOptions.maxFileSizeBytes?`

</td>
<td>

`number`

</td>
<td>

Max file size to process in bytes (default: 10MB)

</td>
</tr>
<tr>
<td>

`options.fileProcessingOptions.onError?`

</td>
<td>

(`fileName`: `string`, `error`: `Error`) => `void`

</td>
<td>

Callback for errors (non-fatal)

</td>
</tr>
<tr>
<td>

`options.fileProcessingOptions.onProgress?`

</td>
<td>

(`current`: `number`, `total`: `number`, `fileName`: `string`) => `void`

</td>
<td>

Callback for progress updates

</td>
</tr>
<tr>
<td>

`options.fileProcessors?`

</td>
<td>

[`FileProcessor`](../../react/Internal/interfaces/FileProcessor.md)\[] | `null`

</td>
<td>

File preprocessors to use for automatic text extraction.

* undefined (default): Use all built-in processors (PDF, Excel, Word)
* null or \[]: Disable preprocessing
* FileProcessor\[]: Use specific processors

</td>
</tr>
<tr>
<td>

`options.getToken?`

</td>
<td>

() => `Promise`<`string` | `null`>

</td>
<td>

Function to retrieve the auth token for API requests

</td>
</tr>
<tr>
<td>

`options.getWalletAddress?`

</td>
<td>

() => `Promise`<`string` | `null`>

</td>
<td>

Async function to poll for wallet address during Privy initialization.

</td>
</tr>
<tr>
<td>

`options.mcpR2Domain?`

</td>
<td>

`string`

</td>
<td>

R2 domain for identifying MCP-generated image URLs.
When set, enables OPFS caching of generated images.
Defaults to the hardcoded MCP\_R2\_DOMAIN from clientConfig.

</td>
</tr>
<tr>
<td>

`options.minContentLength?`

</td>
<td>

`number`

</td>
<td>

Minimum content length required to generate embeddings.
Messages shorter than this are skipped as they provide limited semantic value.

**Default**

```ts
10
```

</td>
</tr>
<tr>
<td>

`options.onData?`

</td>
<td>

(`chunk`: `string`) => `void`

</td>
<td>

Callback invoked with each streamed response chunk

</td>
</tr>
<tr>
<td>

`options.onError?`

</td>
<td>

(`error`: `Error`) => `void`

</td>
<td>

Callback invoked when an error occurs during the request

</td>
</tr>
<tr>
<td>

`options.onFinish?`

</td>
<td>

(`response`: [`LlmapiResponseResponse`](../../client/Internal/type-aliases/LlmapiResponseResponse.md)) => `void`

</td>
<td>

Callback invoked when the response completes successfully

</td>
</tr>
<tr>
<td>

`options.onServerToolCall?`

</td>
<td>

(`toolCall`: `ServerToolCallEvent`) => `void`

</td>
<td>

Callback invoked when a server-side tool (MCP) is called during streaming.
Use this to show activity indicators like "Searching..." in the UI.

</td>
</tr>
<tr>
<td>

`options.onThinking?`

</td>
<td>

(`chunk`: `string`) => `void`

</td>
<td>

Callback invoked when thinking/reasoning content is received (from `<think>` tags or API reasoning)

</td>
</tr>
<tr>
<td>

`options.onToolCallArgumentsDelta?`

</td>
<td>

(`event`: [`ToolCallArgumentsDeltaEvent`](../../react/Internal/type-aliases/ToolCallArgumentsDeltaEvent.md)) => `void`

</td>
<td>

Called with partial tool call arguments as they stream in.
Use for live preview of artifacts (HTML, slides) being generated.

</td>
</tr>
<tr>
<td>

`options.preProcessors?`

</td>
<td>

`PromptPreProcessor`\[]

</td>
<td>

Pre-processors run after the last user message is received but before
the first LLM request. Each receives the prompt text and a shared
embedding (computed once per request) and may return messages to
enrich the conversation. Forwarded to the underlying `useChat` hook.
See `createWebSearchPreProcessor`, `createCryptoPricePreProcessor`,
`createStockPricePreProcessor`, `createWeatherPreProcessor`, or write
a custom one matching `PromptPreProcessor`.

</td>
</tr>
<tr>
<td>

`options.serverTools?`

</td>
<td>

{ `cacheExpirationMs?`: `number`; }

</td>
<td>

Configuration for server-side tools fetching and caching.
Server tools are fetched from /api/v1/tools and cached in localStorage.

</td>
</tr>
<tr>
<td>

`options.serverTools.cacheExpirationMs?`

</td>
<td>

`number`

</td>
<td>

Cache expiration time in milliseconds (default: 86400000 = 1 day)

</td>
</tr>
<tr>
<td>

`options.signMessage?`

</td>
<td>

[`SignMessageFn`](../../react/Internal/type-aliases/SignMessageFn.md)

</td>
<td>

Function to sign a message for encryption key derivation.

</td>
</tr>
<tr>
<td>

`options.walletAddress?`

</td>
<td>

`string`

</td>
<td>

Wallet address for field-level encryption.
When provided with signMessage, all sensitive content is encrypted at rest.

</td>
</tr>
</tbody>
</table>

## Returns

[`UseChatStorageResult`](../Internal/interfaces/UseChatStorageResult.md)

An object containing chat state, methods, and storage operations

## Example

```tsx
import { Database } from '@nozbe/watermelondb';
import { useChatStorage } from '@anuma/sdk/expo';

function ChatScreen({ database }: { database: Database }) {
  const {
    isLoading,
    sendMessage,
    conversationId,
    getMessages,
  } = useChatStorage({
    database,
    getToken: async () => getAuthToken(),
    onData: (chunk) => setResponse((prev) => prev + chunk),
  });

  const handleSend = async () => {
    const result = await sendMessage({
      content: 'Hello!',
      model: 'fireworks/accounts/fireworks/models/kimi-k2p5',
      includeHistory: true,
    });
  };

  return (
    <View>
      <Button onPress={handleSend} disabled={isLoading} title="Send" />
    </View>
  );
}
```

---
Source: https://docs.anuma.ai/sdk/expo/Internal/functions/buildNotionAuthUrl

# buildNotionAuthUrl

> **buildNotionAuthUrl**(`params`: [`NotionAuthUrlParams`](../interfaces/NotionAuthUrlParams.md)): `string`

Defined in: [src/lib/auth/notion-primitives.ts:284](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/notion-primitives.ts#284)

Build the Notion authorization URL for the OAuth flow.

Returns a URL string that the caller should open in a browser
(e.g. via `expo-auth-session` or `Linking.openURL`).

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`params`

</td>
<td>

[`NotionAuthUrlParams`](../interfaces/NotionAuthUrlParams.md)

</td>
</tr>
</tbody>
</table>

## Returns

`string`

---
Source: https://docs.anuma.ai/sdk/expo/Internal/functions/createNotionTools

# createNotionTools

> **createNotionTools**(`getAccessToken`: () => `string` | `null`, `requestNotionAccess`: () => `Promise`<`string`>): `ToolConfig`\[]

Defined in: [src/tools/notion.ts:1065](https://github.com/anuma-ai/sdk/blob/main/src/tools/notion.ts#1065)

Create all Notion MCP tools

Returns tools that communicate with Notion's hosted MCP server.
The MCP server handles all Notion API interactions.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`getAccessToken`

</td>
<td>

() => `string` | `null`

</td>
</tr>
<tr>
<td>

`requestNotionAccess`

</td>
<td>

() => `Promise`<`string`>

</td>
</tr>
</tbody>
</table>

## Returns

`ToolConfig`\[]

---
Source: https://docs.anuma.ai/sdk/expo/Internal/functions/discoverNotionOAuthEndpoints

# discoverNotionOAuthEndpoints

> **discoverNotionOAuthEndpoints**(): `Promise`<[`NotionOAuthEndpoints`](../interfaces/NotionOAuthEndpoints.md)>

Defined in: [src/lib/auth/notion-primitives.ts:167](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/notion-primitives.ts#167)

Discover OAuth server metadata from Notion's well-known endpoints.

Follows the two-step RFC 8414 flow:

1. `/.well-known/oauth-protected-resource` to find the authorization server.
2. `<authServer>/.well-known/oauth-authorization-server` for metadata.

Falls back to [NOTION\_OAUTH\_CONFIG](../variables/NOTION_OAUTH_CONFIG.md) if discovery fails.

## Returns

`Promise`<[`NotionOAuthEndpoints`](../interfaces/NotionOAuthEndpoints.md)>

---
Source: https://docs.anuma.ai/sdk/expo/Internal/functions/exchangeNotionCode

# exchangeNotionCode

> **exchangeNotionCode**(`params`: [`NotionExchangeCodeParams`](../interfaces/NotionExchangeCodeParams.md)): `Promise`<[`NotionTokenResponse`](../interfaces/NotionTokenResponse.md)>

Defined in: [src/lib/auth/notion-primitives.ts:307](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/notion-primitives.ts#307)

Exchange an authorization code for tokens.

This is a **public client** request — no `client_secret` is sent.
The `code_verifier` proves possession of the original challenge.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`params`

</td>
<td>

[`NotionExchangeCodeParams`](../interfaces/NotionExchangeCodeParams.md)

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<[`NotionTokenResponse`](../interfaces/NotionTokenResponse.md)>

---
Source: https://docs.anuma.ai/sdk/expo/Internal/functions/generateNotionPKCE

# generateNotionPKCE

> **generateNotionPKCE**(): `Promise`<[`NotionPKCEChallenge`](../interfaces/NotionPKCEChallenge.md)>

Defined in: [src/lib/auth/notion-primitives.ts:267](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/notion-primitives.ts#267)

Generate a fresh PKCE challenge (code verifier + code challenge + state).

The caller is responsible for storing the `codeVerifier` securely
(e.g. in `expo-secure-store`) so it can be presented during token exchange.

## Returns

`Promise`<[`NotionPKCEChallenge`](../interfaces/NotionPKCEChallenge.md)>

---
Source: https://docs.anuma.ai/sdk/expo/Internal/functions/refreshNotionAccessToken

# refreshNotionAccessToken

> **refreshNotionAccessToken**(`params`: [`NotionRefreshTokenParams`](../interfaces/NotionRefreshTokenParams.md)): `Promise`<[`NotionTokenResponse`](../interfaces/NotionTokenResponse.md)>

Defined in: [src/lib/auth/notion-primitives.ts:359](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/notion-primitives.ts#359)

Refresh an access token using a refresh token.

This is a **public client** request — no `client_secret` is sent.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`params`

</td>
<td>

[`NotionRefreshTokenParams`](../interfaces/NotionRefreshTokenParams.md)

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<[`NotionTokenResponse`](../interfaces/NotionTokenResponse.md)>

---
Source: https://docs.anuma.ai/sdk/expo/Internal/functions/registerNotionClient

# registerNotionClient

> **registerNotionClient**(`registrationEndpoint`: `string`, `redirectUri`: `string`, `clientName`: `string`): `Promise`<[`NotionClientRegistration`](../interfaces/NotionClientRegistration.md)>

Defined in: [src/lib/auth/notion-primitives.ts:219](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/notion-primitives.ts#219)

Register a new OAuth client dynamically.

Registers as a **public client** (`token_endpoint_auth_method: "none"`)
so no client secret is needed for token exchange (PKCE is used instead).

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`registrationEndpoint`

</td>
<td>

`string`

</td>
<td>

`undefined`

</td>
<td>

The RFC 7591 registration endpoint URL.

</td>
</tr>
<tr>
<td>

`redirectUri`

</td>
<td>

`string`

</td>
<td>

`undefined`

</td>
<td>

Redirect URI to register for this client.

</td>
</tr>
<tr>
<td>

`clientName`

</td>
<td>

`string`

</td>
<td>

`"Anuma"`

</td>
<td>

Human-readable name shown in Notion's consent screen.

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<[`NotionClientRegistration`](../interfaces/NotionClientRegistration.md)>

---
Source: https://docs.anuma.ai/sdk/expo/Internal/interfaces/NotionAuthUrlParams

# NotionAuthUrlParams

Defined in: [src/lib/auth/notion-primitives.ts:69](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/notion-primitives.ts#69)

Parameters for [buildNotionAuthUrl](../functions/buildNotionAuthUrl.md).

## Properties

### authorizationEndpoint

> **authorizationEndpoint**: `string`

Defined in: [src/lib/auth/notion-primitives.ts:70](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/notion-primitives.ts#70)

***

### clientId

> **clientId**: `string`

Defined in: [src/lib/auth/notion-primitives.ts:71](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/notion-primitives.ts#71)

***

### codeChallenge

> **codeChallenge**: `string`

Defined in: [src/lib/auth/notion-primitives.ts:73](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/notion-primitives.ts#73)

***

### redirectUri

> **redirectUri**: `string`

Defined in: [src/lib/auth/notion-primitives.ts:72](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/notion-primitives.ts#72)

***

### state

> **state**: `string`

Defined in: [src/lib/auth/notion-primitives.ts:74](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/notion-primitives.ts#74)

---
Source: https://docs.anuma.ai/sdk/expo/Internal/interfaces/NotionClientRegistration

# NotionClientRegistration

Defined in: [src/lib/auth/notion-primitives.ts:46](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/notion-primitives.ts#46)

Result of dynamic client registration (RFC 7591).

## Properties

### clientId

> **clientId**: `string`

Defined in: [src/lib/auth/notion-primitives.ts:47](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/notion-primitives.ts#47)

***

### clientSecret?

> `optional` **clientSecret**: `string`

Defined in: [src/lib/auth/notion-primitives.ts:48](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/notion-primitives.ts#48)

***

### redirectUri

> **redirectUri**: `string`

Defined in: [src/lib/auth/notion-primitives.ts:50](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/notion-primitives.ts#50)

***

### registeredAt

> **registeredAt**: `number`

Defined in: [src/lib/auth/notion-primitives.ts:49](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/notion-primitives.ts#49)

---
Source: https://docs.anuma.ai/sdk/expo/Internal/interfaces/NotionExchangeCodeParams

# NotionExchangeCodeParams

Defined in: [src/lib/auth/notion-primitives.ts:78](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/notion-primitives.ts#78)

Parameters for [exchangeNotionCode](../functions/exchangeNotionCode.md).

## Properties

### clientId

> **clientId**: `string`

Defined in: [src/lib/auth/notion-primitives.ts:82](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/notion-primitives.ts#82)

***

### code

> **code**: `string`

Defined in: [src/lib/auth/notion-primitives.ts:80](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/notion-primitives.ts#80)

***

### codeVerifier

> **codeVerifier**: `string`

Defined in: [src/lib/auth/notion-primitives.ts:83](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/notion-primitives.ts#83)

***

### redirectUri

> **redirectUri**: `string`

Defined in: [src/lib/auth/notion-primitives.ts:81](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/notion-primitives.ts#81)

***

### tokenEndpoint

> **tokenEndpoint**: `string`

Defined in: [src/lib/auth/notion-primitives.ts:79](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/notion-primitives.ts#79)

---
Source: https://docs.anuma.ai/sdk/expo/Internal/interfaces/NotionOAuthEndpoints

# NotionOAuthEndpoints

Defined in: [src/lib/auth/notion-primitives.ts:36](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/notion-primitives.ts#36)

Endpoints discovered via RFC 8414 OAuth Server Metadata.

## Properties

### authorization\_endpoint

> **authorization\_endpoint**: `string`

Defined in: [src/lib/auth/notion-primitives.ts:37](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/notion-primitives.ts#37)

***

### code\_challenge\_methods\_supported?

> `optional` **code\_challenge\_methods\_supported**: `string`\[]

Defined in: [src/lib/auth/notion-primitives.ts:42](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/notion-primitives.ts#42)

***

### registration\_endpoint?

> `optional` **registration\_endpoint**: `string`

Defined in: [src/lib/auth/notion-primitives.ts:39](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/notion-primitives.ts#39)

***

### response\_types\_supported?

> `optional` **response\_types\_supported**: `string`\[]

Defined in: [src/lib/auth/notion-primitives.ts:41](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/notion-primitives.ts#41)

***

### scopes\_supported?

> `optional` **scopes\_supported**: `string`\[]

Defined in: [src/lib/auth/notion-primitives.ts:40](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/notion-primitives.ts#40)

***

### token\_endpoint

> **token\_endpoint**: `string`

Defined in: [src/lib/auth/notion-primitives.ts:38](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/notion-primitives.ts#38)

---
Source: https://docs.anuma.ai/sdk/expo/Internal/interfaces/NotionPKCEChallenge

# NotionPKCEChallenge

Defined in: [src/lib/auth/notion-primitives.ts:54](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/notion-primitives.ts#54)

PKCE challenge pair + CSRF state.

## Properties

### codeChallenge

> **codeChallenge**: `string`

Defined in: [src/lib/auth/notion-primitives.ts:56](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/notion-primitives.ts#56)

***

### codeVerifier

> **codeVerifier**: `string`

Defined in: [src/lib/auth/notion-primitives.ts:55](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/notion-primitives.ts#55)

***

### state

> **state**: `string`

Defined in: [src/lib/auth/notion-primitives.ts:57](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/notion-primitives.ts#57)

---
Source: https://docs.anuma.ai/sdk/expo/Internal/interfaces/NotionRefreshTokenParams

# NotionRefreshTokenParams

Defined in: [src/lib/auth/notion-primitives.ts:87](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/notion-primitives.ts#87)

Parameters for [refreshNotionAccessToken](../functions/refreshNotionAccessToken.md).

## Properties

### clientId

> **clientId**: `string`

Defined in: [src/lib/auth/notion-primitives.ts:90](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/notion-primitives.ts#90)

***

### refreshToken

> **refreshToken**: `string`

Defined in: [src/lib/auth/notion-primitives.ts:89](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/notion-primitives.ts#89)

***

### tokenEndpoint

> **tokenEndpoint**: `string`

Defined in: [src/lib/auth/notion-primitives.ts:88](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/notion-primitives.ts#88)

---
Source: https://docs.anuma.ai/sdk/expo/Internal/interfaces/NotionTokenResponse

# NotionTokenResponse

Defined in: [src/lib/auth/notion-primitives.ts:61](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/notion-primitives.ts#61)

Token response from the token endpoint.

## Properties

### accessToken

> **accessToken**: `string`

Defined in: [src/lib/auth/notion-primitives.ts:62](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/notion-primitives.ts#62)

***

### expiresAt?

> `optional` **expiresAt**: `number`

Defined in: [src/lib/auth/notion-primitives.ts:64](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/notion-primitives.ts#64)

***

### refreshToken?

> `optional` **refreshToken**: `string`

Defined in: [src/lib/auth/notion-primitives.ts:63](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/notion-primitives.ts#63)

***

### scope?

> `optional` **scope**: `string`

Defined in: [src/lib/auth/notion-primitives.ts:65](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/notion-primitives.ts#65)

---
Source: https://docs.anuma.ai/sdk/expo/Internal/interfaces/UseChatStorageOptions

# UseChatStorageOptions

Defined in: [src/expo/useChatStorage.ts:199](https://github.com/anuma-ai/sdk/blob/main/src/expo/useChatStorage.ts#199)

Options for useChatStorage hook (Expo version)

Uses the base options without React-specific features (no local chat, no tools).

## Extends

* `BaseUseChatStorageOptions`

## Properties

### apiType?

> `optional` **apiType**: `ApiType`

Defined in: [src/expo/useChatStorage.ts:205](https://github.com/anuma-ai/sdk/blob/main/src/expo/useChatStorage.ts#205)

Which API endpoint to use. Default: "responses"

* "responses": OpenAI Responses API (supports thinking, reasoning, conversations)
* "completions": OpenAI Chat Completions API (wider model compatibility)

***

### autoCreateConversation?

> `optional` **autoCreateConversation**: `boolean`

Defined in: [src/lib/db/chat/types.ts:336](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#336)

Automatically create a new conversation if none is set (default: true)

**Inherited from**

`BaseUseChatStorageOptions.autoCreateConversation`

***

### autoEmbedMessages?

> `optional` **autoEmbedMessages**: `boolean`

Defined in: [src/lib/db/chat/types.ts:394](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#394)

Automatically generate embeddings for messages after saving.
Enables semantic search over past conversations via searchMessages().

**Default**

```ts
true
```

**Inherited from**

`BaseUseChatStorageOptions.autoEmbedMessages`

***

### autoFlushOnKeyAvailable?

> `optional` **autoFlushOnKeyAvailable**: `boolean`

Defined in: [src/expo/useChatStorage.ts:236](https://github.com/anuma-ai/sdk/blob/main/src/expo/useChatStorage.ts#236)

Auto-flush queued operations when key becomes available.

**Default**

```ts
true
```

***

### baseUrl?

> `optional` **baseUrl**: `string`

Defined in: [src/lib/db/chat/types.ts:342](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#342)

Base URL for the chat API endpoint

**Inherited from**

`BaseUseChatStorageOptions.baseUrl`

***

### conversationId?

> `optional` **conversationId**: `string`

Defined in: [src/lib/db/chat/types.ts:334](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#334)

ID of an existing conversation to load and continue

**Inherited from**

`BaseUseChatStorageOptions.conversationId`

***

### database

> **database**: `Database`

Defined in: [src/lib/db/chat/types.ts:332](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#332)

WatermelonDB database instance for storing conversations and messages

**Inherited from**

`BaseUseChatStorageOptions.database`

***

### defaultConversationTitle?

> `optional` **defaultConversationTitle**: `string`

Defined in: [src/lib/db/chat/types.ts:338](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#338)

Title for auto-created conversations (default: "New conversation")

**Inherited from**

`BaseUseChatStorageOptions.defaultConversationTitle`

***

### embeddedWalletSigner?

> `optional` **embeddedWalletSigner**: [`EmbeddedWalletSignerFn`](../../../react/Internal/type-aliases/EmbeddedWalletSignerFn.md)

Defined in: [src/expo/useChatStorage.ts:221](https://github.com/anuma-ai/sdk/blob/main/src/expo/useChatStorage.ts#221)

Function for silent signing with Privy embedded wallets.

***

### embeddingModel?

> `optional` **embeddingModel**: `string`

Defined in: [src/lib/db/chat/types.ts:399](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#399)

Embedding model to use when autoEmbedMessages is enabled.

**Default**

```ts
DEFAULT_API_EMBEDDING_MODEL
```

**Inherited from**

`BaseUseChatStorageOptions.embeddingModel`

***

### enableQueue?

> `optional` **enableQueue**: `boolean`

Defined in: [src/expo/useChatStorage.ts:231](https://github.com/anuma-ai/sdk/blob/main/src/expo/useChatStorage.ts#231)

Enable the in-memory write queue.

**Default**

```ts
true
```

***

### fileProcessingOptions?

> `optional` **fileProcessingOptions**: `object`

Defined in: [src/lib/db/chat/types.ts:371](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#371)

Options for file preprocessing behavior

**keepOriginalFiles?**

> `optional` **keepOriginalFiles**: `boolean`

Whether to keep original file attachments (default: true)

**maxFileSizeBytes?**

> `optional` **maxFileSizeBytes**: `number`

Max file size to process in bytes (default: 10MB)

**onError()?**

> `optional` **onError**: (`fileName`: `string`, `error`: `Error`) => `void`

Callback for errors (non-fatal)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`fileName`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`error`

</td>
<td>

`Error`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

**onProgress()?**

> `optional` **onProgress**: (`current`: `number`, `total`: `number`, `fileName`: `string`) => `void`

Callback for progress updates

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`current`

</td>
<td>

`number`

</td>
</tr>
<tr>
<td>

`total`

</td>
<td>

`number`

</td>
</tr>
<tr>
<td>

`fileName`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

**Inherited from**

`BaseUseChatStorageOptions.fileProcessingOptions`

***

### fileProcessors?

> `optional` **fileProcessors**: [`FileProcessor`](../../../react/Internal/interfaces/FileProcessor.md)\[] | `null`

Defined in: [src/lib/db/chat/types.ts:367](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#367)

File preprocessors to use for automatic text extraction.

* undefined (default): Use all built-in processors (PDF, Excel, Word)
* null or \[]: Disable preprocessing
* FileProcessor\[]: Use specific processors

**Inherited from**

`BaseUseChatStorageOptions.fileProcessors`

***

### getToken()?

> `optional` **getToken**: () => `Promise`<`string` | `null`>

Defined in: [src/lib/db/chat/types.ts:340](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#340)

Function to retrieve the auth token for API requests

**Returns**

`Promise`<`string` | `null`>

**Inherited from**

`BaseUseChatStorageOptions.getToken`

***

### getWalletAddress()?

> `optional` **getWalletAddress**: () => `Promise`<`string` | `null`>

Defined in: [src/expo/useChatStorage.ts:226](https://github.com/anuma-ai/sdk/blob/main/src/expo/useChatStorage.ts#226)

Async function to poll for wallet address during Privy initialization.

**Returns**

`Promise`<`string` | `null`>

***

### mcpR2Domain?

> `optional` **mcpR2Domain**: `string`

Defined in: [src/lib/db/chat/types.ts:411](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#411)

R2 domain for identifying MCP-generated image URLs.
When set, enables OPFS caching of generated images.
Defaults to the hardcoded MCP\_R2\_DOMAIN from clientConfig.

**Inherited from**

`BaseUseChatStorageOptions.mcpR2Domain`

***

### minContentLength?

> `optional` **minContentLength**: `number`

Defined in: [src/lib/db/chat/types.ts:405](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#405)

Minimum content length required to generate embeddings.
Messages shorter than this are skipped as they provide limited semantic value.

**Default**

```ts
10
```

**Inherited from**

`BaseUseChatStorageOptions.minContentLength`

***

### onData()?

> `optional` **onData**: (`chunk`: `string`) => `void`

Defined in: [src/lib/db/chat/types.ts:344](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#344)

Callback invoked with each streamed response chunk

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`chunk`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

**Inherited from**

`BaseUseChatStorageOptions.onData`

***

### onError()?

> `optional` **onError**: (`error`: `Error`) => `void`

Defined in: [src/lib/db/chat/types.ts:350](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#350)

Callback invoked when an error occurs during the request

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`error`

</td>
<td>

`Error`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

**Inherited from**

`BaseUseChatStorageOptions.onError`

***

### onFinish()?

> `optional` **onFinish**: (`response`: [`LlmapiResponseResponse`](../../../client/Internal/type-aliases/LlmapiResponseResponse.md)) => `void`

Defined in: [src/lib/db/chat/types.ts:348](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#348)

Callback invoked when the response completes successfully

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`response`

</td>
<td>

[`LlmapiResponseResponse`](../../../client/Internal/type-aliases/LlmapiResponseResponse.md)

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

**Inherited from**

`BaseUseChatStorageOptions.onFinish`

***

### onServerToolCall()?

> `optional` **onServerToolCall**: (`toolCall`: `ServerToolCallEvent`) => `void`

Defined in: [src/lib/db/chat/types.ts:355](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#355)

Callback invoked when a server-side tool (MCP) is called during streaming.
Use this to show activity indicators like "Searching..." in the UI.

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`toolCall`

</td>
<td>

`ServerToolCallEvent`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

**Inherited from**

`BaseUseChatStorageOptions.onServerToolCall`

***

### onThinking()?

> `optional` **onThinking**: (`chunk`: `string`) => `void`

Defined in: [src/lib/db/chat/types.ts:346](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#346)

Callback invoked when thinking/reasoning content is received (from `<think>` tags or API reasoning)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`chunk`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

**Inherited from**

`BaseUseChatStorageOptions.onThinking`

***

### onToolCallArgumentsDelta()?

> `optional` **onToolCallArgumentsDelta**: (`event`: [`ToolCallArgumentsDeltaEvent`](../../../react/Internal/type-aliases/ToolCallArgumentsDeltaEvent.md)) => `void`

Defined in: [src/lib/db/chat/types.ts:360](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#360)

Called with partial tool call arguments as they stream in.
Use for live preview of artifacts (HTML, slides) being generated.

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`event`

</td>
<td>

[`ToolCallArgumentsDeltaEvent`](../../../react/Internal/type-aliases/ToolCallArgumentsDeltaEvent.md)

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

**Inherited from**

`BaseUseChatStorageOptions.onToolCallArgumentsDelta`

***

### preProcessors?

> `optional` **preProcessors**: `PromptPreProcessor`\[]

Defined in: [src/lib/db/chat/types.ts:421](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#421)

Pre-processors run after the last user message is received but before
the first LLM request. Each receives the prompt text and a shared
embedding (computed once per request) and may return messages to
enrich the conversation. Forwarded to the underlying `useChat` hook.
See `createWebSearchPreProcessor`, `createCryptoPricePreProcessor`,
`createStockPricePreProcessor`, `createWeatherPreProcessor`, or write
a custom one matching `PromptPreProcessor`.

**Inherited from**

`BaseUseChatStorageOptions.preProcessors`

***

### serverTools?

> `optional` **serverTools**: `object`

Defined in: [src/lib/db/chat/types.ts:385](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#385)

Configuration for server-side tools fetching and caching.
Server tools are fetched from /api/v1/tools and cached in localStorage.

**cacheExpirationMs?**

> `optional` **cacheExpirationMs**: `number`

Cache expiration time in milliseconds (default: 86400000 = 1 day)

**Inherited from**

`BaseUseChatStorageOptions.serverTools`

***

### signMessage?

> `optional` **signMessage**: [`SignMessageFn`](../../../react/Internal/type-aliases/SignMessageFn.md)

Defined in: [src/expo/useChatStorage.ts:216](https://github.com/anuma-ai/sdk/blob/main/src/expo/useChatStorage.ts#216)

Function to sign a message for encryption key derivation.

***

### walletAddress?

> `optional` **walletAddress**: `string`

Defined in: [src/expo/useChatStorage.ts:211](https://github.com/anuma-ai/sdk/blob/main/src/expo/useChatStorage.ts#211)

Wallet address for field-level encryption.
When provided with signMessage, all sensitive content is encrypted at rest.

---
Source: https://docs.anuma.ai/sdk/expo/Internal/interfaces/UseChatStorageResult

# UseChatStorageResult

Defined in: [src/expo/useChatStorage.ts:266](https://github.com/anuma-ai/sdk/blob/main/src/expo/useChatStorage.ts#266)

Result returned by useChatStorage hook (Expo version)

Extends base result with Expo-specific sendMessage signature.

## Extends

* `BaseUseChatStorageResult`

## Properties

### clearQueue()

> **clearQueue**: () => `void`

Defined in: [src/expo/useChatStorage.ts:300](https://github.com/anuma-ai/sdk/blob/main/src/expo/useChatStorage.ts#300)

Clear all queued operations without writing them.

**Returns**

`void`

***

### conversationId

> **conversationId**: `string` | `null`

Defined in: [src/lib/db/chat/types.ts:770](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#770)

**Inherited from**

`BaseUseChatStorageResult.conversationId`

***

### createConversation()

> **createConversation**: (`options?`: [`CreateConversationOptions`](../../../react/Internal/interfaces/CreateConversationOptions.md)) => `Promise`<[`StoredConversation`](../../../react/Internal/interfaces/StoredConversation.md)>

Defined in: [src/lib/db/chat/types.ts:772](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#772)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options?`

</td>
<td>

[`CreateConversationOptions`](../../../react/Internal/interfaces/CreateConversationOptions.md)

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`StoredConversation`](../../../react/Internal/interfaces/StoredConversation.md)>

**Inherited from**

`BaseUseChatStorageResult.createConversation`

***

### createMemoryEngineTool()

> **createMemoryEngineTool**: (`searchOptions?`: `Partial`<[`MemoryEngineSearchOptions`](../../../react/Internal/interfaces/MemoryEngineSearchOptions.md)>) => `ToolConfig`

Defined in: [src/expo/useChatStorage.ts:285](https://github.com/anuma-ai/sdk/blob/main/src/expo/useChatStorage.ts#285)

Create a memory engine tool for LLM to search past conversations.
The tool is pre-configured with the hook's storage context and auth.

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`searchOptions?`

</td>
<td>

`Partial`<[`MemoryEngineSearchOptions`](../../../react/Internal/interfaces/MemoryEngineSearchOptions.md)>

</td>
<td>

Optional search configuration (limit, minSimilarity, etc.)

</td>
</tr>
</tbody>
</table>

**Returns**

`ToolConfig`

A ToolConfig that can be passed to sendMessage's clientTools

**Example**

```ts
const memoryTool = createMemoryEngineTool({ limit: 5 });
await sendMessage({
  messages: [...],
  clientTools: [memoryTool],
});
```

***

### createMemoryVaultTool()

> **createMemoryVaultTool**: (`options?`: [`MemoryVaultToolOptions`](../../../react/Internal/interfaces/MemoryVaultToolOptions.md)) => `ToolConfig`

Defined in: [src/expo/useChatStorage.ts:288](https://github.com/anuma-ai/sdk/blob/main/src/expo/useChatStorage.ts#288)

Create a memory vault tool pre-configured with hook's vault context and encryption.

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options?`

</td>
<td>

[`MemoryVaultToolOptions`](../../../react/Internal/interfaces/MemoryVaultToolOptions.md)

</td>
</tr>
</tbody>
</table>

**Returns**

`ToolConfig`

***

### deleteConversation()

> **deleteConversation**: (`id`: `string`) => `Promise`<`boolean`>

Defined in: [src/lib/db/chat/types.ts:776](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#776)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`id`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`boolean`>

**Inherited from**

`BaseUseChatStorageResult.deleteConversation`

***

### deleteVaultMemory()

> **deleteVaultMemory**: (`id`: `string`) => `Promise`<`boolean`>

Defined in: [src/expo/useChatStorage.ts:294](https://github.com/anuma-ai/sdk/blob/main/src/expo/useChatStorage.ts#294)

Delete a vault memory by its ID (soft delete).

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`id`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`boolean`>

***

### flushQueue()

> **flushQueue**: () => `Promise`<[`FlushResult`](../../../react/Internal/interfaces/FlushResult.md)>

Defined in: [src/expo/useChatStorage.ts:297](https://github.com/anuma-ai/sdk/blob/main/src/expo/useChatStorage.ts#297)

Manually flush all queued operations for the current wallet.

**Returns**

`Promise`<[`FlushResult`](../../../react/Internal/interfaces/FlushResult.md)>

***

### getConversation()

> **getConversation**: (`id`: `string`) => `Promise`<[`StoredConversation`](../../../react/Internal/interfaces/StoredConversation.md) | `null`>

Defined in: [src/lib/db/chat/types.ts:773](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#773)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`id`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`StoredConversation`](../../../react/Internal/interfaces/StoredConversation.md) | `null`>

**Inherited from**

`BaseUseChatStorageResult.getConversation`

***

### getConversations()

> **getConversations**: () => `Promise`<[`StoredConversation`](../../../react/Internal/interfaces/StoredConversation.md)\[]>

Defined in: [src/lib/db/chat/types.ts:774](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#774)

**Returns**

`Promise`<[`StoredConversation`](../../../react/Internal/interfaces/StoredConversation.md)\[]>

**Inherited from**

`BaseUseChatStorageResult.getConversations`

***

### getMessages()

> **getMessages**: (`conversationId`: `string`) => `Promise`<[`StoredMessage`](../../../react/Internal/interfaces/StoredMessage.md)\[]>

Defined in: [src/lib/db/chat/types.ts:777](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#777)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`conversationId`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`StoredMessage`](../../../react/Internal/interfaces/StoredMessage.md)\[]>

**Inherited from**

`BaseUseChatStorageResult.getMessages`

***

### getVaultMemories()

> **getVaultMemories**: (`options?`: `object`) => `Promise`<[`StoredVaultMemory`](../../../react/Internal/interfaces/StoredVaultMemory.md)\[]>

Defined in: [src/expo/useChatStorage.ts:291](https://github.com/anuma-ai/sdk/blob/main/src/expo/useChatStorage.ts#291)

Get all vault memories for context injection.

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options?`

</td>
<td>

`object`

</td>
</tr>
<tr>
<td>

`options.scopes?`

</td>
<td>

`string`\[]

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`StoredVaultMemory`](../../../react/Internal/interfaces/StoredVaultMemory.md)\[]>

***

### isLoading

> **isLoading**: `boolean`

Defined in: [src/lib/db/chat/types.ts:768](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#768)

**Inherited from**

`BaseUseChatStorageResult.isLoading`

***

### queueStatus

> **queueStatus**: [`QueueStatus`](../../../react/Internal/interfaces/QueueStatus.md)

Defined in: [src/expo/useChatStorage.ts:303](https://github.com/anuma-ai/sdk/blob/main/src/expo/useChatStorage.ts#303)

Current status of the write queue.

***

### sendMessage()

> **sendMessage**: (`args`: [`SendMessageWithStorageArgs`](../type-aliases/SendMessageWithStorageArgs.md)) => `Promise`<`BaseSendMessageWithStorageResult`>

Defined in: [src/expo/useChatStorage.ts:268](https://github.com/anuma-ai/sdk/blob/main/src/expo/useChatStorage.ts#268)

Send a message and automatically store it (Expo version)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`args`

</td>
<td>

[`SendMessageWithStorageArgs`](../type-aliases/SendMessageWithStorageArgs.md)

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`BaseSendMessageWithStorageResult`>

***

### setConversationId()

> **setConversationId**: (`id`: `string` | `null`) => `void`

Defined in: [src/lib/db/chat/types.ts:771](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#771)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`id`

</td>
<td>

`string` | `null`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

**Inherited from**

`BaseUseChatStorageResult.setConversationId`

***

### stop()

> **stop**: () => `void`

Defined in: [src/lib/db/chat/types.ts:769](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#769)

**Returns**

`void`

**Inherited from**

`BaseUseChatStorageResult.stop`

***

### updateConversationTitle()

> **updateConversationTitle**: (`id`: `string`, `title`: `string`) => `Promise`<`boolean`>

Defined in: [src/lib/db/chat/types.ts:775](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#775)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`id`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`title`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`boolean`>

**Inherited from**

`BaseUseChatStorageResult.updateConversationTitle`

---
Source: https://docs.anuma.ai/sdk/expo/Internal/type-aliases/SendMessageWithStorageArgs

# SendMessageWithStorageArgs

> **SendMessageWithStorageArgs** = `BaseSendMessageWithStorageArgs` & `object`

Defined in: [src/expo/useChatStorage.ts:245](https://github.com/anuma-ai/sdk/blob/main/src/expo/useChatStorage.ts#245)

Arguments for sendMessage with storage (Expo version)

Uses the base arguments without React-specific features (no runTools, no headers).

## Type Declaration

### apiType?

> `optional` **apiType**: `ApiType`

Override the API type for this request only.
Useful when different models need different APIs.

**Default**

```ts
Uses the hook-level apiType or "responses"
```

---
Source: https://docs.anuma.ai/sdk/expo/Internal/type-aliases/SendMessageWithStorageResult

# SendMessageWithStorageResult

> **SendMessageWithStorageResult** = `BaseSendMessageWithStorageResult`

Defined in: [src/expo/useChatStorage.ts:259](https://github.com/anuma-ai/sdk/blob/main/src/expo/useChatStorage.ts#259)

Result from sendMessage with storage (Expo version)

Uses the base result without tool execution information.

---
Source: https://docs.anuma.ai/sdk/expo/Internal/type-aliases/UseModelsOptions

# UseModelsOptions

> **UseModelsOptions** = `object`

Defined in: [src/react/useModels.ts:12](https://github.com/anuma-ai/sdk/blob/main/src/react/useModels.ts#12)

## Properties

### autoFetch?

> `optional` **autoFetch**: `boolean`

Defined in: [src/react/useModels.ts:28](https://github.com/anuma-ai/sdk/blob/main/src/react/useModels.ts#28)

Whether to fetch models automatically on mount (default: true)

***

### baseUrl?

> `optional` **baseUrl**: `string`

Defined in: [src/react/useModels.ts:20](https://github.com/anuma-ai/sdk/blob/main/src/react/useModels.ts#20)

Optional base URL for the API requests.

***

### getToken()?

> `optional` **getToken**: () => `Promise`<`string` | `null`>

Defined in: [src/react/useModels.ts:16](https://github.com/anuma-ai/sdk/blob/main/src/react/useModels.ts#16)

Custom function to get auth token for API calls

**Returns**

`Promise`<`string` | `null`>

***

### provider?

> `optional` **provider**: `string`

Defined in: [src/react/useModels.ts:24](https://github.com/anuma-ai/sdk/blob/main/src/react/useModels.ts#24)

Optional filter for specific provider (e.g. "openai")

---
Source: https://docs.anuma.ai/sdk/expo/Internal/variables/NOTION_OAUTH_CONFIG

# NOTION\_OAUTH\_CONFIG

> `const` **NOTION\_OAUTH\_CONFIG**: `object`

Defined in: [src/lib/auth/notion-primitives.ts:21](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/notion-primitives.ts#21)

Well-known Notion MCP OAuth endpoints (fallback values).

## Type Declaration

### authorizationEndpoint

> `readonly` **authorizationEndpoint**: `"https://api.notion.com/v1/oauth/authorize"` = `"https://api.notion.com/v1/oauth/authorize"`

Fallback authorization endpoint.

### mcpBase

> `readonly` **mcpBase**: `"https://mcp.notion.com"` = `"https://mcp.notion.com"`

Base URL for the Notion MCP server.

### registrationEndpoint

> `readonly` **registrationEndpoint**: `"https://api.notion.com/v1/oauth/register"` = `"https://api.notion.com/v1/oauth/register"`

Fallback dynamic client registration endpoint (RFC 7591).

### tokenEndpoint

> `readonly` **tokenEndpoint**: `"https://api.notion.com/v1/oauth/token"` = `"https://api.notion.com/v1/oauth/token"`

Fallback token endpoint.

---
Source: https://docs.anuma.ai/sdk/expo/Internal/variables/xhrTransport

# xhrTransport

> `const` **xhrTransport**: `StreamingTransport`

Defined in: [src/lib/chat/xhrTransport.ts:40](https://github.com/anuma-ai/sdk/blob/main/src/lib/chat/xhrTransport.ts#40)

XHR-based streaming transport for React Native environments.

React Native's `fetch` doesn't support `response.body` streaming,
so this transport uses `XMLHttpRequest` with `onprogress` to stream
SSE events. It exposes the same `{ stream: AsyncIterable }` interface
as the default fetch-based transport.

---
Source: https://docs.anuma.ai/sdk/next

# Overview

Next.js configuration plugin for @anuma/sdk

Use this to automatically configure Webpack aliases and server exclusions
needed for the SDK's dependencies.

## Example

```ts
// next.config.ts
import { withAnuma } from "@anuma/sdk/next";

const nextConfig = {
  // your config...
};

export default withAnuma(nextConfig);
```

## Functions

| Function | Description |
| ------ | ------ |
| [withAnuma](Internal/functions/withAnuma.md) | - |

---
Source: https://docs.anuma.ai/sdk/next/Internal/functions/withAnuma

# withAnuma

> **withAnuma**(`nextConfig`: `NextConfig`): `object`

Defined in: [src/next/index.ts:44](https://github.com/anuma-ai/sdk/blob/main/src/next/index.ts#44)

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`nextConfig`

</td>
<td>

`NextConfig`

</td>
</tr>
</tbody>
</table>

## Returns

`object`

### serverExternalPackages

> **serverExternalPackages**: `string`\[]

### webpack()

> **webpack**: (`config`: `WebpackConfig`, `options`: `WebpackOptions`) => `WebpackConfig`

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`config`

</td>
<td>

`WebpackConfig`

</td>
</tr>
<tr>
<td>

`options`

</td>
<td>

`WebpackOptions`

</td>
</tr>
</tbody>
</table>

**Returns**

`WebpackConfig`

---
Source: https://docs.anuma.ai/sdk/react

# Overview

The `@anuma/sdk/react` package provides a collection of React hooks
designed to simplify building AI features in your applications. These hooks
abstract away the complexity of managing streaming responses, loading states,
authentication, and real-time updates, letting you focus on creating great
user experiences.

## Why Use These Hooks?

Building AI-powered interfaces involves handling many concerns: streaming
responses token-by-token, managing conversation state, coordinating tool
execution, processing file attachments, and more. These hooks provide
production-ready abstractions that handle these complexities out of the box.

**Key benefits:**

* **Streaming-first**: Built-in support for real-time streaming with
  automatic UI updates as content arrives
* **State management**: Automatic handling of loading states, errors, and
  request lifecycle
* **File processing**: Extract text from PDFs and images (OCR) to provide
  document context to your AI
* **Memory & context**: Extract and retrieve relevant memories using semantic
  search to make your AI context-aware
* **Wallet-based encryption**: Secure data encryption using wallet signatures
  for Web3 applications

## Quick Start

```tsx
import { useChat } from "@anuma/sdk/react";

function ChatComponent() {
  const { isLoading, sendMessage, stop } = useChat({
    getToken: async () => getAuthToken(),
    onData: (chunk) => setResponse((prev) => prev + chunk),
  });

  const handleSend = async () => {
    await sendMessage({
      messages: [{ role: "user", content: [{ type: "text", text: input }] }],
      model: "fireworks/accounts/fireworks/models/kimi-k2p5",
    });
  };

  return (
    <div>
      <button onClick={handleSend} disabled={isLoading}>Send</button>
      {isLoading && <button onClick={stop}>Stop</button>}
    </div>
  );
}
```

## Encryption

| Function | Description |
| ------ | ------ |
| [decryptData](Encryption/decryptData.md) | Decrypts data using AES-GCM with the stored encryption key. |
| [decryptDataBatch](Encryption/decryptDataBatch.md) | Batch decrypt multiple values efficiently with a single key lookup. Much faster than calling decryptData for each value individually. |
| [encryptData](Encryption/encryptData.md) | Encrypts data using AES-GCM with the stored encryption key. |
| [encryptDataBatch](Encryption/encryptDataBatch.md) | Batch encrypt multiple values efficiently with a single key lookup. Much faster than calling encryptData for each value individually. |

## Hooks

| Name | Description |
| ------ | ------ |
| [UseEncryptionResult](Hooks/UseEncryptionResult.md) | Result returned by the useEncryption hook. |
| [UseExportPdfResult](Hooks/UseExportPdfResult.md) | Result returned by the useExportPdf hook. |
| [UseOCRResult](Hooks/UseOCRResult.md) | Result returned by the useOCR hook. |
| [UsePdfResult](Hooks/UsePdfResult.md) | Result returned by the usePdf hook. |
| [UseVoiceOptions](Hooks/UseVoiceOptions.md) | Options for the useVoice hook. |
| [UseVoiceResult](Hooks/UseVoiceResult.md) | Result returned by the useVoice hook. |
| [useBackup](Hooks/useBackup.md) | Unified React hook for backup and restore functionality. |
| [useBackupAuth](Hooks/useBackupAuth.md) | Hook to access unified backup authentication state and methods. |
| [useChat](Hooks/useChat.md) | A React hook for managing chat completions with authentication. |
| [useChatStorage](Hooks/useChatStorage.md) | A React hook that wraps useChat with automatic message persistence using WatermelonDB. |
| [useCredits](Hooks/useCredits.md) | React hook for managing credits: checking balance, browsing packs, and purchasing credits. |
| [useDropboxAuth](Hooks/useDropboxAuth.md) | Hook to access Dropbox authentication state and methods. |
| [useDropboxBackup](Hooks/useDropboxBackup.md) | React hook for Dropbox backup and restore functionality. |
| [useEncryption](Hooks/useEncryption.md) | Hook that provides encryption key management for securing local data. |
| [useExportPdf](Hooks/useExportPdf.md) | React hook for exporting content as PDF. |
| [useFiles](Hooks/useFiles.md) | A React hook for managing files (images, videos, audio, documents). |
| [useGoogleDriveAuth](Hooks/useGoogleDriveAuth.md) | Hook to access Google Drive authentication state and methods. |
| [useGoogleDriveBackup](Hooks/useGoogleDriveBackup.md) | React hook for Google Drive backup and restore functionality. |
| [useICloudAuth](Hooks/useICloudAuth.md) | Hook to access iCloud authentication state and methods. |
| [useICloudBackup](Hooks/useICloudBackup.md) | React hook for iCloud backup and restore functionality. |
| [useModels](Hooks/useModels.md) | React hook for fetching available LLM models. Automatically fetches all available models. |
| [useOCR](Hooks/useOCR.md) | React hook for extracting text from images using OCR. |
| [usePdf](Hooks/usePdf.md) | React hook for extracting text from PDF files. |
| [usePhoneCalls](Hooks/usePhoneCalls.md) | React hook for phone calling: checking availability, creating calls, fetching their status, and polling for completion. |
| [useProjects](Hooks/useProjects.md) | A React hook for managing projects (conversation groups). |
| [useSettings](Hooks/useSettings.md) | A React hook for managing user settings with automatic persistence using WatermelonDB. |
| [useSubscription](Hooks/useSubscription.md) | React hook for managing subscription status and billing operations. Provides methods to check status, upgrade, manage billing, cancel, and renew subscriptions. |
| [useTools](Hooks/useTools.md) | React hook for fetching and caching server-side tools. |
| [useVoice](Hooks/useVoice.md) | React hook for recording voice and transcribing it on-device using Whisper. |

## Other

### BACKUP\_DRIVE\_CONVERSATIONS\_FOLDER

Renames and re-exports [DEFAULT\_DRIVE\_CONVERSATIONS\_FOLDER](Internal/variables/DEFAULT_DRIVE_CONVERSATIONS_FOLDER.md)

***

### BACKUP\_DRIVE\_ROOT\_FOLDER

Renames and re-exports [DEFAULT\_DRIVE\_ROOT\_FOLDER](Internal/variables/DEFAULT_DRIVE_ROOT_FOLDER.md)

***

### BACKUP\_ICLOUD\_FOLDER

Renames and re-exports [DEFAULT\_ICLOUD\_BACKUP\_FOLDER](Internal/variables/DEFAULT_ICLOUD_BACKUP_FOLDER.md)

***

### DEFAULT\_DROPBOX\_FOLDER

Renames and re-exports [DEFAULT\_BACKUP\_FOLDER](Internal/variables/DEFAULT_BACKUP_FOLDER.md)

## PDF Export

| Name | Description |
| ------ | ------ |
| [PdfExportOptions](PDF-Export/PdfExportOptions.md) | Options for PDF export. |
| [PdfExportProgress](PDF-Export/PdfExportProgress.md) | Progress event emitted during PDF export. |
| [PdfExportStage](PDF-Export/PdfExportStage.md) | Stages of the PDF export pipeline. |
| [exportElementToPdf](PDF-Export/exportElementToPdf.md) | Capture a rendered HTML element as a high-fidelity PDF. |
| [exportMarkdownToPdf](PDF-Export/exportMarkdownToPdf.md) | Convert a markdown string to a PDF. No DOM required. |
| [renderElementToCanvas](PDF-Export/renderElementToCanvas.md) | Render a DOM element to a canvas using iframe isolation. |

---
Source: https://docs.anuma.ai/sdk/react/Encryption/decryptData

# decryptData

> **decryptData**(`encryptedHex`: `string`, `address`: `string`, `version`: `EncryptionKeyVersion`): `Promise`<`string`>

Defined in: [src/react/useEncryption.ts:627](https://github.com/anuma-ai/sdk/blob/main/src/react/useEncryption.ts#627)

Decrypts data using AES-GCM with the stored encryption key.

This function uses the encryption key previously generated via `requestEncryptionKey`
to decrypt data. The key must exist in memory before calling this function, or it
will throw an error prompting the user to sign a message.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`encryptedHex`

</td>
<td>

`string`

</td>
<td>

`undefined`

</td>
<td>

Encrypted data as hex string (IV + ciphertext + auth tag)

</td>
</tr>
<tr>
<td>

`address`

</td>
<td>

`string`

</td>
<td>

`undefined`

</td>
<td>

The wallet address associated with the encryption key

</td>
</tr>
<tr>
<td>

`version`

</td>
<td>

`EncryptionKeyVersion`

</td>
<td>

`"v3"`

</td>
<td>

‐

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`string`>

Decrypted data as string

## Throws

Error if encryption key is not found in memory or if decryption fails

## Example

```tsx
import { decryptData, requestEncryptionKey } from "@anuma/sdk/react";

// First, ensure encryption key exists
await requestEncryptionKey(walletAddress);

// Then decrypt data
const encrypted = localStorage.getItem("mySecret");
if (encrypted) {
  const decrypted = await decryptData(encrypted, walletAddress);
  console.log("Decrypted:", decrypted);
}
```

---
Source: https://docs.anuma.ai/sdk/react/Encryption/decryptDataBatch

# decryptDataBatch

> **decryptDataBatch**(`encryptedValues`: `string`\[], `address`: `string`): `Promise`<`string`\[]>

Defined in: [src/react/useEncryption.ts:815](https://github.com/anuma-ai/sdk/blob/main/src/react/useEncryption.ts#815)

Batch decrypt multiple values efficiently with a single key lookup.
Much faster than calling decryptData for each value individually.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`encryptedValues`

</td>
<td>

`string`\[]

</td>
<td>

Array of encrypted hex strings

</td>
</tr>
<tr>
<td>

`address`

</td>
<td>

`string`

</td>
<td>

The wallet address associated with the encryption key

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`string`\[]>

Array of decrypted plaintext values

## Throws

Error if encryption key is not found in memory or decryption fails

## Example

```tsx
const decrypted = await decryptDataBatch(
  [encrypted1, encrypted2, encrypted3],
  walletAddress
);
```

---
Source: https://docs.anuma.ai/sdk/react/Encryption/encryptData

# encryptData

> **encryptData**(`plaintext`: `string` | `Uint8Array`<`ArrayBufferLike`>, `address`: `string`): `Promise`<`string`>

Defined in: [src/react/useEncryption.ts:583](https://github.com/anuma-ai/sdk/blob/main/src/react/useEncryption.ts#583)

Encrypts data using AES-GCM with the stored encryption key.

This function uses the encryption key previously generated via `requestEncryptionKey`
to encrypt data. The key must exist in memory before calling this function, or it
will throw an error prompting the user to sign a message.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`plaintext`

</td>
<td>

`string` | `Uint8Array`<`ArrayBufferLike`>

</td>
<td>

The data to encrypt (string or Uint8Array)

</td>
</tr>
<tr>
<td>

`address`

</td>
<td>

`string`

</td>
<td>

The wallet address associated with the encryption key

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`string`>

Encrypted data as hex string (IV + ciphertext + auth tag)

## Throws

Error if encryption key is not found in memory

## Example

```tsx
import { encryptData, requestEncryptionKey } from "@anuma/sdk/react";

// First, ensure encryption key exists
await requestEncryptionKey(walletAddress);

// Then encrypt data
const encrypted = await encryptData("my secret data", walletAddress);
localStorage.setItem("mySecret", encrypted);
```

---
Source: https://docs.anuma.ai/sdk/react/Encryption/encryptDataBatch

# encryptDataBatch

> **encryptDataBatch**(`values`: (`string` | `Uint8Array`<`ArrayBufferLike`>)\[], `address`: `string`): `Promise`<`string`\[]>

Defined in: [src/react/useEncryption.ts:778](https://github.com/anuma-ai/sdk/blob/main/src/react/useEncryption.ts#778)

Batch encrypt multiple values efficiently with a single key lookup.
Much faster than calling encryptData for each value individually.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`values`

</td>
<td>

(`string` | `Uint8Array`<`ArrayBufferLike`>)\[]

</td>
<td>

Array of plaintext values to encrypt

</td>
</tr>
<tr>
<td>

`address`

</td>
<td>

`string`

</td>
<td>

The wallet address associated with the encryption key

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`string`\[]>

Array of encrypted values as hex strings

## Throws

Error if encryption key is not found in memory

## Example

```tsx
const encrypted = await encryptDataBatch(
  ["secret1", "secret2", "secret3"],
  walletAddress
);
```

---
Source: https://docs.anuma.ai/sdk/react/Hooks/useBackup

# useBackup

> **useBackup**(`options`: `object`): [`UseBackupResult`](../Internal/interfaces/UseBackupResult.md)

Defined in: [src/react/useBackup.ts:183](https://github.com/anuma-ai/sdk/blob/main/src/react/useBackup.ts#183)

Unified React hook for backup and restore functionality.

This hook provides methods to backup conversations to both Dropbox and Google Drive,
and restore them. It handles all the logic for checking timestamps, skipping
unchanged files, authentication, and managing the backup/restore process.

Must be used within a BackupAuthProvider.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

`object`

</td>
<td>

‐

</td>
</tr>
<tr>
<td>

`options.database`

</td>
<td>

`Database`

</td>
<td>

WatermelonDB database instance

</td>
</tr>
<tr>
<td>

`options.dropboxFolder?`

</td>
<td>

`string`

</td>
<td>

Dropbox folder path for backups (default: '/ai-chat-app/conversations')

</td>
</tr>
<tr>
<td>

`options.exportConversation`

</td>
<td>

(`conversationId`: `string`, `userAddress`: `string`) => `Promise`<{ `blob?`: `Blob`; `success`: `boolean`; }>

</td>
<td>

Export a conversation to an encrypted blob

</td>
</tr>
<tr>
<td>

`options.googleConversationsFolder?`

</td>
<td>

`string`

</td>
<td>

Google Drive conversations subfolder (default: 'conversations')

</td>
</tr>
<tr>
<td>

`options.googleRootFolder?`

</td>
<td>

`string`

</td>
<td>

Google Drive root folder name (default: 'ai-chat-app')

</td>
</tr>
<tr>
<td>

`options.importConversation`

</td>
<td>

(`blob`: `Blob`, `userAddress`: `string`) => `Promise`<{ `success`: `boolean`; }>

</td>
<td>

Import a conversation from an encrypted blob

</td>
</tr>
<tr>
<td>

`options.requestEncryptionKey`

</td>
<td>

(`address`: `string`) => `Promise`<`void`>

</td>
<td>

Request encryption key for the user address

</td>
</tr>
<tr>
<td>

`options.userAddress`

</td>
<td>

`string` | `null`

</td>
<td>

Current user address (null if not signed in)

</td>
</tr>
</tbody>
</table>

## Returns

[`UseBackupResult`](../Internal/interfaces/UseBackupResult.md)

## Example

```tsx
import { useBackup } from "@anuma/sdk/react";

function BackupManager() {
  const { dropbox, googleDrive, hasAnyProvider } = useBackup({
    database,
    userAddress,
    requestEncryptionKey,
    exportConversation,
    importConversation,
  });

  if (!hasAnyProvider) {
    return <p>No backup providers configured</p>;
  }

  return (
    <div>
      {dropbox.isConfigured && (
        <div>
          <h3>Dropbox</h3>
          {dropbox.isAuthenticated ? (
            <>
              <button onClick={() => dropbox.backup()}>Backup</button>
              <button onClick={() => dropbox.restore()}>Restore</button>
              <button onClick={dropbox.disconnect}>Disconnect</button>
            </>
          ) : (
            <button onClick={dropbox.connect}>Connect Dropbox</button>
          )}
        </div>
      )}

      {googleDrive.isConfigured && (
        <div>
          <h3>Google Drive</h3>
          {googleDrive.isAuthenticated ? (
            <>
              <button onClick={() => googleDrive.backup()}>Backup</button>
              <button onClick={() => googleDrive.restore()}>Restore</button>
              <button onClick={googleDrive.disconnect}>Disconnect</button>
            </>
          ) : (
            <button onClick={googleDrive.connect}>Connect Google Drive</button>
          )}
        </div>
      )}
    </div>
  );
}
```

---
Source: https://docs.anuma.ai/sdk/react/Hooks/useBackupAuth

# useBackupAuth

> **useBackupAuth**(): [`BackupAuthContextValue`](../Internal/interfaces/BackupAuthContextValue.md)

Defined in: [src/react/useBackupAuth.ts:495](https://github.com/anuma-ai/sdk/blob/main/src/react/useBackupAuth.ts#495)

Hook to access unified backup authentication state and methods.

Must be used within a BackupAuthProvider.

## Returns

[`BackupAuthContextValue`](../Internal/interfaces/BackupAuthContextValue.md)

## Example

```tsx
import { useBackupAuth } from "@anuma/sdk/react";

function BackupSettings() {
  const { dropbox, googleDrive, logoutAll } = useBackupAuth();

  return (
    <div>
      <h3>Backup Providers</h3>

      {dropbox.isConfigured && (
        <div>
          <span>Dropbox: {dropbox.isAuthenticated ? 'Connected' : 'Not connected'}</span>
          {dropbox.isAuthenticated ? (
            <button onClick={dropbox.logout}>Disconnect</button>
          ) : (
            <button onClick={dropbox.requestAccess}>Connect</button>
          )}
        </div>
      )}

      {googleDrive.isConfigured && (
        <div>
          <span>Google Drive: {googleDrive.isAuthenticated ? 'Connected' : 'Not connected'}</span>
          {googleDrive.isAuthenticated ? (
            <button onClick={googleDrive.logout}>Disconnect</button>
          ) : (
            <button onClick={googleDrive.requestAccess}>Connect</button>
          )}
        </div>
      )}

      <button onClick={logoutAll}>Disconnect All</button>
    </div>
  );
}
```

---
Source: https://docs.anuma.ai/sdk/react/Hooks/useChat

# useChat

> **useChat**(`options?`: `object`): `UseChatResult`

Defined in: [src/react/useChat.ts:141](https://github.com/anuma-ai/sdk/blob/main/src/react/useChat.ts#141)

A React hook for managing chat completions with authentication.

This hook provides a convenient way to send chat messages to the LLM API
with automatic token management and loading state handling.
Streaming is enabled by default for better user experience.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options?`

</td>
<td>

`object`

</td>
<td>

Optional configuration object

</td>
</tr>
<tr>
<td>

`options.apiType?`

</td>
<td>

`ApiType`

</td>
<td>

Which API endpoint to use. Default: "auto"

* "auto": automatically selects the best API based on model support
* "responses": OpenAI Responses API (supports thinking, reasoning, conversations)
* "completions": OpenAI Chat Completions API (wider model compatibility)

</td>
</tr>
<tr>
<td>

`options.baseUrl?`

</td>
<td>

`string`

</td>
<td>

Optional base URL for the API requests.

</td>
</tr>
<tr>
<td>

`options.getToken?`

</td>
<td>

() => `Promise`<`string` | `null`>

</td>
<td>

An async function that returns an authentication token.
This token will be used as a Bearer token in the Authorization header.
If not provided, `sendMessage` will return an error.

</td>
</tr>
<tr>
<td>

`options.onData?`

</td>
<td>

(`chunk`: `string`) => `void`

</td>
<td>

Callback function to be called when a new data chunk is received.

</td>
</tr>
<tr>
<td>

`options.onError?`

</td>
<td>

(`error`: `Error`) => `void`

</td>
<td>

Callback function to be called when an unexpected error is encountered.

**Note:** This callback is NOT called for aborted requests (via `stop()` or
component unmount). Aborts are intentional actions and are not considered
errors. To detect aborts, check the `error` field in the `sendMessage` result:
`result.error === "Request aborted"`.

</td>
</tr>
<tr>
<td>

`options.onFinish?`

</td>
<td>

(`response`: `ApiResponse`) => `void`

</td>
<td>

Callback function to be called when the chat completion finishes successfully.
Receives raw API response - either Responses API or Completions API format.

</td>
</tr>
<tr>
<td>

`options.onServerToolCall?`

</td>
<td>

(`toolCall`: `ServerToolCallEvent`) => `void`

</td>
<td>

Callback function to be called when a server-side tool (MCP) is invoked during streaming.
Use this to show activity indicators like "Searching..." in the UI.

</td>
</tr>
<tr>
<td>

`options.onStepFinish?`

</td>
<td>

(`event`: [`StepFinishEvent`](../Internal/type-aliases/StepFinishEvent.md)) => `void`

</td>
<td>

Called after each tool execution round completes.
Receives the round index, model content, tool calls, results, and token usage.
Useful for progress indicators, cost tracking, and custom early-exit logic.

</td>
</tr>
<tr>
<td>

`options.onThinking?`

</td>
<td>

(`chunk`: `string`) => `void`

</td>
<td>

Callback function to be called when thinking/reasoning content is received.
This is called with delta chunks as the model "thinks" through a problem.

</td>
</tr>
<tr>
<td>

`options.onToolCall?`

</td>
<td>

(`toolCall`: [`LlmapiToolCall`](../../client/Internal/type-aliases/LlmapiToolCall.md)) => `void`

</td>
<td>

Callback function to be called when a tool call is requested by the LLM
but no executor is registered for it (e.g. server-side tools).

</td>
</tr>
<tr>
<td>

`options.onToolCallArgumentsDelta?`

</td>
<td>

(`event`: [`ToolCallArgumentsDeltaEvent`](../Internal/type-aliases/ToolCallArgumentsDeltaEvent.md)) => `void`

</td>
<td>

Called with partial tool call arguments as they stream in.
Use for live preview of artifacts (HTML, slides) being generated.

</td>
</tr>
<tr>
<td>

`options.preProcessors?`

</td>
<td>

`PromptPreProcessor`\[]

</td>
<td>

Pre-processors run after the last user message is received but before the
first LLM request. Each receives the prompt text and a shared embedding
(computed once per request) and may return messages to enrich the
conversation. See `createWebSearchPreProcessor`,
`createCryptoPricePreProcessor`, `createStockPricePreProcessor`,
`createWeatherPreProcessor`, or write a custom one matching
`PromptPreProcessor`.

</td>
</tr>
<tr>
<td>

`options.smoothing?`

</td>
<td>

`boolean` | `StreamSmoothingConfig`

</td>
<td>

Controls adaptive output smoothing for streaming responses.
Fast models can return text faster than is comfortable to read — smoothing
buffers incoming chunks and releases them at a consistent, adaptive pace.

* `true` or omitted: enabled with defaults (200→400 chars/sec over 3s)
* `false`: disabled, callbacks fire immediately with raw chunks
* `StreamSmoothingConfig`: custom speed/ramp configuration

**Default**

```ts
true
```

</td>
</tr>
</tbody>
</table>

## Returns

`UseChatResult`

## Example

```tsx
// Basic usage with API
const { isLoading, sendMessage, stop } = useChat({
  getToken: async () => await getAuthToken(),
  onFinish: (response) => console.log("Chat finished:", response),
  onError: (error) => console.error("Chat error:", error)
});

const handleSend = async () => {
  const result = await sendMessage({
    messages: [{ role: 'user', content: [{ type: 'text', text: 'Hello!' }] }],
    model: 'your-provider/your-model'
  });
};

// Using extended thinking
const result = await sendMessage({
  messages: [{ role: 'user', content: [{ type: 'text', text: 'Solve this complex problem...' }] }],
  model: 'your-provider/your-model',
  thinking: { type: 'enabled', budget_tokens: 10000 },
  onThinking: (chunk) => console.log('Thinking:', chunk)
});

// Using reasoning
const result = await sendMessage({
  messages: [{ role: 'user', content: [{ type: 'text', text: 'Reason through this...' }] }],
  model: 'your-provider/your-model',
  reasoning: { effort: 'high', summary: 'detailed' }
});
```

---
Source: https://docs.anuma.ai/sdk/react/Hooks/useChatStorage

# useChatStorage

> **useChatStorage**(`options`: `object`): [`UseChatStorageResult`](../Internal/interfaces/UseChatStorageResult.md)

Defined in: [src/react/useChatStorage.ts:958](https://github.com/anuma-ai/sdk/blob/main/src/react/useChatStorage.ts#958)

A React hook that wraps useChat with automatic message persistence using WatermelonDB.

This hook provides all the functionality of useChat plus automatic storage of
messages and conversations to a WatermelonDB database. Messages are automatically
saved when sent and when responses are received.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

`object`

</td>
<td>

Configuration options

</td>
</tr>
<tr>
<td>

`options.activeToolSets?`

</td>
<td>

`string`\[]

</td>
<td>

Tool set names that should expand unconditionally for this request,
bypassing the anchor-similarity check. Use when conversation state
implies a set should be present regardless of how the prompt is phrased
— e.g., pass `["slides"]` when the conversation already contains a slide
deck artifact, so short follow-up prompts ("add a thank you slide",
"make it bigger") still get the full slide toolkit.

Read via a ref so updates are visible to in-flight `sendMessage` calls
without rebuilding the callback.

Names must match a set's `name` from `BUILT_IN_TOOL_SETS` or
`extraToolSets`. Unknown names are ignored.

</td>
</tr>
<tr>
<td>

`options.apiType?`

</td>
<td>

`ApiType`

</td>
<td>

Which API endpoint to use. Default: "responses"

* "responses": OpenAI Responses API (supports thinking, reasoning, conversations)
* "completions": OpenAI Chat Completions API (wider model compatibility)

</td>
</tr>
<tr>
<td>

`options.autoCreateConversation?`

</td>
<td>

`boolean`

</td>
<td>

Automatically create a new conversation if none is set (default: true)

</td>
</tr>
<tr>
<td>

`options.autoEmbedMessages?`

</td>
<td>

`boolean`

</td>
<td>

Automatically generate embeddings for messages after saving.
Enables semantic search over past conversations via searchMessages().

**Default**

```ts
true
```

</td>
</tr>
<tr>
<td>

`options.autoFlushOnKeyAvailable?`

</td>
<td>

`boolean`

</td>
<td>

Automatically flush queued operations when the encryption key becomes
available. Requires `enableQueue` to be true.

**Default**

```ts
true
```

</td>
</tr>
<tr>
<td>

`options.baseUrl?`

</td>
<td>

`string`

</td>
<td>

Base URL for the chat API endpoint

</td>
</tr>
<tr>
<td>

`options.conversationId?`

</td>
<td>

`string`

</td>
<td>

ID of an existing conversation to load and continue

</td>
</tr>
<tr>
<td>

`options.database`

</td>
<td>

`Database`

</td>
<td>

WatermelonDB database instance for storing conversations and messages

</td>
</tr>
<tr>
<td>

`options.defaultConversationTitle?`

</td>
<td>

`string`

</td>
<td>

Title for auto-created conversations (default: "New conversation")

</td>
</tr>
<tr>
<td>

`options.embeddedWalletSigner?`

</td>
<td>

[`EmbeddedWalletSignerFn`](../Internal/type-aliases/EmbeddedWalletSignerFn.md)

</td>
<td>

Function for silent signing with Privy embedded wallets.
When provided, enables automatic encryption key derivation without
user confirmation modals.

</td>
</tr>
<tr>
<td>

`options.embeddingModel?`

</td>
<td>

`string`

</td>
<td>

Embedding model to use when autoEmbedMessages is enabled.

**Default**

```ts
DEFAULT_API_EMBEDDING_MODEL
```

</td>
</tr>
<tr>
<td>

`options.enableQueue?`

</td>
<td>

`boolean`

</td>
<td>

Enable the in-memory write queue for operations when encryption key
isn't yet available. When enabled, operations are held in memory and
flushed to encrypted storage once the key becomes available.

**Default**

```ts
true
```

</td>
</tr>
<tr>
<td>

`options.extraToolSets?`

</td>
<td>

[`ToolSet`](../Internal/interfaces/ToolSet.md)\[]

</td>
<td>

Additional tool sets to apply on top of the built-in ones (app-generation,
slides, github). When any anchor tool in a custom set is selected by
semantic matching, all members of that set are included automatically.

Treated as static config — set once at hook setup. Changing it across
renders does not affect in-flight `sendMessage` calls; use
`activeToolSets` for dynamic, conversation-state-driven overrides.

</td>
</tr>
<tr>
<td>

`options.fileProcessingOptions?`

</td>
<td>

{ `keepOriginalFiles?`: `boolean`; `maxFileSizeBytes?`: `number`; `onError?`: (`fileName`: `string`, `error`: `Error`) => `void`; `onProgress?`: (`current`: `number`, `total`: `number`, `fileName`: `string`) => `void`; }

</td>
<td>

Options for file preprocessing behavior

</td>
</tr>
<tr>
<td>

`options.fileProcessingOptions.keepOriginalFiles?`

</td>
<td>

`boolean`

</td>
<td>

Whether to keep original file attachments (default: true)

</td>
</tr>
<tr>
<td>

`options.fileProcessingOptions.maxFileSizeBytes?`

</td>
<td>

`number`

</td>
<td>

Max file size to process in bytes (default: 10MB)

</td>
</tr>
<tr>
<td>

`options.fileProcessingOptions.onError?`

</td>
<td>

(`fileName`: `string`, `error`: `Error`) => `void`

</td>
<td>

Callback for errors (non-fatal)

</td>
</tr>
<tr>
<td>

`options.fileProcessingOptions.onProgress?`

</td>
<td>

(`current`: `number`, `total`: `number`, `fileName`: `string`) => `void`

</td>
<td>

Callback for progress updates

</td>
</tr>
<tr>
<td>

`options.fileProcessors?`

</td>
<td>

[`FileProcessor`](../Internal/interfaces/FileProcessor.md)\[] | `null`

</td>
<td>

File preprocessors to use for automatic text extraction.

* undefined (default): Use all built-in processors (PDF, Excel, Word)
* null or \[]: Disable preprocessing
* FileProcessor\[]: Use specific processors

</td>
</tr>
<tr>
<td>

`options.getToken?`

</td>
<td>

() => `Promise`<`string` | `null`>

</td>
<td>

Function to retrieve the auth token for API requests

</td>
</tr>
<tr>
<td>

`options.getWalletAddress?`

</td>
<td>

() => `Promise`<`string` | `null`>

</td>
<td>

Async function that returns the wallet address when available.
Used for polling during Privy embedded wallet initialization.
When the wallet isn't ready yet, should return null.

</td>
</tr>
<tr>
<td>

`options.mcpR2Domain?`

</td>
<td>

`string`

</td>
<td>

R2 domain for identifying MCP-generated image URLs.
When set, enables OPFS caching of generated images.
Defaults to the hardcoded MCP\_R2\_DOMAIN from clientConfig.

</td>
</tr>
<tr>
<td>

`options.minContentLength?`

</td>
<td>

`number`

</td>
<td>

Minimum content length required to generate embeddings.
Messages shorter than this are skipped as they provide limited semantic value.

**Default**

```ts
10
```

</td>
</tr>
<tr>
<td>

`options.onData?`

</td>
<td>

(`chunk`: `string`) => `void`

</td>
<td>

Callback invoked with each streamed response chunk

</td>
</tr>
<tr>
<td>

`options.onError?`

</td>
<td>

(`error`: `Error`) => `void`

</td>
<td>

Callback invoked when an error occurs during the request

</td>
</tr>
<tr>
<td>

`options.onFinish?`

</td>
<td>

(`response`: [`LlmapiResponseResponse`](../../client/Internal/type-aliases/LlmapiResponseResponse.md)) => `void`

</td>
<td>

Callback invoked when the response completes successfully

</td>
</tr>
<tr>
<td>

`options.onServerToolCall?`

</td>
<td>

(`toolCall`: `ServerToolCallEvent`) => `void`

</td>
<td>

Callback invoked when a server-side tool (MCP) is called during streaming.
Use this to show activity indicators like "Searching..." in the UI.

</td>
</tr>
<tr>
<td>

`options.onThinking?`

</td>
<td>

(`chunk`: `string`) => `void`

</td>
<td>

Callback invoked when thinking/reasoning content is received (from `<think>` tags or API reasoning)

</td>
</tr>
<tr>
<td>

`options.onToolCallArgumentsDelta?`

</td>
<td>

(`event`: [`ToolCallArgumentsDeltaEvent`](../Internal/type-aliases/ToolCallArgumentsDeltaEvent.md)) => `void`

</td>
<td>

Called with partial tool call arguments as they stream in.
Use for live preview of artifacts (HTML, slides) being generated.

</td>
</tr>
<tr>
<td>

`options.preProcessors?`

</td>
<td>

`PromptPreProcessor`\[]

</td>
<td>

Pre-processors run after the last user message is received but before
the first LLM request. Each receives the prompt text and a shared
embedding (computed once per request) and may return messages to
enrich the conversation. Forwarded to the underlying `useChat` hook.
See `createWebSearchPreProcessor`, `createCryptoPricePreProcessor`,
`createStockPricePreProcessor`, `createWeatherPreProcessor`, or write
a custom one matching `PromptPreProcessor`.

</td>
</tr>
<tr>
<td>

`options.serverTools?`

</td>
<td>

{ `cacheExpirationMs?`: `number`; }

</td>
<td>

Configuration for server-side tools fetching and caching.
Server tools are fetched from /api/v1/tools and cached in localStorage.

</td>
</tr>
<tr>
<td>

`options.serverTools.cacheExpirationMs?`

</td>
<td>

`number`

</td>
<td>

Cache expiration time in milliseconds (default: 86400000 = 1 day)

</td>
</tr>
<tr>
<td>

`options.signMessage?`

</td>
<td>

[`SignMessageFn`](../Internal/type-aliases/SignMessageFn.md)

</td>
<td>

Function to sign a message for encryption key derivation.
Typically from Privy's useSignMessage hook.
Required together with walletAddress for field-level encryption.

</td>
</tr>
<tr>
<td>

`options.walletAddress?`

</td>
<td>

`string`

</td>
<td>

Wallet address for encrypted file storage and field-level encryption.
When provided with signMessage, all sensitive message content, conversation titles,
and media metadata are encrypted at rest using AES-GCM with wallet-derived keys.

Requires:

* OPFS browser support (for file storage)
* signMessage function (for encryption key derivation)

When not provided, data is stored in plaintext (backwards compatible).

</td>
</tr>
</tbody>
</table>

## Returns

[`UseChatStorageResult`](../Internal/interfaces/UseChatStorageResult.md)

An object containing chat state, methods, and storage operations

## Example

```tsx
import { Database } from '@nozbe/watermelondb';
import { useChatStorage } from '@anuma/sdk/react';

function ChatComponent({ database }: { database: Database }) {
  const {
    isLoading,
    sendMessage,
    conversationId,
    getMessages,
    createConversation,
  } = useChatStorage({
    database,
    getToken: async () => getAuthToken(),
    onData: (chunk) => setResponse((prev) => prev + chunk),
  });

  const handleSend = async () => {
    const result = await sendMessage({
      content: 'Hello, how are you?',
      model: 'fireworks/accounts/fireworks/models/kimi-k2p5',
      includeHistory: true, // Include previous messages from this conversation
    });

    if (result.error) {
      console.error('Error:', result.error);
    } else {
      console.log('User message stored:', result.userMessage);
      console.log('Assistant message stored:', result.assistantMessage);
    }
  };

  return (
    <div>
      <button onClick={handleSend} disabled={isLoading}>Send</button>
    </div>
  );
}
```

---
Source: https://docs.anuma.ai/sdk/react/Hooks/useCredits

# useCredits

> **useCredits**(`options`: `object`): [`UseCreditsResult`](../Internal/type-aliases/UseCreditsResult.md)

Defined in: [src/react/useCredits.ts:76](https://github.com/anuma-ai/sdk/blob/main/src/react/useCredits.ts#76)

React hook for managing credits: checking balance, browsing packs, and
purchasing credits.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

`object`

</td>
<td>

‐

</td>
</tr>
<tr>
<td>

`options.autoFetch?`

</td>
<td>

`boolean`

</td>
<td>

Whether to fetch credit balance automatically on mount (default: true)

</td>
</tr>
<tr>
<td>

`options.baseUrl?`

</td>
<td>

`string`

</td>
<td>

Optional base URL for the API requests.

</td>
</tr>
<tr>
<td>

`options.getToken?`

</td>
<td>

() => `Promise`<`string` | `null`>

</td>
<td>

Custom function to get auth token for API calls

</td>
</tr>
<tr>
<td>

`options.onError?`

</td>
<td>

(`error`: `Error`) => `void`

</td>
<td>

Optional callback for error handling

</td>
</tr>
</tbody>
</table>

## Returns

[`UseCreditsResult`](../Internal/type-aliases/UseCreditsResult.md)

---
Source: https://docs.anuma.ai/sdk/react/Hooks/useDropboxAuth

# useDropboxAuth

> **useDropboxAuth**(): [`DropboxAuthContextValue`](../Internal/interfaces/DropboxAuthContextValue.md)

Defined in: [src/react/useDropboxAuth.ts:216](https://github.com/anuma-ai/sdk/blob/main/src/react/useDropboxAuth.ts#216)

Hook to access Dropbox authentication state and methods.

Must be used within a DropboxAuthProvider.

## Returns

[`DropboxAuthContextValue`](../Internal/interfaces/DropboxAuthContextValue.md)

## Example

```tsx
import { useDropboxAuth } from "@anuma/sdk/react";

function DropboxButton() {
  const { isAuthenticated, isConfigured, requestAccess, logout } = useDropboxAuth();

  if (!isConfigured) {
    return <p>Dropbox not configured</p>;
  }

  if (isAuthenticated) {
    return <button onClick={logout}>Disconnect Dropbox</button>;
  }

  return <button onClick={requestAccess}>Connect Dropbox</button>;
}
```

---
Source: https://docs.anuma.ai/sdk/react/Hooks/useDropboxBackup

# useDropboxBackup

> **useDropboxBackup**(`options`: `object`): [`UseDropboxBackupResult`](../Internal/interfaces/UseDropboxBackupResult.md)

Defined in: [src/react/useDropboxBackup.ts:99](https://github.com/anuma-ai/sdk/blob/main/src/react/useDropboxBackup.ts#99)

React hook for Dropbox backup and restore functionality.

This hook provides methods to backup conversations to Dropbox and restore them.
It handles all the logic for checking timestamps, skipping unchanged files,
authentication, and managing the backup/restore process.

Must be used within a DropboxAuthProvider.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

`object`

</td>
<td>

‐

</td>
</tr>
<tr>
<td>

`options.backupFolder?`

</td>
<td>

`string`

</td>
<td>

Dropbox folder path for backups (default: '/ai-chat-app/conversations')

</td>
</tr>
<tr>
<td>

`options.database`

</td>
<td>

`Database`

</td>
<td>

WatermelonDB database instance

</td>
</tr>
<tr>
<td>

`options.exportConversation`

</td>
<td>

(`conversationId`: `string`, `userAddress`: `string`) => `Promise`<{ `blob?`: `Blob`; `success`: `boolean`; }>

</td>
<td>

Export a conversation to an encrypted blob

</td>
</tr>
<tr>
<td>

`options.importConversation`

</td>
<td>

(`blob`: `Blob`, `userAddress`: `string`) => `Promise`<{ `success`: `boolean`; }>

</td>
<td>

Import a conversation from an encrypted blob

</td>
</tr>
<tr>
<td>

`options.requestEncryptionKey`

</td>
<td>

(`address`: `string`) => `Promise`<`void`>

</td>
<td>

Request encryption key for the user address

</td>
</tr>
<tr>
<td>

`options.userAddress`

</td>
<td>

`string` | `null`

</td>
<td>

Current user address (null if not signed in)

</td>
</tr>
</tbody>
</table>

## Returns

[`UseDropboxBackupResult`](../Internal/interfaces/UseDropboxBackupResult.md)

## Example

```tsx
import { useDropboxBackup } from "@anuma/sdk/react";

function BackupButton() {
  const { backup, restore, isConfigured } = useDropboxBackup({
    database,
    userAddress,
    requestEncryptionKey,
    exportConversation,
    importConversation,
  });

  const handleBackup = async () => {
    const result = await backup({
      onProgress: (current, total) => {
        console.log(`Progress: ${current}/${total}`);
      },
    });

    if ("error" in result) {
      console.error(result.error);
    } else {
      console.log(`Uploaded: ${result.uploaded}, Skipped: ${result.skipped}`);
    }
  };

  return <button onClick={handleBackup} disabled={!isConfigured}>Backup</button>;
}
```

---
Source: https://docs.anuma.ai/sdk/react/Hooks/useEncryption

# useEncryption

> **useEncryption**(`signMessage`: [`SignMessageFn`](../Internal/type-aliases/SignMessageFn.md), `embeddedWalletSigner?`: [`EmbeddedWalletSignerFn`](../Internal/type-aliases/EmbeddedWalletSignerFn.md)): [`UseEncryptionResult`](UseEncryptionResult.md)

Defined in: [src/react/useEncryption.ts:1489](https://github.com/anuma-ai/sdk/blob/main/src/react/useEncryption.ts#1489)

Hook that provides encryption key management for securing local data.

This hook helps you encrypt and decrypt data using a key derived from a wallet
signature. It requires `@privy-io/react-auth` for wallet authentication. Keys are
stored in memory only and do not persist across page reloads for security.

## How it works

1. User signs a message with their wallet
2. The signature is used to deterministically derive an encryption key
3. The key is stored in memory (not localStorage) for the session
4. Data can be encrypted/decrypted using this key
5. On page reload, user must sign again to derive the key

## Security Features

* **In-memory only**: Keys never touch disk or localStorage
* **Deterministic**: Same wallet + signature always generates same key
* **Session-scoped**: Keys cleared on page reload
* **XSS-resistant**: Keys not accessible after page reload

## Embedded Wallet Support

For Privy embedded wallets, you can provide an `embeddedWalletSigner` function
to enable silent signing without user confirmation modals. This is useful for
deterministic key generation that should happen automatically.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`signMessage`

</td>
<td>

[`SignMessageFn`](../Internal/type-aliases/SignMessageFn.md)

</td>
<td>

Function to sign a message (from Privy's useSignMessage hook)

</td>
</tr>
<tr>
<td>

`embeddedWalletSigner?`

</td>
<td>

[`EmbeddedWalletSignerFn`](../Internal/type-aliases/EmbeddedWalletSignerFn.md)

</td>
<td>

Optional function for silent signing with embedded wallets

</td>
</tr>
</tbody>
</table>

## Returns

[`UseEncryptionResult`](UseEncryptionResult.md)

Functions to request encryption keys and manage key pairs

## Examples

```tsx
import { usePrivy, useWallets } from "@privy-io/react-auth";
import { useEncryption, encryptData, decryptData } from "@anuma/sdk/react";

function SecureComponent() {
  const { user, signMessage } = usePrivy();
  const { wallets } = useWallets();
  const embeddedWallet = wallets.find(w => w.walletClientType === 'privy');

  // Create silent signer for embedded wallets
  const embeddedSigner = useCallback(async (message: string) => {
    if (embeddedWallet) {
      const { signature } = await embeddedWallet.signMessage({ message });
      return signature;
    }
    throw new Error('No embedded wallet');
  }, [embeddedWallet]);

  const { requestEncryptionKey } = useEncryption(signMessage, embeddedSigner);

  // Request encryption key when user is authenticated
  useEffect(() => {
    if (user?.wallet?.address) {
      // This will use silent signing for embedded wallets
      await requestEncryptionKey(user.wallet.address);
    }
  }, [user]);

  // Encrypt data
  const saveSecret = async (text: string) => {
    const encrypted = await encryptData(text, user.wallet.address);
    localStorage.setItem("mySecret", encrypted);
  };

  // Decrypt data
  const loadSecret = async () => {
    const encrypted = localStorage.getItem("mySecret");
    if (encrypted) {
      const decrypted = await decryptData(encrypted, user.wallet.address);
      console.log(decrypted);
    }
  };

  return (
    <div>
      <button onClick={() => saveSecret("my secret data")}>Encrypt & Save</button>
      <button onClick={loadSecret}>Load & Decrypt</button>
    </div>
  );
}
```

```tsx
// Standard usage with external wallets (shows confirmation modal)
import { usePrivy } from "@privy-io/react-auth";
import { useEncryption, encryptData, decryptData } from "@anuma/sdk/react";

function SecureComponent() {
  const { user, signMessage } = usePrivy();
  const { requestEncryptionKey } = useEncryption(signMessage);

  // Request encryption key when user is authenticated
  useEffect(() => {
    if (user?.wallet?.address) {
      // This will prompt user to sign if key doesn't exist
      await requestEncryptionKey(user.wallet.address);
    }
  }, [user]);
}
```

```tsx
// ECDH key pair generation for end-to-end encryption
import { usePrivy } from "@privy-io/react-auth";
import { useEncryption } from "@anuma/sdk/react";

function E2EEComponent() {
  const { signMessage } = usePrivy();
  const { requestKeyPair, exportPublicKey } = useEncryption(signMessage);

  const setupEncryption = async (walletAddress: string) => {
    // Generate deterministic ECDH key pair from wallet signature
    await requestKeyPair(walletAddress);

    // Export public key to share with others
    const publicKey = await exportPublicKey(walletAddress);
    console.log("Share this public key:", publicKey);
  };
}
```

---
Source: https://docs.anuma.ai/sdk/react/Hooks/UseEncryptionResult

# UseEncryptionResult

Defined in: [src/react/useEncryption.ts:1348](https://github.com/anuma-ai/sdk/blob/main/src/react/useEncryption.ts#1348)

Result returned by the useEncryption hook.

## Properties

### clearKeyPair()

> **clearKeyPair**: (`walletAddress`: `string`) => `void`

Defined in: [src/react/useEncryption.ts:1358](https://github.com/anuma-ai/sdk/blob/main/src/react/useEncryption.ts#1358)

Clear the key pair for a wallet address from memory

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`walletAddress`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

***

### exportPublicKey()

> **exportPublicKey**: (`walletAddress`: `string`) => `Promise`<`string`>

Defined in: [src/react/useEncryption.ts:1354](https://github.com/anuma-ai/sdk/blob/main/src/react/useEncryption.ts#1354)

Export the public key for a wallet address as base64-encoded SPKI

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`walletAddress`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`string`>

***

### hasKeyPair()

> **hasKeyPair**: (`walletAddress`: `string`) => `boolean`

Defined in: [src/react/useEncryption.ts:1356](https://github.com/anuma-ai/sdk/blob/main/src/react/useEncryption.ts#1356)

Check if a key pair exists in memory for a wallet address

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`walletAddress`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`boolean`

***

### requestEncryptionKey()

> **requestEncryptionKey**: (`walletAddress`: `string`) => `Promise`<`void`>

Defined in: [src/react/useEncryption.ts:1350](https://github.com/anuma-ai/sdk/blob/main/src/react/useEncryption.ts#1350)

Request and generate an encryption key for a wallet address

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`walletAddress`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`void`>

***

### requestKeyPair()

> **requestKeyPair**: (`walletAddress`: `string`) => `Promise`<`void`>

Defined in: [src/react/useEncryption.ts:1352](https://github.com/anuma-ai/sdk/blob/main/src/react/useEncryption.ts#1352)

Request and generate an ECDH key pair for a wallet address

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`walletAddress`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`void`>

---
Source: https://docs.anuma.ai/sdk/react/Hooks/useExportPdf

# useExportPdf

> **useExportPdf**(): [`UseExportPdfResult`](UseExportPdfResult.md)

Defined in: [src/react/useExportPdf.ts:61](https://github.com/anuma-ai/sdk/blob/main/src/react/useExportPdf.ts#61)

React hook for exporting content as PDF.

Provides two export paths:

* **DOM capture** (`exportElementToPdf` / `downloadElementAsPdf`): captures a
  rendered HTML element with full styling (syntax highlighting, math, diagrams).
* **Headless** (`exportMarkdownToPdf` / `downloadMarkdownAsPdf`): converts raw
  markdown to a formatted PDF without requiring a DOM.

Exposes `progress` state that updates in real-time during export, and
`renderElementToCanvas` for producing a preview before building the PDF.

## Returns

[`UseExportPdfResult`](UseExportPdfResult.md)

---
Source: https://docs.anuma.ai/sdk/react/Hooks/UseExportPdfResult

# UseExportPdfResult

Defined in: [src/react/useExportPdf.ts:10](https://github.com/anuma-ai/sdk/blob/main/src/react/useExportPdf.ts#10)

Result returned by the useExportPdf hook.

## Properties

### downloadElementAsPdf()

> **downloadElementAsPdf**: (`element`: `HTMLElement`, `options?`: [`PdfExportOptions`](../PDF-Export/PdfExportOptions.md)) => `Promise`<`void`>

Defined in: [src/react/useExportPdf.ts:16](https://github.com/anuma-ai/sdk/blob/main/src/react/useExportPdf.ts#16)

Convenience: export element and trigger browser download

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`element`

</td>
<td>

`HTMLElement`

</td>
</tr>
<tr>
<td>

`options?`

</td>
<td>

[`PdfExportOptions`](../PDF-Export/PdfExportOptions.md)

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`void`>

***

### downloadMarkdownAsPdf()

> **downloadMarkdownAsPdf**: (`markdown`: `string`, `options?`: [`PdfExportOptions`](../PDF-Export/PdfExportOptions.md)) => `Promise`<`void`>

Defined in: [src/react/useExportPdf.ts:18](https://github.com/anuma-ai/sdk/blob/main/src/react/useExportPdf.ts#18)

Convenience: export markdown and trigger browser download

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`markdown`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`options?`

</td>
<td>

[`PdfExportOptions`](../PDF-Export/PdfExportOptions.md)

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`void`>

***

### error

> **error**: `Error` | `null`

Defined in: [src/react/useExportPdf.ts:26](https://github.com/anuma-ai/sdk/blob/main/src/react/useExportPdf.ts#26)

Error from the last export attempt

***

### exportElementToPdf()

> **exportElementToPdf**: (`element`: `HTMLElement`, `options?`: [`PdfExportOptions`](../PDF-Export/PdfExportOptions.md)) => `Promise`<`Blob`>

Defined in: [src/react/useExportPdf.ts:12](https://github.com/anuma-ai/sdk/blob/main/src/react/useExportPdf.ts#12)

DOM capture: export a rendered HTML element as a high-fidelity PDF

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`element`

</td>
<td>

`HTMLElement`

</td>
</tr>
<tr>
<td>

`options?`

</td>
<td>

[`PdfExportOptions`](../PDF-Export/PdfExportOptions.md)

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`Blob`>

***

### exportMarkdownToPdf()

> **exportMarkdownToPdf**: (`markdown`: `string`, `options?`: [`PdfExportOptions`](../PDF-Export/PdfExportOptions.md)) => `Promise`<`Blob`>

Defined in: [src/react/useExportPdf.ts:14](https://github.com/anuma-ai/sdk/blob/main/src/react/useExportPdf.ts#14)

Headless: export a raw markdown string as PDF (no DOM required)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`markdown`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`options?`

</td>
<td>

[`PdfExportOptions`](../PDF-Export/PdfExportOptions.md)

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`Blob`>

***

### isExporting

> **isExporting**: `boolean`

Defined in: [src/react/useExportPdf.ts:22](https://github.com/anuma-ai/sdk/blob/main/src/react/useExportPdf.ts#22)

Whether a PDF export is currently in progress

***

### progress

> **progress**: [`PdfExportProgress`](../PDF-Export/PdfExportProgress.md) | `null`

Defined in: [src/react/useExportPdf.ts:24](https://github.com/anuma-ai/sdk/blob/main/src/react/useExportPdf.ts#24)

Current export progress, or null when idle

***

### renderElementToCanvas()

> **renderElementToCanvas**: (`element`: `HTMLElement`) => `Promise`<`HTMLCanvasElement`>

Defined in: [src/react/useExportPdf.ts:20](https://github.com/anuma-ai/sdk/blob/main/src/react/useExportPdf.ts#20)

Render an element to canvas for preview (first half of DOM capture pipeline)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`element`

</td>
<td>

`HTMLElement`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`HTMLCanvasElement`>

---
Source: https://docs.anuma.ai/sdk/react/Hooks/useFiles

# useFiles

> **useFiles**(`options`: [`UseFilesOptions`](../Internal/interfaces/UseFilesOptions.md)): [`UseFilesResult`](../Internal/interfaces/UseFilesResult.md)

Defined in: [src/react/useFiles.ts:193](https://github.com/anuma-ai/sdk/blob/main/src/react/useFiles.ts#193)

A React hook for managing files (images, videos, audio, documents).

This hook provides comprehensive CRUD operations for file records stored in
WatermelonDB, along with file reading capabilities from OPFS encrypted storage.
It supports both user-uploaded files and AI-generated files (e.g., DALL-E images).

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`UseFilesOptions`](../Internal/interfaces/UseFilesOptions.md)

</td>
<td>

Configuration options

</td>
</tr>
</tbody>
</table>

## Returns

[`UseFilesResult`](../Internal/interfaces/UseFilesResult.md)

An object containing file state and methods

## Example

```tsx
import { useFiles } from '@anthropic-ai/sdk/react';

function FileGallery({ database, walletAddress }) {
  const {
    getImages,
    readFile,
    createBlobUrl,
    isReady,
  } = useFiles({ database, walletAddress });

  const [images, setImages] = useState<StoredMedia[]>([]);

  useEffect(() => {
    if (isReady && walletAddress) {
      getImages(20).then(setImages);
    }
  }, [isReady, walletAddress, getImages]);

  return (
    <div>
      {images.map((img) => (
        <FileImage key={img.mediaId} file={img} createBlobUrl={createBlobUrl} />
      ))}
    </div>
  );
}
```

---
Source: https://docs.anuma.ai/sdk/react/Hooks/useGoogleDriveAuth

# useGoogleDriveAuth

> **useGoogleDriveAuth**(): [`GoogleDriveAuthContextValue`](../Internal/interfaces/GoogleDriveAuthContextValue.md)

Defined in: [src/react/useGoogleDriveAuth.ts:218](https://github.com/anuma-ai/sdk/blob/main/src/react/useGoogleDriveAuth.ts#218)

Hook to access Google Drive authentication state and methods.

Must be used within a GoogleDriveAuthProvider.

## Returns

[`GoogleDriveAuthContextValue`](../Internal/interfaces/GoogleDriveAuthContextValue.md)

## Example

```tsx
import { useGoogleDriveAuth } from "@anuma/sdk/react";

function GoogleDriveButton() {
  const { isAuthenticated, isConfigured, requestAccess, logout } = useGoogleDriveAuth();

  if (!isConfigured) {
    return <p>Google Drive not configured</p>;
  }

  if (isAuthenticated) {
    return <button onClick={logout}>Disconnect Google Drive</button>;
  }

  return <button onClick={requestAccess}>Connect Google Drive</button>;
}
```

---
Source: https://docs.anuma.ai/sdk/react/Hooks/useGoogleDriveBackup

# useGoogleDriveBackup

> **useGoogleDriveBackup**(`options`: `object`): [`UseGoogleDriveBackupResult`](../Internal/interfaces/UseGoogleDriveBackupResult.md)

Defined in: [src/react/useGoogleDriveBackup.ts:102](https://github.com/anuma-ai/sdk/blob/main/src/react/useGoogleDriveBackup.ts#102)

React hook for Google Drive backup and restore functionality.

This hook provides methods to backup conversations to Google Drive and restore them.
It handles all the logic for checking timestamps, skipping unchanged files,
authentication, and managing the backup/restore process.

Must be used within a GoogleDriveAuthProvider.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

`object`

</td>
<td>

‐

</td>
</tr>
<tr>
<td>

`options.conversationsFolder?`

</td>
<td>

`string`

</td>
<td>

Subfolder for conversations (default: 'conversations')

</td>
</tr>
<tr>
<td>

`options.database`

</td>
<td>

`Database`

</td>
<td>

WatermelonDB database instance

</td>
</tr>
<tr>
<td>

`options.exportConversation`

</td>
<td>

(`conversationId`: `string`, `userAddress`: `string`) => `Promise`<{ `blob?`: `Blob`; `success`: `boolean`; }>

</td>
<td>

Export a conversation to an encrypted blob

</td>
</tr>
<tr>
<td>

`options.importConversation`

</td>
<td>

(`blob`: `Blob`, `userAddress`: `string`) => `Promise`<{ `success`: `boolean`; }>

</td>
<td>

Import a conversation from an encrypted blob

</td>
</tr>
<tr>
<td>

`options.requestEncryptionKey`

</td>
<td>

(`address`: `string`) => `Promise`<`void`>

</td>
<td>

Request encryption key for the user address

</td>
</tr>
<tr>
<td>

`options.rootFolder?`

</td>
<td>

`string`

</td>
<td>

Root folder name in Google Drive (default: 'ai-chat-app')

</td>
</tr>
<tr>
<td>

`options.userAddress`

</td>
<td>

`string` | `null`

</td>
<td>

Current user address (null if not signed in)

</td>
</tr>
</tbody>
</table>

## Returns

[`UseGoogleDriveBackupResult`](../Internal/interfaces/UseGoogleDriveBackupResult.md)

## Example

```tsx
import { useGoogleDriveBackup } from "@anuma/sdk/react";

function BackupButton() {
  const { backup, restore, isConfigured, isAuthenticated } = useGoogleDriveBackup({
    database,
    userAddress,
    requestEncryptionKey,
    exportConversation,
    importConversation,
  });

  const handleBackup = async () => {
    const result = await backup({
      onProgress: (current, total) => {
        console.log(`Progress: ${current}/${total}`);
      },
    });

    if ("error" in result) {
      console.error(result.error);
    } else {
      console.log(`Uploaded: ${result.uploaded}, Skipped: ${result.skipped}`);
    }
  };

  return <button onClick={handleBackup} disabled={!isConfigured}>Backup</button>;
}
```

---
Source: https://docs.anuma.ai/sdk/react/Hooks/useICloudAuth

# useICloudAuth

> **useICloudAuth**(): [`ICloudAuthContextValue`](../Internal/interfaces/ICloudAuthContextValue.md)

Defined in: [src/react/useICloudAuth.ts:213](https://github.com/anuma-ai/sdk/blob/main/src/react/useICloudAuth.ts#213)

Hook to access iCloud authentication state and methods.

Must be used within an ICloudAuthProvider.

## Returns

[`ICloudAuthContextValue`](../Internal/interfaces/ICloudAuthContextValue.md)

## Example

```tsx
import { useICloudAuth } from "@anuma/sdk/react";

function ICloudStatus() {
  const { isAuthenticated, isAvailable, requestAccess, logout } = useICloudAuth();

  if (!isAvailable) {
    return <p>iCloud is not available. Please load CloudKit JS.</p>;
  }

  return (
    <div>
      {isAuthenticated ? (
        <>
          <span>Connected to iCloud</span>
          <button onClick={logout}>Disconnect</button>
        </>
      ) : (
        <button onClick={requestAccess}>Connect to iCloud</button>
      )}
    </div>
  );
}
```

---
Source: https://docs.anuma.ai/sdk/react/Hooks/useICloudBackup

# useICloudBackup

> **useICloudBackup**(`options`: `object`): [`UseICloudBackupResult`](../Internal/interfaces/UseICloudBackupResult.md)

Defined in: [src/react/useICloudBackup.ts:103](https://github.com/anuma-ai/sdk/blob/main/src/react/useICloudBackup.ts#103)

React hook for iCloud backup and restore functionality.

This hook provides methods to backup conversations to iCloud and restore them.
It handles all the logic for checking timestamps, skipping unchanged files,
authentication, and managing the backup/restore process.

Must be used within an ICloudAuthProvider.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

`object`

</td>
<td>

‐

</td>
</tr>
<tr>
<td>

`options.database`

</td>
<td>

`Database`

</td>
<td>

WatermelonDB database instance

</td>
</tr>
<tr>
<td>

`options.exportConversation`

</td>
<td>

(`conversationId`: `string`, `userAddress`: `string`) => `Promise`<{ `blob?`: `Blob`; `success`: `boolean`; }>

</td>
<td>

Export a conversation to an encrypted blob

</td>
</tr>
<tr>
<td>

`options.importConversation`

</td>
<td>

(`blob`: `Blob`, `userAddress`: `string`) => `Promise`<{ `success`: `boolean`; }>

</td>
<td>

Import a conversation from an encrypted blob

</td>
</tr>
<tr>
<td>

`options.requestEncryptionKey`

</td>
<td>

(`address`: `string`) => `Promise`<`void`>

</td>
<td>

Request encryption key for the user address

</td>
</tr>
<tr>
<td>

`options.userAddress`

</td>
<td>

`string` | `null`

</td>
<td>

Current user address (null if not signed in)

</td>
</tr>
</tbody>
</table>

## Returns

[`UseICloudBackupResult`](../Internal/interfaces/UseICloudBackupResult.md)

## Example

```tsx
import { useICloudBackup } from "@anuma/sdk/react";

function BackupButton() {
  const { backup, restore, isConfigured, isAuthenticated, isAvailable } = useICloudBackup({
    database,
    userAddress,
    requestEncryptionKey,
    exportConversation,
    importConversation,
  });

  if (!isAvailable) {
    return <p>CloudKit JS not loaded</p>;
  }

  const handleBackup = async () => {
    const result = await backup({
      onProgress: (current, total) => {
        console.log(`Progress: ${current}/${total}`);
      },
    });

    if ("error" in result) {
      console.error(result.error);
    } else {
      console.log(`Uploaded: ${result.uploaded}, Skipped: ${result.skipped}`);
    }
  };

  return <button onClick={handleBackup} disabled={!isConfigured}>Backup to iCloud</button>;
}
```

---
Source: https://docs.anuma.ai/sdk/react/Hooks/useModels

# useModels

> **useModels**(`options`: `object`): [`UseModelsResult`](../Internal/type-aliases/UseModelsResult.md)

Defined in: [src/react/useModels.ts:43](https://github.com/anuma-ai/sdk/blob/main/src/react/useModels.ts#43)

React hook for fetching available LLM models.
Automatically fetches all available models.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

`object`

</td>
<td>

‐

</td>
</tr>
<tr>
<td>

`options.autoFetch?`

</td>
<td>

`boolean`

</td>
<td>

Whether to fetch models automatically on mount (default: true)

</td>
</tr>
<tr>
<td>

`options.baseUrl?`

</td>
<td>

`string`

</td>
<td>

Optional base URL for the API requests.

</td>
</tr>
<tr>
<td>

`options.getToken?`

</td>
<td>

() => `Promise`<`string` | `null`>

</td>
<td>

Custom function to get auth token for API calls

</td>
</tr>
<tr>
<td>

`options.provider?`

</td>
<td>

`string`

</td>
<td>

Optional filter for specific provider (e.g. "openai")

</td>
</tr>
</tbody>
</table>

## Returns

[`UseModelsResult`](../Internal/type-aliases/UseModelsResult.md)

---
Source: https://docs.anuma.ai/sdk/react/Hooks/useOCR

# useOCR

> **useOCR**(): [`UseOCRResult`](UseOCRResult.md)

Defined in: [src/react/useOCR.ts:30](https://github.com/anuma-ai/sdk/blob/main/src/react/useOCR.ts#30)

React hook for extracting text from images using OCR.

## Returns

[`UseOCRResult`](UseOCRResult.md)

---
Source: https://docs.anuma.ai/sdk/react/Hooks/UseOCRResult

# UseOCRResult

Defined in: [src/react/useOCR.ts:17](https://github.com/anuma-ai/sdk/blob/main/src/react/useOCR.ts#17)

Result returned by the useOCR hook.

## Properties

### error

> **error**: `Error` | `null`

Defined in: [src/react/useOCR.ts:23](https://github.com/anuma-ai/sdk/blob/main/src/react/useOCR.ts#23)

Error from the last OCR extraction attempt

***

### extractOCRContext()

> **extractOCRContext**: (`files`: [`OCRFile`](../Internal/interfaces/OCRFile.md)\[]) => `Promise`<`string` | `null`>

Defined in: [src/react/useOCR.ts:19](https://github.com/anuma-ai/sdk/blob/main/src/react/useOCR.ts#19)

Extract text from images using OCR

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`files`

</td>
<td>

[`OCRFile`](../Internal/interfaces/OCRFile.md)\[]

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`string` | `null`>

***

### isProcessing

> **isProcessing**: `boolean`

Defined in: [src/react/useOCR.ts:21](https://github.com/anuma-ai/sdk/blob/main/src/react/useOCR.ts#21)

Whether OCR processing is in progress

---
Source: https://docs.anuma.ai/sdk/react/Hooks/usePdf

# usePdf

> **usePdf**(): [`UsePdfResult`](UsePdfResult.md)

Defined in: [src/react/usePdf.ts:31](https://github.com/anuma-ai/sdk/blob/main/src/react/usePdf.ts#31)

React hook for extracting text from PDF files.

## Returns

[`UsePdfResult`](UsePdfResult.md)

---
Source: https://docs.anuma.ai/sdk/react/Hooks/UsePdfResult

# UsePdfResult

Defined in: [src/react/usePdf.ts:18](https://github.com/anuma-ai/sdk/blob/main/src/react/usePdf.ts#18)

Result returned by the usePdf hook.

## Properties

### error

> **error**: `Error` | `null`

Defined in: [src/react/usePdf.ts:24](https://github.com/anuma-ai/sdk/blob/main/src/react/usePdf.ts#24)

Error from the last PDF extraction attempt

***

### extractPdfContext()

> **extractPdfContext**: (`files`: [`PdfFile`](../Internal/interfaces/PdfFile.md)\[]) => `Promise`<`string` | `null`>

Defined in: [src/react/usePdf.ts:20](https://github.com/anuma-ai/sdk/blob/main/src/react/usePdf.ts#20)

Extract text from PDF files

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`files`

</td>
<td>

[`PdfFile`](../Internal/interfaces/PdfFile.md)\[]

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`string` | `null`>

***

### isProcessing

> **isProcessing**: `boolean`

Defined in: [src/react/usePdf.ts:22](https://github.com/anuma-ai/sdk/blob/main/src/react/usePdf.ts#22)

Whether PDF processing is in progress

---
Source: https://docs.anuma.ai/sdk/react/Hooks/usePhoneCalls

# usePhoneCalls

> **usePhoneCalls**(`options`: `object`): [`UsePhoneCallsResult`](../Internal/type-aliases/UsePhoneCallsResult.md)

Defined in: [src/react/usePhoneCalls.ts:146](https://github.com/anuma-ai/sdk/blob/main/src/react/usePhoneCalls.ts#146)

React hook for phone calling: checking availability, creating calls,
fetching their status, and polling for completion.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

`object`

</td>
<td>

‐

</td>
</tr>
<tr>
<td>

`options.autoFetchAvailability?`

</td>
<td>

`boolean`

</td>
<td>

Whether to fetch feature availability automatically on mount (default: true)

</td>
</tr>
<tr>
<td>

`options.baseUrl?`

</td>
<td>

`string`

</td>
<td>

Optional base URL for the API requests.

</td>
</tr>
<tr>
<td>

`options.getToken?`

</td>
<td>

() => `Promise`<`string` | `null`>

</td>
<td>

Custom function to get auth token for API calls

</td>
</tr>
<tr>
<td>

`options.onError?`

</td>
<td>

(`error`: `Error`) => `void`

</td>
<td>

Optional callback for error handling

</td>
</tr>
</tbody>
</table>

## Returns

[`UsePhoneCallsResult`](../Internal/type-aliases/UsePhoneCallsResult.md)

---
Source: https://docs.anuma.ai/sdk/react/Hooks/useProjects

# useProjects

> **useProjects**(`options`: [`UseProjectsOptions`](../Internal/interfaces/UseProjectsOptions.md)): [`UseProjectsResult`](../Internal/interfaces/UseProjectsResult.md)

Defined in: [src/react/useProjects.ts:130](https://github.com/anuma-ai/sdk/blob/main/src/react/useProjects.ts#130)

A React hook for managing projects (conversation groups).

Projects allow users to organize their conversations by topic, purpose,
or any other criteria. This hook provides CRUD operations for projects
and methods to manage conversation-project associations.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`UseProjectsOptions`](../Internal/interfaces/UseProjectsOptions.md)

</td>
<td>

Configuration options

</td>
</tr>
</tbody>
</table>

## Returns

[`UseProjectsResult`](../Internal/interfaces/UseProjectsResult.md)

An object containing project state and methods

## Example

```tsx
import { useProjects } from '@anuma/sdk/react';

function ProjectsComponent({ database }) {
  const {
    projects,
    createProject,
    getProjectConversations,
    updateConversationProject,
  } = useProjects({ database });

  const handleCreateProject = async () => {
    const project = await createProject({ name: 'My New Project' });
    console.log('Created project:', project.projectId);
  };

  return (
    <div>
      <button onClick={handleCreateProject}>New Project</button>
      {projects.map((p) => (
        <div key={p.projectId}>{p.name}</div>
      ))}
    </div>
  );
}
```

---
Source: https://docs.anuma.ai/sdk/react/Hooks/useSettings

# useSettings

> **useSettings**(`options`: `object`): [`UseSettingsResult`](../Internal/interfaces/UseSettingsResult.md)

Defined in: [src/react/useSettings.ts:110](https://github.com/anuma-ai/sdk/blob/main/src/react/useSettings.ts#110)

A React hook for managing user settings with automatic persistence using WatermelonDB.

This hook provides methods to get, set, and delete user preferences,
with automatic loading and migration when a wallet address is provided.

The hook supports both the legacy `modelPreference` API (deprecated) and
the new unified `userPreference` API that stores profile data, model preferences,
and personality settings in a single table.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

`object`

</td>
<td>

Configuration options

</td>
</tr>
<tr>
<td>

`options.database`

</td>
<td>

`Database`

</td>
<td>

‐

</td>
</tr>
<tr>
<td>

`options.walletAddress?`

</td>
<td>

`string`

</td>
<td>

‐

</td>
</tr>
</tbody>
</table>

## Returns

[`UseSettingsResult`](../Internal/interfaces/UseSettingsResult.md)

An object containing settings state and methods

## Example

```tsx
import { Database } from '@nozbe/watermelondb';
import { useSettings } from '@anuma/sdk/react';

function SettingsComponent({ database }: { database: Database }) {
  const {
    userPreference,
    isLoading,
    setUserPreference,
    updateProfile,
    updatePersonality,
  } = useSettings({
    database,
    walletAddress: '0x123...', // Auto-loads and migrates preference
  });

  const handleProfileUpdate = async () => {
    await updateProfile('0x123...', {
      nickname: 'John',
      occupation: 'Developer',
    });
  };

  return (
    <div>
      <p>Nickname: {userPreference?.nickname ?? 'Not set'}</p>
      <button onClick={handleProfileUpdate}>Update Profile</button>
    </div>
  );
}
```

---
Source: https://docs.anuma.ai/sdk/react/Hooks/useSubscription

# useSubscription

> **useSubscription**(`options`: `object`): [`UseSubscriptionResult`](../Internal/type-aliases/UseSubscriptionResult.md)

Defined in: [src/react/useSubscription.ts:90](https://github.com/anuma-ai/sdk/blob/main/src/react/useSubscription.ts#90)

React hook for managing subscription status and billing operations.
Provides methods to check status, upgrade, manage billing, cancel, and renew subscriptions.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

`object`

</td>
<td>

‐

</td>
</tr>
<tr>
<td>

`options.autoFetch?`

</td>
<td>

`boolean`

</td>
<td>

Whether to fetch subscription status automatically on mount (default: true)

</td>
</tr>
<tr>
<td>

`options.baseUrl?`

</td>
<td>

`string`

</td>
<td>

Optional base URL for the API requests.

</td>
</tr>
<tr>
<td>

`options.getToken?`

</td>
<td>

() => `Promise`<`string` | `null`>

</td>
<td>

Custom function to get auth token for API calls

</td>
</tr>
<tr>
<td>

`options.onError?`

</td>
<td>

(`error`: `Error`) => `void`

</td>
<td>

Optional callback for error handling

</td>
</tr>
</tbody>
</table>

## Returns

[`UseSubscriptionResult`](../Internal/type-aliases/UseSubscriptionResult.md)

---
Source: https://docs.anuma.ai/sdk/react/Hooks/useTools

# useTools

> **useTools**(`options`: `object`): [`UseToolsResult`](../Internal/type-aliases/UseToolsResult.md)

Defined in: [src/react/useTools.ts:84](https://github.com/anuma-ai/sdk/blob/main/src/react/useTools.ts#84)

React hook for fetching and caching server-side tools.

This hook provides:

* Automatic fetching of tools on mount
* Caching with localStorage persistence
* Checksum-based cache invalidation
* Automatic refresh when tools change on the server

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

`object`

</td>
<td>

‐

</td>
</tr>
<tr>
<td>

`options.autoFetch?`

</td>
<td>

`boolean`

</td>
<td>

Whether to fetch tools automatically on mount (default: true)

</td>
</tr>
<tr>
<td>

`options.baseUrl?`

</td>
<td>

`string`

</td>
<td>

Optional base URL for the API requests.

</td>
</tr>
<tr>
<td>

`options.getToken`

</td>
<td>

() => `Promise`<`string` | `null`>

</td>
<td>

Custom function to get auth token for API calls

</td>
</tr>
<tr>
<td>

`options.includeTools?`

</td>
<td>

`string`\[]

</td>
<td>

Filter to include only specific tools by name.

* undefined: include all tools
* \[]: include no tools
* \['tool1', 'tool2']: include only named tools

</td>
</tr>
</tbody>
</table>

## Returns

[`UseToolsResult`](../Internal/type-aliases/UseToolsResult.md)

## Example

```tsx
const { tools, checkForUpdates, refresh } = useTools({
  getToken: async () => authToken,
});

// After sending a message, check if tools need refresh
const result = await sendMessage({ messages, model });
checkForUpdates(result.toolsChecksum);
```

---
Source: https://docs.anuma.ai/sdk/react/Hooks/useVoice

# useVoice

> **useVoice**(`options?`: [`UseVoiceOptions`](UseVoiceOptions.md)): [`UseVoiceResult`](UseVoiceResult.md)

Defined in: [src/react/useVoice.ts:201](https://github.com/anuma-ai/sdk/blob/main/src/react/useVoice.ts#201)

React hook for recording voice and transcribing it on-device using Whisper.

Transcription runs entirely in the browser via `@huggingface/transformers`
(ONNX Runtime + WebAssembly). The Whisper model (~40 MB for tiny) is
downloaded on first use and cached by the browser.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options?`

</td>
<td>

[`UseVoiceOptions`](UseVoiceOptions.md)

</td>
</tr>
</tbody>
</table>

## Returns

[`UseVoiceResult`](UseVoiceResult.md)

## Example

```tsx
const { startRecording, stopRecording, transcribe } = useVoice();

const handleStop = async () => {
  const recording = await stopRecording();
  const { text } = await transcribe(recording);
  // Send text to LLM via useChat
};
```

---
Source: https://docs.anuma.ai/sdk/react/Hooks/UseVoiceOptions

# UseVoiceOptions

Defined in: [src/react/useVoice.ts:58](https://github.com/anuma-ai/sdk/blob/main/src/react/useVoice.ts#58)

Options for the useVoice hook.

## Properties

### language?

> `optional` **language**: `string`

Defined in: [src/react/useVoice.ts:74](https://github.com/anuma-ai/sdk/blob/main/src/react/useVoice.ts#74)

Language code for transcription (e.g. "en", "es", "fr").
If omitted, Whisper auto-detects the language.

***

### model?

> `optional` **model**: [`WhisperModel`](../Internal/type-aliases/WhisperModel.md)

Defined in: [src/react/useVoice.ts:69](https://github.com/anuma-ai/sdk/blob/main/src/react/useVoice.ts#69)

Whisper model to use for transcription.
Larger models are more accurate but slower to download and run.

* `whisper-tiny`: ~40 MB, fastest
* `whisper-base`: ~75 MB, balanced
* `whisper-small`: ~250 MB, most accurate

Append `.en` for English-only variants (slightly faster).

**Default**

```ts
"whisper-tiny"
```

***

### onModelProgress()?

> `optional` **onModelProgress**: (`progress`: [`ModelLoadProgress`](../Internal/interfaces/ModelLoadProgress.md)) => `void`

Defined in: [src/react/useVoice.ts:79](https://github.com/anuma-ai/sdk/blob/main/src/react/useVoice.ts#79)

Called during model download with progress updates.
Useful for showing a download progress bar on first use.

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`progress`

</td>
<td>

[`ModelLoadProgress`](../Internal/interfaces/ModelLoadProgress.md)

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

---
Source: https://docs.anuma.ai/sdk/react/Hooks/UseVoiceResult

# UseVoiceResult

Defined in: [src/react/useVoice.ts:86](https://github.com/anuma-ai/sdk/blob/main/src/react/useVoice.ts#86)

Result returned by the useVoice hook.

## Properties

### abortNativeTranscription()

> **abortNativeTranscription**: () => `void`

Defined in: [src/react/useVoice.ts:118](https://github.com/anuma-ai/sdk/blob/main/src/react/useVoice.ts#118)

Abort on-device speech recognition without returning a result.

**Returns**

`void`

***

### disposeModel()

> **disposeModel**: () => `Promise`<`void`>

Defined in: [src/react/useVoice.ts:100](https://github.com/anuma-ai/sdk/blob/main/src/react/useVoice.ts#100)

Dispose the loaded model to free WASM memory. Useful on memory-constrained devices (mobile).

**Returns**

`Promise`<`void`>

***

### error

> **error**: `Error` | `null`

Defined in: [src/react/useVoice.ts:110](https://github.com/anuma-ai/sdk/blob/main/src/react/useVoice.ts#110)

Error from the last operation

***

### isLoadingModel

> **isLoadingModel**: `boolean`

Defined in: [src/react/useVoice.ts:104](https://github.com/anuma-ai/sdk/blob/main/src/react/useVoice.ts#104)

Whether the Whisper model is currently loading/downloading

***

### isModelLoaded

> **isModelLoaded**: `boolean`

Defined in: [src/react/useVoice.ts:102](https://github.com/anuma-ai/sdk/blob/main/src/react/useVoice.ts#102)

Whether the Whisper model has been loaded

***

### isNativeListening

> **isNativeListening**: `boolean`

Defined in: [src/react/useVoice.ts:120](https://github.com/anuma-ai/sdk/blob/main/src/react/useVoice.ts#120)

Whether on-device speech recognition is currently listening.

***

### isRecording

> **isRecording**: `boolean`

Defined in: [src/react/useVoice.ts:88](https://github.com/anuma-ai/sdk/blob/main/src/react/useVoice.ts#88)

Whether the microphone is currently recording

***

### isTranscribing

> **isTranscribing**: `boolean`

Defined in: [src/react/useVoice.ts:94](https://github.com/anuma-ai/sdk/blob/main/src/react/useVoice.ts#94)

Whether transcription is in progress

***

### nativeSpeechAvailable

> **nativeSpeechAvailable**: `boolean`

Defined in: [src/react/useVoice.ts:112](https://github.com/anuma-ai/sdk/blob/main/src/react/useVoice.ts#112)

Whether on-device speech recognition is available (iOS Safari). No audio leaves the device.

***

### preloadModel()

> **preloadModel**: () => `Promise`<`void`>

Defined in: [src/react/useVoice.ts:98](https://github.com/anuma-ai/sdk/blob/main/src/react/useVoice.ts#98)

Preload the Whisper model so transcription starts instantly later

**Returns**

`Promise`<`void`>

***

### recording

> **recording**: [`VoiceRecording`](../Internal/interfaces/VoiceRecording.md) | `null`

Defined in: [src/react/useVoice.ts:106](https://github.com/anuma-ai/sdk/blob/main/src/react/useVoice.ts#106)

The last recording

***

### startNativeTranscription()

> **startNativeTranscription**: () => `void`

Defined in: [src/react/useVoice.ts:114](https://github.com/anuma-ai/sdk/blob/main/src/react/useVoice.ts#114)

Start on-device speech recognition. Call stopNativeTranscription() to get the result.

**Returns**

`void`

***

### startRecording()

> **startRecording**: () => `Promise`<`void`>

Defined in: [src/react/useVoice.ts:90](https://github.com/anuma-ai/sdk/blob/main/src/react/useVoice.ts#90)

Start recording from the microphone

**Returns**

`Promise`<`void`>

***

### stopNativeTranscription()

> **stopNativeTranscription**: () => `Promise`<[`TranscriptionResult`](../Internal/interfaces/TranscriptionResult.md)>

Defined in: [src/react/useVoice.ts:116](https://github.com/anuma-ai/sdk/blob/main/src/react/useVoice.ts#116)

Stop on-device speech recognition and return the accumulated text.

**Returns**

`Promise`<[`TranscriptionResult`](../Internal/interfaces/TranscriptionResult.md)>

***

### stopRecording()

> **stopRecording**: () => `Promise`<[`VoiceRecording`](../Internal/interfaces/VoiceRecording.md)>

Defined in: [src/react/useVoice.ts:92](https://github.com/anuma-ai/sdk/blob/main/src/react/useVoice.ts#92)

Stop recording and return the audio

**Returns**

`Promise`<[`VoiceRecording`](../Internal/interfaces/VoiceRecording.md)>

***

### transcribe()

> **transcribe**: (`recording?`: [`VoiceRecording`](../Internal/interfaces/VoiceRecording.md)) => `Promise`<[`TranscriptionResult`](../Internal/interfaces/TranscriptionResult.md)>

Defined in: [src/react/useVoice.ts:96](https://github.com/anuma-ai/sdk/blob/main/src/react/useVoice.ts#96)

Transcribe a recording. Uses the last recording if none provided.

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`recording?`

</td>
<td>

[`VoiceRecording`](../Internal/interfaces/VoiceRecording.md)

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`TranscriptionResult`](../Internal/interfaces/TranscriptionResult.md)>

***

### transcription

> **transcription**: [`TranscriptionResult`](../Internal/interfaces/TranscriptionResult.md) | `null`

Defined in: [src/react/useVoice.ts:108](https://github.com/anuma-ai/sdk/blob/main/src/react/useVoice.ts#108)

The last transcription result

---
Source: https://docs.anuma.ai/sdk/react/Internal/classes/AnumaJsxError

# AnumaJsxError

Defined in: [src/tools/slides/jsx.ts:69](https://github.com/anuma-ai/sdk/blob/main/src/tools/slides/jsx.ts#69)

## Extends

* `Error`

## Constructors

### Constructor

> **new AnumaJsxError**(`message`: `string`, `loc?`: { `column`: `number`; `line`: `number`; } | `null`): `AnumaJsxError`

Defined in: [src/tools/slides/jsx.ts:73](https://github.com/anuma-ai/sdk/blob/main/src/tools/slides/jsx.ts#73)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`message`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`loc?`

</td>
<td>

{ `column`: `number`; `line`: `number`; } | `null`

</td>
</tr>
</tbody>
</table>

**Returns**

`AnumaJsxError`

**Overrides**

`Error.constructor`

## Properties

### column?

> `readonly` `optional` **column**: `number`

Defined in: [src/tools/slides/jsx.ts:71](https://github.com/anuma-ai/sdk/blob/main/src/tools/slides/jsx.ts#71)

***

### line?

> `readonly` `optional` **line**: `number`

Defined in: [src/tools/slides/jsx.ts:70](https://github.com/anuma-ai/sdk/blob/main/src/tools/slides/jsx.ts#70)

***

### message

> **message**: `string`

Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1077

**Inherited from**

`Error.message`

***

### name

> **name**: `string`

Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1076

**Inherited from**

`Error.name`

***

### stack?

> `optional` **stack**: `string`

Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1078

**Inherited from**

`Error.stack`

***

### stackTraceLimit

> `static` **stackTraceLimit**: `number`

Defined in: node\_modules/.pnpm/@types+node@25.0.3/node\_modules/@types/node/globals.d.ts:67

The `Error.stackTraceLimit` property specifies the number of stack frames
collected by a stack trace (whether generated by `new Error().stack` or
`Error.captureStackTrace(obj)`).

The default value is `10` but may be set to any valid JavaScript number. Changes
will affect any stack trace captured *after* the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will
not capture any frames.

**Inherited from**

`Error.stackTraceLimit`

## Methods

### captureStackTrace()

> `static` **captureStackTrace**(`targetObject`: `object`, `constructorOpt?`: `Function`): `void`

Defined in: node\_modules/.pnpm/@types+node@25.0.3/node\_modules/@types/node/globals.d.ts:51

Creates a `.stack` property on `targetObject`, which when accessed returns
a string representing the location in the code at which
`Error.captureStackTrace()` was called.

```js
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`
```

The first line of the trace will be prefixed with
`${myObject.name}: ${myObject.message}`.

The optional `constructorOpt` argument accepts a function. If given, all frames
above `constructorOpt`, including `constructorOpt`, will be omitted from the
generated stack trace.

The `constructorOpt` argument is useful for hiding implementation
details of error generation from the user. For instance:

```js
function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();
```

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`targetObject`

</td>
<td>

`object`

</td>
</tr>
<tr>
<td>

`constructorOpt?`

</td>
<td>

`Function`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

**Inherited from**

`Error.captureStackTrace`

***

### prepareStackTrace()

> `static` **prepareStackTrace**(`err`: `Error`, `stackTraces`: `CallSite`\[]): `any`

Defined in: node\_modules/.pnpm/@types+node@25.0.3/node\_modules/@types/node/globals.d.ts:55

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`err`

</td>
<td>

`Error`

</td>
</tr>
<tr>
<td>

`stackTraces`

</td>
<td>

`CallSite`\[]

</td>
</tr>
</tbody>
</table>

**Returns**

`any`

**See**

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

**Inherited from**

`Error.prepareStackTrace`

---
Source: https://docs.anuma.ai/sdk/react/Internal/classes/AppFileModel

# AppFileModel

Defined in: [src/lib/db/appFiles/models.ts:5](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/appFiles/models.ts#5)

## Extends

* `default`

## Constructors

### Constructor

> **new AppFileModel**(`collection`: `Collection`<`Model`>, `raw`: `_RawRecord`): `AppFile`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:117

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`collection`

</td>
<td>

`Collection`<`Model`>

</td>
</tr>
<tr>
<td>

`raw`

</td>
<td>

`_RawRecord`

</td>
</tr>
</tbody>
</table>

**Returns**

`AppFile`

**Inherited from**

`Model.constructor`

## Properties

### \_\_changes?

> `optional` **\_\_changes**: `BehaviorSubject`<`any`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:40

**Inherited from**

`Model.__changes`

***

### \_isEditing

> **\_isEditing**: `boolean`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:36

**Inherited from**

`Model._isEditing`

***

### \_preparedState

> **\_preparedState**: `"create"` | `"update"` | `"markAsDeleted"` | `"destroyPermanently"` | `null`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:38

**Inherited from**

`Model._preparedState`

***

### \_raw

> **\_raw**: `_RawRecord`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:34

**Inherited from**

`Model._raw`

***

### \_subscribers

> **\_subscribers**: \[(`isDeleted`: `boolean`) => `void`, `any`]\[]

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:125

**Inherited from**

`Model._subscribers`

***

### collection

> **collection**: `Collection`<`Model`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:88

**Inherited from**

`Model.collection`

***

### content

> **content**: `string`

Defined in: [src/lib/db/appFiles/models.ts:12](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/appFiles/models.ts#12)

***

### conversationId

> **conversationId**: `string`

Defined in: [src/lib/db/appFiles/models.ts:10](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/appFiles/models.ts#10)

***

### createdAt

> **createdAt**: `Date`

Defined in: [src/lib/db/appFiles/models.ts:13](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/appFiles/models.ts#13)

***

### path

> **path**: `string`

Defined in: [src/lib/db/appFiles/models.ts:11](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/appFiles/models.ts#11)

***

### updatedAt

> **updatedAt**: `Date`

Defined in: [src/lib/db/appFiles/models.ts:14](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/appFiles/models.ts#14)

***

### \_wmelonTag

> `static` **\_wmelonTag**: `string`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:32

**Inherited from**

`Model._wmelonTag`

***

### associations

> `static` **associations**: `Associations` = `{}`

Defined in: [src/lib/db/appFiles/models.ts:8](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/appFiles/models.ts#8)

**Overrides**

`Model.associations`

***

### table

> `static` **table**: `string` = `"app_files"`

Defined in: [src/lib/db/appFiles/models.ts:6](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/appFiles/models.ts#6)

**Overrides**

`Model.table`

## Accessors

### asModel

**Get Signature**

> **get** **asModel**(): `this`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:97

**Returns**

`this`

**Inherited from**

`Model.asModel`

***

### collections

**Get Signature**

> **get** **collections**(): `CollectionMap`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:91

**Returns**

`CollectionMap`

**Inherited from**

`Model.collections`

***

### database

**Get Signature**

> **get** **database**(): `Database`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:93

**Returns**

`Database`

**Inherited from**

`Model.database`

***

### db

**Get Signature**

> **get** **db**(): `Database`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:95

**Returns**

`Database`

**Inherited from**

`Model.db`

***

### id

**Get Signature**

> **get** **id**(): `string`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:44

**Returns**

`string`

**Inherited from**

`Model.id`

***

### syncStatus

**Get Signature**

> **get** **syncStatus**(): `SyncStatus`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:46

**Returns**

`SyncStatus`

**Inherited from**

`Model.syncStatus`

***

### table

**Get Signature**

> **get** **table**(): `string`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:113

**Returns**

`string`

**Inherited from**

`Model.table`

## Methods

### \_\_ensureCanSetRaw()

> **\_\_ensureCanSetRaw**(): `void`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:141

**Returns**

`void`

**Inherited from**

`Model.__ensureCanSetRaw`

***

### \_\_ensureNotDisposable()

> **\_\_ensureNotDisposable**(`debugName`: `string`): `void`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:143

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`debugName`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

**Inherited from**

`Model.__ensureNotDisposable`

***

### \_dangerouslySetRawWithoutMarkingColumnChange()

> **\_dangerouslySetRawWithoutMarkingColumnChange**(`rawFieldName`: `string`, `rawValue`: `Value`): `void`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:139

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`rawFieldName`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`rawValue`

</td>
<td>

`Value`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

**Inherited from**

`Model._dangerouslySetRawWithoutMarkingColumnChange`

***

### \_getChanges()

> **\_getChanges**(): `BehaviorSubject`<`any`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:42

**Returns**

`BehaviorSubject`<`any`>

**Inherited from**

`Model._getChanges`

***

### \_getRaw()

> **\_getRaw**(`rawFieldName`: `string`): `Value`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:133

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`rawFieldName`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Value`

**Inherited from**

`Model._getRaw`

***

### \_notifyChanged()

> **\_notifyChanged**(): `void`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:129

**Returns**

`void`

**Inherited from**

`Model._notifyChanged`

***

### \_notifyDestroyed()

> **\_notifyDestroyed**(): `void`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:131

**Returns**

`void`

**Inherited from**

`Model._notifyDestroyed`

***

### \_setRaw()

> **\_setRaw**(`rawFieldName`: `string`, `rawValue`: `Value`): `void`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:135

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`rawFieldName`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`rawValue`

</td>
<td>

`Value`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

**Inherited from**

`Model._setRaw`

***

### batch()

> **batch**(...`records`: `$ReadOnlyArray`<`false` | `void` | `Model` | `null`>): `Promise`<`void`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:102

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

...`records`

</td>
<td>

`$ReadOnlyArray`<`false` | `void` | `Model` | `null`>

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`void`>

**Inherited from**

`Model.batch`

***

### callReader()

> **callReader**<`T`>(`action`: () => `Promise`<`T`>): `Promise`<`T`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:108

**Type Parameters**

<table>
<thead>
<tr>
<th>Type Parameter</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`T`

</td>
</tr>
</tbody>
</table>

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`action`

</td>
<td>

() => `Promise`<`T`>

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`T`>

**Inherited from**

`Model.callReader`

***

### callWriter()

> **callWriter**<`T`>(`action`: () => `Promise`<`T`>): `Promise`<`T`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:105

**Type Parameters**

<table>
<thead>
<tr>
<th>Type Parameter</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`T`

</td>
</tr>
</tbody>
</table>

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`action`

</td>
<td>

() => `Promise`<`T`>

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`T`>

**Inherited from**

`Model.callWriter`

***

### destroyPermanently()

> **destroyPermanently**(): `Promise`<`void`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:74

**Returns**

`Promise`<`void`>

**Inherited from**

`Model.destroyPermanently`

***

### experimentalDestroyPermanently()

> **experimentalDestroyPermanently**(): `Promise`<`void`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:78

**Returns**

`Promise`<`void`>

**Inherited from**

`Model.experimentalDestroyPermanently`

***

### experimentalMarkAsDeleted()

> **experimentalMarkAsDeleted**(): `Promise`<`void`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:76

**Returns**

`Promise`<`void`>

**Inherited from**

`Model.experimentalMarkAsDeleted`

***

### experimentalSubscribe()

> **experimentalSubscribe**(`subscriber`: (`isDeleted`: `boolean`) => `void`, `debugInfo?`: `any`): `Unsubscribe`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:127

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`subscriber`

</td>
<td>

(`isDeleted`: `boolean`) => `void`

</td>
</tr>
<tr>
<td>

`debugInfo?`

</td>
<td>

`any`

</td>
</tr>
</tbody>
</table>

**Returns**

`Unsubscribe`

**Inherited from**

`Model.experimentalSubscribe`

***

### markAsDeleted()

> **markAsDeleted**(): `Promise`<`void`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:70

**Returns**

`Promise`<`void`>

**Inherited from**

`Model.markAsDeleted`

***

### observe()

> **observe**(): `Observable`<`AppFile`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:84

**Returns**

`Observable`<`AppFile`>

**Inherited from**

`Model.observe`

***

### prepareDestroyPermanently()

> **prepareDestroyPermanently**(): `this`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:66

**Returns**

`this`

**Inherited from**

`Model.prepareDestroyPermanently`

***

### prepareMarkAsDeleted()

> **prepareMarkAsDeleted**(): `this`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:64

**Returns**

`this`

**Inherited from**

`Model.prepareMarkAsDeleted`

***

### prepareUpdate()

> **prepareUpdate**(`recordUpdater?`: (`_`: `this`) => `void`): `this`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:62

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`recordUpdater?`

</td>
<td>

(`_`: `this`) => `void`

</td>
</tr>
</tbody>
</table>

**Returns**

`this`

**Inherited from**

`Model.prepareUpdate`

***

### subAction()

> **subAction**<`T`>(`action`: () => `Promise`<`T`>): `Promise`<`T`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:111

**Type Parameters**

<table>
<thead>
<tr>
<th>Type Parameter</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`T`

</td>
</tr>
</tbody>
</table>

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`action`

</td>
<td>

() => `Promise`<`T`>

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`T`>

**Inherited from**

`Model.subAction`

***

### update()

> **update**(`recordUpdater?`: (`_`: `this`) => `void`): `Promise`<`AppFile`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:55

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`recordUpdater?`

</td>
<td>

(`_`: `this`) => `void`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`AppFile`>

**Inherited from**

`Model.update`

***

### \_disposableFromDirtyRaw()

> `static` **\_disposableFromDirtyRaw**(`collection`: `Collection`<`Model`>, `dirtyRaw`: `DirtyRaw`): `Model`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:123

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`collection`

</td>
<td>

`Collection`<`Model`>

</td>
</tr>
<tr>
<td>

`dirtyRaw`

</td>
<td>

`DirtyRaw`

</td>
</tr>
</tbody>
</table>

**Returns**

`Model`

**Inherited from**

`Model._disposableFromDirtyRaw`

***

### \_prepareCreate()

> `static` **\_prepareCreate**(`collection`: `Collection`<`Model`>, `recordBuilder`: (`_`: `Model`) => `void`): `Model`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:119

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`collection`

</td>
<td>

`Collection`<`Model`>

</td>
</tr>
<tr>
<td>

`recordBuilder`

</td>
<td>

(`_`: `Model`) => `void`

</td>
</tr>
</tbody>
</table>

**Returns**

`Model`

**Inherited from**

`Model._prepareCreate`

***

### \_prepareCreateFromDirtyRaw()

> `static` **\_prepareCreateFromDirtyRaw**(`collection`: `Collection`<`Model`>, `dirtyRaw`: `DirtyRaw`): `Model`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:121

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`collection`

</td>
<td>

`Collection`<`Model`>

</td>
</tr>
<tr>
<td>

`dirtyRaw`

</td>
<td>

`DirtyRaw`

</td>
</tr>
</tbody>
</table>

**Returns**

`Model`

**Inherited from**

`Model._prepareCreateFromDirtyRaw`

---
Source: https://docs.anuma.ai/sdk/react/Internal/classes/BlobUrlManager

# BlobUrlManager

Defined in: [src/lib/storage/opfs.ts:313](https://github.com/anuma-ai/sdk/blob/main/src/lib/storage/opfs.ts#313)

Manager for blob URLs to prevent memory leaks.
Tracks active blob URLs and provides cleanup functionality.

## Constructors

### Constructor

> **new BlobUrlManager**(): `BlobUrlManager`

**Returns**

`BlobUrlManager`

## Accessors

### size

**Get Signature**

> **get** **size**(): `number`

Defined in: [src/lib/storage/opfs.ts:359](https://github.com/anuma-ai/sdk/blob/main/src/lib/storage/opfs.ts#359)

Gets the count of active blob URLs.

**Returns**

`number`

## Methods

### createUrl()

> **createUrl**(`fileId`: `string`, `blob`: `Blob`): `string`

Defined in: [src/lib/storage/opfs.ts:319](https://github.com/anuma-ai/sdk/blob/main/src/lib/storage/opfs.ts#319)

Creates a blob URL for a file and tracks it.

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`fileId`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`blob`

</td>
<td>

`Blob`

</td>
</tr>
</tbody>
</table>

**Returns**

`string`

***

### getUrl()

> **getUrl**(`fileId`: `string`): `string` | `undefined`

Defined in: [src/lib/storage/opfs.ts:331](https://github.com/anuma-ai/sdk/blob/main/src/lib/storage/opfs.ts#331)

Gets the active blob URL for a file, if any.

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`fileId`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`string` | `undefined`

***

### revokeAll()

> **revokeAll**(): `void`

Defined in: [src/lib/storage/opfs.ts:349](https://github.com/anuma-ai/sdk/blob/main/src/lib/storage/opfs.ts#349)

Revokes all tracked blob URLs.

**Returns**

`void`

***

### revokeUrl()

> **revokeUrl**(`fileId`: `string`): `void`

Defined in: [src/lib/storage/opfs.ts:338](https://github.com/anuma-ai/sdk/blob/main/src/lib/storage/opfs.ts#338)

Revokes a blob URL and removes it from tracking.

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`fileId`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

---
Source: https://docs.anuma.ai/sdk/react/Internal/classes/ChatConversation

# ChatConversation

Defined in: [src/lib/db/chat/models.ts:53](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/models.ts#53)

## Extends

* `default`

## Constructors

### Constructor

> **new ChatConversation**(`collection`: `Collection`<`Model`>, `raw`: `_RawRecord`): `Conversation`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:117

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`collection`

</td>
<td>

`Collection`<`Model`>

</td>
</tr>
<tr>
<td>

`raw`

</td>
<td>

`_RawRecord`

</td>
</tr>
</tbody>
</table>

**Returns**

`Conversation`

**Inherited from**

`Model.constructor`

## Properties

### \_\_changes?

> `optional` **\_\_changes**: `BehaviorSubject`<`any`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:40

**Inherited from**

`Model.__changes`

***

### \_isEditing

> **\_isEditing**: `boolean`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:36

**Inherited from**

`Model._isEditing`

***

### \_preparedState

> **\_preparedState**: `"create"` | `"update"` | `"markAsDeleted"` | `"destroyPermanently"` | `null`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:38

**Inherited from**

[`Project`](Project.md).[`_preparedState`](Project.md#_preparedstate)

***

### \_raw

> **\_raw**: `_RawRecord`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:34

**Inherited from**

`Model._raw`

***

### \_subscribers

> **\_subscribers**: \[(`isDeleted`: `boolean`) => `void`, `any`]\[]

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:125

**Inherited from**

`Model._subscribers`

***

### collection

> **collection**: `Collection`<`Model`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:88

**Inherited from**

`Model.collection`

***

### conversationId

> **conversationId**: `string`

Defined in: [src/lib/db/chat/models.ts:61](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/models.ts#61)

***

### createdAt

> **createdAt**: `Date`

Defined in: [src/lib/db/chat/models.ts:64](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/models.ts#64)

***

### isDeleted

> **isDeleted**: `boolean`

Defined in: [src/lib/db/chat/models.ts:66](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/models.ts#66)

***

### projectId?

> `optional` **projectId**: `string`

Defined in: [src/lib/db/chat/models.ts:63](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/models.ts#63)

***

### title

> **title**: `string`

Defined in: [src/lib/db/chat/models.ts:62](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/models.ts#62)

***

### updatedAt

> **updatedAt**: `Date`

Defined in: [src/lib/db/chat/models.ts:65](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/models.ts#65)

***

### \_wmelonTag

> `static` **\_wmelonTag**: `string`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:32

**Inherited from**

`Model._wmelonTag`

***

### associations

> `static` **associations**: `Associations`

Defined in: [src/lib/db/chat/models.ts:56](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/models.ts#56)

**Overrides**

`Model.associations`

***

### table

> `static` **table**: `string` = `"conversations"`

Defined in: [src/lib/db/chat/models.ts:54](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/models.ts#54)

**Overrides**

`Model.table`

## Accessors

### asModel

**Get Signature**

> **get** **asModel**(): `this`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:97

**Returns**

`this`

**Inherited from**

`Model.asModel`

***

### collections

**Get Signature**

> **get** **collections**(): `CollectionMap`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:91

**Returns**

`CollectionMap`

**Inherited from**

`Model.collections`

***

### database

**Get Signature**

> **get** **database**(): `Database`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:93

**Returns**

`Database`

**Inherited from**

`Model.database`

***

### db

**Get Signature**

> **get** **db**(): `Database`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:95

**Returns**

`Database`

**Inherited from**

`Model.db`

***

### id

**Get Signature**

> **get** **id**(): `string`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:44

**Returns**

`string`

**Inherited from**

`Model.id`

***

### syncStatus

**Get Signature**

> **get** **syncStatus**(): `SyncStatus`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:46

**Returns**

`SyncStatus`

**Inherited from**

`Model.syncStatus`

***

### table

**Get Signature**

> **get** **table**(): `string`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:113

**Returns**

`string`

**Inherited from**

[`Project`](Project.md).[`table`](Project.md#table-1)

## Methods

### \_\_ensureCanSetRaw()

> **\_\_ensureCanSetRaw**(): `void`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:141

**Returns**

`void`

**Inherited from**

`Model.__ensureCanSetRaw`

***

### \_\_ensureNotDisposable()

> **\_\_ensureNotDisposable**(`debugName`: `string`): `void`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:143

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`debugName`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

**Inherited from**

`Model.__ensureNotDisposable`

***

### \_dangerouslySetRawWithoutMarkingColumnChange()

> **\_dangerouslySetRawWithoutMarkingColumnChange**(`rawFieldName`: `string`, `rawValue`: `Value`): `void`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:139

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`rawFieldName`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`rawValue`

</td>
<td>

`Value`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

**Inherited from**

`Model._dangerouslySetRawWithoutMarkingColumnChange`

***

### \_getChanges()

> **\_getChanges**(): `BehaviorSubject`<`any`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:42

**Returns**

`BehaviorSubject`<`any`>

**Inherited from**

`Model._getChanges`

***

### \_getRaw()

> **\_getRaw**(`rawFieldName`: `string`): `Value`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:133

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`rawFieldName`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Value`

**Inherited from**

`Model._getRaw`

***

### \_notifyChanged()

> **\_notifyChanged**(): `void`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:129

**Returns**

`void`

**Inherited from**

`Model._notifyChanged`

***

### \_notifyDestroyed()

> **\_notifyDestroyed**(): `void`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:131

**Returns**

`void`

**Inherited from**

`Model._notifyDestroyed`

***

### \_setRaw()

> **\_setRaw**(`rawFieldName`: `string`, `rawValue`: `Value`): `void`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:135

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`rawFieldName`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`rawValue`

</td>
<td>

`Value`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

**Inherited from**

`Model._setRaw`

***

### batch()

> **batch**(...`records`: `$ReadOnlyArray`<`false` | `void` | `Model` | `null`>): `Promise`<`void`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:102

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

...`records`

</td>
<td>

`$ReadOnlyArray`<`false` | `void` | `Model` | `null`>

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`void`>

**Inherited from**

`Model.batch`

***

### callReader()

> **callReader**<`T`>(`action`: () => `Promise`<`T`>): `Promise`<`T`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:108

**Type Parameters**

<table>
<thead>
<tr>
<th>Type Parameter</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`T`

</td>
</tr>
</tbody>
</table>

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`action`

</td>
<td>

() => `Promise`<`T`>

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`T`>

**Inherited from**

`Model.callReader`

***

### callWriter()

> **callWriter**<`T`>(`action`: () => `Promise`<`T`>): `Promise`<`T`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:105

**Type Parameters**

<table>
<thead>
<tr>
<th>Type Parameter</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`T`

</td>
</tr>
</tbody>
</table>

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`action`

</td>
<td>

() => `Promise`<`T`>

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`T`>

**Inherited from**

`Model.callWriter`

***

### destroyPermanently()

> **destroyPermanently**(): `Promise`<`void`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:74

**Returns**

`Promise`<`void`>

**Inherited from**

`Model.destroyPermanently`

***

### experimentalDestroyPermanently()

> **experimentalDestroyPermanently**(): `Promise`<`void`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:78

**Returns**

`Promise`<`void`>

**Inherited from**

`Model.experimentalDestroyPermanently`

***

### experimentalMarkAsDeleted()

> **experimentalMarkAsDeleted**(): `Promise`<`void`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:76

**Returns**

`Promise`<`void`>

**Inherited from**

`Model.experimentalMarkAsDeleted`

***

### experimentalSubscribe()

> **experimentalSubscribe**(`subscriber`: (`isDeleted`: `boolean`) => `void`, `debugInfo?`: `any`): `Unsubscribe`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:127

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`subscriber`

</td>
<td>

(`isDeleted`: `boolean`) => `void`

</td>
</tr>
<tr>
<td>

`debugInfo?`

</td>
<td>

`any`

</td>
</tr>
</tbody>
</table>

**Returns**

`Unsubscribe`

**Inherited from**

`Model.experimentalSubscribe`

***

### markAsDeleted()

> **markAsDeleted**(): `Promise`<`void`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:70

**Returns**

`Promise`<`void`>

**Inherited from**

`Model.markAsDeleted`

***

### observe()

> **observe**(): `Observable`<`Conversation`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:84

**Returns**

`Observable`<`Conversation`>

**Inherited from**

`Model.observe`

***

### prepareDestroyPermanently()

> **prepareDestroyPermanently**(): `this`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:66

**Returns**

`this`

**Inherited from**

`Model.prepareDestroyPermanently`

***

### prepareMarkAsDeleted()

> **prepareMarkAsDeleted**(): `this`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:64

**Returns**

`this`

**Inherited from**

`Model.prepareMarkAsDeleted`

***

### prepareUpdate()

> **prepareUpdate**(`recordUpdater?`: (`_`: `this`) => `void`): `this`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:62

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`recordUpdater?`

</td>
<td>

(`_`: `this`) => `void`

</td>
</tr>
</tbody>
</table>

**Returns**

`this`

**Inherited from**

`Model.prepareUpdate`

***

### subAction()

> **subAction**<`T`>(`action`: () => `Promise`<`T`>): `Promise`<`T`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:111

**Type Parameters**

<table>
<thead>
<tr>
<th>Type Parameter</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`T`

</td>
</tr>
</tbody>
</table>

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`action`

</td>
<td>

() => `Promise`<`T`>

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`T`>

**Inherited from**

`Model.subAction`

***

### update()

> **update**(`recordUpdater?`: (`_`: `this`) => `void`): `Promise`<`Conversation`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:55

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`recordUpdater?`

</td>
<td>

(`_`: `this`) => `void`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`Conversation`>

**Inherited from**

`Model.update`

***

### \_disposableFromDirtyRaw()

> `static` **\_disposableFromDirtyRaw**(`collection`: `Collection`<`Model`>, `dirtyRaw`: `DirtyRaw`): `Model`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:123

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`collection`

</td>
<td>

`Collection`<`Model`>

</td>
</tr>
<tr>
<td>

`dirtyRaw`

</td>
<td>

`DirtyRaw`

</td>
</tr>
</tbody>
</table>

**Returns**

`Model`

**Inherited from**

`Model._disposableFromDirtyRaw`

***

### \_prepareCreate()

> `static` **\_prepareCreate**(`collection`: `Collection`<`Model`>, `recordBuilder`: (`_`: `Model`) => `void`): `Model`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:119

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`collection`

</td>
<td>

`Collection`<`Model`>

</td>
</tr>
<tr>
<td>

`recordBuilder`

</td>
<td>

(`_`: `Model`) => `void`

</td>
</tr>
</tbody>
</table>

**Returns**

`Model`

**Inherited from**

`Model._prepareCreate`

***

### \_prepareCreateFromDirtyRaw()

> `static` **\_prepareCreateFromDirtyRaw**(`collection`: `Collection`<`Model`>, `dirtyRaw`: `DirtyRaw`): `Model`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:121

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`collection`

</td>
<td>

`Collection`<`Model`>

</td>
</tr>
<tr>
<td>

`dirtyRaw`

</td>
<td>

`DirtyRaw`

</td>
</tr>
</tbody>
</table>

**Returns**

`Model`

**Inherited from**

`Model._prepareCreateFromDirtyRaw`

---
Source: https://docs.anuma.ai/sdk/react/Internal/classes/ChatMessage

# ChatMessage

Defined in: [src/lib/db/chat/models.ts:16](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/models.ts#16)

## Extends

* `default`

## Constructors

### Constructor

> **new ChatMessage**(`collection`: `Collection`<`Model`>, `raw`: `_RawRecord`): `Message`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:117

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`collection`

</td>
<td>

`Collection`<`Model`>

</td>
</tr>
<tr>
<td>

`raw`

</td>
<td>

`_RawRecord`

</td>
</tr>
</tbody>
</table>

**Returns**

`Message`

**Inherited from**

`Model.constructor`

## Properties

### \_\_changes?

> `optional` **\_\_changes**: `BehaviorSubject`<`any`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:40

**Inherited from**

`Model.__changes`

***

### \_isEditing

> **\_isEditing**: `boolean`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:36

**Inherited from**

`Model._isEditing`

***

### \_preparedState

> **\_preparedState**: `"create"` | `"update"` | `"markAsDeleted"` | `"destroyPermanently"` | `null`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:38

**Inherited from**

[`Project`](Project.md).[`_preparedState`](Project.md#_preparedstate)

***

### \_raw

> **\_raw**: `_RawRecord`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:34

**Inherited from**

`Model._raw`

***

### \_subscribers

> **\_subscribers**: \[(`isDeleted`: `boolean`) => `void`, `any`]\[]

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:125

**Inherited from**

`Model._subscribers`

***

### chunks?

> `optional` **chunks**: [`MessageChunk`](../interfaces/MessageChunk.md)\[]

Defined in: [src/lib/db/chat/models.ts:38](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/models.ts#38)

***

### collection

> **collection**: `Collection`<`Model`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:88

**Inherited from**

`Model.collection`

***

### content

> **content**: `string`

Defined in: [src/lib/db/chat/models.ts:27](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/models.ts#27)

***

### conversationId

> **conversationId**: `string`

Defined in: [src/lib/db/chat/models.ts:25](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/models.ts#25)

***

### createdAt

> **createdAt**: `Date`

Defined in: [src/lib/db/chat/models.ts:34](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/models.ts#34)

***

### embeddingModel?

> `optional` **embeddingModel**: `string`

Defined in: [src/lib/db/chat/models.ts:37](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/models.ts#37)

***

### error?

> `optional` **error**: `string`

Defined in: [src/lib/db/chat/models.ts:43](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/models.ts#43)

***

### feedback?

> `optional` **feedback**: [`MessageFeedback`](../type-aliases/MessageFeedback.md)

Defined in: [src/lib/db/chat/models.ts:48](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/models.ts#48)

***

### fileIds?

> `optional` **fileIds**: `string`\[]

Defined in: [src/lib/db/chat/models.ts:33](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/models.ts#33)

Array of media\_id references for direct lookup

***

### ~~files?~~

> `optional` **files**: [`FileMetadata`](../interfaces/FileMetadata.md)\[]

Defined in: [src/lib/db/chat/models.ts:31](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/models.ts#31)

**Deprecated**

Use fileIds with media table instead

***

### imageModel?

> `optional` **imageModel**: `string`

Defined in: [src/lib/db/chat/models.ts:29](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/models.ts#29)

***

### messageId

> **messageId**: `number`

Defined in: [src/lib/db/chat/models.ts:24](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/models.ts#24)

***

### model?

> `optional` **model**: `string`

Defined in: [src/lib/db/chat/models.ts:28](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/models.ts#28)

***

### parentMessageId?

> `optional` **parentMessageId**: `string`

Defined in: [src/lib/db/chat/models.ts:47](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/models.ts#47)

***

### responseDuration?

> `optional` **responseDuration**: `number`

Defined in: [src/lib/db/chat/models.ts:41](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/models.ts#41)

***

### role

> **role**: [`ChatRole`](../type-aliases/ChatRole.md)

Defined in: [src/lib/db/chat/models.ts:26](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/models.ts#26)

***

### sources?

> `optional` **sources**: [`SearchSource`](../interfaces/SearchSource.md)\[]

Defined in: [src/lib/db/chat/models.ts:40](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/models.ts#40)

***

### thinking?

> `optional` **thinking**: `string`

Defined in: [src/lib/db/chat/models.ts:46](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/models.ts#46)

***

### thoughtProcess?

> `optional` **thoughtProcess**: `ActivityPhase`\[]

Defined in: [src/lib/db/chat/models.ts:45](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/models.ts#45)

***

### toolCallEvents?

> `optional` **toolCallEvents**: [`LlmapiToolCallEvent`](../../../client/Internal/type-aliases/LlmapiToolCallEvent.md)\[]

Defined in: [src/lib/db/chat/models.ts:50](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/models.ts#50)

***

### updatedAt

> **updatedAt**: `Date`

Defined in: [src/lib/db/chat/models.ts:35](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/models.ts#35)

***

### usage?

> `optional` **usage**: [`StoredChatCompletionUsage`](../interfaces/StoredChatCompletionUsage.md)

Defined in: [src/lib/db/chat/models.ts:39](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/models.ts#39)

***

### vector?

> `optional` **vector**: `number`\[]

Defined in: [src/lib/db/chat/models.ts:36](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/models.ts#36)

***

### wasStopped?

> `optional` **wasStopped**: `boolean`

Defined in: [src/lib/db/chat/models.ts:42](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/models.ts#42)

***

### \_wmelonTag

> `static` **\_wmelonTag**: `string`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:32

**Inherited from**

`Model._wmelonTag`

***

### associations

> `static` **associations**: `Associations`

Defined in: [src/lib/db/chat/models.ts:19](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/models.ts#19)

**Overrides**

`Model.associations`

***

### table

> `static` **table**: `string` = `"history"`

Defined in: [src/lib/db/chat/models.ts:17](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/models.ts#17)

**Overrides**

`Model.table`

## Accessors

### asModel

**Get Signature**

> **get** **asModel**(): `this`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:97

**Returns**

`this`

**Inherited from**

`Model.asModel`

***

### collections

**Get Signature**

> **get** **collections**(): `CollectionMap`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:91

**Returns**

`CollectionMap`

**Inherited from**

`Model.collections`

***

### database

**Get Signature**

> **get** **database**(): `Database`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:93

**Returns**

`Database`

**Inherited from**

`Model.database`

***

### db

**Get Signature**

> **get** **db**(): `Database`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:95

**Returns**

`Database`

**Inherited from**

`Model.db`

***

### id

**Get Signature**

> **get** **id**(): `string`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:44

**Returns**

`string`

**Inherited from**

`Model.id`

***

### syncStatus

**Get Signature**

> **get** **syncStatus**(): `SyncStatus`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:46

**Returns**

`SyncStatus`

**Inherited from**

`Model.syncStatus`

***

### table

**Get Signature**

> **get** **table**(): `string`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:113

**Returns**

`string`

**Inherited from**

[`Project`](Project.md).[`table`](Project.md#table-1)

## Methods

### \_\_ensureCanSetRaw()

> **\_\_ensureCanSetRaw**(): `void`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:141

**Returns**

`void`

**Inherited from**

`Model.__ensureCanSetRaw`

***

### \_\_ensureNotDisposable()

> **\_\_ensureNotDisposable**(`debugName`: `string`): `void`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:143

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`debugName`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

**Inherited from**

`Model.__ensureNotDisposable`

***

### \_dangerouslySetRawWithoutMarkingColumnChange()

> **\_dangerouslySetRawWithoutMarkingColumnChange**(`rawFieldName`: `string`, `rawValue`: `Value`): `void`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:139

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`rawFieldName`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`rawValue`

</td>
<td>

`Value`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

**Inherited from**

`Model._dangerouslySetRawWithoutMarkingColumnChange`

***

### \_getChanges()

> **\_getChanges**(): `BehaviorSubject`<`any`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:42

**Returns**

`BehaviorSubject`<`any`>

**Inherited from**

`Model._getChanges`

***

### \_getRaw()

> **\_getRaw**(`rawFieldName`: `string`): `Value`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:133

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`rawFieldName`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Value`

**Inherited from**

`Model._getRaw`

***

### \_notifyChanged()

> **\_notifyChanged**(): `void`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:129

**Returns**

`void`

**Inherited from**

`Model._notifyChanged`

***

### \_notifyDestroyed()

> **\_notifyDestroyed**(): `void`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:131

**Returns**

`void`

**Inherited from**

`Model._notifyDestroyed`

***

### \_setRaw()

> **\_setRaw**(`rawFieldName`: `string`, `rawValue`: `Value`): `void`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:135

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`rawFieldName`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`rawValue`

</td>
<td>

`Value`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

**Inherited from**

`Model._setRaw`

***

### batch()

> **batch**(...`records`: `$ReadOnlyArray`<`false` | `void` | `Model` | `null`>): `Promise`<`void`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:102

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

...`records`

</td>
<td>

`$ReadOnlyArray`<`false` | `void` | `Model` | `null`>

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`void`>

**Inherited from**

`Model.batch`

***

### callReader()

> **callReader**<`T`>(`action`: () => `Promise`<`T`>): `Promise`<`T`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:108

**Type Parameters**

<table>
<thead>
<tr>
<th>Type Parameter</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`T`

</td>
</tr>
</tbody>
</table>

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`action`

</td>
<td>

() => `Promise`<`T`>

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`T`>

**Inherited from**

`Model.callReader`

***

### callWriter()

> **callWriter**<`T`>(`action`: () => `Promise`<`T`>): `Promise`<`T`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:105

**Type Parameters**

<table>
<thead>
<tr>
<th>Type Parameter</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`T`

</td>
</tr>
</tbody>
</table>

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`action`

</td>
<td>

() => `Promise`<`T`>

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`T`>

**Inherited from**

`Model.callWriter`

***

### destroyPermanently()

> **destroyPermanently**(): `Promise`<`void`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:74

**Returns**

`Promise`<`void`>

**Inherited from**

`Model.destroyPermanently`

***

### experimentalDestroyPermanently()

> **experimentalDestroyPermanently**(): `Promise`<`void`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:78

**Returns**

`Promise`<`void`>

**Inherited from**

`Model.experimentalDestroyPermanently`

***

### experimentalMarkAsDeleted()

> **experimentalMarkAsDeleted**(): `Promise`<`void`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:76

**Returns**

`Promise`<`void`>

**Inherited from**

`Model.experimentalMarkAsDeleted`

***

### experimentalSubscribe()

> **experimentalSubscribe**(`subscriber`: (`isDeleted`: `boolean`) => `void`, `debugInfo?`: `any`): `Unsubscribe`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:127

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`subscriber`

</td>
<td>

(`isDeleted`: `boolean`) => `void`

</td>
</tr>
<tr>
<td>

`debugInfo?`

</td>
<td>

`any`

</td>
</tr>
</tbody>
</table>

**Returns**

`Unsubscribe`

**Inherited from**

`Model.experimentalSubscribe`

***

### markAsDeleted()

> **markAsDeleted**(): `Promise`<`void`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:70

**Returns**

`Promise`<`void`>

**Inherited from**

`Model.markAsDeleted`

***

### observe()

> **observe**(): `Observable`<`Message`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:84

**Returns**

`Observable`<`Message`>

**Inherited from**

`Model.observe`

***

### prepareDestroyPermanently()

> **prepareDestroyPermanently**(): `this`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:66

**Returns**

`this`

**Inherited from**

`Model.prepareDestroyPermanently`

***

### prepareMarkAsDeleted()

> **prepareMarkAsDeleted**(): `this`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:64

**Returns**

`this`

**Inherited from**

`Model.prepareMarkAsDeleted`

***

### prepareUpdate()

> **prepareUpdate**(`recordUpdater?`: (`_`: `this`) => `void`): `this`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:62

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`recordUpdater?`

</td>
<td>

(`_`: `this`) => `void`

</td>
</tr>
</tbody>
</table>

**Returns**

`this`

**Inherited from**

`Model.prepareUpdate`

***

### subAction()

> **subAction**<`T`>(`action`: () => `Promise`<`T`>): `Promise`<`T`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:111

**Type Parameters**

<table>
<thead>
<tr>
<th>Type Parameter</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`T`

</td>
</tr>
</tbody>
</table>

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`action`

</td>
<td>

() => `Promise`<`T`>

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`T`>

**Inherited from**

`Model.subAction`

***

### update()

> **update**(`recordUpdater?`: (`_`: `this`) => `void`): `Promise`<`Message`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:55

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`recordUpdater?`

</td>
<td>

(`_`: `this`) => `void`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`Message`>

**Inherited from**

`Model.update`

***

### \_disposableFromDirtyRaw()

> `static` **\_disposableFromDirtyRaw**(`collection`: `Collection`<`Model`>, `dirtyRaw`: `DirtyRaw`): `Model`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:123

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`collection`

</td>
<td>

`Collection`<`Model`>

</td>
</tr>
<tr>
<td>

`dirtyRaw`

</td>
<td>

`DirtyRaw`

</td>
</tr>
</tbody>
</table>

**Returns**

`Model`

**Inherited from**

`Model._disposableFromDirtyRaw`

***

### \_prepareCreate()

> `static` **\_prepareCreate**(`collection`: `Collection`<`Model`>, `recordBuilder`: (`_`: `Model`) => `void`): `Model`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:119

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`collection`

</td>
<td>

`Collection`<`Model`>

</td>
</tr>
<tr>
<td>

`recordBuilder`

</td>
<td>

(`_`: `Model`) => `void`

</td>
</tr>
</tbody>
</table>

**Returns**

`Model`

**Inherited from**

`Model._prepareCreate`

***

### \_prepareCreateFromDirtyRaw()

> `static` **\_prepareCreateFromDirtyRaw**(`collection`: `Collection`<`Model`>, `dirtyRaw`: `DirtyRaw`): `Model`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:121

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`collection`

</td>
<td>

`Collection`<`Model`>

</td>
</tr>
<tr>
<td>

`dirtyRaw`

</td>
<td>

`DirtyRaw`

</td>
</tr>
</tbody>
</table>

**Returns**

`Model`

**Inherited from**

`Model._prepareCreateFromDirtyRaw`

---
Source: https://docs.anuma.ai/sdk/react/Internal/classes/DatabaseManager

# DatabaseManager

Defined in: [src/lib/db/manager.ts:154](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/manager.ts#154)

Manages per-wallet WatermelonDB database instances.

Each wallet address gets its own isolated database. The manager handles:

* Singleton caching per wallet
* Automatic database switching when the wallet changes
* Destructive schema migration detection and handling
* Per-wallet storage key namespacing

## Example

```typescript
import { DatabaseManager, webPlatformStorage, sdkSchema, sdkMigrations } from '@anuma/sdk/react';
import LokiJSAdapter from '@nozbe/watermelondb/adapters/lokijs';

const dbManager = new DatabaseManager({
  dbNamePrefix: 'my-app',
  createAdapter: (dbName, schema, migrations) => new LokiJSAdapter({
    schema,
    migrations,
    dbName,
    useWebWorker: false,
    useIncrementalIndexedDB: true,
  }),
  storage: webPlatformStorage,
  onDestructiveMigration: () => window.location.reload(),
});

// Get the database for the current wallet
const database = dbManager.getDatabase(walletAddress);
```

## Constructors

### Constructor

> **new DatabaseManager**(`options`: [`DatabaseManagerOptions`](../interfaces/DatabaseManagerOptions.md)): `DatabaseManager`

Defined in: [src/lib/db/manager.ts:165](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/manager.ts#165)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`DatabaseManagerOptions`](../interfaces/DatabaseManagerOptions.md)

</td>
</tr>
</tbody>
</table>

**Returns**

`DatabaseManager`

## Methods

### getDatabase()

> **getDatabase**(`walletAddress?`: `string`): `Database`

Defined in: [src/lib/db/manager.ts:191](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/manager.ts#191)

Get or create a WatermelonDB Database instance for the given wallet.

If the wallet address has changed since the last call, the previous
database instance is discarded and a new one is created.

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`walletAddress?`

</td>
<td>

`string`

</td>
<td>

The wallet address to scope the database to.
If undefined, uses a "guest" database.

</td>
</tr>
</tbody>
</table>

**Returns**

`Database`

The WatermelonDB Database instance

**Throws**

If a destructive migration is in progress

***

### getDbName()

> **getDbName**(`walletAddress?`: `string`): `string`

Defined in: [src/lib/db/manager.ts:176](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/manager.ts#176)

Get the database name for a given wallet address.

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`walletAddress?`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`string`

***

### resetDatabase()

> **resetDatabase**(): `Promise`<`void`>

Defined in: [src/lib/db/manager.ts:234](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/manager.ts#234)

Reset the current database (useful for logout or testing).

**Returns**

`Promise`<`void`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/classes/ExcelProcessor

# ExcelProcessor

Defined in: [src/lib/processors/ExcelProcessor.ts:24](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/ExcelProcessor.ts#24)

Processor for Excel files (.xlsx) that converts to JSON structure.

Uses a dynamic import for exceljs so the heavy dependency tree is only
loaded when actually processing an Excel file.

## Implements

* [`FileProcessor`](../interfaces/FileProcessor.md)

## Constructors

### Constructor

> **new ExcelProcessor**(): `ExcelProcessor`

**Returns**

`ExcelProcessor`

## Properties

### name

> `readonly` **name**: `"excel"` = `"excel"`

Defined in: [src/lib/processors/ExcelProcessor.ts:25](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/ExcelProcessor.ts#25)

Unique identifier for this processor

**Implementation of**

[`FileProcessor`](../interfaces/FileProcessor.md).[`name`](../interfaces/FileProcessor.md#name)

***

### supportedExtensions

> `readonly` **supportedExtensions**: `string`\[]

Defined in: [src/lib/processors/ExcelProcessor.ts:29](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/ExcelProcessor.ts#29)

File extensions this processor can handle (fallback if MIME type unavailable)

**Implementation of**

[`FileProcessor`](../interfaces/FileProcessor.md).[`supportedExtensions`](../interfaces/FileProcessor.md#supportedextensions)

***

### supportedMimeTypes

> `readonly` **supportedMimeTypes**: `string`\[]

Defined in: [src/lib/processors/ExcelProcessor.ts:26](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/ExcelProcessor.ts#26)

MIME types this processor can handle

**Implementation of**

[`FileProcessor`](../interfaces/FileProcessor.md).[`supportedMimeTypes`](../interfaces/FileProcessor.md#supportedmimetypes)

## Methods

### process()

> **process**(`file`: [`FileWithData`](../interfaces/FileWithData.md)): `Promise`<[`ProcessedFileResult`](../interfaces/ProcessedFileResult.md) | `null`>

Defined in: [src/lib/processors/ExcelProcessor.ts:36](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/ExcelProcessor.ts#36)

Process a file and extract text content

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`file`

</td>
<td>

[`FileWithData`](../interfaces/FileWithData.md)

</td>
<td>

File metadata with data URL

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`ProcessedFileResult`](../interfaces/ProcessedFileResult.md) | `null`>

Extracted text content and metadata, or null if processing fails/not applicable

**Implementation of**

[`FileProcessor`](../interfaces/FileProcessor.md).[`process`](../interfaces/FileProcessor.md#process)

---
Source: https://docs.anuma.ai/sdk/react/Internal/classes/PdfProcessor

# PdfProcessor

Defined in: [src/lib/processors/PdfProcessor.ts:17](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/PdfProcessor.ts#17)

Processor for PDF files that extracts text content.
Falls back to rendering pages as images when text extraction yields no
content (e.g. scanned/image-based PDFs), enabling vision models to read
the document.

## Implements

* [`FileProcessor`](../interfaces/FileProcessor.md)

## Constructors

### Constructor

> **new PdfProcessor**(): `PdfProcessor`

**Returns**

`PdfProcessor`

## Properties

### name

> `readonly` **name**: `"pdf"` = `"pdf"`

Defined in: [src/lib/processors/PdfProcessor.ts:18](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/PdfProcessor.ts#18)

Unique identifier for this processor

**Implementation of**

[`FileProcessor`](../interfaces/FileProcessor.md).[`name`](../interfaces/FileProcessor.md#name)

***

### supportedExtensions

> `readonly` **supportedExtensions**: `string`\[]

Defined in: [src/lib/processors/PdfProcessor.ts:20](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/PdfProcessor.ts#20)

File extensions this processor can handle (fallback if MIME type unavailable)

**Implementation of**

[`FileProcessor`](../interfaces/FileProcessor.md).[`supportedExtensions`](../interfaces/FileProcessor.md#supportedextensions)

***

### supportedMimeTypes

> `readonly` **supportedMimeTypes**: `string`\[]

Defined in: [src/lib/processors/PdfProcessor.ts:19](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/PdfProcessor.ts#19)

MIME types this processor can handle

**Implementation of**

[`FileProcessor`](../interfaces/FileProcessor.md).[`supportedMimeTypes`](../interfaces/FileProcessor.md#supportedmimetypes)

## Methods

### process()

> **process**(`file`: [`FileWithData`](../interfaces/FileWithData.md)): `Promise`<[`ProcessedFileResult`](../interfaces/ProcessedFileResult.md) | `null`>

Defined in: [src/lib/processors/PdfProcessor.ts:22](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/PdfProcessor.ts#22)

Process a file and extract text content

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`file`

</td>
<td>

[`FileWithData`](../interfaces/FileWithData.md)

</td>
<td>

File metadata with data URL

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`ProcessedFileResult`](../interfaces/ProcessedFileResult.md) | `null`>

Extracted text content and metadata, or null if processing fails/not applicable

**Implementation of**

[`FileProcessor`](../interfaces/FileProcessor.md).[`process`](../interfaces/FileProcessor.md#process)

---
Source: https://docs.anuma.ai/sdk/react/Internal/classes/ProcessorRegistry

# ProcessorRegistry

Defined in: [src/lib/processors/registry.ts:16](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/registry.ts#16)

Registry for managing and finding file processors

## Constructors

### Constructor

> **new ProcessorRegistry**(): `ProcessorRegistry`

**Returns**

`ProcessorRegistry`

## Methods

### findProcessor()

> **findProcessor**(`file`: [`FileTypeQuery`](../interfaces/FileTypeQuery.md)): [`FileProcessor`](../interfaces/FileProcessor.md) | `null`

Defined in: [src/lib/processors/registry.ts:31](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/registry.ts#31)

Find a processor that can handle the given file

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`file`

</td>
<td>

[`FileTypeQuery`](../interfaces/FileTypeQuery.md)

</td>
<td>

File metadata to match

</td>
</tr>
</tbody>
</table>

**Returns**

[`FileProcessor`](../interfaces/FileProcessor.md) | `null`

The matching processor, or null if none found

***

### getAll()

> **getAll**(): [`FileProcessor`](../interfaces/FileProcessor.md)\[]

Defined in: [src/lib/processors/registry.ts:97](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/registry.ts#97)

Get all registered processors

**Returns**

[`FileProcessor`](../interfaces/FileProcessor.md)\[]

***

### getSupportedExtensions()

> **getSupportedExtensions**(): `string`\[]

Defined in: [src/lib/processors/registry.ts:84](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/registry.ts#84)

Get the union of all file extensions handled by registered processors.
Includes the leading dot (e.g. `.md`, `.pdf`) so values can be passed
directly to an `<input accept>` attribute.
Result is deduplicated and sorted for stable output.

**Returns**

`string`\[]

***

### getSupportedMimeTypes()

> **getSupportedMimeTypes**(): `string`\[]

Defined in: [src/lib/processors/registry.ts:68](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/registry.ts#68)

Get the union of all MIME types handled by registered processors.
Useful for building an `<input type="file" accept="...">` allowlist.
Result is deduplicated and sorted for stable output.

**Returns**

`string`\[]

***

### isSupported()

> **isSupported**(`file`: [`FileTypeQuery`](../interfaces/FileTypeQuery.md)): `boolean`

Defined in: [src/lib/processors/registry.ts:59](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/registry.ts#59)

Test whether any registered processor can handle the given file.
Convenience wrapper around `findProcessor` for upload-time validation
where you only care about the boolean answer.

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`file`

</td>
<td>

[`FileTypeQuery`](../interfaces/FileTypeQuery.md)

</td>
</tr>
</tbody>
</table>

**Returns**

`boolean`

***

### register()

> **register**(`processor`: [`FileProcessor`](../interfaces/FileProcessor.md)): `void`

Defined in: [src/lib/processors/registry.ts:22](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/registry.ts#22)

Register a processor

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`processor`

</td>
<td>

[`FileProcessor`](../interfaces/FileProcessor.md)

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

---
Source: https://docs.anuma.ai/sdk/react/Internal/classes/Project

# Project

Defined in: [src/lib/db/project/models.ts:5](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/project/models.ts#5)

## Extends

* `default`

## Constructors

### Constructor

> **new Project**(`collection`: `Collection`<`Model`>, `raw`: `_RawRecord`): `Project`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:117

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`collection`

</td>
<td>

`Collection`<`Model`>

</td>
</tr>
<tr>
<td>

`raw`

</td>
<td>

`_RawRecord`

</td>
</tr>
</tbody>
</table>

**Returns**

`Project`

**Inherited from**

`Model.constructor`

## Properties

### \_\_changes?

> `optional` **\_\_changes**: `BehaviorSubject`<`any`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:40

**Inherited from**

`Model.__changes`

***

### \_isEditing

> **\_isEditing**: `boolean`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:36

**Inherited from**

`Model._isEditing`

***

### \_preparedState

> **\_preparedState**: `"create"` | `"update"` | `"markAsDeleted"` | `"destroyPermanently"` | `null`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:38

**Inherited from**

`Model._preparedState`

***

### \_raw

> **\_raw**: `_RawRecord`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:34

**Inherited from**

`Model._raw`

***

### \_subscribers

> **\_subscribers**: \[(`isDeleted`: `boolean`) => `void`, `any`]\[]

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:125

**Inherited from**

`Model._subscribers`

***

### collection

> **collection**: `Collection`<`Model`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:88

**Inherited from**

`Model.collection`

***

### createdAt

> **createdAt**: `Date`

Defined in: [src/lib/db/project/models.ts:14](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/project/models.ts#14)

***

### isDeleted

> **isDeleted**: `boolean`

Defined in: [src/lib/db/project/models.ts:16](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/project/models.ts#16)

***

### name

> **name**: `string`

Defined in: [src/lib/db/project/models.ts:13](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/project/models.ts#13)

***

### projectId

> **projectId**: `string`

Defined in: [src/lib/db/project/models.ts:12](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/project/models.ts#12)

***

### updatedAt

> **updatedAt**: `Date`

Defined in: [src/lib/db/project/models.ts:15](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/project/models.ts#15)

***

### \_wmelonTag

> `static` **\_wmelonTag**: `string`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:32

**Inherited from**

`Model._wmelonTag`

***

### associations

> `static` **associations**: `Associations`

Defined in: [src/lib/db/project/models.ts:8](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/project/models.ts#8)

**Overrides**

`Model.associations`

***

### table

> `static` **table**: `string` = `"projects"`

Defined in: [src/lib/db/project/models.ts:6](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/project/models.ts#6)

**Overrides**

`Model.table`

## Accessors

### asModel

**Get Signature**

> **get** **asModel**(): `this`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:97

**Returns**

`this`

**Inherited from**

`Model.asModel`

***

### collections

**Get Signature**

> **get** **collections**(): `CollectionMap`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:91

**Returns**

`CollectionMap`

**Inherited from**

`Model.collections`

***

### database

**Get Signature**

> **get** **database**(): `Database`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:93

**Returns**

`Database`

**Inherited from**

`Model.database`

***

### db

**Get Signature**

> **get** **db**(): `Database`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:95

**Returns**

`Database`

**Inherited from**

`Model.db`

***

### id

**Get Signature**

> **get** **id**(): `string`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:44

**Returns**

`string`

**Inherited from**

`Model.id`

***

### syncStatus

**Get Signature**

> **get** **syncStatus**(): `SyncStatus`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:46

**Returns**

`SyncStatus`

**Inherited from**

`Model.syncStatus`

***

### table

**Get Signature**

> **get** **table**(): `string`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:113

**Returns**

`string`

**Inherited from**

`Model.table`

## Methods

### \_\_ensureCanSetRaw()

> **\_\_ensureCanSetRaw**(): `void`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:141

**Returns**

`void`

**Inherited from**

`Model.__ensureCanSetRaw`

***

### \_\_ensureNotDisposable()

> **\_\_ensureNotDisposable**(`debugName`: `string`): `void`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:143

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`debugName`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

**Inherited from**

`Model.__ensureNotDisposable`

***

### \_dangerouslySetRawWithoutMarkingColumnChange()

> **\_dangerouslySetRawWithoutMarkingColumnChange**(`rawFieldName`: `string`, `rawValue`: `Value`): `void`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:139

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`rawFieldName`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`rawValue`

</td>
<td>

`Value`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

**Inherited from**

`Model._dangerouslySetRawWithoutMarkingColumnChange`

***

### \_getChanges()

> **\_getChanges**(): `BehaviorSubject`<`any`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:42

**Returns**

`BehaviorSubject`<`any`>

**Inherited from**

`Model._getChanges`

***

### \_getRaw()

> **\_getRaw**(`rawFieldName`: `string`): `Value`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:133

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`rawFieldName`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Value`

**Inherited from**

`Model._getRaw`

***

### \_notifyChanged()

> **\_notifyChanged**(): `void`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:129

**Returns**

`void`

**Inherited from**

`Model._notifyChanged`

***

### \_notifyDestroyed()

> **\_notifyDestroyed**(): `void`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:131

**Returns**

`void`

**Inherited from**

`Model._notifyDestroyed`

***

### \_setRaw()

> **\_setRaw**(`rawFieldName`: `string`, `rawValue`: `Value`): `void`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:135

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`rawFieldName`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`rawValue`

</td>
<td>

`Value`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

**Inherited from**

`Model._setRaw`

***

### batch()

> **batch**(...`records`: `$ReadOnlyArray`<`false` | `void` | `Model` | `null`>): `Promise`<`void`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:102

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

...`records`

</td>
<td>

`$ReadOnlyArray`<`false` | `void` | `Model` | `null`>

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`void`>

**Inherited from**

`Model.batch`

***

### callReader()

> **callReader**<`T`>(`action`: () => `Promise`<`T`>): `Promise`<`T`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:108

**Type Parameters**

<table>
<thead>
<tr>
<th>Type Parameter</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`T`

</td>
</tr>
</tbody>
</table>

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`action`

</td>
<td>

() => `Promise`<`T`>

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`T`>

**Inherited from**

`Model.callReader`

***

### callWriter()

> **callWriter**<`T`>(`action`: () => `Promise`<`T`>): `Promise`<`T`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:105

**Type Parameters**

<table>
<thead>
<tr>
<th>Type Parameter</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`T`

</td>
</tr>
</tbody>
</table>

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`action`

</td>
<td>

() => `Promise`<`T`>

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`T`>

**Inherited from**

`Model.callWriter`

***

### destroyPermanently()

> **destroyPermanently**(): `Promise`<`void`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:74

**Returns**

`Promise`<`void`>

**Inherited from**

`Model.destroyPermanently`

***

### experimentalDestroyPermanently()

> **experimentalDestroyPermanently**(): `Promise`<`void`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:78

**Returns**

`Promise`<`void`>

**Inherited from**

`Model.experimentalDestroyPermanently`

***

### experimentalMarkAsDeleted()

> **experimentalMarkAsDeleted**(): `Promise`<`void`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:76

**Returns**

`Promise`<`void`>

**Inherited from**

`Model.experimentalMarkAsDeleted`

***

### experimentalSubscribe()

> **experimentalSubscribe**(`subscriber`: (`isDeleted`: `boolean`) => `void`, `debugInfo?`: `any`): `Unsubscribe`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:127

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`subscriber`

</td>
<td>

(`isDeleted`: `boolean`) => `void`

</td>
</tr>
<tr>
<td>

`debugInfo?`

</td>
<td>

`any`

</td>
</tr>
</tbody>
</table>

**Returns**

`Unsubscribe`

**Inherited from**

`Model.experimentalSubscribe`

***

### markAsDeleted()

> **markAsDeleted**(): `Promise`<`void`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:70

**Returns**

`Promise`<`void`>

**Inherited from**

`Model.markAsDeleted`

***

### observe()

> **observe**(): `Observable`<`Project`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:84

**Returns**

`Observable`<`Project`>

**Inherited from**

`Model.observe`

***

### prepareDestroyPermanently()

> **prepareDestroyPermanently**(): `this`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:66

**Returns**

`this`

**Inherited from**

`Model.prepareDestroyPermanently`

***

### prepareMarkAsDeleted()

> **prepareMarkAsDeleted**(): `this`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:64

**Returns**

`this`

**Inherited from**

`Model.prepareMarkAsDeleted`

***

### prepareUpdate()

> **prepareUpdate**(`recordUpdater?`: (`_`: `this`) => `void`): `this`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:62

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`recordUpdater?`

</td>
<td>

(`_`: `this`) => `void`

</td>
</tr>
</tbody>
</table>

**Returns**

`this`

**Inherited from**

`Model.prepareUpdate`

***

### subAction()

> **subAction**<`T`>(`action`: () => `Promise`<`T`>): `Promise`<`T`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:111

**Type Parameters**

<table>
<thead>
<tr>
<th>Type Parameter</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`T`

</td>
</tr>
</tbody>
</table>

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`action`

</td>
<td>

() => `Promise`<`T`>

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`T`>

**Inherited from**

`Model.subAction`

***

### update()

> **update**(`recordUpdater?`: (`_`: `this`) => `void`): `Promise`<`Project`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:55

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`recordUpdater?`

</td>
<td>

(`_`: `this`) => `void`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`Project`>

**Inherited from**

`Model.update`

***

### \_disposableFromDirtyRaw()

> `static` **\_disposableFromDirtyRaw**(`collection`: `Collection`<`Model`>, `dirtyRaw`: `DirtyRaw`): `Model`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:123

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`collection`

</td>
<td>

`Collection`<`Model`>

</td>
</tr>
<tr>
<td>

`dirtyRaw`

</td>
<td>

`DirtyRaw`

</td>
</tr>
</tbody>
</table>

**Returns**

`Model`

**Inherited from**

`Model._disposableFromDirtyRaw`

***

### \_prepareCreate()

> `static` **\_prepareCreate**(`collection`: `Collection`<`Model`>, `recordBuilder`: (`_`: `Model`) => `void`): `Model`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:119

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`collection`

</td>
<td>

`Collection`<`Model`>

</td>
</tr>
<tr>
<td>

`recordBuilder`

</td>
<td>

(`_`: `Model`) => `void`

</td>
</tr>
</tbody>
</table>

**Returns**

`Model`

**Inherited from**

`Model._prepareCreate`

***

### \_prepareCreateFromDirtyRaw()

> `static` **\_prepareCreateFromDirtyRaw**(`collection`: `Collection`<`Model`>, `dirtyRaw`: `DirtyRaw`): `Model`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:121

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`collection`

</td>
<td>

`Collection`<`Model`>

</td>
</tr>
<tr>
<td>

`dirtyRaw`

</td>
<td>

`DirtyRaw`

</td>
</tr>
</tbody>
</table>

**Returns**

`Model`

**Inherited from**

`Model._prepareCreateFromDirtyRaw`

---
Source: https://docs.anuma.ai/sdk/react/Internal/classes/ProviderStreamError

# ProviderStreamError

Defined in: [src/lib/chat/toolLoop.ts:209](https://github.com/anuma-ai/sdk/blob/main/src/lib/chat/toolLoop.ts#209)

Error thrown when an upstream provider emits an in-stream error event.
Carries the provider's code (e.g. `"timeout"`) so callers can match
programmatically via `err instanceof ProviderStreamError && err.code === "timeout"`
instead of string-matching the message.

## Extends

* `Error`

## Constructors

### Constructor

> **new ProviderStreamError**(`message`: `string`, `code?`: `string`): `ProviderStreamError`

Defined in: [src/lib/chat/toolLoop.ts:211](https://github.com/anuma-ai/sdk/blob/main/src/lib/chat/toolLoop.ts#211)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`message`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`code?`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`ProviderStreamError`

**Overrides**

`Error.constructor`

## Properties

### code

> `readonly` **code**: `string` | `undefined`

Defined in: [src/lib/chat/toolLoop.ts:210](https://github.com/anuma-ai/sdk/blob/main/src/lib/chat/toolLoop.ts#210)

***

### message

> **message**: `string`

Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1077

**Inherited from**

`Error.message`

***

### name

> **name**: `string`

Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1076

**Inherited from**

`Error.name`

***

### stack?

> `optional` **stack**: `string`

Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1078

**Inherited from**

`Error.stack`

***

### stackTraceLimit

> `static` **stackTraceLimit**: `number`

Defined in: node\_modules/.pnpm/@types+node@25.0.3/node\_modules/@types/node/globals.d.ts:67

The `Error.stackTraceLimit` property specifies the number of stack frames
collected by a stack trace (whether generated by `new Error().stack` or
`Error.captureStackTrace(obj)`).

The default value is `10` but may be set to any valid JavaScript number. Changes
will affect any stack trace captured *after* the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will
not capture any frames.

**Inherited from**

`Error.stackTraceLimit`

## Methods

### captureStackTrace()

> `static` **captureStackTrace**(`targetObject`: `object`, `constructorOpt?`: `Function`): `void`

Defined in: node\_modules/.pnpm/@types+node@25.0.3/node\_modules/@types/node/globals.d.ts:51

Creates a `.stack` property on `targetObject`, which when accessed returns
a string representing the location in the code at which
`Error.captureStackTrace()` was called.

```js
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`
```

The first line of the trace will be prefixed with
`${myObject.name}: ${myObject.message}`.

The optional `constructorOpt` argument accepts a function. If given, all frames
above `constructorOpt`, including `constructorOpt`, will be omitted from the
generated stack trace.

The `constructorOpt` argument is useful for hiding implementation
details of error generation from the user. For instance:

```js
function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();
```

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`targetObject`

</td>
<td>

`object`

</td>
</tr>
<tr>
<td>

`constructorOpt?`

</td>
<td>

`Function`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

**Inherited from**

`Error.captureStackTrace`

***

### prepareStackTrace()

> `static` **prepareStackTrace**(`err`: `Error`, `stackTraces`: `CallSite`\[]): `any`

Defined in: node\_modules/.pnpm/@types+node@25.0.3/node\_modules/@types/node/globals.d.ts:55

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`err`

</td>
<td>

`Error`

</td>
</tr>
<tr>
<td>

`stackTraces`

</td>
<td>

`CallSite`\[]

</td>
</tr>
</tbody>
</table>

**Returns**

`any`

**See**

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

**Inherited from**

`Error.prepareStackTrace`

---
Source: https://docs.anuma.ai/sdk/react/Internal/classes/QueueManager

# QueueManager

Defined in: [src/lib/db/queue/manager.ts:114](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/queue/manager.ts#114)

## Constructors

### Constructor

> **new QueueManager**(): `QueueManager`

**Returns**

`QueueManager`

## Methods

### clear()

> **clear**(`walletAddress`: `string`): `void`

Defined in: [src/lib/db/queue/manager.ts:321](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/queue/manager.ts#321)

Clear all queued operations for a wallet.

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`walletAddress`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

***

### flush()

> **flush**(`encryptionContext`: [`QueueEncryptionContext`](../interfaces/QueueEncryptionContext.md), `executor`: [`OperationExecutor`](../type-aliases/OperationExecutor.md)): `Promise`<[`FlushResult`](../interfaces/FlushResult.md)>

Defined in: [src/lib/db/queue/manager.ts:215](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/queue/manager.ts#215)

Flush all queued operations for a wallet by executing them with encryption.

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`encryptionContext`

</td>
<td>

[`QueueEncryptionContext`](../interfaces/QueueEncryptionContext.md)

</td>
<td>

Wallet address and signing functions for encryption

</td>
</tr>
<tr>
<td>

`executor`

</td>
<td>

[`OperationExecutor`](../type-aliases/OperationExecutor.md)

</td>
<td>

Function that executes each operation against the database

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`FlushResult`](../interfaces/FlushResult.md)>

Result with succeeded/failed operation IDs

***

### getOperations()

> **getOperations**(`walletAddress`: `string`): [`QueuedOperation`](../interfaces/QueuedOperation.md)\[]

Defined in: [src/lib/db/queue/manager.ts:173](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/queue/manager.ts#173)

Get all pending operations for a wallet, sorted by dependency order.

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`walletAddress`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

[`QueuedOperation`](../interfaces/QueuedOperation.md)\[]

***

### getStatus()

> **getStatus**(`walletAddress`: `string`): [`QueueStatus`](../interfaces/QueueStatus.md)

Defined in: [src/lib/db/queue/manager.ts:196](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/queue/manager.ts#196)

Get the status of a wallet's queue.

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`walletAddress`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

[`QueueStatus`](../interfaces/QueueStatus.md)

***

### hasPending()

> **hasPending**(`walletAddress`: `string`): `boolean`

Defined in: [src/lib/db/queue/manager.ts:364](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/queue/manager.ts#364)

Check if a wallet has any pending operations.

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`walletAddress`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`boolean`

***

### onQueueChange()

> **onQueueChange**(`walletAddress`: `string`, `callback`: () => `void`): () => `void`

Defined in: [src/lib/db/queue/manager.ts:345](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/queue/manager.ts#345)

Register a listener for queue changes on a wallet.

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`walletAddress`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`callback`

</td>
<td>

() => `void`

</td>
</tr>
</tbody>
</table>

**Returns**

Unsubscribe function

> (): `void`

**Returns**

`void`

***

### pause()

> **pause**(`walletAddress`: `string`): `void`

Defined in: [src/lib/db/queue/manager.ts:330](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/queue/manager.ts#330)

Pause the queue for a wallet (stops flush mid-way).

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`walletAddress`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

***

### queueOperation()

> **queueOperation**(`walletAddress`: `string`, `type`: [`QueuedOperationType`](../type-aliases/QueuedOperationType.md), `payload`: `Record`<`string`, `any`>, `dependencies`: `string`\[], `maxRetries`: `number`): `string` | `null`

Defined in: [src/lib/db/queue/manager.ts:130](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/queue/manager.ts#130)

Queue a new operation for a wallet.

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Default value</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`walletAddress`

</td>
<td>

`string`

</td>
<td>

`undefined`

</td>
</tr>
<tr>
<td>

`type`

</td>
<td>

[`QueuedOperationType`](../type-aliases/QueuedOperationType.md)

</td>
<td>

`undefined`

</td>
</tr>
<tr>
<td>

`payload`

</td>
<td>

`Record`<`string`, `any`>

</td>
<td>

`undefined`

</td>
</tr>
<tr>
<td>

`dependencies`

</td>
<td>

`string`\[]

</td>
<td>

`[]`

</td>
</tr>
<tr>
<td>

`maxRetries`

</td>
<td>

`number`

</td>
<td>

`DEFAULT_MAX_RETRIES`

</td>
</tr>
</tbody>
</table>

**Returns**

`string` | `null`

The operation ID, or null if queue is full.

***

### removeOperation()

> **removeOperation**(`walletAddress`: `string`, `operationId`: `string`): `void`

Defined in: [src/lib/db/queue/manager.ts:182](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/queue/manager.ts#182)

Remove a specific operation from the queue.

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`walletAddress`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`operationId`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

***

### resume()

> **resume**(`walletAddress`: `string`): `void`

Defined in: [src/lib/db/queue/manager.ts:337](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/queue/manager.ts#337)

Resume the queue for a wallet.

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`walletAddress`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

---
Source: https://docs.anuma.ai/sdk/react/Internal/classes/SavedToolModel

# SavedToolModel

Defined in: [src/lib/db/savedTools/models.ts:9](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/savedTools/models.ts#9)

## Extends

* `default`

## Constructors

### Constructor

> **new SavedToolModel**(`collection`: `Collection`<`Model`>, `raw`: `_RawRecord`): `SavedTool`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:117

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`collection`

</td>
<td>

`Collection`<`Model`>

</td>
</tr>
<tr>
<td>

`raw`

</td>
<td>

`_RawRecord`

</td>
</tr>
</tbody>
</table>

**Returns**

`SavedTool`

**Inherited from**

`Model.constructor`

## Properties

### \_\_changes?

> `optional` **\_\_changes**: `BehaviorSubject`<`any`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:40

**Inherited from**

`Model.__changes`

***

### \_isEditing

> **\_isEditing**: `boolean`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:36

**Inherited from**

`Model._isEditing`

***

### \_preparedState

> **\_preparedState**: `"create"` | `"update"` | `"markAsDeleted"` | `"destroyPermanently"` | `null`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:38

**Inherited from**

`Model._preparedState`

***

### \_raw

> **\_raw**: `_RawRecord`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:34

**Inherited from**

`Model._raw`

***

### \_subscribers

> **\_subscribers**: \[(`isDeleted`: `boolean`) => `void`, `any`]\[]

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:125

**Inherited from**

`Model._subscribers`

***

### collection

> **collection**: `Collection`<`Model`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:88

**Inherited from**

`Model.collection`

***

### conversationId?

> `optional` **conversationId**: `string`

Defined in: [src/lib/db/savedTools/models.ts:20](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/savedTools/models.ts#20)

***

### createdAt

> **createdAt**: `Date`

Defined in: [src/lib/db/savedTools/models.ts:22](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/savedTools/models.ts#22)

***

### description

> **description**: `string`

Defined in: [src/lib/db/savedTools/models.ts:16](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/savedTools/models.ts#16)

***

### displayName

> **displayName**: `string`

Defined in: [src/lib/db/savedTools/models.ts:15](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/savedTools/models.ts#15)

***

### html

> **html**: `string`

Defined in: [src/lib/db/savedTools/models.ts:19](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/savedTools/models.ts#19)

***

### isDeleted

> **isDeleted**: `boolean`

Defined in: [src/lib/db/savedTools/models.ts:24](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/savedTools/models.ts#24)

***

### name

> **name**: `string`

Defined in: [src/lib/db/savedTools/models.ts:14](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/savedTools/models.ts#14)

***

### parameters

> **parameters**: `Record`<`string`, [`SavedToolParameter`](../interfaces/SavedToolParameter.md)>

Defined in: [src/lib/db/savedTools/models.ts:18](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/savedTools/models.ts#18)

***

### updatedAt

> **updatedAt**: `Date`

Defined in: [src/lib/db/savedTools/models.ts:23](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/savedTools/models.ts#23)

***

### \_wmelonTag

> `static` **\_wmelonTag**: `string`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:32

**Inherited from**

`Model._wmelonTag`

***

### associations

> `static` **associations**: `Associations` = `{}`

Defined in: [src/lib/db/savedTools/models.ts:12](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/savedTools/models.ts#12)

**Overrides**

`Model.associations`

***

### table

> `static` **table**: `string` = `"saved_tools"`

Defined in: [src/lib/db/savedTools/models.ts:10](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/savedTools/models.ts#10)

**Overrides**

`Model.table`

## Accessors

### asModel

**Get Signature**

> **get** **asModel**(): `this`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:97

**Returns**

`this`

**Inherited from**

`Model.asModel`

***

### collections

**Get Signature**

> **get** **collections**(): `CollectionMap`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:91

**Returns**

`CollectionMap`

**Inherited from**

`Model.collections`

***

### database

**Get Signature**

> **get** **database**(): `Database`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:93

**Returns**

`Database`

**Inherited from**

`Model.database`

***

### db

**Get Signature**

> **get** **db**(): `Database`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:95

**Returns**

`Database`

**Inherited from**

`Model.db`

***

### id

**Get Signature**

> **get** **id**(): `string`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:44

**Returns**

`string`

**Inherited from**

`Model.id`

***

### syncStatus

**Get Signature**

> **get** **syncStatus**(): `SyncStatus`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:46

**Returns**

`SyncStatus`

**Inherited from**

`Model.syncStatus`

***

### table

**Get Signature**

> **get** **table**(): `string`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:113

**Returns**

`string`

**Inherited from**

`Model.table`

## Methods

### \_\_ensureCanSetRaw()

> **\_\_ensureCanSetRaw**(): `void`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:141

**Returns**

`void`

**Inherited from**

`Model.__ensureCanSetRaw`

***

### \_\_ensureNotDisposable()

> **\_\_ensureNotDisposable**(`debugName`: `string`): `void`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:143

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`debugName`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

**Inherited from**

`Model.__ensureNotDisposable`

***

### \_dangerouslySetRawWithoutMarkingColumnChange()

> **\_dangerouslySetRawWithoutMarkingColumnChange**(`rawFieldName`: `string`, `rawValue`: `Value`): `void`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:139

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`rawFieldName`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`rawValue`

</td>
<td>

`Value`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

**Inherited from**

`Model._dangerouslySetRawWithoutMarkingColumnChange`

***

### \_getChanges()

> **\_getChanges**(): `BehaviorSubject`<`any`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:42

**Returns**

`BehaviorSubject`<`any`>

**Inherited from**

`Model._getChanges`

***

### \_getRaw()

> **\_getRaw**(`rawFieldName`: `string`): `Value`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:133

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`rawFieldName`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Value`

**Inherited from**

`Model._getRaw`

***

### \_notifyChanged()

> **\_notifyChanged**(): `void`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:129

**Returns**

`void`

**Inherited from**

`Model._notifyChanged`

***

### \_notifyDestroyed()

> **\_notifyDestroyed**(): `void`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:131

**Returns**

`void`

**Inherited from**

`Model._notifyDestroyed`

***

### \_setRaw()

> **\_setRaw**(`rawFieldName`: `string`, `rawValue`: `Value`): `void`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:135

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`rawFieldName`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`rawValue`

</td>
<td>

`Value`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

**Inherited from**

`Model._setRaw`

***

### batch()

> **batch**(...`records`: `$ReadOnlyArray`<`false` | `void` | `Model` | `null`>): `Promise`<`void`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:102

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

...`records`

</td>
<td>

`$ReadOnlyArray`<`false` | `void` | `Model` | `null`>

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`void`>

**Inherited from**

`Model.batch`

***

### callReader()

> **callReader**<`T`>(`action`: () => `Promise`<`T`>): `Promise`<`T`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:108

**Type Parameters**

<table>
<thead>
<tr>
<th>Type Parameter</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`T`

</td>
</tr>
</tbody>
</table>

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`action`

</td>
<td>

() => `Promise`<`T`>

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`T`>

**Inherited from**

`Model.callReader`

***

### callWriter()

> **callWriter**<`T`>(`action`: () => `Promise`<`T`>): `Promise`<`T`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:105

**Type Parameters**

<table>
<thead>
<tr>
<th>Type Parameter</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`T`

</td>
</tr>
</tbody>
</table>

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`action`

</td>
<td>

() => `Promise`<`T`>

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`T`>

**Inherited from**

`Model.callWriter`

***

### destroyPermanently()

> **destroyPermanently**(): `Promise`<`void`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:74

**Returns**

`Promise`<`void`>

**Inherited from**

`Model.destroyPermanently`

***

### experimentalDestroyPermanently()

> **experimentalDestroyPermanently**(): `Promise`<`void`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:78

**Returns**

`Promise`<`void`>

**Inherited from**

`Model.experimentalDestroyPermanently`

***

### experimentalMarkAsDeleted()

> **experimentalMarkAsDeleted**(): `Promise`<`void`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:76

**Returns**

`Promise`<`void`>

**Inherited from**

`Model.experimentalMarkAsDeleted`

***

### experimentalSubscribe()

> **experimentalSubscribe**(`subscriber`: (`isDeleted`: `boolean`) => `void`, `debugInfo?`: `any`): `Unsubscribe`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:127

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`subscriber`

</td>
<td>

(`isDeleted`: `boolean`) => `void`

</td>
</tr>
<tr>
<td>

`debugInfo?`

</td>
<td>

`any`

</td>
</tr>
</tbody>
</table>

**Returns**

`Unsubscribe`

**Inherited from**

`Model.experimentalSubscribe`

***

### markAsDeleted()

> **markAsDeleted**(): `Promise`<`void`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:70

**Returns**

`Promise`<`void`>

**Inherited from**

`Model.markAsDeleted`

***

### observe()

> **observe**(): `Observable`<`SavedTool`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:84

**Returns**

`Observable`<`SavedTool`>

**Inherited from**

`Model.observe`

***

### prepareDestroyPermanently()

> **prepareDestroyPermanently**(): `this`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:66

**Returns**

`this`

**Inherited from**

`Model.prepareDestroyPermanently`

***

### prepareMarkAsDeleted()

> **prepareMarkAsDeleted**(): `this`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:64

**Returns**

`this`

**Inherited from**

`Model.prepareMarkAsDeleted`

***

### prepareUpdate()

> **prepareUpdate**(`recordUpdater?`: (`_`: `this`) => `void`): `this`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:62

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`recordUpdater?`

</td>
<td>

(`_`: `this`) => `void`

</td>
</tr>
</tbody>
</table>

**Returns**

`this`

**Inherited from**

`Model.prepareUpdate`

***

### subAction()

> **subAction**<`T`>(`action`: () => `Promise`<`T`>): `Promise`<`T`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:111

**Type Parameters**

<table>
<thead>
<tr>
<th>Type Parameter</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`T`

</td>
</tr>
</tbody>
</table>

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`action`

</td>
<td>

() => `Promise`<`T`>

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`T`>

**Inherited from**

`Model.subAction`

***

### update()

> **update**(`recordUpdater?`: (`_`: `this`) => `void`): `Promise`<`SavedTool`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:55

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`recordUpdater?`

</td>
<td>

(`_`: `this`) => `void`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`SavedTool`>

**Inherited from**

`Model.update`

***

### \_disposableFromDirtyRaw()

> `static` **\_disposableFromDirtyRaw**(`collection`: `Collection`<`Model`>, `dirtyRaw`: `DirtyRaw`): `Model`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:123

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`collection`

</td>
<td>

`Collection`<`Model`>

</td>
</tr>
<tr>
<td>

`dirtyRaw`

</td>
<td>

`DirtyRaw`

</td>
</tr>
</tbody>
</table>

**Returns**

`Model`

**Inherited from**

`Model._disposableFromDirtyRaw`

***

### \_prepareCreate()

> `static` **\_prepareCreate**(`collection`: `Collection`<`Model`>, `recordBuilder`: (`_`: `Model`) => `void`): `Model`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:119

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`collection`

</td>
<td>

`Collection`<`Model`>

</td>
</tr>
<tr>
<td>

`recordBuilder`

</td>
<td>

(`_`: `Model`) => `void`

</td>
</tr>
</tbody>
</table>

**Returns**

`Model`

**Inherited from**

`Model._prepareCreate`

***

### \_prepareCreateFromDirtyRaw()

> `static` **\_prepareCreateFromDirtyRaw**(`collection`: `Collection`<`Model`>, `dirtyRaw`: `DirtyRaw`): `Model`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:121

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`collection`

</td>
<td>

`Collection`<`Model`>

</td>
</tr>
<tr>
<td>

`dirtyRaw`

</td>
<td>

`DirtyRaw`

</td>
</tr>
</tbody>
</table>

**Returns**

`Model`

**Inherited from**

`Model._prepareCreateFromDirtyRaw`

---
Source: https://docs.anuma.ai/sdk/react/Internal/classes/StoredMediaModel

# StoredMediaModel

Defined in: [src/lib/db/media/models.ts:11](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/models.ts#11)

WatermelonDB model for media records.
Represents files stored in the library (images, videos, audio, documents).

## Extends

* `default`

## Constructors

### Constructor

> **new StoredMediaModel**(`collection`: `Collection`<`Model`>, `raw`: `_RawRecord`): `Media`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:117

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`collection`

</td>
<td>

`Collection`<`Model`>

</td>
</tr>
<tr>
<td>

`raw`

</td>
<td>

`_RawRecord`

</td>
</tr>
</tbody>
</table>

**Returns**

`Media`

**Inherited from**

`Model.constructor`

## Properties

### \_\_changes?

> `optional` **\_\_changes**: `BehaviorSubject`<`any`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:40

**Inherited from**

`Model.__changes`

***

### \_isEditing

> **\_isEditing**: `boolean`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:36

**Inherited from**

`Model._isEditing`

***

### \_preparedState

> **\_preparedState**: `"create"` | `"update"` | `"markAsDeleted"` | `"destroyPermanently"` | `null`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:38

**Inherited from**

`Model._preparedState`

***

### \_raw

> **\_raw**: `_RawRecord`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:34

**Inherited from**

`Model._raw`

***

### \_subscribers

> **\_subscribers**: \[(`isDeleted`: `boolean`) => `void`, `any`]\[]

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:125

**Inherited from**

`Model._subscribers`

***

### collection

> **collection**: `Collection`<`Model`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:88

**Inherited from**

`Model.collection`

***

### conversationId?

> `optional` **conversationId**: `string`

Defined in: [src/lib/db/media/models.ts:23](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/models.ts#23)

***

### createdAt

> **createdAt**: `Date`

Defined in: [src/lib/db/media/models.ts:44](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/models.ts#44)

***

### dimensions?

> `optional` **dimensions**: [`MediaDimensions`](../interfaces/MediaDimensions.md)

Defined in: [src/lib/db/media/models.ts:39](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/models.ts#39)

***

### duration?

> `optional` **duration**: `number`

Defined in: [src/lib/db/media/models.ts:40](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/models.ts#40)

***

### isDeleted

> **isDeleted**: `boolean`

Defined in: [src/lib/db/media/models.ts:48](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/models.ts#48)

***

### mediaId

> **mediaId**: `string`

Defined in: [src/lib/db/media/models.ts:20](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/models.ts#20)

***

### mediaType

> **mediaType**: [`MediaType`](../type-aliases/MediaType.md)

Defined in: [src/lib/db/media/models.ts:28](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/models.ts#28)

***

### messageId?

> `optional` **messageId**: `string`

Defined in: [src/lib/db/media/models.ts:22](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/models.ts#22)

***

### metadata?

> `optional` **metadata**: [`MediaMetadata`](../interfaces/MediaMetadata.md)

Defined in: [src/lib/db/media/models.ts:41](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/models.ts#41)

***

### mimeType

> **mimeType**: `string`

Defined in: [src/lib/db/media/models.ts:27](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/models.ts#27)

***

### model?

> `optional` **model**: `string`

Defined in: [src/lib/db/media/models.ts:33](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/models.ts#33)

***

### name

> **name**: `string`

Defined in: [src/lib/db/media/models.ts:26](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/models.ts#26)

***

### role

> **role**: [`MediaRole`](../type-aliases/MediaRole.md)

Defined in: [src/lib/db/media/models.ts:32](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/models.ts#32)

***

### size

> **size**: `number`

Defined in: [src/lib/db/media/models.ts:29](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/models.ts#29)

***

### sourceUrl?

> `optional` **sourceUrl**: `string`

Defined in: [src/lib/db/media/models.ts:36](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/models.ts#36)

***

### updatedAt

> **updatedAt**: `Date`

Defined in: [src/lib/db/media/models.ts:45](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/models.ts#45)

***

### walletAddress

> **walletAddress**: `string`

Defined in: [src/lib/db/media/models.ts:21](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/models.ts#21)

***

### \_wmelonTag

> `static` **\_wmelonTag**: `string`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:32

**Inherited from**

`Model._wmelonTag`

***

### associations

> `static` **associations**: `Associations`

Defined in: [src/lib/db/media/models.ts:14](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/models.ts#14)

**Overrides**

`Model.associations`

***

### table

> `static` **table**: `string` = `"media"`

Defined in: [src/lib/db/media/models.ts:12](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/models.ts#12)

**Overrides**

`Model.table`

## Accessors

### asModel

**Get Signature**

> **get** **asModel**(): `this`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:97

**Returns**

`this`

**Inherited from**

`Model.asModel`

***

### collections

**Get Signature**

> **get** **collections**(): `CollectionMap`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:91

**Returns**

`CollectionMap`

**Inherited from**

`Model.collections`

***

### database

**Get Signature**

> **get** **database**(): `Database`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:93

**Returns**

`Database`

**Inherited from**

`Model.database`

***

### db

**Get Signature**

> **get** **db**(): `Database`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:95

**Returns**

`Database`

**Inherited from**

`Model.db`

***

### id

**Get Signature**

> **get** **id**(): `string`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:44

**Returns**

`string`

**Inherited from**

`Model.id`

***

### syncStatus

**Get Signature**

> **get** **syncStatus**(): `SyncStatus`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:46

**Returns**

`SyncStatus`

**Inherited from**

`Model.syncStatus`

***

### table

**Get Signature**

> **get** **table**(): `string`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:113

**Returns**

`string`

**Inherited from**

`Model.table`

## Methods

### \_\_ensureCanSetRaw()

> **\_\_ensureCanSetRaw**(): `void`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:141

**Returns**

`void`

**Inherited from**

`Model.__ensureCanSetRaw`

***

### \_\_ensureNotDisposable()

> **\_\_ensureNotDisposable**(`debugName`: `string`): `void`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:143

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`debugName`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

**Inherited from**

`Model.__ensureNotDisposable`

***

### \_dangerouslySetRawWithoutMarkingColumnChange()

> **\_dangerouslySetRawWithoutMarkingColumnChange**(`rawFieldName`: `string`, `rawValue`: `Value`): `void`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:139

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`rawFieldName`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`rawValue`

</td>
<td>

`Value`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

**Inherited from**

`Model._dangerouslySetRawWithoutMarkingColumnChange`

***

### \_getChanges()

> **\_getChanges**(): `BehaviorSubject`<`any`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:42

**Returns**

`BehaviorSubject`<`any`>

**Inherited from**

`Model._getChanges`

***

### \_getRaw()

> **\_getRaw**(`rawFieldName`: `string`): `Value`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:133

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`rawFieldName`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Value`

**Inherited from**

`Model._getRaw`

***

### \_notifyChanged()

> **\_notifyChanged**(): `void`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:129

**Returns**

`void`

**Inherited from**

`Model._notifyChanged`

***

### \_notifyDestroyed()

> **\_notifyDestroyed**(): `void`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:131

**Returns**

`void`

**Inherited from**

`Model._notifyDestroyed`

***

### \_setRaw()

> **\_setRaw**(`rawFieldName`: `string`, `rawValue`: `Value`): `void`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:135

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`rawFieldName`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`rawValue`

</td>
<td>

`Value`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

**Inherited from**

`Model._setRaw`

***

### batch()

> **batch**(...`records`: `$ReadOnlyArray`<`false` | `void` | `Model` | `null`>): `Promise`<`void`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:102

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

...`records`

</td>
<td>

`$ReadOnlyArray`<`false` | `void` | `Model` | `null`>

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`void`>

**Inherited from**

`Model.batch`

***

### callReader()

> **callReader**<`T`>(`action`: () => `Promise`<`T`>): `Promise`<`T`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:108

**Type Parameters**

<table>
<thead>
<tr>
<th>Type Parameter</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`T`

</td>
</tr>
</tbody>
</table>

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`action`

</td>
<td>

() => `Promise`<`T`>

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`T`>

**Inherited from**

`Model.callReader`

***

### callWriter()

> **callWriter**<`T`>(`action`: () => `Promise`<`T`>): `Promise`<`T`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:105

**Type Parameters**

<table>
<thead>
<tr>
<th>Type Parameter</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`T`

</td>
</tr>
</tbody>
</table>

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`action`

</td>
<td>

() => `Promise`<`T`>

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`T`>

**Inherited from**

`Model.callWriter`

***

### destroyPermanently()

> **destroyPermanently**(): `Promise`<`void`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:74

**Returns**

`Promise`<`void`>

**Inherited from**

`Model.destroyPermanently`

***

### experimentalDestroyPermanently()

> **experimentalDestroyPermanently**(): `Promise`<`void`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:78

**Returns**

`Promise`<`void`>

**Inherited from**

`Model.experimentalDestroyPermanently`

***

### experimentalMarkAsDeleted()

> **experimentalMarkAsDeleted**(): `Promise`<`void`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:76

**Returns**

`Promise`<`void`>

**Inherited from**

`Model.experimentalMarkAsDeleted`

***

### experimentalSubscribe()

> **experimentalSubscribe**(`subscriber`: (`isDeleted`: `boolean`) => `void`, `debugInfo?`: `any`): `Unsubscribe`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:127

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`subscriber`

</td>
<td>

(`isDeleted`: `boolean`) => `void`

</td>
</tr>
<tr>
<td>

`debugInfo?`

</td>
<td>

`any`

</td>
</tr>
</tbody>
</table>

**Returns**

`Unsubscribe`

**Inherited from**

`Model.experimentalSubscribe`

***

### markAsDeleted()

> **markAsDeleted**(): `Promise`<`void`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:70

**Returns**

`Promise`<`void`>

**Inherited from**

`Model.markAsDeleted`

***

### observe()

> **observe**(): `Observable`<`Media`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:84

**Returns**

`Observable`<`Media`>

**Inherited from**

`Model.observe`

***

### prepareDestroyPermanently()

> **prepareDestroyPermanently**(): `this`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:66

**Returns**

`this`

**Inherited from**

`Model.prepareDestroyPermanently`

***

### prepareMarkAsDeleted()

> **prepareMarkAsDeleted**(): `this`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:64

**Returns**

`this`

**Inherited from**

`Model.prepareMarkAsDeleted`

***

### prepareUpdate()

> **prepareUpdate**(`recordUpdater?`: (`_`: `this`) => `void`): `this`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:62

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`recordUpdater?`

</td>
<td>

(`_`: `this`) => `void`

</td>
</tr>
</tbody>
</table>

**Returns**

`this`

**Inherited from**

`Model.prepareUpdate`

***

### subAction()

> **subAction**<`T`>(`action`: () => `Promise`<`T`>): `Promise`<`T`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:111

**Type Parameters**

<table>
<thead>
<tr>
<th>Type Parameter</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`T`

</td>
</tr>
</tbody>
</table>

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`action`

</td>
<td>

() => `Promise`<`T`>

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`T`>

**Inherited from**

`Model.subAction`

***

### update()

> **update**(`recordUpdater?`: (`_`: `this`) => `void`): `Promise`<`Media`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:55

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`recordUpdater?`

</td>
<td>

(`_`: `this`) => `void`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`Media`>

**Inherited from**

`Model.update`

***

### \_disposableFromDirtyRaw()

> `static` **\_disposableFromDirtyRaw**(`collection`: `Collection`<`Model`>, `dirtyRaw`: `DirtyRaw`): `Model`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:123

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`collection`

</td>
<td>

`Collection`<`Model`>

</td>
</tr>
<tr>
<td>

`dirtyRaw`

</td>
<td>

`DirtyRaw`

</td>
</tr>
</tbody>
</table>

**Returns**

`Model`

**Inherited from**

`Model._disposableFromDirtyRaw`

***

### \_prepareCreate()

> `static` **\_prepareCreate**(`collection`: `Collection`<`Model`>, `recordBuilder`: (`_`: `Model`) => `void`): `Model`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:119

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`collection`

</td>
<td>

`Collection`<`Model`>

</td>
</tr>
<tr>
<td>

`recordBuilder`

</td>
<td>

(`_`: `Model`) => `void`

</td>
</tr>
</tbody>
</table>

**Returns**

`Model`

**Inherited from**

`Model._prepareCreate`

***

### \_prepareCreateFromDirtyRaw()

> `static` **\_prepareCreateFromDirtyRaw**(`collection`: `Collection`<`Model`>, `dirtyRaw`: `DirtyRaw`): `Model`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:121

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`collection`

</td>
<td>

`Collection`<`Model`>

</td>
</tr>
<tr>
<td>

`dirtyRaw`

</td>
<td>

`DirtyRaw`

</td>
</tr>
</tbody>
</table>

**Returns**

`Model`

**Inherited from**

`Model._prepareCreateFromDirtyRaw`

---
Source: https://docs.anuma.ai/sdk/react/Internal/classes/StoredModelPreferenceModel

# StoredModelPreferenceModel

Defined in: [src/lib/db/settings/models.ts:4](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/settings/models.ts#4)

## Extends

* `default`

## Constructors

### Constructor

> **new StoredModelPreferenceModel**(`collection`: `Collection`<`Model`>, `raw`: `_RawRecord`): `ModelPreference`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:117

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`collection`

</td>
<td>

`Collection`<`Model`>

</td>
</tr>
<tr>
<td>

`raw`

</td>
<td>

`_RawRecord`

</td>
</tr>
</tbody>
</table>

**Returns**

`ModelPreference`

**Inherited from**

`Model.constructor`

## Properties

### \_\_changes?

> `optional` **\_\_changes**: `BehaviorSubject`<`any`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:40

**Inherited from**

`Model.__changes`

***

### \_isEditing

> **\_isEditing**: `boolean`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:36

**Inherited from**

`Model._isEditing`

***

### \_preparedState

> **\_preparedState**: `"create"` | `"update"` | `"markAsDeleted"` | `"destroyPermanently"` | `null`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:38

**Inherited from**

`Model._preparedState`

***

### \_raw

> **\_raw**: `_RawRecord`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:34

**Inherited from**

`Model._raw`

***

### \_subscribers

> **\_subscribers**: \[(`isDeleted`: `boolean`) => `void`, `any`]\[]

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:125

**Inherited from**

`Model._subscribers`

***

### collection

> **collection**: `Collection`<`Model`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:88

**Inherited from**

`Model.collection`

***

### models?

> `optional` **models**: `string`

Defined in: [src/lib/db/settings/models.ts:8](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/settings/models.ts#8)

***

### walletAddress

> **walletAddress**: `string`

Defined in: [src/lib/db/settings/models.ts:7](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/settings/models.ts#7)

***

### \_wmelonTag

> `static` **\_wmelonTag**: `string`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:32

**Inherited from**

`Model._wmelonTag`

***

### associations

> `static` **associations**: `Associations`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:29

**Inherited from**

`Model.associations`

***

### table

> `static` **table**: `string` = `"modelPreferences"`

Defined in: [src/lib/db/settings/models.ts:5](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/settings/models.ts#5)

**Overrides**

`Model.table`

## Accessors

### asModel

**Get Signature**

> **get** **asModel**(): `this`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:97

**Returns**

`this`

**Inherited from**

`Model.asModel`

***

### collections

**Get Signature**

> **get** **collections**(): `CollectionMap`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:91

**Returns**

`CollectionMap`

**Inherited from**

`Model.collections`

***

### database

**Get Signature**

> **get** **database**(): `Database`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:93

**Returns**

`Database`

**Inherited from**

`Model.database`

***

### db

**Get Signature**

> **get** **db**(): `Database`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:95

**Returns**

`Database`

**Inherited from**

`Model.db`

***

### id

**Get Signature**

> **get** **id**(): `string`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:44

**Returns**

`string`

**Inherited from**

`Model.id`

***

### syncStatus

**Get Signature**

> **get** **syncStatus**(): `SyncStatus`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:46

**Returns**

`SyncStatus`

**Inherited from**

`Model.syncStatus`

***

### table

**Get Signature**

> **get** **table**(): `string`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:113

**Returns**

`string`

**Inherited from**

`Model.table`

## Methods

### \_\_ensureCanSetRaw()

> **\_\_ensureCanSetRaw**(): `void`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:141

**Returns**

`void`

**Inherited from**

`Model.__ensureCanSetRaw`

***

### \_\_ensureNotDisposable()

> **\_\_ensureNotDisposable**(`debugName`: `string`): `void`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:143

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`debugName`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

**Inherited from**

`Model.__ensureNotDisposable`

***

### \_dangerouslySetRawWithoutMarkingColumnChange()

> **\_dangerouslySetRawWithoutMarkingColumnChange**(`rawFieldName`: `string`, `rawValue`: `Value`): `void`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:139

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`rawFieldName`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`rawValue`

</td>
<td>

`Value`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

**Inherited from**

`Model._dangerouslySetRawWithoutMarkingColumnChange`

***

### \_getChanges()

> **\_getChanges**(): `BehaviorSubject`<`any`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:42

**Returns**

`BehaviorSubject`<`any`>

**Inherited from**

`Model._getChanges`

***

### \_getRaw()

> **\_getRaw**(`rawFieldName`: `string`): `Value`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:133

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`rawFieldName`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Value`

**Inherited from**

`Model._getRaw`

***

### \_notifyChanged()

> **\_notifyChanged**(): `void`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:129

**Returns**

`void`

**Inherited from**

`Model._notifyChanged`

***

### \_notifyDestroyed()

> **\_notifyDestroyed**(): `void`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:131

**Returns**

`void`

**Inherited from**

`Model._notifyDestroyed`

***

### \_setRaw()

> **\_setRaw**(`rawFieldName`: `string`, `rawValue`: `Value`): `void`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:135

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`rawFieldName`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`rawValue`

</td>
<td>

`Value`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

**Inherited from**

`Model._setRaw`

***

### batch()

> **batch**(...`records`: `$ReadOnlyArray`<`false` | `void` | `Model` | `null`>): `Promise`<`void`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:102

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

...`records`

</td>
<td>

`$ReadOnlyArray`<`false` | `void` | `Model` | `null`>

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`void`>

**Inherited from**

`Model.batch`

***

### callReader()

> **callReader**<`T`>(`action`: () => `Promise`<`T`>): `Promise`<`T`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:108

**Type Parameters**

<table>
<thead>
<tr>
<th>Type Parameter</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`T`

</td>
</tr>
</tbody>
</table>

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`action`

</td>
<td>

() => `Promise`<`T`>

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`T`>

**Inherited from**

`Model.callReader`

***

### callWriter()

> **callWriter**<`T`>(`action`: () => `Promise`<`T`>): `Promise`<`T`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:105

**Type Parameters**

<table>
<thead>
<tr>
<th>Type Parameter</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`T`

</td>
</tr>
</tbody>
</table>

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`action`

</td>
<td>

() => `Promise`<`T`>

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`T`>

**Inherited from**

`Model.callWriter`

***

### destroyPermanently()

> **destroyPermanently**(): `Promise`<`void`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:74

**Returns**

`Promise`<`void`>

**Inherited from**

`Model.destroyPermanently`

***

### experimentalDestroyPermanently()

> **experimentalDestroyPermanently**(): `Promise`<`void`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:78

**Returns**

`Promise`<`void`>

**Inherited from**

`Model.experimentalDestroyPermanently`

***

### experimentalMarkAsDeleted()

> **experimentalMarkAsDeleted**(): `Promise`<`void`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:76

**Returns**

`Promise`<`void`>

**Inherited from**

`Model.experimentalMarkAsDeleted`

***

### experimentalSubscribe()

> **experimentalSubscribe**(`subscriber`: (`isDeleted`: `boolean`) => `void`, `debugInfo?`: `any`): `Unsubscribe`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:127

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`subscriber`

</td>
<td>

(`isDeleted`: `boolean`) => `void`

</td>
</tr>
<tr>
<td>

`debugInfo?`

</td>
<td>

`any`

</td>
</tr>
</tbody>
</table>

**Returns**

`Unsubscribe`

**Inherited from**

`Model.experimentalSubscribe`

***

### markAsDeleted()

> **markAsDeleted**(): `Promise`<`void`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:70

**Returns**

`Promise`<`void`>

**Inherited from**

`Model.markAsDeleted`

***

### observe()

> **observe**(): `Observable`<`ModelPreference`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:84

**Returns**

`Observable`<`ModelPreference`>

**Inherited from**

`Model.observe`

***

### prepareDestroyPermanently()

> **prepareDestroyPermanently**(): `this`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:66

**Returns**

`this`

**Inherited from**

`Model.prepareDestroyPermanently`

***

### prepareMarkAsDeleted()

> **prepareMarkAsDeleted**(): `this`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:64

**Returns**

`this`

**Inherited from**

`Model.prepareMarkAsDeleted`

***

### prepareUpdate()

> **prepareUpdate**(`recordUpdater?`: (`_`: `this`) => `void`): `this`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:62

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`recordUpdater?`

</td>
<td>

(`_`: `this`) => `void`

</td>
</tr>
</tbody>
</table>

**Returns**

`this`

**Inherited from**

`Model.prepareUpdate`

***

### subAction()

> **subAction**<`T`>(`action`: () => `Promise`<`T`>): `Promise`<`T`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:111

**Type Parameters**

<table>
<thead>
<tr>
<th>Type Parameter</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`T`

</td>
</tr>
</tbody>
</table>

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`action`

</td>
<td>

() => `Promise`<`T`>

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`T`>

**Inherited from**

`Model.subAction`

***

### update()

> **update**(`recordUpdater?`: (`_`: `this`) => `void`): `Promise`<`ModelPreference`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:55

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`recordUpdater?`

</td>
<td>

(`_`: `this`) => `void`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`ModelPreference`>

**Inherited from**

`Model.update`

***

### \_disposableFromDirtyRaw()

> `static` **\_disposableFromDirtyRaw**(`collection`: `Collection`<`Model`>, `dirtyRaw`: `DirtyRaw`): `Model`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:123

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`collection`

</td>
<td>

`Collection`<`Model`>

</td>
</tr>
<tr>
<td>

`dirtyRaw`

</td>
<td>

`DirtyRaw`

</td>
</tr>
</tbody>
</table>

**Returns**

`Model`

**Inherited from**

`Model._disposableFromDirtyRaw`

***

### \_prepareCreate()

> `static` **\_prepareCreate**(`collection`: `Collection`<`Model`>, `recordBuilder`: (`_`: `Model`) => `void`): `Model`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:119

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`collection`

</td>
<td>

`Collection`<`Model`>

</td>
</tr>
<tr>
<td>

`recordBuilder`

</td>
<td>

(`_`: `Model`) => `void`

</td>
</tr>
</tbody>
</table>

**Returns**

`Model`

**Inherited from**

`Model._prepareCreate`

***

### \_prepareCreateFromDirtyRaw()

> `static` **\_prepareCreateFromDirtyRaw**(`collection`: `Collection`<`Model`>, `dirtyRaw`: `DirtyRaw`): `Model`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:121

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`collection`

</td>
<td>

`Collection`<`Model`>

</td>
</tr>
<tr>
<td>

`dirtyRaw`

</td>
<td>

`DirtyRaw`

</td>
</tr>
</tbody>
</table>

**Returns**

`Model`

**Inherited from**

`Model._prepareCreateFromDirtyRaw`

---
Source: https://docs.anuma.ai/sdk/react/Internal/classes/StoredUserPreferenceModel

# StoredUserPreferenceModel

Defined in: [src/lib/db/userPreferences/models.ts:10](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/userPreferences/models.ts#10)

WatermelonDB model for user preferences.

Stores unified user preferences including profile data, model preferences,
and personality settings.

## Extends

* `default`

## Constructors

### Constructor

> **new StoredUserPreferenceModel**(`collection`: `Collection`<`Model`>, `raw`: `_RawRecord`): `UserPreference`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:117

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`collection`

</td>
<td>

`Collection`<`Model`>

</td>
</tr>
<tr>
<td>

`raw`

</td>
<td>

`_RawRecord`

</td>
</tr>
</tbody>
</table>

**Returns**

`UserPreference`

**Inherited from**

`Model.constructor`

## Properties

### \_\_changes?

> `optional` **\_\_changes**: `BehaviorSubject`<`any`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:40

**Inherited from**

`Model.__changes`

***

### \_isEditing

> **\_isEditing**: `boolean`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:36

**Inherited from**

`Model._isEditing`

***

### \_preparedState

> **\_preparedState**: `"create"` | `"update"` | `"markAsDeleted"` | `"destroyPermanently"` | `null`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:38

**Inherited from**

`Model._preparedState`

***

### \_raw

> **\_raw**: `_RawRecord`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:34

**Inherited from**

`Model._raw`

***

### \_subscribers

> **\_subscribers**: \[(`isDeleted`: `boolean`) => `void`, `any`]\[]

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:125

**Inherited from**

`Model._subscribers`

***

### collection

> **collection**: `Collection`<`Model`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:88

**Inherited from**

`Model.collection`

***

### createdAt

> **createdAt**: `number`

Defined in: [src/lib/db/userPreferences/models.ts:26](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/userPreferences/models.ts#26)

***

### description?

> `optional` **description**: `string`

Defined in: [src/lib/db/userPreferences/models.ts:19](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/userPreferences/models.ts#19)

***

### models?

> `optional` **models**: `string`

Defined in: [src/lib/db/userPreferences/models.ts:22](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/userPreferences/models.ts#22)

***

### nickname?

> `optional` **nickname**: `string`

Defined in: [src/lib/db/userPreferences/models.ts:17](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/userPreferences/models.ts#17)

***

### occupation?

> `optional` **occupation**: `string`

Defined in: [src/lib/db/userPreferences/models.ts:18](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/userPreferences/models.ts#18)

***

### personality?

> `optional` **personality**: `string`

Defined in: [src/lib/db/userPreferences/models.ts:23](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/userPreferences/models.ts#23)

***

### updatedAt

> **updatedAt**: `number`

Defined in: [src/lib/db/userPreferences/models.ts:27](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/userPreferences/models.ts#27)

***

### walletAddress

> **walletAddress**: `string`

Defined in: [src/lib/db/userPreferences/models.ts:14](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/userPreferences/models.ts#14)

***

### \_wmelonTag

> `static` **\_wmelonTag**: `string`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:32

**Inherited from**

`Model._wmelonTag`

***

### associations

> `static` **associations**: `Associations`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:29

**Inherited from**

`Model.associations`

***

### table

> `static` **table**: `string` = `"userPreferences"`

Defined in: [src/lib/db/userPreferences/models.ts:11](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/userPreferences/models.ts#11)

**Overrides**

`Model.table`

## Accessors

### asModel

**Get Signature**

> **get** **asModel**(): `this`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:97

**Returns**

`this`

**Inherited from**

`Model.asModel`

***

### collections

**Get Signature**

> **get** **collections**(): `CollectionMap`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:91

**Returns**

`CollectionMap`

**Inherited from**

`Model.collections`

***

### database

**Get Signature**

> **get** **database**(): `Database`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:93

**Returns**

`Database`

**Inherited from**

`Model.database`

***

### db

**Get Signature**

> **get** **db**(): `Database`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:95

**Returns**

`Database`

**Inherited from**

`Model.db`

***

### id

**Get Signature**

> **get** **id**(): `string`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:44

**Returns**

`string`

**Inherited from**

`Model.id`

***

### syncStatus

**Get Signature**

> **get** **syncStatus**(): `SyncStatus`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:46

**Returns**

`SyncStatus`

**Inherited from**

`Model.syncStatus`

***

### table

**Get Signature**

> **get** **table**(): `string`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:113

**Returns**

`string`

**Inherited from**

`Model.table`

## Methods

### \_\_ensureCanSetRaw()

> **\_\_ensureCanSetRaw**(): `void`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:141

**Returns**

`void`

**Inherited from**

`Model.__ensureCanSetRaw`

***

### \_\_ensureNotDisposable()

> **\_\_ensureNotDisposable**(`debugName`: `string`): `void`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:143

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`debugName`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

**Inherited from**

`Model.__ensureNotDisposable`

***

### \_dangerouslySetRawWithoutMarkingColumnChange()

> **\_dangerouslySetRawWithoutMarkingColumnChange**(`rawFieldName`: `string`, `rawValue`: `Value`): `void`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:139

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`rawFieldName`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`rawValue`

</td>
<td>

`Value`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

**Inherited from**

`Model._dangerouslySetRawWithoutMarkingColumnChange`

***

### \_getChanges()

> **\_getChanges**(): `BehaviorSubject`<`any`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:42

**Returns**

`BehaviorSubject`<`any`>

**Inherited from**

`Model._getChanges`

***

### \_getRaw()

> **\_getRaw**(`rawFieldName`: `string`): `Value`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:133

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`rawFieldName`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Value`

**Inherited from**

`Model._getRaw`

***

### \_notifyChanged()

> **\_notifyChanged**(): `void`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:129

**Returns**

`void`

**Inherited from**

`Model._notifyChanged`

***

### \_notifyDestroyed()

> **\_notifyDestroyed**(): `void`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:131

**Returns**

`void`

**Inherited from**

`Model._notifyDestroyed`

***

### \_setRaw()

> **\_setRaw**(`rawFieldName`: `string`, `rawValue`: `Value`): `void`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:135

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`rawFieldName`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`rawValue`

</td>
<td>

`Value`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

**Inherited from**

`Model._setRaw`

***

### batch()

> **batch**(...`records`: `$ReadOnlyArray`<`false` | `void` | `Model` | `null`>): `Promise`<`void`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:102

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

...`records`

</td>
<td>

`$ReadOnlyArray`<`false` | `void` | `Model` | `null`>

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`void`>

**Inherited from**

`Model.batch`

***

### callReader()

> **callReader**<`T`>(`action`: () => `Promise`<`T`>): `Promise`<`T`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:108

**Type Parameters**

<table>
<thead>
<tr>
<th>Type Parameter</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`T`

</td>
</tr>
</tbody>
</table>

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`action`

</td>
<td>

() => `Promise`<`T`>

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`T`>

**Inherited from**

`Model.callReader`

***

### callWriter()

> **callWriter**<`T`>(`action`: () => `Promise`<`T`>): `Promise`<`T`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:105

**Type Parameters**

<table>
<thead>
<tr>
<th>Type Parameter</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`T`

</td>
</tr>
</tbody>
</table>

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`action`

</td>
<td>

() => `Promise`<`T`>

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`T`>

**Inherited from**

`Model.callWriter`

***

### destroyPermanently()

> **destroyPermanently**(): `Promise`<`void`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:74

**Returns**

`Promise`<`void`>

**Inherited from**

`Model.destroyPermanently`

***

### experimentalDestroyPermanently()

> **experimentalDestroyPermanently**(): `Promise`<`void`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:78

**Returns**

`Promise`<`void`>

**Inherited from**

`Model.experimentalDestroyPermanently`

***

### experimentalMarkAsDeleted()

> **experimentalMarkAsDeleted**(): `Promise`<`void`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:76

**Returns**

`Promise`<`void`>

**Inherited from**

`Model.experimentalMarkAsDeleted`

***

### experimentalSubscribe()

> **experimentalSubscribe**(`subscriber`: (`isDeleted`: `boolean`) => `void`, `debugInfo?`: `any`): `Unsubscribe`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:127

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`subscriber`

</td>
<td>

(`isDeleted`: `boolean`) => `void`

</td>
</tr>
<tr>
<td>

`debugInfo?`

</td>
<td>

`any`

</td>
</tr>
</tbody>
</table>

**Returns**

`Unsubscribe`

**Inherited from**

`Model.experimentalSubscribe`

***

### markAsDeleted()

> **markAsDeleted**(): `Promise`<`void`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:70

**Returns**

`Promise`<`void`>

**Inherited from**

`Model.markAsDeleted`

***

### observe()

> **observe**(): `Observable`<`UserPreference`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:84

**Returns**

`Observable`<`UserPreference`>

**Inherited from**

`Model.observe`

***

### prepareDestroyPermanently()

> **prepareDestroyPermanently**(): `this`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:66

**Returns**

`this`

**Inherited from**

`Model.prepareDestroyPermanently`

***

### prepareMarkAsDeleted()

> **prepareMarkAsDeleted**(): `this`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:64

**Returns**

`this`

**Inherited from**

`Model.prepareMarkAsDeleted`

***

### prepareUpdate()

> **prepareUpdate**(`recordUpdater?`: (`_`: `this`) => `void`): `this`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:62

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`recordUpdater?`

</td>
<td>

(`_`: `this`) => `void`

</td>
</tr>
</tbody>
</table>

**Returns**

`this`

**Inherited from**

`Model.prepareUpdate`

***

### subAction()

> **subAction**<`T`>(`action`: () => `Promise`<`T`>): `Promise`<`T`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:111

**Type Parameters**

<table>
<thead>
<tr>
<th>Type Parameter</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`T`

</td>
</tr>
</tbody>
</table>

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`action`

</td>
<td>

() => `Promise`<`T`>

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`T`>

**Inherited from**

`Model.subAction`

***

### update()

> **update**(`recordUpdater?`: (`_`: `this`) => `void`): `Promise`<`UserPreference`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:55

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`recordUpdater?`

</td>
<td>

(`_`: `this`) => `void`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`UserPreference`>

**Inherited from**

`Model.update`

***

### \_disposableFromDirtyRaw()

> `static` **\_disposableFromDirtyRaw**(`collection`: `Collection`<`Model`>, `dirtyRaw`: `DirtyRaw`): `Model`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:123

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`collection`

</td>
<td>

`Collection`<`Model`>

</td>
</tr>
<tr>
<td>

`dirtyRaw`

</td>
<td>

`DirtyRaw`

</td>
</tr>
</tbody>
</table>

**Returns**

`Model`

**Inherited from**

`Model._disposableFromDirtyRaw`

***

### \_prepareCreate()

> `static` **\_prepareCreate**(`collection`: `Collection`<`Model`>, `recordBuilder`: (`_`: `Model`) => `void`): `Model`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:119

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`collection`

</td>
<td>

`Collection`<`Model`>

</td>
</tr>
<tr>
<td>

`recordBuilder`

</td>
<td>

(`_`: `Model`) => `void`

</td>
</tr>
</tbody>
</table>

**Returns**

`Model`

**Inherited from**

`Model._prepareCreate`

***

### \_prepareCreateFromDirtyRaw()

> `static` **\_prepareCreateFromDirtyRaw**(`collection`: `Collection`<`Model`>, `dirtyRaw`: `DirtyRaw`): `Model`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:121

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`collection`

</td>
<td>

`Collection`<`Model`>

</td>
</tr>
<tr>
<td>

`dirtyRaw`

</td>
<td>

`DirtyRaw`

</td>
</tr>
</tbody>
</table>

**Returns**

`Model`

**Inherited from**

`Model._prepareCreateFromDirtyRaw`

---
Source: https://docs.anuma.ai/sdk/react/Internal/classes/StoredVaultFolderModel

# StoredVaultFolderModel

Defined in: [src/lib/db/vaultFolders/models.ts:4](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/vaultFolders/models.ts#4)

## Extends

* `default`

## Constructors

### Constructor

> **new StoredVaultFolderModel**(`collection`: `Collection`<`Model`>, `raw`: `_RawRecord`): `VaultFolder`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:117

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`collection`

</td>
<td>

`Collection`<`Model`>

</td>
</tr>
<tr>
<td>

`raw`

</td>
<td>

`_RawRecord`

</td>
</tr>
</tbody>
</table>

**Returns**

`VaultFolder`

**Inherited from**

`Model.constructor`

## Properties

### \_\_changes?

> `optional` **\_\_changes**: `BehaviorSubject`<`any`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:40

**Inherited from**

`Model.__changes`

***

### \_isEditing

> **\_isEditing**: `boolean`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:36

**Inherited from**

`Model._isEditing`

***

### \_preparedState

> **\_preparedState**: `"create"` | `"update"` | `"markAsDeleted"` | `"destroyPermanently"` | `null`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:38

**Inherited from**

`Model._preparedState`

***

### \_raw

> **\_raw**: `_RawRecord`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:34

**Inherited from**

`Model._raw`

***

### \_subscribers

> **\_subscribers**: \[(`isDeleted`: `boolean`) => `void`, `any`]\[]

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:125

**Inherited from**

`Model._subscribers`

***

### collection

> **collection**: `Collection`<`Model`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:88

**Inherited from**

`Model.collection`

***

### context

> **context**: `string` | `null`

Defined in: [src/lib/db/vaultFolders/models.ts:13](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/vaultFolders/models.ts#13)

***

### createdAt

> **createdAt**: `Date`

Defined in: [src/lib/db/vaultFolders/models.ts:9](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/vaultFolders/models.ts#9)

***

### isDeleted

> **isDeleted**: `boolean`

Defined in: [src/lib/db/vaultFolders/models.ts:11](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/vaultFolders/models.ts#11)

***

### isSystem

> **isSystem**: `boolean`

Defined in: [src/lib/db/vaultFolders/models.ts:12](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/vaultFolders/models.ts#12)

***

### name

> **name**: `string`

Defined in: [src/lib/db/vaultFolders/models.ts:7](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/vaultFolders/models.ts#7)

***

### scope

> **scope**: `string`

Defined in: [src/lib/db/vaultFolders/models.ts:8](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/vaultFolders/models.ts#8)

***

### updatedAt

> **updatedAt**: `Date`

Defined in: [src/lib/db/vaultFolders/models.ts:10](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/vaultFolders/models.ts#10)

***

### \_wmelonTag

> `static` **\_wmelonTag**: `string`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:32

**Inherited from**

`Model._wmelonTag`

***

### associations

> `static` **associations**: `Associations`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:29

**Inherited from**

`Model.associations`

***

### table

> `static` **table**: `string` = `"vault_folders"`

Defined in: [src/lib/db/vaultFolders/models.ts:5](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/vaultFolders/models.ts#5)

**Overrides**

`Model.table`

## Accessors

### asModel

**Get Signature**

> **get** **asModel**(): `this`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:97

**Returns**

`this`

**Inherited from**

`Model.asModel`

***

### collections

**Get Signature**

> **get** **collections**(): `CollectionMap`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:91

**Returns**

`CollectionMap`

**Inherited from**

`Model.collections`

***

### database

**Get Signature**

> **get** **database**(): `Database`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:93

**Returns**

`Database`

**Inherited from**

`Model.database`

***

### db

**Get Signature**

> **get** **db**(): `Database`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:95

**Returns**

`Database`

**Inherited from**

`Model.db`

***

### id

**Get Signature**

> **get** **id**(): `string`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:44

**Returns**

`string`

**Inherited from**

`Model.id`

***

### syncStatus

**Get Signature**

> **get** **syncStatus**(): `SyncStatus`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:46

**Returns**

`SyncStatus`

**Inherited from**

`Model.syncStatus`

***

### table

**Get Signature**

> **get** **table**(): `string`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:113

**Returns**

`string`

**Inherited from**

`Model.table`

## Methods

### \_\_ensureCanSetRaw()

> **\_\_ensureCanSetRaw**(): `void`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:141

**Returns**

`void`

**Inherited from**

`Model.__ensureCanSetRaw`

***

### \_\_ensureNotDisposable()

> **\_\_ensureNotDisposable**(`debugName`: `string`): `void`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:143

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`debugName`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

**Inherited from**

`Model.__ensureNotDisposable`

***

### \_dangerouslySetRawWithoutMarkingColumnChange()

> **\_dangerouslySetRawWithoutMarkingColumnChange**(`rawFieldName`: `string`, `rawValue`: `Value`): `void`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:139

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`rawFieldName`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`rawValue`

</td>
<td>

`Value`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

**Inherited from**

`Model._dangerouslySetRawWithoutMarkingColumnChange`

***

### \_getChanges()

> **\_getChanges**(): `BehaviorSubject`<`any`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:42

**Returns**

`BehaviorSubject`<`any`>

**Inherited from**

`Model._getChanges`

***

### \_getRaw()

> **\_getRaw**(`rawFieldName`: `string`): `Value`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:133

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`rawFieldName`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Value`

**Inherited from**

`Model._getRaw`

***

### \_notifyChanged()

> **\_notifyChanged**(): `void`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:129

**Returns**

`void`

**Inherited from**

`Model._notifyChanged`

***

### \_notifyDestroyed()

> **\_notifyDestroyed**(): `void`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:131

**Returns**

`void`

**Inherited from**

`Model._notifyDestroyed`

***

### \_setRaw()

> **\_setRaw**(`rawFieldName`: `string`, `rawValue`: `Value`): `void`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:135

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`rawFieldName`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`rawValue`

</td>
<td>

`Value`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

**Inherited from**

`Model._setRaw`

***

### batch()

> **batch**(...`records`: `$ReadOnlyArray`<`false` | `void` | `Model` | `null`>): `Promise`<`void`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:102

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

...`records`

</td>
<td>

`$ReadOnlyArray`<`false` | `void` | `Model` | `null`>

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`void`>

**Inherited from**

`Model.batch`

***

### callReader()

> **callReader**<`T`>(`action`: () => `Promise`<`T`>): `Promise`<`T`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:108

**Type Parameters**

<table>
<thead>
<tr>
<th>Type Parameter</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`T`

</td>
</tr>
</tbody>
</table>

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`action`

</td>
<td>

() => `Promise`<`T`>

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`T`>

**Inherited from**

`Model.callReader`

***

### callWriter()

> **callWriter**<`T`>(`action`: () => `Promise`<`T`>): `Promise`<`T`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:105

**Type Parameters**

<table>
<thead>
<tr>
<th>Type Parameter</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`T`

</td>
</tr>
</tbody>
</table>

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`action`

</td>
<td>

() => `Promise`<`T`>

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`T`>

**Inherited from**

`Model.callWriter`

***

### destroyPermanently()

> **destroyPermanently**(): `Promise`<`void`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:74

**Returns**

`Promise`<`void`>

**Inherited from**

`Model.destroyPermanently`

***

### experimentalDestroyPermanently()

> **experimentalDestroyPermanently**(): `Promise`<`void`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:78

**Returns**

`Promise`<`void`>

**Inherited from**

`Model.experimentalDestroyPermanently`

***

### experimentalMarkAsDeleted()

> **experimentalMarkAsDeleted**(): `Promise`<`void`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:76

**Returns**

`Promise`<`void`>

**Inherited from**

`Model.experimentalMarkAsDeleted`

***

### experimentalSubscribe()

> **experimentalSubscribe**(`subscriber`: (`isDeleted`: `boolean`) => `void`, `debugInfo?`: `any`): `Unsubscribe`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:127

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`subscriber`

</td>
<td>

(`isDeleted`: `boolean`) => `void`

</td>
</tr>
<tr>
<td>

`debugInfo?`

</td>
<td>

`any`

</td>
</tr>
</tbody>
</table>

**Returns**

`Unsubscribe`

**Inherited from**

`Model.experimentalSubscribe`

***

### markAsDeleted()

> **markAsDeleted**(): `Promise`<`void`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:70

**Returns**

`Promise`<`void`>

**Inherited from**

`Model.markAsDeleted`

***

### observe()

> **observe**(): `Observable`<`VaultFolder`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:84

**Returns**

`Observable`<`VaultFolder`>

**Inherited from**

`Model.observe`

***

### prepareDestroyPermanently()

> **prepareDestroyPermanently**(): `this`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:66

**Returns**

`this`

**Inherited from**

`Model.prepareDestroyPermanently`

***

### prepareMarkAsDeleted()

> **prepareMarkAsDeleted**(): `this`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:64

**Returns**

`this`

**Inherited from**

`Model.prepareMarkAsDeleted`

***

### prepareUpdate()

> **prepareUpdate**(`recordUpdater?`: (`_`: `this`) => `void`): `this`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:62

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`recordUpdater?`

</td>
<td>

(`_`: `this`) => `void`

</td>
</tr>
</tbody>
</table>

**Returns**

`this`

**Inherited from**

`Model.prepareUpdate`

***

### subAction()

> **subAction**<`T`>(`action`: () => `Promise`<`T`>): `Promise`<`T`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:111

**Type Parameters**

<table>
<thead>
<tr>
<th>Type Parameter</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`T`

</td>
</tr>
</tbody>
</table>

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`action`

</td>
<td>

() => `Promise`<`T`>

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`T`>

**Inherited from**

`Model.subAction`

***

### update()

> **update**(`recordUpdater?`: (`_`: `this`) => `void`): `Promise`<`VaultFolder`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:55

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`recordUpdater?`

</td>
<td>

(`_`: `this`) => `void`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`VaultFolder`>

**Inherited from**

`Model.update`

***

### \_disposableFromDirtyRaw()

> `static` **\_disposableFromDirtyRaw**(`collection`: `Collection`<`Model`>, `dirtyRaw`: `DirtyRaw`): `Model`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:123

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`collection`

</td>
<td>

`Collection`<`Model`>

</td>
</tr>
<tr>
<td>

`dirtyRaw`

</td>
<td>

`DirtyRaw`

</td>
</tr>
</tbody>
</table>

**Returns**

`Model`

**Inherited from**

`Model._disposableFromDirtyRaw`

***

### \_prepareCreate()

> `static` **\_prepareCreate**(`collection`: `Collection`<`Model`>, `recordBuilder`: (`_`: `Model`) => `void`): `Model`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:119

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`collection`

</td>
<td>

`Collection`<`Model`>

</td>
</tr>
<tr>
<td>

`recordBuilder`

</td>
<td>

(`_`: `Model`) => `void`

</td>
</tr>
</tbody>
</table>

**Returns**

`Model`

**Inherited from**

`Model._prepareCreate`

***

### \_prepareCreateFromDirtyRaw()

> `static` **\_prepareCreateFromDirtyRaw**(`collection`: `Collection`<`Model`>, `dirtyRaw`: `DirtyRaw`): `Model`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:121

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`collection`

</td>
<td>

`Collection`<`Model`>

</td>
</tr>
<tr>
<td>

`dirtyRaw`

</td>
<td>

`DirtyRaw`

</td>
</tr>
</tbody>
</table>

**Returns**

`Model`

**Inherited from**

`Model._prepareCreateFromDirtyRaw`

---
Source: https://docs.anuma.ai/sdk/react/Internal/classes/StoredVaultMemoryModel

# StoredVaultMemoryModel

Defined in: [src/lib/db/memoryVault/models.ts:4](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/memoryVault/models.ts#4)

## Extends

* `default`

## Constructors

### Constructor

> **new StoredVaultMemoryModel**(`collection`: `Collection`<`Model`>, `raw`: `_RawRecord`): `VaultMemory`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:117

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`collection`

</td>
<td>

`Collection`<`Model`>

</td>
</tr>
<tr>
<td>

`raw`

</td>
<td>

`_RawRecord`

</td>
</tr>
</tbody>
</table>

**Returns**

`VaultMemory`

**Inherited from**

`Model.constructor`

## Properties

### \_\_changes?

> `optional` **\_\_changes**: `BehaviorSubject`<`any`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:40

**Inherited from**

`Model.__changes`

***

### \_isEditing

> **\_isEditing**: `boolean`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:36

**Inherited from**

`Model._isEditing`

***

### \_preparedState

> **\_preparedState**: `"create"` | `"update"` | `"markAsDeleted"` | `"destroyPermanently"` | `null`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:38

**Inherited from**

`Model._preparedState`

***

### \_raw

> **\_raw**: `_RawRecord`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:34

**Inherited from**

`Model._raw`

***

### \_subscribers

> **\_subscribers**: \[(`isDeleted`: `boolean`) => `void`, `any`]\[]

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:125

**Inherited from**

`Model._subscribers`

***

### collection

> **collection**: `Collection`<`Model`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:88

**Inherited from**

`Model.collection`

***

### content

> **content**: `string`

Defined in: [src/lib/db/memoryVault/models.ts:7](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/memoryVault/models.ts#7)

***

### createdAt

> **createdAt**: `Date`

Defined in: [src/lib/db/memoryVault/models.ts:12](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/memoryVault/models.ts#12)

***

### embedding

> **embedding**: `string` | `null`

Defined in: [src/lib/db/memoryVault/models.ts:11](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/memoryVault/models.ts#11)

***

### folderId

> **folderId**: `string` | `null`

Defined in: [src/lib/db/memoryVault/models.ts:9](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/memoryVault/models.ts#9)

***

### isDeleted

> **isDeleted**: `boolean`

Defined in: [src/lib/db/memoryVault/models.ts:14](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/memoryVault/models.ts#14)

***

### scope

> **scope**: `string`

Defined in: [src/lib/db/memoryVault/models.ts:8](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/memoryVault/models.ts#8)

***

### updatedAt

> **updatedAt**: `Date`

Defined in: [src/lib/db/memoryVault/models.ts:13](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/memoryVault/models.ts#13)

***

### userId

> **userId**: `string` | `null`

Defined in: [src/lib/db/memoryVault/models.ts:10](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/memoryVault/models.ts#10)

***

### \_wmelonTag

> `static` **\_wmelonTag**: `string`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:32

**Inherited from**

`Model._wmelonTag`

***

### associations

> `static` **associations**: `Associations`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:29

**Inherited from**

`Model.associations`

***

### table

> `static` **table**: `string` = `"memory_vault"`

Defined in: [src/lib/db/memoryVault/models.ts:5](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/memoryVault/models.ts#5)

**Overrides**

`Model.table`

## Accessors

### asModel

**Get Signature**

> **get** **asModel**(): `this`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:97

**Returns**

`this`

**Inherited from**

`Model.asModel`

***

### collections

**Get Signature**

> **get** **collections**(): `CollectionMap`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:91

**Returns**

`CollectionMap`

**Inherited from**

`Model.collections`

***

### database

**Get Signature**

> **get** **database**(): `Database`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:93

**Returns**

`Database`

**Inherited from**

`Model.database`

***

### db

**Get Signature**

> **get** **db**(): `Database`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:95

**Returns**

`Database`

**Inherited from**

`Model.db`

***

### id

**Get Signature**

> **get** **id**(): `string`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:44

**Returns**

`string`

**Inherited from**

`Model.id`

***

### syncStatus

**Get Signature**

> **get** **syncStatus**(): `SyncStatus`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:46

**Returns**

`SyncStatus`

**Inherited from**

`Model.syncStatus`

***

### table

**Get Signature**

> **get** **table**(): `string`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:113

**Returns**

`string`

**Inherited from**

`Model.table`

## Methods

### \_\_ensureCanSetRaw()

> **\_\_ensureCanSetRaw**(): `void`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:141

**Returns**

`void`

**Inherited from**

`Model.__ensureCanSetRaw`

***

### \_\_ensureNotDisposable()

> **\_\_ensureNotDisposable**(`debugName`: `string`): `void`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:143

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`debugName`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

**Inherited from**

`Model.__ensureNotDisposable`

***

### \_dangerouslySetRawWithoutMarkingColumnChange()

> **\_dangerouslySetRawWithoutMarkingColumnChange**(`rawFieldName`: `string`, `rawValue`: `Value`): `void`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:139

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`rawFieldName`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`rawValue`

</td>
<td>

`Value`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

**Inherited from**

`Model._dangerouslySetRawWithoutMarkingColumnChange`

***

### \_getChanges()

> **\_getChanges**(): `BehaviorSubject`<`any`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:42

**Returns**

`BehaviorSubject`<`any`>

**Inherited from**

`Model._getChanges`

***

### \_getRaw()

> **\_getRaw**(`rawFieldName`: `string`): `Value`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:133

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`rawFieldName`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Value`

**Inherited from**

`Model._getRaw`

***

### \_notifyChanged()

> **\_notifyChanged**(): `void`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:129

**Returns**

`void`

**Inherited from**

`Model._notifyChanged`

***

### \_notifyDestroyed()

> **\_notifyDestroyed**(): `void`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:131

**Returns**

`void`

**Inherited from**

`Model._notifyDestroyed`

***

### \_setRaw()

> **\_setRaw**(`rawFieldName`: `string`, `rawValue`: `Value`): `void`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:135

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`rawFieldName`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`rawValue`

</td>
<td>

`Value`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

**Inherited from**

`Model._setRaw`

***

### batch()

> **batch**(...`records`: `$ReadOnlyArray`<`false` | `void` | `Model` | `null`>): `Promise`<`void`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:102

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

...`records`

</td>
<td>

`$ReadOnlyArray`<`false` | `void` | `Model` | `null`>

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`void`>

**Inherited from**

`Model.batch`

***

### callReader()

> **callReader**<`T`>(`action`: () => `Promise`<`T`>): `Promise`<`T`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:108

**Type Parameters**

<table>
<thead>
<tr>
<th>Type Parameter</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`T`

</td>
</tr>
</tbody>
</table>

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`action`

</td>
<td>

() => `Promise`<`T`>

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`T`>

**Inherited from**

`Model.callReader`

***

### callWriter()

> **callWriter**<`T`>(`action`: () => `Promise`<`T`>): `Promise`<`T`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:105

**Type Parameters**

<table>
<thead>
<tr>
<th>Type Parameter</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`T`

</td>
</tr>
</tbody>
</table>

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`action`

</td>
<td>

() => `Promise`<`T`>

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`T`>

**Inherited from**

`Model.callWriter`

***

### destroyPermanently()

> **destroyPermanently**(): `Promise`<`void`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:74

**Returns**

`Promise`<`void`>

**Inherited from**

`Model.destroyPermanently`

***

### experimentalDestroyPermanently()

> **experimentalDestroyPermanently**(): `Promise`<`void`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:78

**Returns**

`Promise`<`void`>

**Inherited from**

`Model.experimentalDestroyPermanently`

***

### experimentalMarkAsDeleted()

> **experimentalMarkAsDeleted**(): `Promise`<`void`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:76

**Returns**

`Promise`<`void`>

**Inherited from**

`Model.experimentalMarkAsDeleted`

***

### experimentalSubscribe()

> **experimentalSubscribe**(`subscriber`: (`isDeleted`: `boolean`) => `void`, `debugInfo?`: `any`): `Unsubscribe`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:127

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`subscriber`

</td>
<td>

(`isDeleted`: `boolean`) => `void`

</td>
</tr>
<tr>
<td>

`debugInfo?`

</td>
<td>

`any`

</td>
</tr>
</tbody>
</table>

**Returns**

`Unsubscribe`

**Inherited from**

`Model.experimentalSubscribe`

***

### markAsDeleted()

> **markAsDeleted**(): `Promise`<`void`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:70

**Returns**

`Promise`<`void`>

**Inherited from**

`Model.markAsDeleted`

***

### observe()

> **observe**(): `Observable`<`VaultMemory`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:84

**Returns**

`Observable`<`VaultMemory`>

**Inherited from**

`Model.observe`

***

### prepareDestroyPermanently()

> **prepareDestroyPermanently**(): `this`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:66

**Returns**

`this`

**Inherited from**

`Model.prepareDestroyPermanently`

***

### prepareMarkAsDeleted()

> **prepareMarkAsDeleted**(): `this`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:64

**Returns**

`this`

**Inherited from**

`Model.prepareMarkAsDeleted`

***

### prepareUpdate()

> **prepareUpdate**(`recordUpdater?`: (`_`: `this`) => `void`): `this`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:62

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`recordUpdater?`

</td>
<td>

(`_`: `this`) => `void`

</td>
</tr>
</tbody>
</table>

**Returns**

`this`

**Inherited from**

`Model.prepareUpdate`

***

### subAction()

> **subAction**<`T`>(`action`: () => `Promise`<`T`>): `Promise`<`T`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:111

**Type Parameters**

<table>
<thead>
<tr>
<th>Type Parameter</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`T`

</td>
</tr>
</tbody>
</table>

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`action`

</td>
<td>

() => `Promise`<`T`>

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`T`>

**Inherited from**

`Model.subAction`

***

### update()

> **update**(`recordUpdater?`: (`_`: `this`) => `void`): `Promise`<`VaultMemory`>

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:55

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`recordUpdater?`

</td>
<td>

(`_`: `this`) => `void`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`VaultMemory`>

**Inherited from**

`Model.update`

***

### \_disposableFromDirtyRaw()

> `static` **\_disposableFromDirtyRaw**(`collection`: `Collection`<`Model`>, `dirtyRaw`: `DirtyRaw`): `Model`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:123

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`collection`

</td>
<td>

`Collection`<`Model`>

</td>
</tr>
<tr>
<td>

`dirtyRaw`

</td>
<td>

`DirtyRaw`

</td>
</tr>
</tbody>
</table>

**Returns**

`Model`

**Inherited from**

`Model._disposableFromDirtyRaw`

***

### \_prepareCreate()

> `static` **\_prepareCreate**(`collection`: `Collection`<`Model`>, `recordBuilder`: (`_`: `Model`) => `void`): `Model`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:119

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`collection`

</td>
<td>

`Collection`<`Model`>

</td>
</tr>
<tr>
<td>

`recordBuilder`

</td>
<td>

(`_`: `Model`) => `void`

</td>
</tr>
</tbody>
</table>

**Returns**

`Model`

**Inherited from**

`Model._prepareCreate`

***

### \_prepareCreateFromDirtyRaw()

> `static` **\_prepareCreateFromDirtyRaw**(`collection`: `Collection`<`Model`>, `dirtyRaw`: `DirtyRaw`): `Model`

Defined in: node\_modules/.pnpm/@nozbe+watermelondb@0.28.0/node\_modules/@nozbe/watermelondb/Model/index.d.ts:121

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`collection`

</td>
<td>

`Collection`<`Model`>

</td>
</tr>
<tr>
<td>

`dirtyRaw`

</td>
<td>

`DirtyRaw`

</td>
</tr>
</tbody>
</table>

**Returns**

`Model`

**Inherited from**

`Model._prepareCreateFromDirtyRaw`

---
Source: https://docs.anuma.ai/sdk/react/Internal/classes/TextProcessor

# TextProcessor

Defined in: [src/lib/processors/TextProcessor.ts:53](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/TextProcessor.ts#53)

Processor for plain-text files (.md, .txt, .csv, .json, .yaml, etc.) that
decodes the file's data URL as UTF-8 and inlines the contents into the user
message.

Unlike PDF/Word/Excel, no transformation is needed — the raw text IS the
extractable content. Without this processor, text files attached in the UI
would be visible as attachments but their contents would never reach the
model (only `image/*` files are inlined directly by callers).

## Implements

* [`FileProcessor`](../interfaces/FileProcessor.md)

## Constructors

### Constructor

> **new TextProcessor**(): `TextProcessor`

**Returns**

`TextProcessor`

## Properties

### name

> `readonly` **name**: `"text"` = `"text"`

Defined in: [src/lib/processors/TextProcessor.ts:54](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/TextProcessor.ts#54)

Unique identifier for this processor

**Implementation of**

[`FileProcessor`](../interfaces/FileProcessor.md).[`name`](../interfaces/FileProcessor.md#name)

***

### supportedExtensions

> `readonly` **supportedExtensions**: (`".json"` | `".txt"` | `".md"` | `".markdown"` | `".csv"` | `".tsv"` | `".jsonl"` | `".ndjson"` | `".log"` | `".yaml"` | `".yml"` | `".xml"` | `".html"` | `".htm"` | `".ini"` | `".toml"` | `".cfg"` | `".conf"`)\[]

Defined in: [src/lib/processors/TextProcessor.ts:56](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/TextProcessor.ts#56)

File extensions this processor can handle (fallback if MIME type unavailable)

**Implementation of**

[`FileProcessor`](../interfaces/FileProcessor.md).[`supportedExtensions`](../interfaces/FileProcessor.md#supportedextensions)

***

### supportedMimeTypes

> `readonly` **supportedMimeTypes**: (`"application/json"` | `"text/plain"` | `"text/markdown"` | `"text/x-markdown"` | `"text/csv"` | `"text/tab-separated-values"` | `"text/html"` | `"text/xml"` | `"text/yaml"` | `"text/x-yaml"` | `"application/ld+json"` | `"application/xml"` | `"application/yaml"` | `"application/x-yaml"`)\[]

Defined in: [src/lib/processors/TextProcessor.ts:55](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/TextProcessor.ts#55)

MIME types this processor can handle

**Implementation of**

[`FileProcessor`](../interfaces/FileProcessor.md).[`supportedMimeTypes`](../interfaces/FileProcessor.md#supportedmimetypes)

## Methods

### process()

> **process**(`file`: [`FileWithData`](../interfaces/FileWithData.md)): `Promise`<[`ProcessedFileResult`](../interfaces/ProcessedFileResult.md) | `null`>

Defined in: [src/lib/processors/TextProcessor.ts:58](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/TextProcessor.ts#58)

Process a file and extract text content

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`file`

</td>
<td>

[`FileWithData`](../interfaces/FileWithData.md)

</td>
<td>

File metadata with data URL

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`ProcessedFileResult`](../interfaces/ProcessedFileResult.md) | `null`>

Extracted text content and metadata, or null if processing fails/not applicable

**Implementation of**

[`FileProcessor`](../interfaces/FileProcessor.md).[`process`](../interfaces/FileProcessor.md#process)

---
Source: https://docs.anuma.ai/sdk/react/Internal/classes/WalletPoller

# WalletPoller

Defined in: [src/lib/db/queue/walletPoller.ts:11](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/queue/walletPoller.ts#11)

## Constructors

### Constructor

> **new WalletPoller**(): `WalletPoller`

**Returns**

`WalletPoller`

## Methods

### startPolling()

> **startPolling**(`checkWallet`: () => `Promise`<`string` | `null`>, `onWalletReady`: (`address`: `string`) => `void`, `intervalMs`: `number`, `maxAttempts`: `number`): () => `void`

Defined in: [src/lib/db/queue/walletPoller.ts:24](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/queue/walletPoller.ts#24)

Start polling for wallet availability.

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`checkWallet`

</td>
<td>

() => `Promise`<`string` | `null`>

</td>
<td>

`undefined`

</td>
<td>

Returns wallet address when ready, null if not yet available

</td>
</tr>
<tr>
<td>

`onWalletReady`

</td>
<td>

(`address`: `string`) => `void`

</td>
<td>

`undefined`

</td>
<td>

Called with the wallet address when it becomes available

</td>
</tr>
<tr>
<td>

`intervalMs`

</td>
<td>

`number`

</td>
<td>

`DEFAULT_INTERVAL_MS`

</td>
<td>

Polling interval in milliseconds (default: 1000ms)

</td>
</tr>
<tr>
<td>

`maxAttempts`

</td>
<td>

`number`

</td>
<td>

`DEFAULT_MAX_ATTEMPTS`

</td>
<td>

Maximum polling attempts before giving up (default: 60)

</td>
</tr>
</tbody>
</table>

**Returns**

Stop function to cancel polling

> (): `void`

**Returns**

`void`

***

### stop()

> **stop**(): `void`

Defined in: [src/lib/db/queue/walletPoller.ts:64](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/queue/walletPoller.ts#64)

Stop polling.

**Returns**

`void`

---
Source: https://docs.anuma.ai/sdk/react/Internal/classes/WatermelonChatStorageAdapter

# WatermelonChatStorageAdapter

Defined in: [src/lib/storage/WatermelonChatStorageAdapter.ts:69](https://github.com/anuma-ai/sdk/blob/main/src/lib/storage/WatermelonChatStorageAdapter.ts#69)

Backend-agnostic interface for chat/conversation storage.

The method set mirrors the operations we actually use across the SDK:
`*Op` functions in `src/lib/db/chat/operations.ts` plus the `observe*`
patterns used by react hooks. Targeted updates (e.g., `updateMessageError`)
are exposed as separate methods rather than a generic `update()` because
several of them have special semantics (encryption bypass for embeddings,
unique constraints on feedback, etc).

## Implements

* [`ChatStorageAdapter`](../interfaces/ChatStorageAdapter.md)

## Constructors

### Constructor

> **new WatermelonChatStorageAdapter**(`options`: [`WatermelonChatStorageAdapterOptions`](../interfaces/WatermelonChatStorageAdapterOptions.md)): `WatermelonChatStorageAdapter`

Defined in: [src/lib/storage/WatermelonChatStorageAdapter.ts:74](https://github.com/anuma-ai/sdk/blob/main/src/lib/storage/WatermelonChatStorageAdapter.ts#74)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`WatermelonChatStorageAdapterOptions`](../interfaces/WatermelonChatStorageAdapterOptions.md)

</td>
</tr>
</tbody>
</table>

**Returns**

`WatermelonChatStorageAdapter`

## Methods

### clearMessages()

> **clearMessages**(`conversationId`: `string`): `Promise`<`void`>

Defined in: [src/lib/storage/WatermelonChatStorageAdapter.ts:178](https://github.com/anuma-ai/sdk/blob/main/src/lib/storage/WatermelonChatStorageAdapter.ts#178)

Clears all messages in a conversation (used for the "clear chat" action).

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`conversationId`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`void`>

**Implementation of**

[`ChatStorageAdapter`](../interfaces/ChatStorageAdapter.md).[`clearMessages`](../interfaces/ChatStorageAdapter.md#clearmessages)

***

### createConversation()

> **createConversation**(`options?`: [`CreateConversationOptions`](../interfaces/CreateConversationOptions.md)): `Promise`<[`StoredConversation`](../interfaces/StoredConversation.md)>

Defined in: [src/lib/storage/WatermelonChatStorageAdapter.ts:100](https://github.com/anuma-ai/sdk/blob/main/src/lib/storage/WatermelonChatStorageAdapter.ts#100)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options?`

</td>
<td>

[`CreateConversationOptions`](../interfaces/CreateConversationOptions.md)

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`StoredConversation`](../interfaces/StoredConversation.md)>

**Implementation of**

[`ChatStorageAdapter`](../interfaces/ChatStorageAdapter.md).[`createConversation`](../interfaces/ChatStorageAdapter.md#createconversation)

***

### createMessage()

> **createMessage**(`options`: [`CreateMessageOptions`](../interfaces/CreateMessageOptions.md)): `Promise`<[`StoredMessage`](../interfaces/StoredMessage.md)>

Defined in: [src/lib/storage/WatermelonChatStorageAdapter.ts:147](https://github.com/anuma-ai/sdk/blob/main/src/lib/storage/WatermelonChatStorageAdapter.ts#147)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`CreateMessageOptions`](../interfaces/CreateMessageOptions.md)

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`StoredMessage`](../interfaces/StoredMessage.md)>

**Implementation of**

[`ChatStorageAdapter`](../interfaces/ChatStorageAdapter.md).[`createMessage`](../interfaces/ChatStorageAdapter.md#createmessage)

***

### deleteConversation()

> **deleteConversation**(`conversationId`: `string`): `Promise`<`boolean`>

Defined in: [src/lib/storage/WatermelonChatStorageAdapter.ts:112](https://github.com/anuma-ai/sdk/blob/main/src/lib/storage/WatermelonChatStorageAdapter.ts#112)

Soft delete. Implementations are responsible for cascading to messages/media.

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`conversationId`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`boolean`>

**Implementation of**

[`ChatStorageAdapter`](../interfaces/ChatStorageAdapter.md).[`deleteConversation`](../interfaces/ChatStorageAdapter.md#deleteconversation)

***

### getAllFiles()

> **getAllFiles**(): `Promise`<[`StoredFileWithContext`](../interfaces/StoredFileWithContext.md)\[]>

Defined in: [src/lib/storage/WatermelonChatStorageAdapter.ts:231](https://github.com/anuma-ai/sdk/blob/main/src/lib/storage/WatermelonChatStorageAdapter.ts#231)

**Returns**

`Promise`<[`StoredFileWithContext`](../interfaces/StoredFileWithContext.md)\[]>

**Implementation of**

[`ChatStorageAdapter`](../interfaces/ChatStorageAdapter.md).[`getAllFiles`](../interfaces/ChatStorageAdapter.md#getallfiles)

***

### getConversation()

> **getConversation**(`conversationId`: `string`): `Promise`<[`StoredConversation`](../interfaces/StoredConversation.md) | `null`>

Defined in: [src/lib/storage/WatermelonChatStorageAdapter.ts:89](https://github.com/anuma-ai/sdk/blob/main/src/lib/storage/WatermelonChatStorageAdapter.ts#89)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`conversationId`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`StoredConversation`](../interfaces/StoredConversation.md) | `null`>

**Implementation of**

[`ChatStorageAdapter`](../interfaces/ChatStorageAdapter.md).[`getConversation`](../interfaces/ChatStorageAdapter.md#getconversation)

***

### getConversations()

> **getConversations**(`options?`: [`ConversationQueryOptions`](../interfaces/ConversationQueryOptions.md)): `Promise`<[`StoredConversation`](../interfaces/StoredConversation.md)\[]>

Defined in: [src/lib/storage/WatermelonChatStorageAdapter.ts:93](https://github.com/anuma-ai/sdk/blob/main/src/lib/storage/WatermelonChatStorageAdapter.ts#93)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options?`

</td>
<td>

[`ConversationQueryOptions`](../interfaces/ConversationQueryOptions.md)

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`StoredConversation`](../interfaces/StoredConversation.md)\[]>

**Implementation of**

[`ChatStorageAdapter`](../interfaces/ChatStorageAdapter.md).[`getConversations`](../interfaces/ChatStorageAdapter.md#getconversations)

***

### getMessages()

> **getMessages**(`conversationId`: `string`): `Promise`<[`StoredMessage`](../interfaces/StoredMessage.md)\[]>

Defined in: [src/lib/storage/WatermelonChatStorageAdapter.ts:143](https://github.com/anuma-ai/sdk/blob/main/src/lib/storage/WatermelonChatStorageAdapter.ts#143)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`conversationId`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`StoredMessage`](../interfaces/StoredMessage.md)\[]>

**Implementation of**

[`ChatStorageAdapter`](../interfaces/ChatStorageAdapter.md).[`getMessages`](../interfaces/ChatStorageAdapter.md#getmessages)

***

### observeConversations()

> **observeConversations**(`options?`: [`ConversationQueryOptions`](../interfaces/ConversationQueryOptions.md)): [`ChatStorageObservable`](../interfaces/ChatStorageObservable.md)<[`StoredConversation`](../interfaces/StoredConversation.md)\[]>

Defined in: [src/lib/storage/WatermelonChatStorageAdapter.ts:116](https://github.com/anuma-ai/sdk/blob/main/src/lib/storage/WatermelonChatStorageAdapter.ts#116)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options?`

</td>
<td>

[`ConversationQueryOptions`](../interfaces/ConversationQueryOptions.md)

</td>
</tr>
</tbody>
</table>

**Returns**

[`ChatStorageObservable`](../interfaces/ChatStorageObservable.md)<[`StoredConversation`](../interfaces/StoredConversation.md)\[]>

**Implementation of**

[`ChatStorageAdapter`](../interfaces/ChatStorageAdapter.md).[`observeConversations`](../interfaces/ChatStorageAdapter.md#observeconversations)

***

### observeMessages()

> **observeMessages**(`conversationId`: `string`): [`ChatStorageObservable`](../interfaces/ChatStorageObservable.md)<[`StoredMessage`](../interfaces/StoredMessage.md)\[]>

Defined in: [src/lib/storage/WatermelonChatStorageAdapter.ts:182](https://github.com/anuma-ai/sdk/blob/main/src/lib/storage/WatermelonChatStorageAdapter.ts#182)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`conversationId`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

[`ChatStorageObservable`](../interfaces/ChatStorageObservable.md)<[`StoredMessage`](../interfaces/StoredMessage.md)\[]>

**Implementation of**

[`ChatStorageAdapter`](../interfaces/ChatStorageAdapter.md).[`observeMessages`](../interfaces/ChatStorageAdapter.md#observemessages)

***

### updateConversationProject()

> **updateConversationProject**(`conversationId`: `string`, `projectId`: `string` | `null`): `Promise`<`boolean`>

Defined in: [src/lib/storage/WatermelonChatStorageAdapter.ts:108](https://github.com/anuma-ai/sdk/blob/main/src/lib/storage/WatermelonChatStorageAdapter.ts#108)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`conversationId`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`projectId`

</td>
<td>

`string` | `null`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`boolean`>

**Implementation of**

[`ChatStorageAdapter`](../interfaces/ChatStorageAdapter.md).[`updateConversationProject`](../interfaces/ChatStorageAdapter.md#updateconversationproject)

***

### updateConversationTitle()

> **updateConversationTitle**(`conversationId`: `string`, `title`: `string`): `Promise`<`boolean`>

Defined in: [src/lib/storage/WatermelonChatStorageAdapter.ts:104](https://github.com/anuma-ai/sdk/blob/main/src/lib/storage/WatermelonChatStorageAdapter.ts#104)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`conversationId`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`title`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`boolean`>

**Implementation of**

[`ChatStorageAdapter`](../interfaces/ChatStorageAdapter.md).[`updateConversationTitle`](../interfaces/ChatStorageAdapter.md#updateconversationtitle)

***

### updateMessageChunks()

> **updateMessageChunks**(`uniqueId`: `string`, `chunks`: [`MessageChunk`](../interfaces/MessageChunk.md)\[], `embeddingModel`: `string`): `Promise`<[`StoredMessage`](../interfaces/StoredMessage.md) | `null`>

Defined in: [src/lib/storage/WatermelonChatStorageAdapter.ts:159](https://github.com/anuma-ai/sdk/blob/main/src/lib/storage/WatermelonChatStorageAdapter.ts#159)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`uniqueId`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`chunks`

</td>
<td>

[`MessageChunk`](../interfaces/MessageChunk.md)\[]

</td>
</tr>
<tr>
<td>

`embeddingModel`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`StoredMessage`](../interfaces/StoredMessage.md) | `null`>

**Implementation of**

[`ChatStorageAdapter`](../interfaces/ChatStorageAdapter.md).[`updateMessageChunks`](../interfaces/ChatStorageAdapter.md#updatemessagechunks)

***

### updateMessageEmbedding()

> **updateMessageEmbedding**(`uniqueId`: `string`, `vector`: `number`\[], `embeddingModel`: `string`): `Promise`<[`StoredMessage`](../interfaces/StoredMessage.md) | `null`>

Defined in: [src/lib/storage/WatermelonChatStorageAdapter.ts:151](https://github.com/anuma-ai/sdk/blob/main/src/lib/storage/WatermelonChatStorageAdapter.ts#151)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`uniqueId`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`vector`

</td>
<td>

`number`\[]

</td>
</tr>
<tr>
<td>

`embeddingModel`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`StoredMessage`](../interfaces/StoredMessage.md) | `null`>

**Implementation of**

[`ChatStorageAdapter`](../interfaces/ChatStorageAdapter.md).[`updateMessageEmbedding`](../interfaces/ChatStorageAdapter.md#updatemessageembedding)

***

### updateMessageError()

> **updateMessageError**(`uniqueId`: `string`, `error`: `string`): `Promise`<[`StoredMessage`](../interfaces/StoredMessage.md) | `null`>

Defined in: [src/lib/storage/WatermelonChatStorageAdapter.ts:167](https://github.com/anuma-ai/sdk/blob/main/src/lib/storage/WatermelonChatStorageAdapter.ts#167)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`uniqueId`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`error`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`StoredMessage`](../interfaces/StoredMessage.md) | `null`>

**Implementation of**

[`ChatStorageAdapter`](../interfaces/ChatStorageAdapter.md).[`updateMessageError`](../interfaces/ChatStorageAdapter.md#updatemessageerror)

***

### updateMessageFeedback()

> **updateMessageFeedback**(`uniqueId`: `string`, `feedback`: [`MessageFeedback`](../type-aliases/MessageFeedback.md)): `Promise`<[`StoredMessage`](../interfaces/StoredMessage.md) | `null`>

Defined in: [src/lib/storage/WatermelonChatStorageAdapter.ts:171](https://github.com/anuma-ai/sdk/blob/main/src/lib/storage/WatermelonChatStorageAdapter.ts#171)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`uniqueId`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`feedback`

</td>
<td>

[`MessageFeedback`](../type-aliases/MessageFeedback.md)

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`StoredMessage`](../interfaces/StoredMessage.md) | `null`>

**Implementation of**

[`ChatStorageAdapter`](../interfaces/ChatStorageAdapter.md).[`updateMessageFeedback`](../interfaces/ChatStorageAdapter.md#updatemessagefeedback)

***

### write()

> **write**<`T`>(`fn`: (`adapter`: [`ChatStorageAdapter`](../interfaces/ChatStorageAdapter.md)) => `Promise`<`T`>): `Promise`<`T`>

Defined in: [src/lib/storage/WatermelonChatStorageAdapter.ts:243](https://github.com/anuma-ai/sdk/blob/main/src/lib/storage/WatermelonChatStorageAdapter.ts#243)

WatermelonDB nests `database.write()` safely: each method we call inside
the callback already wraps its own writes, and Watermelon collapses the
nesting under a single action. The callback receives the same adapter
instance.

**Type Parameters**

<table>
<thead>
<tr>
<th>Type Parameter</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`T`

</td>
</tr>
</tbody>
</table>

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`fn`

</td>
<td>

(`adapter`: [`ChatStorageAdapter`](../interfaces/ChatStorageAdapter.md)) => `Promise`<`T`>

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`T`>

**Implementation of**

[`ChatStorageAdapter`](../interfaces/ChatStorageAdapter.md).[`write`](../interfaces/ChatStorageAdapter.md#write)

---
Source: https://docs.anuma.ai/sdk/react/Internal/classes/WordProcessor

# WordProcessor

Defined in: [src/lib/processors/WordProcessor.ts:10](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/WordProcessor.ts#10)

Processor for Word documents (.docx) that converts to markdown

## Implements

* [`FileProcessor`](../interfaces/FileProcessor.md)

## Constructors

### Constructor

> **new WordProcessor**(): `WordProcessor`

**Returns**

`WordProcessor`

## Properties

### name

> `readonly` **name**: `"word"` = `"word"`

Defined in: [src/lib/processors/WordProcessor.ts:11](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/WordProcessor.ts#11)

Unique identifier for this processor

**Implementation of**

[`FileProcessor`](../interfaces/FileProcessor.md).[`name`](../interfaces/FileProcessor.md#name)

***

### supportedExtensions

> `readonly` **supportedExtensions**: `string`\[]

Defined in: [src/lib/processors/WordProcessor.ts:15](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/WordProcessor.ts#15)

File extensions this processor can handle (fallback if MIME type unavailable)

**Implementation of**

[`FileProcessor`](../interfaces/FileProcessor.md).[`supportedExtensions`](../interfaces/FileProcessor.md#supportedextensions)

***

### supportedMimeTypes

> `readonly` **supportedMimeTypes**: `string`\[]

Defined in: [src/lib/processors/WordProcessor.ts:12](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/WordProcessor.ts#12)

MIME types this processor can handle

**Implementation of**

[`FileProcessor`](../interfaces/FileProcessor.md).[`supportedMimeTypes`](../interfaces/FileProcessor.md#supportedmimetypes)

## Methods

### process()

> **process**(`file`: [`FileWithData`](../interfaces/FileWithData.md)): `Promise`<[`ProcessedFileResult`](../interfaces/ProcessedFileResult.md) | `null`>

Defined in: [src/lib/processors/WordProcessor.ts:17](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/WordProcessor.ts#17)

Process a file and extract text content

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`file`

</td>
<td>

[`FileWithData`](../interfaces/FileWithData.md)

</td>
<td>

File metadata with data URL

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`ProcessedFileResult`](../interfaces/ProcessedFileResult.md) | `null`>

Extracted text content and metadata, or null if processing fails/not applicable

**Implementation of**

[`FileProcessor`](../interfaces/FileProcessor.md).[`process`](../interfaces/FileProcessor.md#process)

---
Source: https://docs.anuma.ai/sdk/react/Internal/classes/ZipProcessor

# ZipProcessor

Defined in: [src/lib/processors/ZipProcessor.ts:24](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/ZipProcessor.ts#24)

Processor for ZIP archive files that extracts contents and delegates
to other processors for supported file types

## Implements

* [`FileProcessor`](../interfaces/FileProcessor.md)

## Constructors

### Constructor

> **new ZipProcessor**(`options`: [`ZipProcessorOptions`](../interfaces/ZipProcessorOptions.md)): `ZipProcessor`

Defined in: [src/lib/processors/ZipProcessor.ts:42](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/ZipProcessor.ts#42)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`ZipProcessorOptions`](../interfaces/ZipProcessorOptions.md)

</td>
</tr>
</tbody>
</table>

**Returns**

`ZipProcessor`

## Properties

### name

> `readonly` **name**: `"zip"` = `"zip"`

Defined in: [src/lib/processors/ZipProcessor.ts:25](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/ZipProcessor.ts#25)

Unique identifier for this processor

**Implementation of**

[`FileProcessor`](../interfaces/FileProcessor.md).[`name`](../interfaces/FileProcessor.md#name)

***

### supportedExtensions

> `readonly` **supportedExtensions**: `string`\[]

Defined in: [src/lib/processors/ZipProcessor.ts:31](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/ZipProcessor.ts#31)

File extensions this processor can handle (fallback if MIME type unavailable)

**Implementation of**

[`FileProcessor`](../interfaces/FileProcessor.md).[`supportedExtensions`](../interfaces/FileProcessor.md#supportedextensions)

***

### supportedMimeTypes

> `readonly` **supportedMimeTypes**: `string`\[]

Defined in: [src/lib/processors/ZipProcessor.ts:26](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/ZipProcessor.ts#26)

MIME types this processor can handle

**Implementation of**

[`FileProcessor`](../interfaces/FileProcessor.md).[`supportedMimeTypes`](../interfaces/FileProcessor.md#supportedmimetypes)

## Methods

### process()

> **process**(`file`: [`FileWithData`](../interfaces/FileWithData.md)): `Promise`<[`ProcessedFileResult`](../interfaces/ProcessedFileResult.md) | `null`>

Defined in: [src/lib/processors/ZipProcessor.ts:55](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/ZipProcessor.ts#55)

Process a file and extract text content

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`file`

</td>
<td>

[`FileWithData`](../interfaces/FileWithData.md)

</td>
<td>

File metadata with data URL

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`ProcessedFileResult`](../interfaces/ProcessedFileResult.md) | `null`>

Extracted text content and metadata, or null if processing fails/not applicable

**Implementation of**

[`FileProcessor`](../interfaces/FileProcessor.md).[`process`](../interfaces/FileProcessor.md#process)

***

### setRegistry()

> **setRegistry**(`registry`: [`ProcessorRegistry`](ProcessorRegistry.md)): `void`

Defined in: [src/lib/processors/ZipProcessor.ts:51](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/ZipProcessor.ts#51)

Set the processor registry for handling nested files
This must be called before processing if you want nested file support

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`registry`

</td>
<td>

[`ProcessorRegistry`](ProcessorRegistry.md)

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/AnumaShadowIsolationProvider

# AnumaShadowIsolationProvider

> **AnumaShadowIsolationProvider**(`__namedParameters`: [`AnumaShadowIsolationProviderProps`](../interfaces/AnumaShadowIsolationProviderProps.md)): `ReactElement`

Defined in: [src/react/anumaRuntime.tsx:102](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#102)

Toggle shadow-DOM isolation for any `<Anuma.Slide>` rendered inside
the children. The default for slides is isolation ON — pass
`enabled={false}` to render slide children in light DOM instead.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`__namedParameters`

</td>
<td>

[`AnumaShadowIsolationProviderProps`](../interfaces/AnumaShadowIsolationProviderProps.md)

</td>
</tr>
</tbody>
</table>

## Returns

`ReactElement`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/AnumaThemeProvider

# AnumaThemeProvider

> **AnumaThemeProvider**(`__namedParameters`: [`AnumaThemeProviderProps`](../interfaces/AnumaThemeProviderProps.md)): `ReactElement`

Defined in: [src/react/anumaRuntime.tsx:125](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#125)

Wrap any Anuma render with a theme. Tokens like `color: "textPrimary"` in
`style` props (or `fill="accent"` on shapes) resolve against the theme.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`__namedParameters`

</td>
<td>

[`AnumaThemeProviderProps`](../interfaces/AnumaThemeProviderProps.md)

</td>
</tr>
</tbody>
</table>

## Returns

`ReactElement`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/appFileToStored

# appFileToStored

> **appFileToStored**(`file`: [`AppFileModel`](../classes/AppFileModel.md)): [`StoredAppFile`](../interfaces/StoredAppFile.md)

Defined in: [src/lib/db/appFiles/operations.ts:15](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/appFiles/operations.ts#15)

Convert a WatermelonDB AppFile model to a plain StoredAppFile object.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`file`

</td>
<td>

[`AppFileModel`](../classes/AppFileModel.md)

</td>
</tr>
</tbody>
</table>

## Returns

[`StoredAppFile`](../interfaces/StoredAppFile.md)

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/BackupAuthProvider

# BackupAuthProvider

> **BackupAuthProvider**(`__namedParameters`: [`BackupAuthProviderProps`](../interfaces/BackupAuthProviderProps.md)): `Element`

Defined in: [src/react/useBackupAuth.ts:145](https://github.com/anuma-ai/sdk/blob/main/src/react/useBackupAuth.ts#145)

Unified provider component for backup OAuth authentication.

Wrap your app with this provider to enable both Dropbox and Google Drive
authentication. It handles the OAuth 2.0 Authorization Code flow with
refresh tokens for both providers.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`__namedParameters`

</td>
<td>

[`BackupAuthProviderProps`](../interfaces/BackupAuthProviderProps.md)

</td>
</tr>
</tbody>
</table>

## Returns

`Element`

## Example

```tsx
import { BackupAuthProvider } from "@anuma/sdk/react";

function App() {
  return (
    <BackupAuthProvider
      dropboxAppKey={process.env.NEXT_PUBLIC_DROPBOX_APP_KEY}
      dropboxCallbackPath="/auth/dropbox/callback"
      googleClientId={process.env.NEXT_PUBLIC_GOOGLE_CLIENT_ID}
      googleCallbackPath="/auth/google/callback"
      icloudApiToken={process.env.NEXT_PUBLIC_CLOUDKIT_API_TOKEN}
      icloudContainerIdentifier="iCloud.Memoryless"
      apiClient={apiClient}
    >
      <MyApp />
    </BackupAuthProvider>
  );
}
```

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/ChartCard

# ChartCard

> **ChartCard**(`__namedParameters`: [`ChartCardProps`](../type-aliases/ChartCardProps.md)): `Element`

Defined in: [src/react/chart.tsx:367](https://github.com/anuma-ai/sdk/blob/main/src/react/chart.tsx#367)

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`__namedParameters`

</td>
<td>

[`ChartCardProps`](../type-aliases/ChartCardProps.md)

</td>
</tr>
</tbody>
</table>

## Returns

`Element`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/ChartContainer

# ChartContainer

> **ChartContainer**(`__namedParameters`: `ClassAttributes`<`HTMLDivElement`> & `HTMLAttributes`<`HTMLDivElement`> & `object`): `Element`

Defined in: [src/react/chart.tsx:93](https://github.com/anuma-ai/sdk/blob/main/src/react/chart.tsx#93)

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`__namedParameters`

</td>
<td>

`ClassAttributes`<`HTMLDivElement`> & `HTMLAttributes`<`HTMLDivElement`> & `object`

</td>
</tr>
</tbody>
</table>

## Returns

`Element`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/ChartLegendContent

# ChartLegendContent

> **ChartLegendContent**(`__namedParameters`: `ClassAttributes`<`HTMLDivElement`> & `HTMLAttributes`<`HTMLDivElement`> & `Pick`<`Props`, `"verticalAlign"` | `"payload"`> & `object`): `Element` | `null`

Defined in: [src/react/chart.tsx:263](https://github.com/anuma-ai/sdk/blob/main/src/react/chart.tsx#263)

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`__namedParameters`

</td>
<td>

`ClassAttributes`<`HTMLDivElement`> & `HTMLAttributes`<`HTMLDivElement`> & `Pick`<`Props`, `"verticalAlign"` | `"payload"`> & `object`

</td>
</tr>
</tbody>
</table>

## Returns

`Element` | `null`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/ChartStyle

# ChartStyle

> **ChartStyle**(`__namedParameters`: `object`): `Element` | `null`

Defined in: [src/react/chart.tsx:62](https://github.com/anuma-ai/sdk/blob/main/src/react/chart.tsx#62)

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`__namedParameters`

</td>
<td>

`object`

</td>
</tr>
<tr>
<td>

`__namedParameters.config`

</td>
<td>

[`ChartConfig`](../type-aliases/ChartConfig.md)

</td>
</tr>
<tr>
<td>

`__namedParameters.id`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`Element` | `null`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/ChartTooltipContent

# ChartTooltipContent

> **ChartTooltipContent**(`__namedParameters`: `Props`<`ValueType`, `NameType`> & `object` & `ClassAttributes`<`HTMLDivElement`> & `HTMLAttributes`<`HTMLDivElement`> & `object`): `Element` | `null`

Defined in: [src/react/chart.tsx:130](https://github.com/anuma-ai/sdk/blob/main/src/react/chart.tsx#130)

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`__namedParameters`

</td>
<td>

`Props`<`ValueType`, `NameType`> & `object` & `ClassAttributes`<`HTMLDivElement`> & `HTMLAttributes`<`HTMLDivElement`> & `object`

</td>
</tr>
</tbody>
</table>

## Returns

`Element` | `null`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/chunkAndEmbedAllMessages

# chunkAndEmbedAllMessages

> **chunkAndEmbedAllMessages**(`ctx`: [`StorageOperationsContext`](../interfaces/StorageOperationsContext.md), `options`: [`MemoryEngineEmbeddingOptions`](../interfaces/MemoryEngineEmbeddingOptions.md) & [`ChunkingOptions`](../interfaces/ChunkingOptions.md), `filter?`: `object`): `Promise`<`number`>

Defined in: [src/lib/memoryEngine/embeddings.ts:438](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryEngine/embeddings.ts#438)

Chunk and embed all messages without embeddings/chunks in the database.
Uses chunking for long messages, whole-message embedding for short ones.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`StorageOperationsContext`](../interfaces/StorageOperationsContext.md)

</td>
<td>

Storage operations context

</td>
</tr>
<tr>
<td>

`options`

</td>
<td>

[`MemoryEngineEmbeddingOptions`](../interfaces/MemoryEngineEmbeddingOptions.md) & [`ChunkingOptions`](../interfaces/ChunkingOptions.md)

</td>
<td>

Embedding and chunking options

</td>
</tr>
<tr>
<td>

`filter?`

</td>
<td>

`object`

</td>
<td>

Optional filter for which messages to embed

</td>
</tr>
<tr>
<td>

`filter.conversationId?`

</td>
<td>

`string`

</td>
<td>

Only embed messages from this conversation

</td>
</tr>
<tr>
<td>

`filter.minContentLength?`

</td>
<td>

`number`

</td>
<td>

Minimum content length to embed (default: 30). Shorter messages are skipped.

</td>
</tr>
<tr>
<td>

`filter.rechunkExisting?`

</td>
<td>

`boolean`

</td>
<td>

Re-chunk messages that have whole-message embeddings but no chunks

</td>
</tr>
<tr>
<td>

`filter.roles?`

</td>
<td>

(`"user"` | `"assistant"`)\[]

</td>
<td>

Only embed messages with these roles

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`number`>

Number of messages embedded

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/chunkAndEmbedMessage

# chunkAndEmbedMessage

> **chunkAndEmbedMessage**(`ctx`: [`StorageOperationsContext`](../interfaces/StorageOperationsContext.md), `messageId`: `string`, `options`: [`MemoryEngineEmbeddingOptions`](../interfaces/MemoryEngineEmbeddingOptions.md) & [`ChunkingOptions`](../interfaces/ChunkingOptions.md)): `Promise`<[`StoredMessage`](../interfaces/StoredMessage.md) | `null`>

Defined in: [src/lib/memoryEngine/embeddings.ts:376](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryEngine/embeddings.ts#376)

Chunk and embed a single message, storing chunk embeddings in the database.
For messages shorter than chunkSize, falls back to whole-message embedding.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`StorageOperationsContext`](../interfaces/StorageOperationsContext.md)

</td>
<td>

Storage operations context

</td>
</tr>
<tr>
<td>

`messageId`

</td>
<td>

`string`

</td>
<td>

Unique ID of the message to chunk and embed

</td>
</tr>
<tr>
<td>

`options`

</td>
<td>

[`MemoryEngineEmbeddingOptions`](../interfaces/MemoryEngineEmbeddingOptions.md) & [`ChunkingOptions`](../interfaces/ChunkingOptions.md)

</td>
<td>

Embedding and chunking options

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<[`StoredMessage`](../interfaces/StoredMessage.md) | `null`>

The updated message, or null if message not found

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/chunkText

# chunkText

> **chunkText**(`text`: `string`, `options?`: [`ChunkingOptions`](../interfaces/ChunkingOptions.md)): [`TextChunk`](../interfaces/TextChunk.md)\[]

Defined in: [src/lib/memoryEngine/chunking.ts:68](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryEngine/chunking.ts#68)

Split text into overlapping chunks using sentence boundaries.

Algorithm:

1. Split text into sentences
2. Accumulate sentences until chunk size is reached
3. Create chunk with overlap from previous chunk
4. Handle edge cases (very long sentences, short texts)

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`text`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`options?`

</td>
<td>

[`ChunkingOptions`](../interfaces/ChunkingOptions.md)

</td>
</tr>
</tbody>
</table>

## Returns

[`TextChunk`](../interfaces/TextChunk.md)\[]

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/clearAllEncryptionKeys

# ~~clearAllEncryptionKeys()~~

> **clearAllEncryptionKeys**(): `void`

Defined in: [src/react/useEncryption.ts:256](https://github.com/anuma-ai/sdk/blob/main/src/react/useEncryption.ts#256)

Clears all encryption keys from memory.

## Returns

`void`

## Deprecated

Use [clearAllEncryptionState](clearAllEncryptionState.md) instead. This function is kept
as an alias for backwards compatibility and now delegates to the canonical
teardown, which additionally clears `keyAvailableCallbacks`, pending key
requests, and derived ECDH key pairs (both in-memory and persisted).

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/clearAllEncryptionState

# clearAllEncryptionState

> **clearAllEncryptionState**(): `void`

Defined in: [src/react/useEncryption.ts:223](https://github.com/anuma-ai/sdk/blob/main/src/react/useEncryption.ts#223)

Clears all encryption-related state from memory and any derived persistence.

This is the canonical session-teardown entry point. It wipes every module-level
map that retains key material or listeners tied to a session: the raw
encryption keys, cached imported CryptoKey objects, availability callbacks,
pending sign-in flights, and derived ECDH key pairs. It also removes any
persisted ECDH key pairs from localStorage so they can't be decrypted by a
subsequent user on a shared browser.

Call this on logout / session-end to prevent cross-user key leakage on shared
browsers. If you manage auth outside the SDK, wire this into your logout flow.

## Returns

`void`

## Example

```tsx
import { clearAllEncryptionState } from "@anuma/sdk/react";

async function handleLogout() {
  clearAllEncryptionState();
  await privy.logout();
}
```

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/clearAllKeyPairs

# clearAllKeyPairs

> **clearAllKeyPairs**(): `void`

Defined in: [src/react/useEncryption.ts:1319](https://github.com/anuma-ai/sdk/blob/main/src/react/useEncryption.ts#1319)

Clears all key pairs from memory and any persisted entries in localStorage.

Matches the persistence behavior of the per-address [clearKeyPair](clearKeyPair.md);
without this, `clearAllKeyPairs()` would leave `ecdh_keypair_*` ciphertext
behind in storage while `clearKeyPair(address)` removes it.

## Returns

`void`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/clearCalendarToken

# clearCalendarToken

> **clearCalendarToken**(`walletAddress?`: `string`): `void`

Defined in: [src/lib/auth/google-calendar.ts:214](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/google-calendar.ts#214)

Clear stored token data for all storage locations

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`walletAddress?`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`void`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/clearDriveToken

# clearDriveToken

> **clearDriveToken**(`walletAddress?`: `string`): `void`

Defined in: [src/lib/auth/google-drive.ts:213](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/google-drive.ts#213)

Clear stored token data

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`walletAddress?`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`void`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/clearDropboxToken

# clearDropboxToken

> **clearDropboxToken**(): `void`

Defined in: [src/lib/backup/dropbox/auth.ts:307](https://github.com/anuma-ai/sdk/blob/main/src/lib/backup/dropbox/auth.ts#307)

Clear Dropbox token data

## Returns

`void`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/clearEncryptionKey

# clearEncryptionKey

> **clearEncryptionKey**(`address`: `string`): `void`

Defined in: [src/react/useEncryption.ts:194](https://github.com/anuma-ai/sdk/blob/main/src/react/useEncryption.ts#194)

Clears the encryption key for a wallet address from memory

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`address`

</td>
<td>

`string`

</td>
<td>

The wallet address

</td>
</tr>
</tbody>
</table>

## Returns

`void`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/clearGithubToken

# clearGithubToken

> **clearGithubToken**(`walletAddress?`: `string`): `void`

Defined in: [src/lib/auth/github.ts:213](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/github.ts#213)

Clear stored token data

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`walletAddress?`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`void`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/clearGoogleDriveToken

# clearGoogleDriveToken

> **clearGoogleDriveToken**(): `void`

Defined in: [src/lib/backup/google/auth.ts:344](https://github.com/anuma-ai/sdk/blob/main/src/lib/backup/google/auth.ts#344)

Clear Google Drive token data

## Returns

`void`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/clearICloudAuth

# clearICloudAuth

> **clearICloudAuth**(): `void`

Defined in: [src/react/useICloudAuth.ts:232](https://github.com/anuma-ai/sdk/blob/main/src/react/useICloudAuth.ts#232)

Clear iCloud authentication state
Note: This only clears local state; user remains signed in to iCloud

## Returns

`void`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/clearKeyPair

# clearKeyPair

> **clearKeyPair**(`address`: `string`): `void`

Defined in: [src/react/useEncryption.ts:1307](https://github.com/anuma-ai/sdk/blob/main/src/react/useEncryption.ts#1307)

Clears the key pair for a wallet address from memory and localStorage

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`address`

</td>
<td>

`string`

</td>
<td>

The wallet address

</td>
</tr>
</tbody>
</table>

## Returns

`void`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/clearLazyTitleCache

# clearLazyTitleCache

> **clearLazyTitleCache**(): `void`

Defined in: [src/lib/db/chat/lazyDecrypt.ts:100](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/lazyDecrypt.ts#100)

Drop every cached plaintext title and pending decrypt promise.

Wired into `clearAllEncryptionState()` via the listener registry in
`useEncryption.ts`. Also exported so consumers can clear the cache
proactively (e.g. on wallet switch within a session before the
full encryption-state teardown lands).

## Returns

`void`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/clearNotionToken

# clearNotionToken

> **clearNotionToken**(`walletAddress?`: `string`): `void`

Defined in: [src/lib/auth/notion.ts:456](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/notion.ts#456)

Clear stored token data from all storage locations

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`walletAddress?`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`void`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/clearServerToolsCache

# clearServerToolsCache

> **clearServerToolsCache**(): `void`

Defined in: [src/lib/tools/serverTools.ts:290](https://github.com/anuma-ai/sdk/blob/main/src/lib/tools/serverTools.ts#290)

Clear the server tools cache

## Returns

`void`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/cosineInt8

# cosineInt8

> **cosineInt8**(`a`: `Int8Array`, `scaleA`: `number`, `b`: `Int8Array`, `scaleB`: `number`): `number`

Defined in: [src/lib/memoryEngine/quantization.ts:119](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryEngine/quantization.ts#119)

Cosine similarity between two Int8-quantized embeddings.

The integer dot product is exact; the per-vector scales cancel
because cosine normalizes by both magnitudes — passing scaleA and
scaleB is supported for symmetry with the dequantized API but they
are mathematically irrelevant when both vectors share the same
quantization scheme. They are still validated to catch zero-magnitude
(zero-vector) inputs cleanly.

Returns 0 when either vector is zero or dimensions differ. Result is
clamped to \[-1, 1] to absorb floating-point error from sqrt.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`a`

</td>
<td>

`Int8Array`

</td>
<td>

First quantized vector.

</td>
</tr>
<tr>
<td>

`scaleA`

</td>
<td>

`number`

</td>
<td>

Scale factor for `a`. Used only to detect zero vectors.

</td>
</tr>
<tr>
<td>

`b`

</td>
<td>

`Int8Array`

</td>
<td>

Second quantized vector.

</td>
</tr>
<tr>
<td>

`scaleB`

</td>
<td>

`number`

</td>
<td>

Scale factor for `b`. Used only to detect zero vectors.

</td>
</tr>
</tbody>
</table>

## Returns

`number`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/createGitHubTools

# createGitHubTools

> **createGitHubTools**(`getAccessToken`: () => `string` | `null`, `requestGitHubAccess`: () => `Promise`<`string`>): `ToolConfig`\[]

Defined in: [src/tools/github.ts:207](https://github.com/anuma-ai/sdk/blob/main/src/tools/github.ts#207)

Create GitHub tools for the chat system.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`getAccessToken`

</td>
<td>

() => `string` | `null`

</td>
<td>

Returns the current GitHub access token (or null)

</td>
</tr>
<tr>
<td>

`requestGitHubAccess`

</td>
<td>

() => `Promise`<`string`>

</td>
<td>

Triggers the OAuth flow and returns a token

</td>
</tr>
</tbody>
</table>

## Returns

`ToolConfig`\[]

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/createMediaBatchOp

# createMediaBatchOp

> **createMediaBatchOp**(`ctx`: [`MediaOperationsContext`](../interfaces/MediaOperationsContext.md), `optionsArray`: [`CreateMediaOptions`](../interfaces/CreateMediaOptions.md)\[]): `Promise`<[`StoredMedia`](../interfaces/StoredMedia.md)\[]>

Defined in: [src/lib/db/media/operations.ts:142](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/operations.ts#142)

Create multiple media records in a batch.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`MediaOperationsContext`](../interfaces/MediaOperationsContext.md)

</td>
</tr>
<tr>
<td>

`optionsArray`

</td>
<td>

[`CreateMediaOptions`](../interfaces/CreateMediaOptions.md)\[]

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<[`StoredMedia`](../interfaces/StoredMedia.md)\[]>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/createMediaOp

# createMediaOp

> **createMediaOp**(`ctx`: [`MediaOperationsContext`](../interfaces/MediaOperationsContext.md), `options`: [`CreateMediaOptions`](../interfaces/CreateMediaOptions.md)): `Promise`<[`StoredMedia`](../interfaces/StoredMedia.md)>

Defined in: [src/lib/db/media/operations.ts:86](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/operations.ts#86)

Create a new media record.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`MediaOperationsContext`](../interfaces/MediaOperationsContext.md)

</td>
</tr>
<tr>
<td>

`options`

</td>
<td>

[`CreateMediaOptions`](../interfaces/CreateMediaOptions.md)

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<[`StoredMedia`](../interfaces/StoredMedia.md)>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/createMemoryEngineTool

# createMemoryEngineTool

> **createMemoryEngineTool**(`storageCtx`: [`StorageOperationsContext`](../interfaces/StorageOperationsContext.md), `embeddingOptions`: [`MemoryEngineEmbeddingOptions`](../interfaces/MemoryEngineEmbeddingOptions.md), `searchOptions?`: `Partial`<[`MemoryEngineSearchOptions`](../interfaces/MemoryEngineSearchOptions.md)>, `callbacks?`: `object`): `ToolConfig`

Defined in: [src/lib/memoryEngine/tool.ts:93](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryEngine/tool.ts#93)

Creates a memory engine tool for use with chat completions.

The tool allows the LLM to search through past conversation messages
using semantic similarity. Messages must have embeddings stored to be searchable.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`storageCtx`

</td>
<td>

[`StorageOperationsContext`](../interfaces/StorageOperationsContext.md)

</td>
<td>

Storage operations context for database access

</td>
</tr>
<tr>
<td>

`embeddingOptions`

</td>
<td>

[`MemoryEngineEmbeddingOptions`](../interfaces/MemoryEngineEmbeddingOptions.md)

</td>
<td>

Options for embedding generation

</td>
</tr>
<tr>
<td>

`searchOptions?`

</td>
<td>

`Partial`<[`MemoryEngineSearchOptions`](../interfaces/MemoryEngineSearchOptions.md)>

</td>
<td>

Default search options (can be overridden per-call)

</td>
</tr>
<tr>
<td>

`callbacks?`

</td>
<td>

`object`

</td>
<td>

‐

</td>
</tr>
<tr>
<td>

`callbacks.onRetrieve?`

</td>
<td>

(`conversationIds`: `string`\[]) => `void`

</td>
<td>

Called after retrieval with the conversation IDs that were actually returned to the LLM.

</td>
</tr>
</tbody>
</table>

## Returns

`ToolConfig`

A ToolConfig that can be passed to chat completion tools

## Example

```ts
const tool = createMemoryEngineTool(
  storageCtx,
  { getToken: () => getIdentityToken() },
  { limit: 5, minSimilarity: 0.4 }
);

// Use with chat completion
const result = await sendMessage({
  messages: [...],
  tools: [tool],
});
```

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/createMemoryVaultSearchTool

# createMemoryVaultSearchTool

> **createMemoryVaultSearchTool**(`vaultCtx`: [`VaultMemoryOperationsContext`](../interfaces/VaultMemoryOperationsContext.md), `embeddingOptions`: [`MemoryEngineEmbeddingOptions`](../interfaces/MemoryEngineEmbeddingOptions.md), `cache`: [`VaultEmbeddingCache`](../type-aliases/VaultEmbeddingCache.md), `searchOptions?`: [`MemoryVaultSearchOptions`](../interfaces/MemoryVaultSearchOptions.md)): `ToolConfig`

Defined in: [src/lib/memoryVault/searchTool.ts:422](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryVault/searchTool.ts#422)

Creates a memory vault search tool for use with chat completions.

The tool allows the LLM to search through vault memories using semantic
similarity. Vault entries should have their embeddings pre-computed in the
cache (via preEmbedVaultMemories or eagerEmbedContent). Any missing
embeddings are computed on the fly as a fallback.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`vaultCtx`

</td>
<td>

[`VaultMemoryOperationsContext`](../interfaces/VaultMemoryOperationsContext.md)

</td>
<td>

Vault operations context for database access

</td>
</tr>
<tr>
<td>

`embeddingOptions`

</td>
<td>

[`MemoryEngineEmbeddingOptions`](../interfaces/MemoryEngineEmbeddingOptions.md)

</td>
<td>

Options for embedding generation (auth, base URL)

</td>
</tr>
<tr>
<td>

`cache`

</td>
<td>

[`VaultEmbeddingCache`](../type-aliases/VaultEmbeddingCache.md)

</td>
<td>

Pre-populated embedding cache

</td>
</tr>
<tr>
<td>

`searchOptions?`

</td>
<td>

[`MemoryVaultSearchOptions`](../interfaces/MemoryVaultSearchOptions.md)

</td>
<td>

Optional search configuration

</td>
</tr>
</tbody>
</table>

## Returns

`ToolConfig`

A ToolConfig that can be passed to chat completion tools

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/createMemoryVaultTool

# createMemoryVaultTool

> **createMemoryVaultTool**(`vaultCtx`: [`VaultMemoryOperationsContext`](../interfaces/VaultMemoryOperationsContext.md), `options?`: [`MemoryVaultToolOptions`](../interfaces/MemoryVaultToolOptions.md), `embeddingOptions?`: [`MemoryEngineEmbeddingOptions`](../interfaces/MemoryEngineEmbeddingOptions.md), `cache?`: [`VaultEmbeddingCache`](../type-aliases/VaultEmbeddingCache.md)): `ToolConfig`

Defined in: [src/lib/memoryVault/tool.ts:86](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryVault/tool.ts#86)

Creates a memory vault tool for use with chat completions.

The tool allows the LLM to save and update persistent memories.
Each operation can be intercepted for user confirmation before committing.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`vaultCtx`

</td>
<td>

[`VaultMemoryOperationsContext`](../interfaces/VaultMemoryOperationsContext.md)

</td>
<td>

Vault operations context for database access

</td>
</tr>
<tr>
<td>

`options?`

</td>
<td>

[`MemoryVaultToolOptions`](../interfaces/MemoryVaultToolOptions.md)

</td>
<td>

Optional configuration (onSave callback for confirmation)

</td>
</tr>
<tr>
<td>

`embeddingOptions?`

</td>
<td>

[`MemoryEngineEmbeddingOptions`](../interfaces/MemoryEngineEmbeddingOptions.md)

</td>
<td>

‐

</td>
</tr>
<tr>
<td>

`cache?`

</td>
<td>

[`VaultEmbeddingCache`](../type-aliases/VaultEmbeddingCache.md)

</td>
<td>

‐

</td>
</tr>
</tbody>
</table>

## Returns

`ToolConfig`

A ToolConfig that can be passed to chat completion tools

## Example

```ts
const tool = createMemoryVaultTool(vaultCtx, {
  onSave: async (op) => {
    // Show confirmation toast, return true/false
    return await showConfirmationToast(op);
  },
});

await sendMessage({
  messages: [...],
  clientTools: [tool],
});
```

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/createProjectOp

# createProjectOp

> **createProjectOp**(`ctx`: [`ProjectOperationsContext`](../interfaces/ProjectOperationsContext.md), `opts?`: [`CreateProjectOptions`](../interfaces/CreateProjectOptions.md), `defaultName?`: `string`): `Promise`<[`StoredProject`](../interfaces/StoredProject.md)>

Defined in: [src/lib/db/project/operations.ts:35](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/project/operations.ts#35)

Create a new project.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Default value</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`ProjectOperationsContext`](../interfaces/ProjectOperationsContext.md)

</td>
<td>

`undefined`

</td>
</tr>
<tr>
<td>

`opts?`

</td>
<td>

[`CreateProjectOptions`](../interfaces/CreateProjectOptions.md)

</td>
<td>

`undefined`

</td>
</tr>
<tr>
<td>

`defaultName?`

</td>
<td>

`string`

</td>
<td>

`"New Project"`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<[`StoredProject`](../interfaces/StoredProject.md)>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/createSavedToolOp

# createSavedToolOp

> **createSavedToolOp**(`ctx`: [`SavedToolOperationsContext`](../interfaces/SavedToolOperationsContext.md), `opts`: [`CreateSavedToolOptions`](../interfaces/CreateSavedToolOptions.md)): `Promise`<[`StoredSavedTool`](../interfaces/StoredSavedTool.md)>

Defined in: [src/lib/db/savedTools/operations.ts:30](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/savedTools/operations.ts#30)

Create a new saved tool record.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`SavedToolOperationsContext`](../interfaces/SavedToolOperationsContext.md)

</td>
</tr>
<tr>
<td>

`opts`

</td>
<td>

[`CreateSavedToolOptions`](../interfaces/CreateSavedToolOptions.md)

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<[`StoredSavedTool`](../interfaces/StoredSavedTool.md)>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/createServerToolsFilter

# createServerToolsFilter

> **createServerToolsFilter**(`options`: [`CreateServerToolsFilterOptions`](../interfaces/CreateServerToolsFilterOptions.md)): (`embeddings`: `number`\[] | `number`\[]\[], `tools`: [`ServerTool`](../interfaces/ServerTool.md)\[]) => `string`\[]

Defined in: [src/lib/tools/serverTools.ts:1039](https://github.com/anuma-ai/sdk/blob/main/src/lib/tools/serverTools.ts#1039)

Build a server-tools filter function for use with `useChatStorage`'s
`serverTools` option. Composes `findMatchingTools`, `expandToolSetsAdditive`,
and an exclude-list into a single (embeddings, tools) → string\[] callback.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`CreateServerToolsFilterOptions`](../interfaces/CreateServerToolsFilterOptions.md)

</td>
</tr>
</tbody>
</table>

## Returns

> (`embeddings`: `number`\[] | `number`\[]\[], `tools`: [`ServerTool`](../interfaces/ServerTool.md)\[]): `string`\[]

### Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`embeddings`

</td>
<td>

`number`\[] | `number`\[]\[]

</td>
</tr>
<tr>
<td>

`tools`

</td>
<td>

[`ServerTool`](../interfaces/ServerTool.md)\[]

</td>
</tr>
</tbody>
</table>

### Returns

`string`\[]

## Example

```ts
import { createServerToolsFilter } from "@anuma/sdk/tools";

const serverTools = createServerToolsFilter({
  toolSets: [
    {
      name: "fal",
      members: ["AnumaFalMCP-fal_run", "AnumaFalMCP-fal_queue_submit", ...],
      anchors: ["AnumaFalMCP-fal_run", "AnumaFalMCP-fal_queue_submit", ...],
      anchorMinSimilarity: 0.7,
    },
  ],
  excludeTools: ["AnumaFalMCP-fal_billing"],
  matchOptions: { limit: 5, minSimilarity: 0.5 },
});
```

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/createVaultEmbeddingCache

# createVaultEmbeddingCache

> **createVaultEmbeddingCache**(`maxSize`: `number`): [`VaultEmbeddingCache`](../type-aliases/VaultEmbeddingCache.md)

Defined in: [src/lib/memoryVault/lruCache.ts:45](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryVault/lruCache.ts#45)

Create a VaultEmbeddingCache backed by an LRU with a default cap of 1000 entries.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Default value</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`maxSize`

</td>
<td>

`number`

</td>
<td>

`DEFAULT_VAULT_CACHE_SIZE`

</td>
</tr>
</tbody>
</table>

## Returns

[`VaultEmbeddingCache`](../type-aliases/VaultEmbeddingCache.md)

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/createVaultFolderOp

# createVaultFolderOp

> **createVaultFolderOp**(`ctx`: [`VaultFolderOperationsContext`](../interfaces/VaultFolderOperationsContext.md), `opts`: [`CreateVaultFolderOptions`](../interfaces/CreateVaultFolderOptions.md)): `Promise`<[`StoredVaultFolder`](../interfaces/StoredVaultFolder.md)>

Defined in: [src/lib/db/vaultFolders/operations.ts:34](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/vaultFolders/operations.ts#34)

Create a new vault folder.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`VaultFolderOperationsContext`](../interfaces/VaultFolderOperationsContext.md)

</td>
</tr>
<tr>
<td>

`opts`

</td>
<td>

[`CreateVaultFolderOptions`](../interfaces/CreateVaultFolderOptions.md)

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<[`StoredVaultFolder`](../interfaces/StoredVaultFolder.md)>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/createVaultMemoriesBatchOp

# createVaultMemoriesBatchOp

> **createVaultMemoriesBatchOp**(`ctx`: [`VaultMemoryOperationsContext`](../interfaces/VaultMemoryOperationsContext.md), `optionsArray`: [`CreateVaultMemoryOptions`](../interfaces/CreateVaultMemoryOptions.md)\[]): `Promise`<[`StoredVaultMemory`](../interfaces/StoredVaultMemory.md)\[]>

Defined in: [src/lib/db/memoryVault/operations.ts:105](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/memoryVault/operations.ts#105)

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`VaultMemoryOperationsContext`](../interfaces/VaultMemoryOperationsContext.md)

</td>
</tr>
<tr>
<td>

`optionsArray`

</td>
<td>

[`CreateVaultMemoryOptions`](../interfaces/CreateVaultMemoryOptions.md)\[]

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<[`StoredVaultMemory`](../interfaces/StoredVaultMemory.md)\[]>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/createVaultMemoryOp

# createVaultMemoryOp

> **createVaultMemoryOp**(`ctx`: [`VaultMemoryOperationsContext`](../interfaces/VaultMemoryOperationsContext.md), `opts`: [`CreateVaultMemoryOptions`](../interfaces/CreateVaultMemoryOptions.md)): `Promise`<[`StoredVaultMemory`](../interfaces/StoredVaultMemory.md)>

Defined in: [src/lib/db/memoryVault/operations.ts:74](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/memoryVault/operations.ts#74)

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`VaultMemoryOperationsContext`](../interfaces/VaultMemoryOperationsContext.md)

</td>
</tr>
<tr>
<td>

`opts`

</td>
<td>

[`CreateVaultMemoryOptions`](../interfaces/CreateVaultMemoryOptions.md)

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<[`StoredVaultMemory`](../interfaces/StoredVaultMemory.md)>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/decryptConversationTitle

# decryptConversationTitle

> **decryptConversationTitle**(`encryptedTitle`: `string`, `address`: `string`): `Promise`<`string`>

Defined in: [src/lib/db/chat/lazyDecrypt.ts:148](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/lazyDecrypt.ts#148)

Decrypt a single conversation title on demand.

Designed for the lazy display path: pair with `listConversationsLazy`
and call this once a row is actually visible.

Behavior:

* Plaintext input (no `enc:` prefix) is returned unchanged. This
  covers conversations created before encryption was enabled and
  keeps the helper safe to call unconditionally from rendering
  code that may receive a mix of encrypted and plaintext titles.
* Encrypted input is decrypted via `decryptField`, which uses the
  same per-version cached `CryptoKey` as the eager path — no new
  key derivations are triggered.
* Concurrent calls for the same `(address, encryptedTitle)` share
  a single decrypt promise.
* The result is memoized in a 256-entry LRU.

Throws if the encryption key for `address` isn't loaded. (The
underlying `decryptField` would otherwise silently return the
ciphertext, which would surface to the UI as a literal `enc:v3:...`
title — strictly worse than a thrown error the caller can catch.)

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`encryptedTitle`

</td>
<td>

`string`

</td>
<td>

The stored title. May be ciphertext or plaintext.

</td>
</tr>
<tr>
<td>

`address`

</td>
<td>

`string`

</td>
<td>

Wallet address that owns the encryption key.

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`string`>

The decrypted plaintext title.

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/decryptDataBytes

# decryptDataBytes

> **decryptDataBytes**(`encryptedHex`: `string`, `address`: `string`, `version`: `EncryptionKeyVersion`): `Promise`<`Uint8Array`<`ArrayBufferLike`>>

Defined in: [src/react/useEncryption.ts:641](https://github.com/anuma-ai/sdk/blob/main/src/react/useEncryption.ts#641)

Decrypts data and returns as Uint8Array (for binary data)

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`encryptedHex`

</td>
<td>

`string`

</td>
<td>

`undefined`

</td>
<td>

Encrypted data as hex string (IV + ciphertext + auth tag)

</td>
</tr>
<tr>
<td>

`address`

</td>
<td>

`string`

</td>
<td>

`undefined`

</td>
<td>

‐

</td>
</tr>
<tr>
<td>

`version`

</td>
<td>

`EncryptionKeyVersion`

</td>
<td>

`"v3"`

</td>
<td>

‐

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`Uint8Array`<`ArrayBufferLike`>>

Decrypted data as Uint8Array

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/decryptDataWithKey

# decryptDataWithKey

> **decryptDataWithKey**(`encryptedHex`: `string`, `key`: `CryptoKey`): `Promise`<`string`>

Defined in: [src/react/useEncryption.ts:730](https://github.com/anuma-ai/sdk/blob/main/src/react/useEncryption.ts#730)

**`Internal`**

Decrypts data using a pre-fetched CryptoKey.
Use this for batch operations to avoid repeated key lookups.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`encryptedHex`

</td>
<td>

`string`

</td>
<td>

Encrypted data as hex string (IV + ciphertext + auth tag)

</td>
</tr>
<tr>
<td>

`key`

</td>
<td>

`CryptoKey`

</td>
<td>

The CryptoKey for AES-GCM decryption

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`string`>

Decrypted data as string

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/deleteAllAppFilesOp

# deleteAllAppFilesOp

> **deleteAllAppFilesOp**(`ctx`: [`AppFileOperationsContext`](../interfaces/AppFileOperationsContext.md), `conversationId`: `string`): `Promise`<`void`>

Defined in: [src/lib/db/appFiles/operations.ts:122](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/appFiles/operations.ts#122)

Delete all files for a conversation.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`AppFileOperationsContext`](../interfaces/AppFileOperationsContext.md)

</td>
</tr>
<tr>
<td>

`conversationId`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`void`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/deleteAllVaultMemoriesForUserOp

# deleteAllVaultMemoriesForUserOp

> **deleteAllVaultMemoriesForUserOp**(`ctx`: [`VaultMemoryOperationsContext`](../interfaces/VaultMemoryOperationsContext.md), `userId`: `string`): `Promise`<`number`>

Defined in: [src/lib/db/memoryVault/operations.ts:288](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/memoryVault/operations.ts#288)

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`VaultMemoryOperationsContext`](../interfaces/VaultMemoryOperationsContext.md)

</td>
</tr>
<tr>
<td>

`userId`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`number`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/deleteAppFileOp

# deleteAppFileOp

> **deleteAppFileOp**(`ctx`: [`AppFileOperationsContext`](../interfaces/AppFileOperationsContext.md), `conversationId`: `string`, `path`: `string`): `Promise`<`boolean`>

Defined in: [src/lib/db/appFiles/operations.ts:102](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/appFiles/operations.ts#102)

Delete a single file by conversationId and path.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`AppFileOperationsContext`](../interfaces/AppFileOperationsContext.md)

</td>
</tr>
<tr>
<td>

`conversationId`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`path`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`boolean`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/deleteEncryptedFile

# deleteEncryptedFile

> **deleteEncryptedFile**(`fileId`: `string`): `Promise`<`void`>

Defined in: [src/lib/storage/opfs.ts:274](https://github.com/anuma-ai/sdk/blob/main/src/lib/storage/opfs.ts#274)

Deletes a file from OPFS.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`fileId`

</td>
<td>

`string`

</td>
<td>

The file identifier

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`void`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/deleteMediaByConversationOp

# deleteMediaByConversationOp

> **deleteMediaByConversationOp**(`ctx`: [`MediaOperationsContext`](../interfaces/MediaOperationsContext.md), `conversationId`: `string`): `Promise`<`number`>

Defined in: [src/lib/db/media/operations.ts:809](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/operations.ts#809)

Delete all media for a conversation (when conversation is deleted).
Clears source\_url, removes files from OPFS, but keeps all metadata.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`MediaOperationsContext`](../interfaces/MediaOperationsContext.md)

</td>
</tr>
<tr>
<td>

`conversationId`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`number`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/deleteMediaByMessageOp

# deleteMediaByMessageOp

> **deleteMediaByMessageOp**(`ctx`: [`MediaOperationsContext`](../interfaces/MediaOperationsContext.md), `messageId`: `string`): `Promise`<`number`>

Defined in: [src/lib/db/media/operations.ts:846](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/operations.ts#846)

Delete all media for a message (when message is deleted).
Clears source\_url, removes files from OPFS, but keeps all metadata.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`MediaOperationsContext`](../interfaces/MediaOperationsContext.md)

</td>
</tr>
<tr>
<td>

`messageId`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`number`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/deleteMediaOp

# deleteMediaOp

> **deleteMediaOp**(`ctx`: [`MediaOperationsContext`](../interfaces/MediaOperationsContext.md), `mediaId`: `string`): `Promise`<`boolean`>

Defined in: [src/lib/db/media/operations.ts:428](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/operations.ts#428)

Soft delete a media record.
Clears source\_url, removes file from OPFS, but keeps all metadata.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`MediaOperationsContext`](../interfaces/MediaOperationsContext.md)

</td>
</tr>
<tr>
<td>

`mediaId`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`boolean`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/deleteProjectOp

# deleteProjectOp

> **deleteProjectOp**(`ctx`: [`ProjectOperationsContext`](../interfaces/ProjectOperationsContext.md), `id`: `string`): `Promise`<`boolean`>

Defined in: [src/lib/db/project/operations.ts:128](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/project/operations.ts#128)

Soft delete a project. Does not delete associated conversations.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`ProjectOperationsContext`](../interfaces/ProjectOperationsContext.md)

</td>
</tr>
<tr>
<td>

`id`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`boolean`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/deleteSavedToolOp

# deleteSavedToolOp

> **deleteSavedToolOp**(`ctx`: [`SavedToolOperationsContext`](../interfaces/SavedToolOperationsContext.md), `uniqueId`: `string`): `Promise`<`boolean`>

Defined in: [src/lib/db/savedTools/operations.ts:110](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/savedTools/operations.ts#110)

Soft-delete a saved tool. Returns true if the record was found and deleted.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`SavedToolOperationsContext`](../interfaces/SavedToolOperationsContext.md)

</td>
</tr>
<tr>
<td>

`uniqueId`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`boolean`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/deleteVaultFolderOp

# deleteVaultFolderOp

> **deleteVaultFolderOp**(`ctx`: [`VaultFolderOperationsContext`](../interfaces/VaultFolderOperationsContext.md), `id`: `string`): `Promise`<`boolean`>

Defined in: [src/lib/db/vaultFolders/operations.ts:117](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/vaultFolders/operations.ts#117)

Soft-delete a vault folder and unfile all its memories in a single write.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`VaultFolderOperationsContext`](../interfaces/VaultFolderOperationsContext.md)

</td>
</tr>
<tr>
<td>

`id`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`boolean`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/deleteVaultMemoryOp

# deleteVaultMemoryOp

> **deleteVaultMemoryOp**(`ctx`: [`VaultMemoryOperationsContext`](../interfaces/VaultMemoryOperationsContext.md), `id`: `string`): `Promise`<`boolean`>

Defined in: [src/lib/db/memoryVault/operations.ts:251](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/memoryVault/operations.ts#251)

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`VaultMemoryOperationsContext`](../interfaces/VaultMemoryOperationsContext.md)

</td>
</tr>
<tr>
<td>

`id`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`boolean`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/dequantizeEmbedding

# dequantizeEmbedding

> **dequantizeEmbedding**(`__namedParameters`: [`QuantizedEmbedding`](../interfaces/QuantizedEmbedding.md)): `Float32Array`

Defined in: [src/lib/memoryEngine/quantization.ts:89](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryEngine/quantization.ts#89)

Dequantize an Int8 embedding back into Float32.

Inverse of [quantizeEmbedding](quantizeEmbedding.md) up to ~1/127 quantization error.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`__namedParameters`

</td>
<td>

[`QuantizedEmbedding`](../interfaces/QuantizedEmbedding.md)

</td>
</tr>
</tbody>
</table>

## Returns

`Float32Array`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/DropboxAuthProvider

# DropboxAuthProvider

> **DropboxAuthProvider**(`__namedParameters`: [`DropboxAuthProviderProps`](../interfaces/DropboxAuthProviderProps.md)): `Element`

Defined in: [src/react/useDropboxAuth.ts:92](https://github.com/anuma-ai/sdk/blob/main/src/react/useDropboxAuth.ts#92)

Provider component for Dropbox OAuth authentication.

Wrap your app with this provider to enable Dropbox authentication.
It handles the OAuth 2.0 Authorization Code flow with refresh tokens.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`__namedParameters`

</td>
<td>

[`DropboxAuthProviderProps`](../interfaces/DropboxAuthProviderProps.md)

</td>
</tr>
</tbody>
</table>

## Returns

`Element`

## Example

```tsx
import { DropboxAuthProvider } from "@anuma/sdk/react";

function App() {
  return (
    <DropboxAuthProvider
      appKey={process.env.NEXT_PUBLIC_DROPBOX_APP_KEY}
      callbackPath="/auth/dropbox/callback"
    >
      <MyApp />
    </DropboxAuthProvider>
  );
}
```

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/eagerEmbedContent

# eagerEmbedContent

> **eagerEmbedContent**(`content`: `string`, `embeddingOptions`: [`MemoryEngineEmbeddingOptions`](../interfaces/MemoryEngineEmbeddingOptions.md), `cache`: [`VaultEmbeddingCache`](../type-aliases/VaultEmbeddingCache.md), `vaultCtx?`: [`VaultMemoryOperationsContext`](../interfaces/VaultMemoryOperationsContext.md), `memoryId?`: `string`): `Promise`<`void`>

Defined in: [src/lib/memoryVault/searchTool.ts:269](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryVault/searchTool.ts#269)

Eagerly embed a single piece of content and store it in the cache.
Call this when a vault memory is created or updated.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`content`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`embeddingOptions`

</td>
<td>

[`MemoryEngineEmbeddingOptions`](../interfaces/MemoryEngineEmbeddingOptions.md)

</td>
</tr>
<tr>
<td>

`cache`

</td>
<td>

[`VaultEmbeddingCache`](../type-aliases/VaultEmbeddingCache.md)

</td>
</tr>
<tr>
<td>

`vaultCtx?`

</td>
<td>

[`VaultMemoryOperationsContext`](../interfaces/VaultMemoryOperationsContext.md)

</td>
</tr>
<tr>
<td>

`memoryId?`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`void`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/embedAllMessages

# embedAllMessages

> **embedAllMessages**(`ctx`: [`StorageOperationsContext`](../interfaces/StorageOperationsContext.md), `options`: [`MemoryEngineEmbeddingOptions`](../interfaces/MemoryEngineEmbeddingOptions.md), `filter?`: `object`): `Promise`<`number`>

Defined in: [src/lib/memoryEngine/embeddings.ts:308](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryEngine/embeddings.ts#308)

Embed all messages without embeddings in the database

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`StorageOperationsContext`](../interfaces/StorageOperationsContext.md)

</td>
<td>

Storage operations context

</td>
</tr>
<tr>
<td>

`options`

</td>
<td>

[`MemoryEngineEmbeddingOptions`](../interfaces/MemoryEngineEmbeddingOptions.md)

</td>
<td>

Embedding options

</td>
</tr>
<tr>
<td>

`filter?`

</td>
<td>

`object`

</td>
<td>

Optional filter for which messages to embed

</td>
</tr>
<tr>
<td>

`filter.conversationId?`

</td>
<td>

`string`

</td>
<td>

Only embed messages from this conversation

</td>
</tr>
<tr>
<td>

`filter.minContentLength?`

</td>
<td>

`number`

</td>
<td>

Minimum content length to embed (default: 30). Shorter messages are skipped.

</td>
</tr>
<tr>
<td>

`filter.roles?`

</td>
<td>

(`"user"` | `"assistant"`)\[]

</td>
<td>

Only embed messages with these roles

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`number`>

Number of messages embedded

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/embedMessage

# embedMessage

> **embedMessage**(`ctx`: [`StorageOperationsContext`](../interfaces/StorageOperationsContext.md), `messageId`: `string`, `options`: [`MemoryEngineEmbeddingOptions`](../interfaces/MemoryEngineEmbeddingOptions.md)): `Promise`<[`StoredMessage`](../interfaces/StoredMessage.md) | `null`>

Defined in: [src/lib/memoryEngine/embeddings.ts:268](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryEngine/embeddings.ts#268)

Embed a single message and store the embedding in the database

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`StorageOperationsContext`](../interfaces/StorageOperationsContext.md)

</td>
<td>

Storage operations context

</td>
</tr>
<tr>
<td>

`messageId`

</td>
<td>

`string`

</td>
<td>

Unique ID of the message to embed

</td>
</tr>
<tr>
<td>

`options`

</td>
<td>

[`MemoryEngineEmbeddingOptions`](../interfaces/MemoryEngineEmbeddingOptions.md)

</td>
<td>

Embedding options

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<[`StoredMessage`](../interfaces/StoredMessage.md) | `null`>

The updated message with embedding, or null if message not found

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/encryptDataWithKey

# encryptDataWithKey

> **encryptDataWithKey**(`plaintext`: `string` | `Uint8Array`<`ArrayBufferLike`>, `key`: `CryptoKey`): `Promise`<`string`>

Defined in: [src/react/useEncryption.ts:690](https://github.com/anuma-ai/sdk/blob/main/src/react/useEncryption.ts#690)

**`Internal`**

Encrypts data using a pre-fetched CryptoKey.
Use this for batch operations to avoid repeated key lookups.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`plaintext`

</td>
<td>

`string` | `Uint8Array`<`ArrayBufferLike`>

</td>
<td>

The data to encrypt (string or Uint8Array)

</td>
</tr>
<tr>
<td>

`key`

</td>
<td>

`CryptoKey`

</td>
<td>

The CryptoKey for AES-GCM encryption

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`string`>

Encrypted data as hex string (IV + ciphertext + auth tag)

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/ensureDefaultFoldersOp

# ensureDefaultFoldersOp

> **ensureDefaultFoldersOp**(`ctx`: [`VaultFolderOperationsContext`](../interfaces/VaultFolderOperationsContext.md)): `Promise`<`Map`<`string`, `string`>>

Defined in: [src/lib/db/vaultFolders/defaults.ts:20](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/vaultFolders/defaults.ts#20)

Ensure all default system folders exist. Idempotent — skips folders that already exist.
Uses a per-database promise lock so concurrent callers share a single in-flight operation.
Returns a map of ALL folder names (system + user-created) to their IDs.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`VaultFolderOperationsContext`](../interfaces/VaultFolderOperationsContext.md)

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`Map`<`string`, `string`>>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/expandToolSetsAdditive

# expandToolSetsAdditive

> **expandToolSetsAdditive**(`matchedNames`: `Set`<`string`>, `availableNames`: `Set`<`string`>, `scores`: `Map`<`string`, `number`>, `toolSets`: [`ToolSet`](../interfaces/ToolSet.md)\[], `activeSetNames?`: `ReadonlySet`<`string`>): `Set`<`string`>

Defined in: [src/lib/tools/serverTools.ts:976](https://github.com/anuma-ai/sdk/blob/main/src/lib/tools/serverTools.ts#976)

Additively expand tool sets: when any anchor of a set scores at or above
its `anchorMinSimilarity`, all set members are added to the result.
Original matches are preserved; multiple sets can expand independently.

Members of sets that *don't* activate are kept if they were individually
matched. We deliberately don't strip orphans: the cost of a single
borderline tool slipping into the request is cheap (a few extra bytes,
no behavioral impact) but stripping legitimate matches like
`create_file 0.55` on prompts where `patch_file` doesn't also clear the
anchor threshold would silently break app-creation flows. Recall over
precision.

Use this for server-side toolkit suites where the LLM needs the full
call chain (e.g. fal\_list\_models → fal\_model\_schema → fal\_queue\_submit →
fal\_queue\_status → fal\_queue\_result). Differs from `applyToolSets`, which
replaces non-set matches when a set activates.

To express "any member triggers the set" (not specific anchors), pass
`anchors: members` when defining the ToolSet.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`matchedNames`

</td>
<td>

`Set`<`string`>

</td>
<td>

Names selected by semantic matching

</td>
</tr>
<tr>
<td>

`availableNames`

</td>
<td>

`Set`<`string`>

</td>
<td>

All tool names available for selection

</td>
</tr>
<tr>
<td>

`scores`

</td>
<td>

`Map`<`string`, `number`>

</td>
<td>

Map of tool name → similarity score

</td>
</tr>
<tr>
<td>

`toolSets`

</td>
<td>

[`ToolSet`](../interfaces/ToolSet.md)\[]

</td>
<td>

Tool sets to evaluate

</td>
</tr>
<tr>
<td>

`activeSetNames?`

</td>
<td>

`ReadonlySet`<`string`>

</td>
<td>

Set names that should expand unconditionally,
bypassing the anchor-similarity check. Use this when conversation state
implies a set should be present regardless of how the current prompt is
phrased (e.g., a slide deck artifact already exists in the conversation).

</td>
</tr>
</tbody>
</table>

## Returns

`Set`<`string`>

Set including original matches plus members of any activated set

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/exportPublicKey

# exportPublicKey

> **exportPublicKey**(`address`: `string`, `signMessage`: [`SignMessageFn`](../type-aliases/SignMessageFn.md), `embeddedWalletSigner?`: [`EmbeddedWalletSignerFn`](../type-aliases/EmbeddedWalletSignerFn.md)): `Promise`<`string`>

Defined in: [src/react/useEncryption.ts:1279](https://github.com/anuma-ai/sdk/blob/main/src/react/useEncryption.ts#1279)

Exports the public key for a wallet address as SPKI format (base64)

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`address`

</td>
<td>

`string`

</td>
<td>

The wallet address

</td>
</tr>
<tr>
<td>

`signMessage`

</td>
<td>

[`SignMessageFn`](../type-aliases/SignMessageFn.md)

</td>
<td>

Function to sign a message (returns signature hex string)

</td>
</tr>
<tr>
<td>

`embeddedWalletSigner?`

</td>
<td>

[`EmbeddedWalletSignerFn`](../type-aliases/EmbeddedWalletSignerFn.md)

</td>
<td>

Optional function for silent signing with embedded wallets

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`string`>

The public key as base64-encoded SPKI string

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/extractFileIds

# extractFileIds

> **extractFileIds**(`content`: `string`): `string`\[]

Defined in: [src/lib/storage/opfs.ts:28](https://github.com/anuma-ai/sdk/blob/main/src/lib/storage/opfs.ts#28)

Extracts file IDs from content containing placeholders.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`content`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`string`\[]

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/fileExists

# fileExists

> **fileExists**(`fileId`: `string`): `Promise`<`boolean`>

Defined in: [src/lib/storage/opfs.ts:294](https://github.com/anuma-ai/sdk/blob/main/src/lib/storage/opfs.ts#294)

Checks if a file exists in OPFS.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`fileId`

</td>
<td>

`string`

</td>
<td>

The file identifier

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`boolean`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/findById

# findById

> **findById**(`root`: [`AnumaNode`](../interfaces/AnumaNode.md), `id`: `string`): [`AnumaNode`](../interfaces/AnumaNode.md) | `null`

Defined in: [src/tools/slides/jsx.ts:1070](https://github.com/anuma-ai/sdk/blob/main/src/tools/slides/jsx.ts#1070)

Find the first node whose `attrs.id` matches `id`.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`root`

</td>
<td>

[`AnumaNode`](../interfaces/AnumaNode.md)

</td>
</tr>
<tr>
<td>

`id`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

[`AnumaNode`](../interfaces/AnumaNode.md) | `null`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/findMatchingTools

# findMatchingTools

> **findMatchingTools**(`promptEmbeddings`: `number`\[] | `number`\[]\[], `tools`: [`ServerTool`](../interfaces/ServerTool.md)\[], `options?`: [`ToolMatchOptions`](../interfaces/ToolMatchOptions.md)): [`ToolMatchResult`](../interfaces/ToolMatchResult.md)\[]

Defined in: [src/lib/tools/serverTools.ts:701](https://github.com/anuma-ai/sdk/blob/main/src/lib/tools/serverTools.ts#701)

Find tools that semantically match prompt embedding(s).

Accepts either a single embedding or an array of embeddings (e.g., from chunked messages).
When multiple embeddings are provided, uses max similarity across all chunks for each tool.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`promptEmbeddings`

</td>
<td>

`number`\[] | `number`\[]\[]

</td>
<td>

Single embedding vector or array of embeddings (for chunked messages)

</td>
</tr>
<tr>
<td>

`tools`

</td>
<td>

[`ServerTool`](../interfaces/ServerTool.md)\[]

</td>
<td>

Array of server tools (with embeddings) to search through

</td>
</tr>
<tr>
<td>

`options?`

</td>
<td>

[`ToolMatchOptions`](../interfaces/ToolMatchOptions.md)

</td>
<td>

Optional matching configuration

</td>
</tr>
</tbody>
</table>

## Returns

[`ToolMatchResult`](../interfaces/ToolMatchResult.md)\[]

Array of matching tools with similarity scores, sorted by relevance

## Example

```ts
// Single embedding
const matches = findMatchingTools(embedding, tools, { limit: 5 });

// Multiple embeddings (chunked message) - uses max similarity
const matches = findMatchingTools(chunkEmbeddings, tools, { limit: 5 });
```

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/findParentOfId

# findParentOfId

> **findParentOfId**(`root`: [`AnumaNode`](../interfaces/AnumaNode.md), `id`: `string`): [`AnumaNode`](../interfaces/AnumaNode.md) | `null`

Defined in: [src/tools/slides/jsx.ts:1083](https://github.com/anuma-ai/sdk/blob/main/src/tools/slides/jsx.ts#1083)

Find the parent of the node with matching id (null if root or missing).

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`root`

</td>
<td>

[`AnumaNode`](../interfaces/AnumaNode.md)

</td>
</tr>
<tr>
<td>

`id`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

[`AnumaNode`](../interfaces/AnumaNode.md) | `null`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/generateConversationId

# generateConversationId

> **generateConversationId**(): `string`

Defined in: [src/lib/db/chat/types.ts:782](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#782)

## Returns

`string`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/generateEmbedding

# generateEmbedding

> **generateEmbedding**(`text`: `string`, `options`: [`MemoryEngineEmbeddingOptions`](../interfaces/MemoryEngineEmbeddingOptions.md)): `Promise`<`number`\[]>

Defined in: [src/lib/memoryEngine/embeddings.ts:41](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryEngine/embeddings.ts#41)

Generate an embedding for text using the API

Supports two auth methods:

* `apiKey`: Uses X-API-Key header (for server-side/CLI usage)
* `getToken`: Uses Authorization: Bearer header (for Privy identity tokens)

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`text`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`options`

</td>
<td>

[`MemoryEngineEmbeddingOptions`](../interfaces/MemoryEngineEmbeddingOptions.md)

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`number`\[]>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/generateEmbeddings

# generateEmbeddings

> **generateEmbeddings**(`texts`: `string`\[], `options`: [`MemoryEngineEmbeddingOptions`](../interfaces/MemoryEngineEmbeddingOptions.md)): `Promise`<`number`\[]\[]>

Defined in: [src/lib/memoryEngine/embeddings.ts:159](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryEngine/embeddings.ts#159)

Generate embeddings for multiple texts, automatically chunking large inputs.

More efficient than calling generateEmbedding multiple times.
Supports the same auth methods as generateEmbedding.
For inputs larger than batchSize (default 100), splits into chunks
processed with bounded concurrency (3 concurrent batches).

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`texts`

</td>
<td>

`string`\[]

</td>
<td>

Array of texts to embed

</td>
</tr>
<tr>
<td>

`options`

</td>
<td>

[`MemoryEngineEmbeddingOptions`](../interfaces/MemoryEngineEmbeddingOptions.md)

</td>
<td>

Embedding options

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`number`\[]\[]>

Array of embeddings in the same order as input texts

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/generateMediaId

# generateMediaId

> **generateMediaId**(): `string`

Defined in: [src/lib/db/media/types.ts:198](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#198)

Generate a unique media ID.

## Returns

`string`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/generateProjectId

# generateProjectId

> **generateProjectId**(): `string`

Defined in: [src/lib/db/project/types.ts:48](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/project/types.ts#48)

Generates a unique project ID with timestamp and random suffix.
Format: proj\_<timestamp>\_<random>

## Returns

`string`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/getAIGeneratedMediaOp

# getAIGeneratedMediaOp

> **getAIGeneratedMediaOp**(`ctx`: [`MediaOperationsContext`](../interfaces/MediaOperationsContext.md), `walletAddress`: `string`, `limit?`: `number`): `Promise`<[`StoredMedia`](../interfaces/StoredMedia.md)\[]>

Defined in: [src/lib/db/media/operations.ts:684](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/operations.ts#684)

Get AI-generated media for a user.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`MediaOperationsContext`](../interfaces/MediaOperationsContext.md)

</td>
</tr>
<tr>
<td>

`walletAddress`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`limit?`

</td>
<td>

`number`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<[`StoredMedia`](../interfaces/StoredMedia.md)\[]>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/getAllSavedToolsOp

# getAllSavedToolsOp

> **getAllSavedToolsOp**(`ctx`: [`SavedToolOperationsContext`](../interfaces/SavedToolOperationsContext.md)): `Promise`<[`StoredSavedTool`](../interfaces/StoredSavedTool.md)\[]>

Defined in: [src/lib/db/savedTools/operations.ts:54](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/savedTools/operations.ts#54)

Fetch all non-deleted saved tools, sorted by creation date (newest first).

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`SavedToolOperationsContext`](../interfaces/SavedToolOperationsContext.md)

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<[`StoredSavedTool`](../interfaces/StoredSavedTool.md)\[]>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/getAllVaultFoldersOp

# getAllVaultFoldersOp

> **getAllVaultFoldersOp**(`ctx`: [`VaultFolderOperationsContext`](../interfaces/VaultFolderOperationsContext.md)): `Promise`<[`StoredVaultFolder`](../interfaces/StoredVaultFolder.md)\[]>

Defined in: [src/lib/db/vaultFolders/operations.ts:53](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/vaultFolders/operations.ts#53)

Get all non-deleted vault folders, sorted by creation date (newest first).

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`VaultFolderOperationsContext`](../interfaces/VaultFolderOperationsContext.md)

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<[`StoredVaultFolder`](../interfaces/StoredVaultFolder.md)\[]>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/getAllVaultMemoriesOp

# getAllVaultMemoriesOp

> **getAllVaultMemoriesOp**(`ctx`: [`VaultMemoryOperationsContext`](../interfaces/VaultMemoryOperationsContext.md), `options?`: `object`): `Promise`<[`StoredVaultMemory`](../interfaces/StoredVaultMemory.md)\[]>

Defined in: [src/lib/db/memoryVault/operations.ts:169](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/memoryVault/operations.ts#169)

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`VaultMemoryOperationsContext`](../interfaces/VaultMemoryOperationsContext.md)

</td>
</tr>
<tr>
<td>

`options?`

</td>
<td>

`object`

</td>
</tr>
<tr>
<td>

`options.folderId?`

</td>
<td>

`string` | `null`

</td>
</tr>
<tr>
<td>

`options.limit?`

</td>
<td>

`number`

</td>
</tr>
<tr>
<td>

`options.scopes?`

</td>
<td>

`string`\[]

</td>
</tr>
<tr>
<td>

`options.since?`

</td>
<td>

`Date`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<[`StoredVaultMemory`](../interfaces/StoredVaultMemory.md)\[]>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/getAllVaultMemoryContentsOp

# getAllVaultMemoryContentsOp

> **getAllVaultMemoryContentsOp**(`ctx`: [`VaultMemoryOperationsContext`](../interfaces/VaultMemoryOperationsContext.md), `options?`: `object`): `Promise`<`string`\[]>

Defined in: [src/lib/db/memoryVault/operations.ts:188](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/memoryVault/operations.ts#188)

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`VaultMemoryOperationsContext`](../interfaces/VaultMemoryOperationsContext.md)

</td>
</tr>
<tr>
<td>

`options?`

</td>
<td>

`object`

</td>
</tr>
<tr>
<td>

`options.since?`

</td>
<td>

`Date`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`string`\[]>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/getAndClearCalendarPendingMessage

# getAndClearCalendarPendingMessage

> **getAndClearCalendarPendingMessage**(): `string` | `null`

Defined in: [src/lib/auth/google-calendar.ts:502](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/google-calendar.ts#502)

Get and clear the pending message

## Returns

`string` | `null`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/getAndClearCalendarReturnUrl

# getAndClearCalendarReturnUrl

> **getAndClearCalendarReturnUrl**(): `string` | `null`

Defined in: [src/lib/auth/google-calendar.ts:484](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/google-calendar.ts#484)

Get and clear the stored return URL

## Returns

`string` | `null`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/getAndClearDrivePendingMessage

# getAndClearDrivePendingMessage

> **getAndClearDrivePendingMessage**(): `string` | `null`

Defined in: [src/lib/auth/google-drive.ts:499](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/google-drive.ts#499)

Get and clear the pending message

## Returns

`string` | `null`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/getAndClearDriveReturnUrl

# getAndClearDriveReturnUrl

> **getAndClearDriveReturnUrl**(): `string` | `null`

Defined in: [src/lib/auth/google-drive.ts:481](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/google-drive.ts#481)

Get and clear the stored return URL

## Returns

`string` | `null`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/getAndClearGithubPendingMessage

# getAndClearGithubPendingMessage

> **getAndClearGithubPendingMessage**(): `string` | `null`

Defined in: [src/lib/auth/github.ts:503](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/github.ts#503)

Get and clear the pending message

## Returns

`string` | `null`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/getAndClearGithubReturnUrl

# getAndClearGithubReturnUrl

> **getAndClearGithubReturnUrl**(): `string` | `null`

Defined in: [src/lib/auth/github.ts:485](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/github.ts#485)

Get and clear the stored return URL

## Returns

`string` | `null`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/getAndClearNotionPendingMessage

# getAndClearNotionPendingMessage

> **getAndClearNotionPendingMessage**(): `string` | `null`

Defined in: [src/lib/auth/notion.ts:1030](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/notion.ts#1030)

Get and clear the pending message

## Returns

`string` | `null`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/getAndClearNotionReturnUrl

# getAndClearNotionReturnUrl

> **getAndClearNotionReturnUrl**(): `string` | `null`

Defined in: [src/lib/auth/notion.ts:1012](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/notion.ts#1012)

Get and clear the stored return URL

## Returns

`string` | `null`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/getAppFileMapOp

# getAppFileMapOp

> **getAppFileMapOp**(`ctx`: [`AppFileOperationsContext`](../interfaces/AppFileOperationsContext.md), `conversationId`: `string`): `Promise`<`Record`<`string`, `string`>>

Defined in: [src/lib/db/appFiles/operations.ts:91](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/appFiles/operations.ts#91)

Get all files for a conversation as a path → content map (for sending to the runner).

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`AppFileOperationsContext`](../interfaces/AppFileOperationsContext.md)

</td>
</tr>
<tr>
<td>

`conversationId`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`Record`<`string`, `string`>>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/getAppFileOp

# getAppFileOp

> **getAppFileOp**(`ctx`: [`AppFileOperationsContext`](../interfaces/AppFileOperationsContext.md), `conversationId`: `string`, `path`: `string`): `Promise`<[`StoredAppFile`](../interfaces/StoredAppFile.md) | `null`>

Defined in: [src/lib/db/appFiles/operations.ts:65](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/appFiles/operations.ts#65)

Read a single file by conversationId and path. Returns null if not found.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`AppFileOperationsContext`](../interfaces/AppFileOperationsContext.md)

</td>
</tr>
<tr>
<td>

`conversationId`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`path`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<[`StoredAppFile`](../interfaces/StoredAppFile.md) | `null`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/getAppFilesOp

# getAppFilesOp

> **getAppFilesOp**(`ctx`: [`AppFileOperationsContext`](../interfaces/AppFileOperationsContext.md), `conversationId`: `string`): `Promise`<[`StoredAppFile`](../interfaces/StoredAppFile.md)\[]>

Defined in: [src/lib/db/appFiles/operations.ts:79](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/appFiles/operations.ts#79)

List all files for a conversation.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`AppFileOperationsContext`](../interfaces/AppFileOperationsContext.md)

</td>
</tr>
<tr>
<td>

`conversationId`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<[`StoredAppFile`](../interfaces/StoredAppFile.md)\[]>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/getAudioOp

# getAudioOp

> **getAudioOp**(`ctx`: [`MediaOperationsContext`](../interfaces/MediaOperationsContext.md), `walletAddress`: `string`, `limit?`: `number`): `Promise`<[`StoredMedia`](../interfaces/StoredMedia.md)\[]>

Defined in: [src/lib/db/media/operations.ts:573](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/operations.ts#573)

Get all audio files for a user.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`MediaOperationsContext`](../interfaces/MediaOperationsContext.md)

</td>
</tr>
<tr>
<td>

`walletAddress`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`limit?`

</td>
<td>

`number`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<[`StoredMedia`](../interfaces/StoredMedia.md)\[]>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/getCachedServerTools

# getCachedServerTools

> **getCachedServerTools**(): [`CachedServerTools`](../interfaces/CachedServerTools.md) | `null`

Defined in: [src/lib/tools/serverTools.ts:233](https://github.com/anuma-ai/sdk/blob/main/src/lib/tools/serverTools.ts#233)

Get cached tools from localStorage

## Returns

[`CachedServerTools`](../interfaces/CachedServerTools.md) | `null`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/getCalendarAccessToken

# getCalendarAccessToken

> **getCalendarAccessToken**(`apiClient?`: `Client`, `walletAddress?`: `string`): `Promise`<`string` | `null`>

Defined in: [src/lib/auth/google-calendar.ts:442](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/google-calendar.ts#442)

Get a valid access token, refreshing if necessary

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`apiClient?`

</td>
<td>

`Client`

</td>
</tr>
<tr>
<td>

`walletAddress?`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`string` | `null`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/getConversationsByProjectLazyOp

# getConversationsByProjectLazyOp

> **getConversationsByProjectLazyOp**(`ctx`: [`StorageOperationsContext`](../interfaces/StorageOperationsContext.md), `projectId`: `string` | `null`): `Promise`<[`LazyStoredConversation`](../interfaces/LazyStoredConversation.md)\[]>

Defined in: [src/lib/db/chat/operations.ts:278](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/operations.ts#278)

Lazy variant of [getConversationsByProjectOp](getConversationsByProjectOp.md).

Same encrypted-title projection as [getConversationsLazyOp](getConversationsLazyOp.md),
filtered by project assignment. Pass `null` to retrieve conversations
with no project.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`StorageOperationsContext`](../interfaces/StorageOperationsContext.md)

</td>
</tr>
<tr>
<td>

`projectId`

</td>
<td>

`string` | `null`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<[`LazyStoredConversation`](../interfaces/LazyStoredConversation.md)\[]>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/getConversationsByProjectOp

# getConversationsByProjectOp

> **getConversationsByProjectOp**(`ctx`: [`StorageOperationsContext`](../interfaces/StorageOperationsContext.md), `projectId`: `string` | `null`): `Promise`<[`StoredConversation`](../interfaces/StoredConversation.md)\[]>

Defined in: [src/lib/db/chat/operations.ts:376](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/operations.ts#376)

Get conversations filtered by project ID.
Pass null to get conversations that don't belong to any project.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`StorageOperationsContext`](../interfaces/StorageOperationsContext.md)

</td>
</tr>
<tr>
<td>

`projectId`

</td>
<td>

`string` | `null`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<[`StoredConversation`](../interfaces/StoredConversation.md)\[]>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/getConversationsLazyOp

# getConversationsLazyOp

> **getConversationsLazyOp**(`ctx`: [`StorageOperationsContext`](../interfaces/StorageOperationsContext.md)): `Promise`<[`LazyStoredConversation`](../interfaces/LazyStoredConversation.md)\[]>

Defined in: [src/lib/db/chat/operations.ts:261](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/operations.ts#261)

Lazy variant of getConversationsOp.

Returns conversations with their raw stored title under
`encryptedTitle` instead of a decrypted `title`. Callers should pair
this with [decryptConversationTitle](decryptConversationTitle.md) (or the underlying
`decryptField`) and decrypt only when a row is rendered.

Behavior is identical to `getConversationsOp` except for the title
projection — sort order, soft-delete filtering, and active-conversation
scoping all match.

Encryption context on `ctx` is intentionally ignored: this op never
decrypts. That is also why the test for this op asserts call count
for `decryptField` is exactly zero.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`StorageOperationsContext`](../interfaces/StorageOperationsContext.md)

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<[`LazyStoredConversation`](../interfaces/LazyStoredConversation.md)\[]>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/getDocumentsOp

# getDocumentsOp

> **getDocumentsOp**(`ctx`: [`MediaOperationsContext`](../interfaces/MediaOperationsContext.md), `walletAddress`: `string`, `limit?`: `number`): `Promise`<[`StoredMedia`](../interfaces/StoredMedia.md)\[]>

Defined in: [src/lib/db/media/operations.ts:584](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/operations.ts#584)

Get all documents for a user.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`MediaOperationsContext`](../interfaces/MediaOperationsContext.md)

</td>
</tr>
<tr>
<td>

`walletAddress`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`limit?`

</td>
<td>

`number`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<[`StoredMedia`](../interfaces/StoredMedia.md)\[]>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/getDriveAccessToken

# getDriveAccessToken

> **getDriveAccessToken**(`apiClient?`: `Client`, `walletAddress?`: `string`): `Promise`<`string` | `null`>

Defined in: [src/lib/auth/google-drive.ts:439](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/google-drive.ts#439)

Get a valid access token, refreshing if necessary

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`apiClient?`

</td>
<td>

`Client`

</td>
</tr>
<tr>
<td>

`walletAddress?`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`string` | `null`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/getEncryptionKey

# getEncryptionKey

> **getEncryptionKey**(`address`: `string`, `version`: `EncryptionKeyVersion`): `Promise`<`CryptoKey`>

Defined in: [src/react/useEncryption.ts:522](https://github.com/anuma-ai/sdk/blob/main/src/react/useEncryption.ts#522)

Gets the encryption key from in-memory storage and imports it as a CryptoKey.
The key must have been previously requested via requestEncryptionKey.
Uses a cache to avoid re-importing the same key on every call.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`address`

</td>
<td>

`string`

</td>
<td>

`undefined`

</td>
<td>

The wallet address

</td>
</tr>
<tr>
<td>

`version`

</td>
<td>

`EncryptionKeyVersion`

</td>
<td>

`"v3"`

</td>
<td>

Which key version to use (default: "v3" for HKDF key)

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`CryptoKey`>

The CryptoKey for AES-GCM encryption/decryption

## Throws

Error if the key hasn't been requested yet

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/getGithubAccessToken

# getGithubAccessToken

> **getGithubAccessToken**(`apiClient?`: `Client`, `walletAddress?`: `string`): `Promise`<`string` | `null`>

Defined in: [src/lib/auth/github.ts:443](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/github.ts#443)

Get a valid access token, refreshing if necessary.
GitHub tokens may not expire — if no expiry is set, the stored token
is returned directly without attempting a refresh.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`apiClient?`

</td>
<td>

`Client`

</td>
</tr>
<tr>
<td>

`walletAddress?`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`string` | `null`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/getGoogleDriveStoredToken

# getGoogleDriveStoredToken

> **getGoogleDriveStoredToken**(`walletAddress?`: `string`): `Promise`<`string` | `null`>

Defined in: [src/lib/backup/google/auth.ts:337](https://github.com/anuma-ai/sdk/blob/main/src/lib/backup/google/auth.ts#337)

Get stored token data for Google Drive

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`walletAddress?`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`string` | `null`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/getId

# getId

> **getId**(`node`: [`AnumaNode`](../interfaces/AnumaNode.md)): `string` | `undefined`

Defined in: [src/tools/slides/jsx.ts:1007](https://github.com/anuma-ai/sdk/blob/main/src/tools/slides/jsx.ts#1007)

Return `attrs.id` as a string, or undefined.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`node`

</td>
<td>

[`AnumaNode`](../interfaces/AnumaNode.md)

</td>
</tr>
</tbody>
</table>

## Returns

`string` | `undefined`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/getImagesOp

# getImagesOp

> **getImagesOp**(`ctx`: [`MediaOperationsContext`](../interfaces/MediaOperationsContext.md), `walletAddress`: `string`, `limit?`: `number`): `Promise`<[`StoredMedia`](../interfaces/StoredMedia.md)\[]>

Defined in: [src/lib/db/media/operations.ts:551](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/operations.ts#551)

Get all images for a user.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`MediaOperationsContext`](../interfaces/MediaOperationsContext.md)

</td>
</tr>
<tr>
<td>

`walletAddress`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`limit?`

</td>
<td>

`number`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<[`StoredMedia`](../interfaces/StoredMedia.md)\[]>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/getLogger

# getLogger

> **getLogger**(): [`Logger`](../interfaces/Logger.md)

Defined in: [src/lib/logger.ts:57](https://github.com/anuma-ai/sdk/blob/main/src/lib/logger.ts#57)

Return the active SDK logger.

## Returns

[`Logger`](../interfaces/Logger.md)

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/getMediaByConversationOp

# getMediaByConversationOp

> **getMediaByConversationOp**(`ctx`: [`MediaOperationsContext`](../interfaces/MediaOperationsContext.md), `walletAddress`: `string`, `conversationId`: `string`, `limit?`: `number`): `Promise`<[`StoredMedia`](../interfaces/StoredMedia.md)\[]>

Defined in: [src/lib/db/media/operations.ts:595](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/operations.ts#595)

Get media by conversation.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`MediaOperationsContext`](../interfaces/MediaOperationsContext.md)

</td>
</tr>
<tr>
<td>

`walletAddress`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`conversationId`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`limit?`

</td>
<td>

`number`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<[`StoredMedia`](../interfaces/StoredMedia.md)\[]>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/getMediaByIdOp

# getMediaByIdOp

> **getMediaByIdOp**(`ctx`: [`MediaOperationsContext`](../interfaces/MediaOperationsContext.md), `mediaId`: `string`): `Promise`<[`StoredMedia`](../interfaces/StoredMedia.md) | `null`>

Defined in: [src/lib/db/media/operations.ts:206](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/operations.ts#206)

Get a media record by its media\_id.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`MediaOperationsContext`](../interfaces/MediaOperationsContext.md)

</td>
</tr>
<tr>
<td>

`mediaId`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<[`StoredMedia`](../interfaces/StoredMedia.md) | `null`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/getMediaByIdsOp

# getMediaByIdsOp

> **getMediaByIdsOp**(`ctx`: [`MediaOperationsContext`](../interfaces/MediaOperationsContext.md), `mediaIds`: `string`\[], `includeDeleted`: `boolean`): `Promise`<[`StoredMedia`](../interfaces/StoredMedia.md)\[]>

Defined in: [src/lib/db/media/operations.ts:630](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/operations.ts#630)

Get media by an array of media IDs.
Useful for fetching media using the fileIds array stored in messages.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Default value</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`MediaOperationsContext`](../interfaces/MediaOperationsContext.md)

</td>
<td>

`undefined`

</td>
</tr>
<tr>
<td>

`mediaIds`

</td>
<td>

`string`\[]

</td>
<td>

`undefined`

</td>
</tr>
<tr>
<td>

`includeDeleted`

</td>
<td>

`boolean`

</td>
<td>

`false`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<[`StoredMedia`](../interfaces/StoredMedia.md)\[]>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/getMediaByMessageOp

# getMediaByMessageOp

> **getMediaByMessageOp**(`ctx`: [`MediaOperationsContext`](../interfaces/MediaOperationsContext.md), `messageId`: `string`): `Promise`<[`StoredMedia`](../interfaces/StoredMedia.md)\[]>

Defined in: [src/lib/db/media/operations.ts:607](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/operations.ts#607)

Get media by message.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`MediaOperationsContext`](../interfaces/MediaOperationsContext.md)

</td>
</tr>
<tr>
<td>

`messageId`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<[`StoredMedia`](../interfaces/StoredMedia.md)\[]>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/getMediaByModelOp

# getMediaByModelOp

> **getMediaByModelOp**(`ctx`: [`MediaOperationsContext`](../interfaces/MediaOperationsContext.md), `walletAddress`: `string`, `model`: `string`, `limit?`: `number`): `Promise`<[`StoredMedia`](../interfaces/StoredMedia.md)\[]>

Defined in: [src/lib/db/media/operations.ts:706](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/operations.ts#706)

Get media by AI model.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`MediaOperationsContext`](../interfaces/MediaOperationsContext.md)

</td>
</tr>
<tr>
<td>

`walletAddress`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`model`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`limit?`

</td>
<td>

`number`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<[`StoredMedia`](../interfaces/StoredMedia.md)\[]>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/getMediaByRoleOp

# getMediaByRoleOp

> **getMediaByRoleOp**(`ctx`: [`MediaOperationsContext`](../interfaces/MediaOperationsContext.md), `walletAddress`: `string`, `role`: [`MediaRole`](../type-aliases/MediaRole.md), `limit?`: `number`): `Promise`<[`StoredMedia`](../interfaces/StoredMedia.md)\[]>

Defined in: [src/lib/db/media/operations.ts:672](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/operations.ts#672)

Get media by role (user uploads vs AI generated).

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`MediaOperationsContext`](../interfaces/MediaOperationsContext.md)

</td>
</tr>
<tr>
<td>

`walletAddress`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`role`

</td>
<td>

[`MediaRole`](../type-aliases/MediaRole.md)

</td>
</tr>
<tr>
<td>

`limit?`

</td>
<td>

`number`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<[`StoredMedia`](../interfaces/StoredMedia.md)\[]>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/getMediaBySourceUrlOp

# getMediaBySourceUrlOp

> **getMediaBySourceUrlOp**(`ctx`: [`MediaOperationsContext`](../interfaces/MediaOperationsContext.md), `sourceUrl`: `string`, `walletAddress`: `string`): `Promise`<[`StoredMedia`](../interfaces/StoredMedia.md) | `null`>

Defined in: [src/lib/db/media/operations.ts:226](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/operations.ts#226)

Get a media record by its source URL.
Note: When encryption is enabled, sourceUrl is encrypted and this query
will only match if the stored value is plaintext (legacy data).
For encrypted data, use getMediaByIdOp instead.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`MediaOperationsContext`](../interfaces/MediaOperationsContext.md)

</td>
</tr>
<tr>
<td>

`sourceUrl`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`walletAddress`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<[`StoredMedia`](../interfaces/StoredMedia.md) | `null`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/getMediaByTypeOp

# getMediaByTypeOp

> **getMediaByTypeOp**(`ctx`: [`MediaOperationsContext`](../interfaces/MediaOperationsContext.md), `walletAddress`: `string`, `mediaType`: [`MediaType`](../type-aliases/MediaType.md), `limit?`: `number`): `Promise`<[`StoredMedia`](../interfaces/StoredMedia.md)\[]>

Defined in: [src/lib/db/media/operations.ts:539](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/operations.ts#539)

Get media by type (image, video, audio, document).

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`MediaOperationsContext`](../interfaces/MediaOperationsContext.md)

</td>
</tr>
<tr>
<td>

`walletAddress`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`mediaType`

</td>
<td>

[`MediaType`](../type-aliases/MediaType.md)

</td>
</tr>
<tr>
<td>

`limit?`

</td>
<td>

`number`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<[`StoredMedia`](../interfaces/StoredMedia.md)\[]>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/getMediaCountOp

# getMediaCountOp

> **getMediaCountOp**(`ctx`: [`MediaOperationsContext`](../interfaces/MediaOperationsContext.md), `walletAddress`: `string`, `mediaType?`: [`MediaType`](../type-aliases/MediaType.md)): `Promise`<`number`>

Defined in: [src/lib/db/media/operations.ts:769](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/operations.ts#769)

Get media count for a user.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`MediaOperationsContext`](../interfaces/MediaOperationsContext.md)

</td>
</tr>
<tr>
<td>

`walletAddress`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`mediaType?`

</td>
<td>

[`MediaType`](../type-aliases/MediaType.md)

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`number`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/getMediaCountsByTypeOp

# getMediaCountsByTypeOp

> **getMediaCountsByTypeOp**(`ctx`: [`MediaOperationsContext`](../interfaces/MediaOperationsContext.md), `walletAddress`: `string`): `Promise`<`Record`<[`MediaType`](../type-aliases/MediaType.md), `number`>>

Defined in: [src/lib/db/media/operations.ts:791](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/operations.ts#791)

Get media counts by type for a user.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`MediaOperationsContext`](../interfaces/MediaOperationsContext.md)

</td>
</tr>
<tr>
<td>

`walletAddress`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`Record`<[`MediaType`](../type-aliases/MediaType.md), `number`>>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/getMediaOp

# getMediaOp

> **getMediaOp**(`ctx`: [`MediaOperationsContext`](../interfaces/MediaOperationsContext.md), `filters`: [`MediaFilterOptions`](../interfaces/MediaFilterOptions.md)): `Promise`<[`StoredMedia`](../interfaces/StoredMedia.md)\[]>

Defined in: [src/lib/db/media/operations.ts:489](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/operations.ts#489)

Get all media for a user with optional filters.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`MediaOperationsContext`](../interfaces/MediaOperationsContext.md)

</td>
</tr>
<tr>
<td>

`filters`

</td>
<td>

[`MediaFilterOptions`](../interfaces/MediaFilterOptions.md)

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<[`StoredMedia`](../interfaces/StoredMedia.md)\[]>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/getMediaTypeFromMime

# getMediaTypeFromMime

> **getMediaTypeFromMime**(`mimeType`: `string`): [`MediaType`](../type-aliases/MediaType.md)

Defined in: [src/lib/db/media/types.ts:205](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#205)

Determine MediaType from MIME type string.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`mimeType`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

[`MediaType`](../type-aliases/MediaType.md)

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/getNotionAccessToken

# getNotionAccessToken

> **getNotionAccessToken**(`walletAddress`: `string` | `undefined`): `Promise`<`string` | `null`>

Defined in: [src/lib/auth/notion.ts:919](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/notion.ts#919)

Get a valid access token, refreshing if necessary

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`walletAddress`

</td>
<td>

`string` | `undefined`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`string` | `null`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/getNotionMCPUrl

# getNotionMCPUrl

> **getNotionMCPUrl**(): `string`

Defined in: [src/lib/auth/notion.ts:1044](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/notion.ts#1044)

Get the Notion MCP server URL for tool connections

## Returns

`string`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/getNumberAttr

# getNumberAttr

> **getNumberAttr**(`node`: [`AnumaNode`](../interfaces/AnumaNode.md), `name`: `string`): `number` | `undefined`

Defined in: [src/tools/slides/jsx.ts:1192](https://github.com/anuma-ai/sdk/blob/main/src/tools/slides/jsx.ts#1192)

Read a number attr, returning undefined if absent or wrong type.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`node`

</td>
<td>

[`AnumaNode`](../interfaces/AnumaNode.md)

</td>
</tr>
<tr>
<td>

`name`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`number` | `undefined`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/getProjectConversationCountOp

# getProjectConversationCountOp

> **getProjectConversationCountOp**(`ctx`: [`ProjectOperationsContext`](../interfaces/ProjectOperationsContext.md), `projectId`: `string`): `Promise`<`number`>

Defined in: [src/lib/db/project/operations.ts:165](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/project/operations.ts#165)

Count the number of conversations in a project.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`ProjectOperationsContext`](../interfaces/ProjectOperationsContext.md)

</td>
</tr>
<tr>
<td>

`projectId`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`number`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/getProjectConversationsOp

# getProjectConversationsOp

> **getProjectConversationsOp**(`ctx`: [`ProjectOperationsContext`](../interfaces/ProjectOperationsContext.md), `projectId`: `string`): `Promise`<[`StoredConversation`](../interfaces/StoredConversation.md)\[]>

Defined in: [src/lib/db/project/operations.ts:147](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/project/operations.ts#147)

Get all conversations belonging to a specific project.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`ProjectOperationsContext`](../interfaces/ProjectOperationsContext.md)

</td>
</tr>
<tr>
<td>

`projectId`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<[`StoredConversation`](../interfaces/StoredConversation.md)\[]>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/getProjectOp

# getProjectOp

> **getProjectOp**(`ctx`: [`ProjectOperationsContext`](../interfaces/ProjectOperationsContext.md), `id`: `string`): `Promise`<[`StoredProject`](../interfaces/StoredProject.md) | `null`>

Defined in: [src/lib/db/project/operations.ts:57](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/project/operations.ts#57)

Get a single project by its project ID.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`ProjectOperationsContext`](../interfaces/ProjectOperationsContext.md)

</td>
</tr>
<tr>
<td>

`id`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<[`StoredProject`](../interfaces/StoredProject.md) | `null`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/getProjectsOp

# getProjectsOp

> **getProjectsOp**(`ctx`: [`ProjectOperationsContext`](../interfaces/ProjectOperationsContext.md)): `Promise`<[`StoredProject`](../interfaces/StoredProject.md)\[]>

Defined in: [src/lib/db/project/operations.ts:71](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/project/operations.ts#71)

Get all non-deleted projects, sorted by creation date (newest first).

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`ProjectOperationsContext`](../interfaces/ProjectOperationsContext.md)

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<[`StoredProject`](../interfaces/StoredProject.md)\[]>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/getRecentMediaOp

# getRecentMediaOp

> **getRecentMediaOp**(`ctx`: [`MediaOperationsContext`](../interfaces/MediaOperationsContext.md), `walletAddress`: `string`, `limit`: `number`): `Promise`<[`StoredMedia`](../interfaces/StoredMedia.md)\[]>

Defined in: [src/lib/db/media/operations.ts:718](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/operations.ts#718)

Get recent media for library homepage.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Default value</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`MediaOperationsContext`](../interfaces/MediaOperationsContext.md)

</td>
<td>

`undefined`

</td>
</tr>
<tr>
<td>

`walletAddress`

</td>
<td>

`string`

</td>
<td>

`undefined`

</td>
</tr>
<tr>
<td>

`limit`

</td>
<td>

`number`

</td>
<td>

`20`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<[`StoredMedia`](../interfaces/StoredMedia.md)\[]>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/getSavedToolByIdOp

# getSavedToolByIdOp

> **getSavedToolByIdOp**(`ctx`: [`SavedToolOperationsContext`](../interfaces/SavedToolOperationsContext.md), `uniqueId`: `string`): `Promise`<[`StoredSavedTool`](../interfaces/StoredSavedTool.md) | `null`>

Defined in: [src/lib/db/savedTools/operations.ts:65](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/savedTools/operations.ts#65)

Fetch a single saved tool by its WatermelonDB ID. Returns null if not found or deleted.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`SavedToolOperationsContext`](../interfaces/SavedToolOperationsContext.md)

</td>
</tr>
<tr>
<td>

`uniqueId`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<[`StoredSavedTool`](../interfaces/StoredSavedTool.md) | `null`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/getServerTools

# getServerTools

> **getServerTools**(`options`: [`ServerToolsOptions`](../interfaces/ServerToolsOptions.md)): `Promise`<[`ServerTool`](../interfaces/ServerTool.md)\[]>

Defined in: [src/lib/tools/serverTools.ts:362](https://github.com/anuma-ai/sdk/blob/main/src/lib/tools/serverTools.ts#362)

Get server tools with caching support.

Flow:

1. Check localStorage cache
2. If cache valid and not force refresh, return cached tools
3. Otherwise, fetch from API, cache, and return
4. On fetch failure, return cached tools if available (stale-while-error)

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`ServerToolsOptions`](../interfaces/ServerToolsOptions.md)

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<[`ServerTool`](../interfaces/ServerTool.md)\[]>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/getStringAttr

# getStringAttr

> **getStringAttr**(`node`: [`AnumaNode`](../interfaces/AnumaNode.md), `name`: `string`): `string` | `undefined`

Defined in: [src/tools/slides/jsx.ts:1186](https://github.com/anuma-ai/sdk/blob/main/src/tools/slides/jsx.ts#1186)

Read a string attr, returning undefined if absent or wrong type.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`node`

</td>
<td>

[`AnumaNode`](../interfaces/AnumaNode.md)

</td>
</tr>
<tr>
<td>

`name`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`string` | `undefined`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/getSupportedFileTypes

# getSupportedFileTypes

> **getSupportedFileTypes**(): `object`

Defined in: [src/lib/processors/preprocessor.ts:81](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/preprocessor.ts#81)

Get the union of all MIME types and extensions handled by the SDK's
default processors. Useful for building an `<input type="file" accept>`
allowlist.

Note: does NOT include image MIME types — add `"image/*"` yourself if you
want the file picker to also accept images. See `isSupportedFile` docs.

## Returns

`object`

### extensions

> **extensions**: `string`\[]

### mimeTypes

> **mimeTypes**: `string`\[]

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/getToolsChecksum

# getToolsChecksum

> **getToolsChecksum**(): `string` | `undefined`

Defined in: [src/lib/tools/serverTools.ts:299](https://github.com/anuma-ai/sdk/blob/main/src/lib/tools/serverTools.ts#299)

Get the checksum of currently cached tools.
Returns undefined if no cache or no checksum stored.

## Returns

`string` | `undefined`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/getUnfiledVaultMemoriesOp

# getUnfiledVaultMemoriesOp

> **getUnfiledVaultMemoriesOp**(`ctx`: [`VaultMemoryOperationsContext`](../interfaces/VaultMemoryOperationsContext.md)): `Promise`<[`StoredVaultMemory`](../interfaces/StoredVaultMemory.md)\[]>

Defined in: [src/lib/db/memoryVault/operations.ts:274](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/memoryVault/operations.ts#274)

Get all non-deleted, unfiled vault memories (folder\_id is null).

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`VaultMemoryOperationsContext`](../interfaces/VaultMemoryOperationsContext.md)

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<[`StoredVaultMemory`](../interfaces/StoredVaultMemory.md)\[]>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/getUserUploadedMediaOp

# getUserUploadedMediaOp

> **getUserUploadedMediaOp**(`ctx`: [`MediaOperationsContext`](../interfaces/MediaOperationsContext.md), `walletAddress`: `string`, `limit?`: `number`): `Promise`<[`StoredMedia`](../interfaces/StoredMedia.md)\[]>

Defined in: [src/lib/db/media/operations.ts:695](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/operations.ts#695)

Get user-uploaded media.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`MediaOperationsContext`](../interfaces/MediaOperationsContext.md)

</td>
</tr>
<tr>
<td>

`walletAddress`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`limit?`

</td>
<td>

`number`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<[`StoredMedia`](../interfaces/StoredMedia.md)\[]>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/getValidCalendarToken

# getValidCalendarToken

> **getValidCalendarToken**(`walletAddress?`: `string`): `Promise`<`string` | `null`>

Defined in: [src/lib/auth/google-calendar.ts:535](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/google-calendar.ts#535)

Get stored token for Calendar (async, for tool token getters)

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`walletAddress?`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`string` | `null`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/getValidDriveToken

# getValidDriveToken

> **getValidDriveToken**(`walletAddress?`: `string`): `Promise`<`string` | `null`>

Defined in: [src/lib/auth/google-drive.ts:532](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/google-drive.ts#532)

Get stored token for Drive (async, supports encrypted storage)

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`walletAddress?`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`string` | `null`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/getValidGithubToken

# getValidGithubToken

> **getValidGithubToken**(`walletAddress?`: `string`): `Promise`<`string` | `null`>

Defined in: [src/lib/auth/github.ts:537](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/github.ts#537)

Get stored token for GitHub (async, supports encrypted storage)

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`walletAddress?`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`string` | `null`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/getValidNotionToken

# getValidNotionToken

> **getValidNotionToken**(): `string` | `null`

Defined in: [src/lib/auth/notion.ts:959](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/notion.ts#959)

Synchronous getter for the current Notion access token.
Reads from the in-memory cache populated by async operations
(getNotionAccessToken, handleNotionCallback, refreshNotionToken).
Matches the sync signature required by tool factories in src/tools/notion.ts.

## Returns

`string` | `null`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/getVaultFolderMemoryCountOp

# getVaultFolderMemoryCountOp

> **getVaultFolderMemoryCountOp**(`ctx`: [`VaultFolderOperationsContext`](../interfaces/VaultFolderOperationsContext.md), `folderId`: `string`): `Promise`<`number`>

Defined in: [src/lib/db/vaultFolders/operations.ts:233](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/vaultFolders/operations.ts#233)

Get the count of non-deleted memories in a folder.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`VaultFolderOperationsContext`](../interfaces/VaultFolderOperationsContext.md)

</td>
</tr>
<tr>
<td>

`folderId`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`number`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/getVaultMemoryOp

# getVaultMemoryOp

> **getVaultMemoryOp**(`ctx`: [`VaultMemoryOperationsContext`](../interfaces/VaultMemoryOperationsContext.md), `id`: `string`): `Promise`<[`StoredVaultMemory`](../interfaces/StoredVaultMemory.md) | `null`>

Defined in: [src/lib/db/memoryVault/operations.ts:151](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/memoryVault/operations.ts#151)

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`VaultMemoryOperationsContext`](../interfaces/VaultMemoryOperationsContext.md)

</td>
</tr>
<tr>
<td>

`id`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<[`StoredVaultMemory`](../interfaces/StoredVaultMemory.md) | `null`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/getVideosOp

# getVideosOp

> **getVideosOp**(`ctx`: [`MediaOperationsContext`](../interfaces/MediaOperationsContext.md), `walletAddress`: `string`, `limit?`: `number`): `Promise`<[`StoredMedia`](../interfaces/StoredMedia.md)\[]>

Defined in: [src/lib/db/media/operations.ts:562](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/operations.ts#562)

Get all videos for a user.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`MediaOperationsContext`](../interfaces/MediaOperationsContext.md)

</td>
</tr>
<tr>
<td>

`walletAddress`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`limit?`

</td>
<td>

`number`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<[`StoredMedia`](../interfaces/StoredMedia.md)\[]>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/GoogleDriveAuthProvider

# GoogleDriveAuthProvider

> **GoogleDriveAuthProvider**(`__namedParameters`: [`GoogleDriveAuthProviderProps`](../interfaces/GoogleDriveAuthProviderProps.md)): `Element`

Defined in: [src/react/useGoogleDriveAuth.ts:92](https://github.com/anuma-ai/sdk/blob/main/src/react/useGoogleDriveAuth.ts#92)

Provider component for Google Drive OAuth authentication.

Wrap your app with this provider to enable Google Drive authentication.
It handles the OAuth 2.0 Authorization Code flow with refresh tokens.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`__namedParameters`

</td>
<td>

[`GoogleDriveAuthProviderProps`](../interfaces/GoogleDriveAuthProviderProps.md)

</td>
</tr>
</tbody>
</table>

## Returns

`Element`

## Example

```tsx
import { GoogleDriveAuthProvider } from "@anuma/sdk/react";

function App() {
  return (
    <GoogleDriveAuthProvider
      clientId={process.env.NEXT_PUBLIC_GOOGLE_CLIENT_ID}
      callbackPath="/auth/google/callback"
    >
      <MyApp />
    </GoogleDriveAuthProvider>
  );
}
```

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/handleCalendarCallback

# handleCalendarCallback

> **handleCalendarCallback**(`callbackPath`: `string`, `apiClient?`: `Client`, `walletAddress?`: `string`): `Promise`<`string` | `null`>

Defined in: [src/lib/auth/google-calendar.ts:324](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/google-calendar.ts#324)

Handle the OAuth callback - exchange code for tokens via backend

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`callbackPath`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`apiClient?`

</td>
<td>

`Client`

</td>
</tr>
<tr>
<td>

`walletAddress?`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`string` | `null`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/handleDriveCallback

# handleDriveCallback

> **handleDriveCallback**(`callbackPath`: `string`, `apiClient?`: `Client`, `walletAddress?`: `string`): `Promise`<`string` | `null`>

Defined in: [src/lib/auth/google-drive.ts:324](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/google-drive.ts#324)

Handle the OAuth callback - exchange code for tokens via backend

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`callbackPath`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`apiClient?`

</td>
<td>

`Client`

</td>
</tr>
<tr>
<td>

`walletAddress?`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`string` | `null`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/handleGithubCallback

# handleGithubCallback

> **handleGithubCallback**(`callbackPath`: `string`, `apiClient?`: `Client`, `walletAddress?`: `string`): `Promise`<`string` | `null`>

Defined in: [src/lib/auth/github.ts:325](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/github.ts#325)

Handle the OAuth callback - exchange code for tokens via backend

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`callbackPath`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`apiClient?`

</td>
<td>

`Client`

</td>
</tr>
<tr>
<td>

`walletAddress?`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`string` | `null`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/handleNotionCallback

# handleNotionCallback

> **handleNotionCallback**(`callbackPath`: `string`, `walletAddress`: `string` | `undefined`): `Promise`<`string` | `null`>

Defined in: [src/lib/auth/notion.ts:738](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/notion.ts#738)

Handle the OAuth callback - exchange code for tokens
This is done directly with Notion (no backend needed due to PKCE)

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`callbackPath`

</td>
<td>

`string`

</td>
<td>

The callback path used during authorization

</td>
</tr>
<tr>
<td>

`walletAddress`

</td>
<td>

`string` | `undefined`

</td>
<td>

Wallet address for token encryption (optional)

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`string` | `null`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/hardDeleteMediaOp

# hardDeleteMediaOp

> **hardDeleteMediaOp**(`ctx`: [`MediaOperationsContext`](../interfaces/MediaOperationsContext.md), `mediaId`: `string`): `Promise`<`boolean`>

Defined in: [src/lib/db/media/operations.ts:461](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/operations.ts#461)

Permanently delete a media record (hard delete).
Also removes the file from OPFS.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`MediaOperationsContext`](../interfaces/MediaOperationsContext.md)

</td>
</tr>
<tr>
<td>

`mediaId`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`boolean`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/hasCalendarCredentials

# hasCalendarCredentials

> **hasCalendarCredentials**(`walletAddress?`: `string`): `Promise`<`boolean`>

Defined in: [src/lib/auth/google-calendar.ts:561](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/google-calendar.ts#561)

Check if we have any stored credentials

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`walletAddress?`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`boolean`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/hasDriveCredentials

# hasDriveCredentials

> **hasDriveCredentials**(`walletAddress?`: `string`): `Promise`<`boolean`>

Defined in: [src/lib/auth/google-drive.ts:558](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/google-drive.ts#558)

Check if we have any stored credentials

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`walletAddress?`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`boolean`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/hasDropboxCredentials

# hasDropboxCredentials

> **hasDropboxCredentials**(`walletAddress?`: `string`): `Promise`<`boolean`>

Defined in: [src/lib/backup/dropbox/auth.ts:314](https://github.com/anuma-ai/sdk/blob/main/src/lib/backup/dropbox/auth.ts#314)

Check if we have any stored credentials (including refresh token)

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`walletAddress?`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`boolean`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/hasEncryptionKey

# hasEncryptionKey

> **hasEncryptionKey**(`address`: `string`): `boolean`

Defined in: [src/react/useEncryption.ts:677](https://github.com/anuma-ai/sdk/blob/main/src/react/useEncryption.ts#677)

Checks if an encryption key exists in memory for the given wallet address

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`address`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`boolean`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/hasGithubCredentials

# hasGithubCredentials

> **hasGithubCredentials**(`walletAddress?`: `string`): `Promise`<`boolean`>

Defined in: [src/lib/auth/github.ts:563](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/github.ts#563)

Check if we have any stored credentials

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`walletAddress?`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`boolean`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/hasGoogleDriveCredentials

# hasGoogleDriveCredentials

> **hasGoogleDriveCredentials**(`walletAddress?`: `string`): `Promise`<`boolean`>

Defined in: [src/lib/backup/google/auth.ts:351](https://github.com/anuma-ai/sdk/blob/main/src/lib/backup/google/auth.ts#351)

Check if we have any stored credentials (including refresh token)

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`walletAddress?`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`boolean`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/hasICloudCredentials

# hasICloudCredentials

> **hasICloudCredentials**(): `boolean`

Defined in: [src/react/useICloudAuth.ts:224](https://github.com/anuma-ai/sdk/blob/main/src/react/useICloudAuth.ts#224)

Check if iCloud is configured (has API token)

## Returns

`boolean`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/hasKeyPair

# hasKeyPair

> **hasKeyPair**(`address`: `string`): `boolean`

Defined in: [src/react/useEncryption.ts:1299](https://github.com/anuma-ai/sdk/blob/main/src/react/useEncryption.ts#1299)

Checks if a key pair exists in memory for the given wallet address

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`address`

</td>
<td>

`string`

</td>
<td>

The wallet address

</td>
</tr>
</tbody>
</table>

## Returns

`boolean`

True if key pair exists, false otherwise

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/hasNotionCredentials

# hasNotionCredentials

> **hasNotionCredentials**(`walletAddress?`: `string`): `Promise`<`boolean`>

Defined in: [src/lib/auth/notion.ts:970](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/notion.ts#970)

Check if we have any stored Notion credentials

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`walletAddress?`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`boolean`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/ICloudAuthProvider

# ICloudAuthProvider

> **ICloudAuthProvider**(`__namedParameters`: [`ICloudAuthProviderProps`](../interfaces/ICloudAuthProviderProps.md)): `Element`

Defined in: [src/react/useICloudAuth.ts:81](https://github.com/anuma-ai/sdk/blob/main/src/react/useICloudAuth.ts#81)

Provider component for iCloud authentication.

Wrap your app with this provider to enable iCloud authentication.
CloudKit JS is loaded automatically when needed.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`__namedParameters`

</td>
<td>

[`ICloudAuthProviderProps`](../interfaces/ICloudAuthProviderProps.md)

</td>
</tr>
</tbody>
</table>

## Returns

`Element`

## Example

```tsx
import { ICloudAuthProvider } from "@anuma/sdk/react";

function App() {
  return (
    <ICloudAuthProvider
      apiToken={process.env.NEXT_PUBLIC_CLOUDKIT_API_TOKEN!}
      containerIdentifier="iCloud.Memoryless"
      environment="production"
    >
      <MyApp />
    </ICloudAuthProvider>
  );
}
```

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/insertAfterId

# insertAfterId

> **insertAfterId**(`root`: [`AnumaNode`](../interfaces/AnumaNode.md), `afterId`: `string`, `node`: [`AnumaNode`](../interfaces/AnumaNode.md)): `boolean`

Defined in: [src/tools/slides/jsx.ts:1140](https://github.com/anuma-ai/sdk/blob/main/src/tools/slides/jsx.ts#1140)

Insert `node` immediately after the node with matching id anywhere in
the tree. Returns true on success.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`root`

</td>
<td>

[`AnumaNode`](../interfaces/AnumaNode.md)

</td>
</tr>
<tr>
<td>

`afterId`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`node`

</td>
<td>

[`AnumaNode`](../interfaces/AnumaNode.md)

</td>
</tr>
</tbody>
</table>

## Returns

`boolean`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/insertChild

# insertChild

> **insertChild**(`parent`: [`AnumaNode`](../interfaces/AnumaNode.md), `node`: [`AnumaNode`](../interfaces/AnumaNode.md), `afterId?`: `string`): `void`

Defined in: [src/tools/slides/jsx.ts:1126](https://github.com/anuma-ai/sdk/blob/main/src/tools/slides/jsx.ts#1126)

Insert `node` into `parent.children`. If `afterId` is provided, the new
node is inserted immediately after the matched sibling; otherwise it is
appended to the end.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`parent`

</td>
<td>

[`AnumaNode`](../interfaces/AnumaNode.md)

</td>
</tr>
<tr>
<td>

`node`

</td>
<td>

[`AnumaNode`](../interfaces/AnumaNode.md)

</td>
</tr>
<tr>
<td>

`afterId?`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`void`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/isAnumaTag

# isAnumaTag

> **isAnumaTag**(`tag`: `string`): `boolean`

Defined in: [src/tools/slides/jsx.ts:626](https://github.com/anuma-ai/sdk/blob/main/src/tools/slides/jsx.ts#626)

True when a tag is an Anuma primitive (capitalized local name).

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`tag`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`boolean`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/isCalendarCallback

# isCalendarCallback

> **isCalendarCallback**(`callbackPath`: `string`): `boolean`

Defined in: [src/lib/auth/google-calendar.ts:311](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/google-calendar.ts#311)

Check if current URL is a Calendar OAuth callback

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`callbackPath`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`boolean`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/isDriveCallback

# isDriveCallback

> **isDriveCallback**(`callbackPath`: `string`): `boolean`

Defined in: [src/lib/auth/google-drive.ts:311](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/google-drive.ts#311)

Check if current URL is a Drive OAuth callback

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`callbackPath`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`boolean`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/isGithubCallback

# isGithubCallback

> **isGithubCallback**(`callbackPath`: `string`): `boolean`

Defined in: [src/lib/auth/github.ts:312](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/github.ts#312)

Check if current URL is a GitHub OAuth callback

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`callbackPath`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`boolean`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/isHtmlTag

# isHtmlTag

> **isHtmlTag**(`tag`: `string`): `boolean`

Defined in: [src/tools/slides/jsx.ts:636](https://github.com/anuma-ai/sdk/blob/main/src/tools/slides/jsx.ts#636)

True when a tag is a plain HTML element from the allowlist.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`tag`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`boolean`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/isNotionCallback

# isNotionCallback

> **isNotionCallback**(`callbackPath`: `string`): `boolean`

Defined in: [src/lib/auth/notion.ts:713](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/notion.ts#713)

Check if current URL is a Notion OAuth callback

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`callbackPath`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`boolean`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/isOPFSSupported

# isOPFSSupported

> **isOPFSSupported**(): `boolean`

Defined in: [src/lib/storage/opfs.ts:36](https://github.com/anuma-ai/sdk/blob/main/src/lib/storage/opfs.ts#36)

Checks if the browser supports OPFS.

## Returns

`boolean`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/isR2UrlExpired

# isR2UrlExpired

> **isR2UrlExpired**(`sourceUrl`: `string`, `createdAt?`: `string` | `number` | `Date`): `boolean`

Defined in: [src/lib/storage/r2Expiry.ts:35](https://github.com/anuma-ai/sdk/blob/main/src/lib/storage/r2Expiry.ts#35)

Returns `true` if the given R2 presigned URL is expired.

**Primary**: Parses `X-Amz-Date` + `X-Amz-Expires` query params to compute
the exact expiry timestamp.

**Fallback**: If URL parsing fails, checks `createdAt + R2_DEFAULT_TTL_MS`.

If neither method can determine expiry, returns `false` (assume valid).

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`sourceUrl`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`createdAt?`

</td>
<td>

`string` | `number` | `Date`

</td>
</tr>
</tbody>
</table>

## Returns

`boolean`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/isSupportedFile

# isSupportedFile

> **isSupportedFile**(`file`: [`FileTypeQuery`](../interfaces/FileTypeQuery.md)): `boolean`

Defined in: [src/lib/processors/preprocessor.ts:69](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/preprocessor.ts#69)

Test whether the SDK can extract text from the given file.

Use this for upload-time validation in drag-drop handlers, file-picker
onChange, or paste handlers — block at the boundary with a clear message
instead of silently accepting a file the model will never see.

Note: this covers files handled by the SDK's text extractors (PDF, Word,
Excel, Zip, plain text/markdown/JSON, etc.). Image files (`image/*`) are
sent directly as `image_url` content parts and are NOT handled by
processors — combine with an image check in your validation:

```ts
const ok = file.type.startsWith("image/") || isSupportedFile(file);
```

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`file`

</td>
<td>

[`FileTypeQuery`](../interfaces/FileTypeQuery.md)

</td>
</tr>
</tbody>
</table>

## Returns

`boolean`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/isSupportedMediaType

# isSupportedMediaType

> **isSupportedMediaType**(`mimeType`: `string`): `boolean`

Defined in: [src/lib/db/media/types.ts:224](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#224)

Check if a MIME type is supported for the library.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`mimeType`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`boolean`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/LoggerProvider

# LoggerProvider

> **LoggerProvider**(`__namedParameters`: [`LoggerProviderProps`](../interfaces/LoggerProviderProps.md)): `ReactNode`

Defined in: [src/react/LoggerProvider.tsx:37](https://github.com/anuma-ai/sdk/blob/main/src/react/LoggerProvider.tsx#37)

Sets the active SDK logger for the lifetime of this component.
Restores the previous logger on unmount, so it can be nested or used
alongside a top-level `setLogger` call without discarding the outer logger.

The `logger` prop is compared by reference — memoize it to avoid
unnecessary effect re-runs on every parent render.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`__namedParameters`

</td>
<td>

[`LoggerProviderProps`](../interfaces/LoggerProviderProps.md)

</td>
</tr>
</tbody>
</table>

## Returns

`ReactNode`

## Example

```tsx
import { useMemo } from "react";
import { LoggerProvider, type Logger } from "@anuma/sdk/react";

const myLogger = useMemo<Logger>(() => ({
  debug: () => {},
  info: (...args) => posthog.capture("sdk_info", { message: args }),
  warn: (...args) => console.warn("[SDK]", ...args),
  error: (...args) => Sentry.captureMessage(args.join(" ")),
}), []);

<LoggerProvider logger={myLogger}>
  <App />
</LoggerProvider>
```

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/mediaToStored

# mediaToStored

> **mediaToStored**(`media`: [`StoredMediaModel`](../classes/StoredMediaModel.md), `walletAddress?`: `string`, `signMessage?`: [`SignMessageFn`](../type-aliases/SignMessageFn.md), `embeddedWalletSigner?`: [`EmbeddedWalletSignerFn`](../type-aliases/EmbeddedWalletSignerFn.md)): `Promise`<[`StoredMedia`](../interfaces/StoredMedia.md)>

Defined in: [src/lib/db/media/operations.ts:63](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/operations.ts#63)

Converts a Media model to StoredMedia, decrypting fields if encryption context is available.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`media`

</td>
<td>

[`StoredMediaModel`](../classes/StoredMediaModel.md)

</td>
</tr>
<tr>
<td>

`walletAddress?`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`signMessage?`

</td>
<td>

[`SignMessageFn`](../type-aliases/SignMessageFn.md)

</td>
</tr>
<tr>
<td>

`embeddedWalletSigner?`

</td>
<td>

[`EmbeddedWalletSignerFn`](../type-aliases/EmbeddedWalletSignerFn.md)

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<[`StoredMedia`](../interfaces/StoredMedia.md)>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/migrateCalendarToken

# migrateCalendarToken

> **migrateCalendarToken**(`walletAddress`: `string`): `Promise`<`boolean`>

Defined in: [src/lib/auth/google-calendar.ts:573](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/google-calendar.ts#573)

Migrate unencrypted Calendar tokens to encrypted wallet-scoped storage.
Call this when a wallet address and encryption key become available
after the initial OAuth flow.

Returns true if migration was performed (or already complete), false otherwise.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`walletAddress`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`boolean`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/migrateDisplayResult

# migrateDisplayResult

> **migrateDisplayResult**(`result`: `unknown`, `fromVersion`: `number`, `toVersion`: `number`, `migrations`: [`DisplayToolMigrations`](../type-aliases/DisplayToolMigrations.md)): `unknown`

Defined in: [src/tools/uiInteraction.ts:122](https://github.com/anuma-ai/sdk/blob/main/src/tools/uiInteraction.ts#122)

Migrate a stored display result from an older version to the current version.

Runs the migration chain step-by-step: fromVersion → fromVersion+1 → … → toVersion.
Steps with no registered migration function are skipped (result passes through unchanged).
Returns the original result unchanged if fromVersion >= toVersion.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`result`

</td>
<td>

`unknown`

</td>
</tr>
<tr>
<td>

`fromVersion`

</td>
<td>

`number`

</td>
</tr>
<tr>
<td>

`toVersion`

</td>
<td>

`number`

</td>
</tr>
<tr>
<td>

`migrations`

</td>
<td>

[`DisplayToolMigrations`](../type-aliases/DisplayToolMigrations.md)

</td>
</tr>
</tbody>
</table>

## Returns

`unknown`

## Example

```typescript
const migrated = migrateDisplayResult(storedResult, 1, 3, {
  "1->2": (v1) => ({ ...v1, added: v1.old ?? 0 }),
  "2->3": (v2) => ({ ...v2, renamed: v2.added }),
});
```

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/migrateDriveToken

# migrateDriveToken

> **migrateDriveToken**(`walletAddress`: `string`): `Promise`<`boolean`>

Defined in: [src/lib/auth/google-drive.ts:570](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/google-drive.ts#570)

Migrate unencrypted Drive tokens to encrypted storage.
Call this when a wallet address and encryption key become available
after the initial OAuth flow.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`walletAddress`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`boolean`>

true if migration occurred, false otherwise

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/migrateGithubToken

# migrateGithubToken

> **migrateGithubToken**(`walletAddress`: `string`): `Promise`<`boolean`>

Defined in: [src/lib/auth/github.ts:575](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/github.ts#575)

Migrate unencrypted GitHub tokens to encrypted storage.
Call this when a wallet address and encryption key become available
after the initial OAuth flow.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`walletAddress`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`boolean`>

true if migration occurred, false otherwise

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/migrateNotionClientRegistration

# migrateNotionClientRegistration

> **migrateNotionClientRegistration**(`walletAddress`: `string`): `Promise`<`boolean`>

Defined in: [src/lib/auth/notion.ts:525](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/notion.ts#525)

Migrate unencrypted client registration to encrypted format.
Call this when wallet/encryption key becomes available.

Checks two sources:

1. sessionStorage fallback (from startNotionAuth when wallet was unavailable)
2. Legacy plain-text localStorage (from before encryption was added)

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`walletAddress`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`boolean`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/migrateNotionToken

# migrateNotionToken

> **migrateNotionToken**(`walletAddress`: `string`): `Promise`<`boolean`>

Defined in: [src/lib/auth/notion.ts:480](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/notion.ts#480)

Migrate unencrypted tokens to encrypted format
Call this when wallet/encryption key becomes available after OAuth

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`walletAddress`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`boolean`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/moveMemoriesToFolderOp

# moveMemoriesToFolderOp

> **moveMemoriesToFolderOp**(`ctx`: [`VaultFolderOperationsContext`](../interfaces/VaultFolderOperationsContext.md), `memoryIds`: `string`\[], `folderId`: `string` | `null`): `Promise`<`boolean`>

Defined in: [src/lib/db/vaultFolders/operations.ts:154](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/vaultFolders/operations.ts#154)

Move memories to a folder (or unfile them by passing null).

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`VaultFolderOperationsContext`](../interfaces/VaultFolderOperationsContext.md)

</td>
</tr>
<tr>
<td>

`memoryIds`

</td>
<td>

`string`\[]

</td>
</tr>
<tr>
<td>

`folderId`

</td>
<td>

`string` | `null`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`boolean`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/onKeyAvailable

# onKeyAvailable

> **onKeyAvailable**(`address`: `string`, `callback`: () => `void`): () => `void`

Defined in: [src/react/useEncryption.ts:109](https://github.com/anuma-ai/sdk/blob/main/src/react/useEncryption.ts#109)

Register a callback that fires when an encryption key becomes available for an address.
If the key is already available, the callback fires immediately.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`address`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`callback`

</td>
<td>

() => `void`

</td>
</tr>
</tbody>
</table>

## Returns

Unsubscribe function

> (): `void`

### Returns

`void`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/parseJsx

# parseJsx

> **parseJsx**(`source`: `string`, `options?`: `object`): [`AnumaNode`](../interfaces/AnumaNode.md)

Defined in: [src/tools/slides/jsx.ts:532](https://github.com/anuma-ai/sdk/blob/main/src/tools/slides/jsx.ts#532)

Parse a JSX source string into an AnumaNode tree.

`strict` mode (opt-in, defaults to `false`) enables checks that catch
model-emitted JSX with the wrong convention before it lands in the deck:
top-level visual-styling props on text elements (which the renderer
silently ignores → invisible output). Stored decks load with strict off
— any deck previously built before the strict check existed might carry
non-conforming JSX, and we don't want a tightened validator to retro-
actively break every tool call on that deck. Callers that parse
model-submitted JSX (`add_slide`, `insert_slide`, `replace_slide`,
`replace_element`, `insert_element`) pass `strict: true`.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`source`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`options?`

</td>
<td>

`object`

</td>
</tr>
<tr>
<td>

`options.strict?`

</td>
<td>

`boolean`

</td>
</tr>
</tbody>
</table>

## Returns

[`AnumaNode`](../interfaces/AnumaNode.md)

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/preEmbedVaultMemories

# preEmbedVaultMemories

> **preEmbedVaultMemories**(`vaultCtx`: [`VaultMemoryOperationsContext`](../interfaces/VaultMemoryOperationsContext.md), `embeddingOptions`: [`MemoryEngineEmbeddingOptions`](../interfaces/MemoryEngineEmbeddingOptions.md), `cache`: [`VaultEmbeddingCache`](../type-aliases/VaultEmbeddingCache.md), `options?`: `object`): `Promise`<`void`>

Defined in: [src/lib/memoryVault/searchTool.ts:225](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryVault/searchTool.ts#225)

Pre-embed all vault memories that are not yet in the cache.
Call this at init time so searches are instant.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`vaultCtx`

</td>
<td>

[`VaultMemoryOperationsContext`](../interfaces/VaultMemoryOperationsContext.md)

</td>
</tr>
<tr>
<td>

`embeddingOptions`

</td>
<td>

[`MemoryEngineEmbeddingOptions`](../interfaces/MemoryEngineEmbeddingOptions.md)

</td>
</tr>
<tr>
<td>

`cache`

</td>
<td>

[`VaultEmbeddingCache`](../type-aliases/VaultEmbeddingCache.md)

</td>
</tr>
<tr>
<td>

`options?`

</td>
<td>

`object`

</td>
</tr>
<tr>
<td>

`options.scopes?`

</td>
<td>

`string`\[]

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`void`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/preprocessFiles

# preprocessFiles

> **preprocessFiles**(`files`: [`FileMetadata`](../interfaces/FileMetadata.md)\[] | `undefined`, `options`: [`PreprocessingOptions`](../interfaces/PreprocessingOptions.md)): `Promise`<[`PreprocessingResult`](../interfaces/PreprocessingResult.md)>

Defined in: [src/lib/processors/preprocessor.ts:118](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/preprocessor.ts#118)

Preprocess files by extracting text content

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`files`

</td>
<td>

[`FileMetadata`](../interfaces/FileMetadata.md)\[] | `undefined`

</td>
<td>

Files to process

</td>
</tr>
<tr>
<td>

`options`

</td>
<td>

[`PreprocessingOptions`](../interfaces/PreprocessingOptions.md)

</td>
<td>

Preprocessing options

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<[`PreprocessingResult`](../interfaces/PreprocessingResult.md)>

Result with extracted content and metadata

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/previewToolSelection

# previewToolSelection

> **previewToolSelection**(`options`: `object`): `Promise`<{ `clientToolNames`: `string`\[]; `serverToolNames`: `string`\[]; }>

Defined in: [src/react/useChatStorage.ts:301](https://github.com/anuma-ai/sdk/blob/main/src/react/useChatStorage.ts#301)

Preview which tools `useChatStorage` will include for a given prompt,
without making the actual chat request.

Runs the exact same client + server tool selection pipeline that
`useChatStorage`'s `sendMessage` runs internally — same embedding,
same `autoFilterClientTools` call, same server-tools branch — so the
returned names are guaranteed to match what a real request would
include for that prompt + config.

Intended for debug UIs ("show me what the model will see for this
prompt"). Pass the same `clientTools`, `serverToolsFilter`,
`extraToolSets`, and `activeToolSets` you pass to `useChatStorage`
so the result is faithful.

Caveats:

* For server tools, this only mirrors the dynamic `findMatchingTools`
  path (the one used for the responses API in `sendMessage`). If your
  serverToolsFilter is a function, it's invoked directly with the
  prompt embedding.
* Embedding generation hits the same `/embeddings` endpoint as the
  real request; pass a shared `clientToolEmbeddingsCache` if you call
  this repeatedly to avoid re-embedding tool descriptions.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

`object`

</td>
<td>

‐

</td>
</tr>
<tr>
<td>

`options.activeToolSets?`

</td>
<td>

`string`\[]

</td>
<td>

‐

</td>
</tr>
<tr>
<td>

`options.baseUrl?`

</td>
<td>

`string`

</td>
<td>

‐

</td>
</tr>
<tr>
<td>

`options.clientToolEmbeddingsCache?`

</td>
<td>

`Map`<`string`, `number`\[]>

</td>
<td>

Optional cache of tool-description embeddings, shared across calls.

</td>
</tr>
<tr>
<td>

`options.clientTools?`

</td>
<td>

[`LlmapiChatCompletionTool`](../../../client/Internal/type-aliases/LlmapiChatCompletionTool.md)\[]

</td>
<td>

‐

</td>
</tr>
<tr>
<td>

`options.embeddingModel?`

</td>
<td>

`string`

</td>
<td>

‐

</td>
</tr>
<tr>
<td>

`options.extraToolSets?`

</td>
<td>

[`ToolSet`](../interfaces/ToolSet.md)\[]

</td>
<td>

‐

</td>
</tr>
<tr>
<td>

`options.getToken`

</td>
<td>

() => `Promise`<`string` | `null`>

</td>
<td>

‐

</td>
</tr>
<tr>
<td>

`options.prompt`

</td>
<td>

`string`

</td>
<td>

‐

</td>
</tr>
<tr>
<td>

`options.serverToolsConfig?`

</td>
<td>

{ `cacheExpirationMs?`: `number`; }

</td>
<td>

‐

</td>
</tr>
<tr>
<td>

`options.serverToolsConfig.cacheExpirationMs?`

</td>
<td>

`number`

</td>
<td>

‐

</td>
</tr>
<tr>
<td>

`options.serverToolsFilter?`

</td>
<td>

`string`\[] | [`ServerToolsFilterFn`](../type-aliases/ServerToolsFilterFn.md)

</td>
<td>

‐

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<{ `clientToolNames`: `string`\[]; `serverToolNames`: `string`\[]; }>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/projectToStored

# projectToStored

> **projectToStored**(`project`: [`Project`](../classes/Project.md)): [`StoredProject`](../interfaces/StoredProject.md)

Defined in: [src/lib/db/project/operations.ts:15](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/project/operations.ts#15)

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`project`

</td>
<td>

[`Project`](../classes/Project.md)

</td>
</tr>
</tbody>
</table>

## Returns

[`StoredProject`](../interfaces/StoredProject.md)

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/putAppFileOp

# putAppFileOp

> **putAppFileOp**(`ctx`: [`AppFileOperationsContext`](../interfaces/AppFileOperationsContext.md), `conversationId`: `string`, `path`: `string`, `content`: `string`): `Promise`<[`StoredAppFile`](../interfaces/StoredAppFile.md)>

Defined in: [src/lib/db/appFiles/operations.ts:30](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/appFiles/operations.ts#30)

Create or overwrite a file. If a file with the same conversationId + path
already exists, it is updated in place.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`AppFileOperationsContext`](../interfaces/AppFileOperationsContext.md)

</td>
</tr>
<tr>
<td>

`conversationId`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`path`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`content`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<[`StoredAppFile`](../interfaces/StoredAppFile.md)>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/quantizeEmbedding

# quantizeEmbedding

> **quantizeEmbedding**(`v`: `number`\[] | `Float32Array`<`ArrayBufferLike`>): [`QuantizedEmbedding`](../interfaces/QuantizedEmbedding.md)

Defined in: [src/lib/memoryEngine/quantization.ts:53](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryEngine/quantization.ts#53)

Quantize a Float32 embedding (or number\[]) into an Int8 vector + scale.

The scale is the maximum absolute value across the input; all other
values are mapped linearly into \[-127, 127] and rounded. A zero vector
yields a zero Int8Array and a scale of 0.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`v`

</td>
<td>

`number`\[] | `Float32Array`<`ArrayBufferLike`>

</td>
<td>

The embedding to quantize. Either a Float32Array (typical for
on-device caches) or a plain number\[] (typical for values fresh out of
`JSON.parse`). Plain numbers are read directly without copying into a
Float32Array first.

</td>
</tr>
</tbody>
</table>

## Returns

[`QuantizedEmbedding`](../interfaces/QuantizedEmbedding.md)

The quantized data + scale. The returned `data.length === v.length`.

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/readEncryptedFile

# readEncryptedFile

> **readEncryptedFile**(`fileId`: `string`, `encryptionKey`: `CryptoKey`): `Promise`<{ `blob`: `Blob`; `metadata`: `StoredFileMetadata`; } | `null`>

Defined in: [src/lib/storage/opfs.ts:234](https://github.com/anuma-ai/sdk/blob/main/src/lib/storage/opfs.ts#234)

Reads and decrypts a file from OPFS.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`fileId`

</td>
<td>

`string`

</td>
<td>

The file identifier

</td>
</tr>
<tr>
<td>

`encryptionKey`

</td>
<td>

`CryptoKey`

</td>
<td>

CryptoKey for decryption

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<{ `blob`: `Blob`; `metadata`: `StoredFileMetadata`; } | `null`>

The decrypted blob, or null if not found

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/refreshCalendarToken

# refreshCalendarToken

> **refreshCalendarToken**(`apiClient?`: `Client`, `walletAddress?`: `string`): `Promise`<`string` | `null`>

Defined in: [src/lib/auth/google-calendar.ts:378](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/google-calendar.ts#378)

Refresh the access token using the stored refresh token

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`apiClient?`

</td>
<td>

`Client`

</td>
</tr>
<tr>
<td>

`walletAddress?`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`string` | `null`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/refreshDriveToken

# refreshDriveToken

> **refreshDriveToken**(`apiClient?`: `Client`, `walletAddress?`: `string`): `Promise`<`string` | `null`>

Defined in: [src/lib/auth/google-drive.ts:378](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/google-drive.ts#378)

Refresh the access token using the stored refresh token

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`apiClient?`

</td>
<td>

`Client`

</td>
</tr>
<tr>
<td>

`walletAddress?`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`string` | `null`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/refreshGithubToken

# refreshGithubToken

> **refreshGithubToken**(`apiClient?`: `Client`, `walletAddress?`: `string`): `Promise`<`string` | `null`>

Defined in: [src/lib/auth/github.ts:380](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/github.ts#380)

Refresh the access token using the stored refresh token.
Note: GitHub OAuth tokens may not have refresh tokens (non-expiring tokens).

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`apiClient?`

</td>
<td>

`Client`

</td>
</tr>
<tr>
<td>

`walletAddress?`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`string` | `null`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/refreshNotionToken

# refreshNotionToken

> **refreshNotionToken**(`walletAddress`: `string` | `undefined`): `Promise`<`string` | `null`>

Defined in: [src/lib/auth/notion.ts:833](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/notion.ts#833)

Refresh the access token using the refresh token

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`walletAddress`

</td>
<td>

`string` | `undefined`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`string` | `null`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/relinkMisclassifiedVideosOp

# relinkMisclassifiedVideosOp

> **relinkMisclassifiedVideosOp**(`ctx`: [`MediaOperationsContext`](../interfaces/MediaOperationsContext.md), `walletAddress`: `string`): `Promise`<`number`>

Defined in: [src/lib/db/media/operations.ts:352](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/operations.ts#352)

Recovery migration: relink videos that were mistakenly stored as images.

Earlier builds captured MCP video URLs via the image-extraction fallback and
created StoredMedia records with `media_type = "image"`. Those records hold
the video in encrypted OPFS but never surface in the video player's fallback
or the Videos library tab.

`name`/`source_url` are encrypted at rest, so they can't be matched with SQL.
Detection works off the plaintext `mime_type`:

* `video/*` — blob type was correct
* `image/{mp4,webm,mov}` — blob type was empty, stamped `image/<urlext>`
* `application/octet-stream` — generic; ambiguous in plaintext, so we decrypt
  the record and confirm a video extension on `sourceUrl`/`name` before
  flipping (avoids turning real documents/images into video).

Confirmed rows are flipped to `video` and their mime repaired to `video/<ext>`
so they stay classified correctly. Idempotent: once `video`, rows fall out of
the `media_type = "image"` candidate set.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`MediaOperationsContext`](../interfaces/MediaOperationsContext.md)

</td>
</tr>
<tr>
<td>

`walletAddress`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`number`>

number of records relinked

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/removeById

# removeById

> **removeById**(`root`: [`AnumaNode`](../interfaces/AnumaNode.md), `id`: `string`): `boolean`

Defined in: [src/tools/slides/jsx.ts:1148](https://github.com/anuma-ai/sdk/blob/main/src/tools/slides/jsx.ts#1148)

Remove the node with matching id. Mutates `root`. Returns true on success.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`root`

</td>
<td>

[`AnumaNode`](../interfaces/AnumaNode.md)

</td>
</tr>
<tr>
<td>

`id`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`boolean`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/renderAnumaJsx

# renderAnumaJsx

> **renderAnumaJsx**(`jsx`: `string`): `ReactElement`<`unknown`, `string` | `JSXElementConstructor`<`any`>> | `null`

Defined in: [src/react/anumaRuntime.tsx:1019](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#1019)

Parse a JSX string and render it. Convenience over
`parseJsx(jsx) → renderAnumaTree(node)`.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`jsx`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`ReactElement`<`unknown`, `string` | `JSXElementConstructor`<`any`>> | `null`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/renderAnumaTree

# renderAnumaTree

> **renderAnumaTree**(`node`: [`AnumaNode`](../interfaces/AnumaNode.md)): `ReactElement`<`unknown`, `string` | `JSXElementConstructor`<`any`>> | `null`

Defined in: [src/react/anumaRuntime.tsx:1011](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#1011)

Render a parsed `AnumaNode` tree. Wrap with `<AnumaThemeProvider>` if
you want to override the deck's own theme attrs.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`node`

</td>
<td>

[`AnumaNode`](../interfaces/AnumaNode.md)

</td>
</tr>
</tbody>
</table>

## Returns

`ReactElement`<`unknown`, `string` | `JSXElementConstructor`<`any`>> | `null`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/replaceById

# replaceById

> **replaceById**(`root`: [`AnumaNode`](../interfaces/AnumaNode.md), `id`: `string`, `next`: [`AnumaNode`](../interfaces/AnumaNode.md)): `boolean`

Defined in: [src/tools/slides/jsx.ts:1099](https://github.com/anuma-ai/sdk/blob/main/src/tools/slides/jsx.ts#1099)

Replace the first node with matching id in the tree. Mutates `root` in
place. Returns true on success.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`root`

</td>
<td>

[`AnumaNode`](../interfaces/AnumaNode.md)

</td>
</tr>
<tr>
<td>

`id`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`next`

</td>
<td>

[`AnumaNode`](../interfaces/AnumaNode.md)

</td>
</tr>
</tbody>
</table>

## Returns

`boolean`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/requestEncryptionKey

# requestEncryptionKey

> **requestEncryptionKey**(`walletAddress`: `string`, `signMessage`: [`SignMessageFn`](../type-aliases/SignMessageFn.md), `embeddedWalletSigner?`: [`EmbeddedWalletSignerFn`](../type-aliases/EmbeddedWalletSignerFn.md)): `Promise`<`void`>

Defined in: [src/react/useEncryption.ts:862](https://github.com/anuma-ai/sdk/blob/main/src/react/useEncryption.ts#862)

Requests the user to sign a message to generate an encryption key.
If a key already exists in memory for the given wallet, resolves immediately.

Note: Keys are stored in memory only and do not persist across page reloads.
This is a security feature - users must sign once per session to derive their key.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`walletAddress`

</td>
<td>

`string`

</td>
<td>

The wallet address to generate the key for

</td>
</tr>
<tr>
<td>

`signMessage`

</td>
<td>

[`SignMessageFn`](../type-aliases/SignMessageFn.md)

</td>
<td>

Function to sign a message (returns signature hex string)

</td>
</tr>
<tr>
<td>

`embeddedWalletSigner?`

</td>
<td>

[`EmbeddedWalletSignerFn`](../type-aliases/EmbeddedWalletSignerFn.md)

</td>
<td>

Optional function for silent signing with embedded wallets

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`void`>

Promise that resolves when the key is available

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/requestKeyPair

# requestKeyPair

> **requestKeyPair**(`walletAddress`: `string`, `signMessage`: [`SignMessageFn`](../type-aliases/SignMessageFn.md), `embeddedWalletSigner?`: [`EmbeddedWalletSignerFn`](../type-aliases/EmbeddedWalletSignerFn.md)): `Promise`<`void`>

Defined in: [src/react/useEncryption.ts:1184](https://github.com/anuma-ai/sdk/blob/main/src/react/useEncryption.ts#1184)

Requests the user to sign a message to generate an ECDH key pair.
If a key pair already exists in memory for the given wallet, resolves immediately.

Note: Key pairs are stored in memory only and do not persist across page reloads.
This is a security feature - users must sign once per session to derive their key pair.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`walletAddress`

</td>
<td>

`string`

</td>
<td>

The wallet address to generate the key pair for

</td>
</tr>
<tr>
<td>

`signMessage`

</td>
<td>

[`SignMessageFn`](../type-aliases/SignMessageFn.md)

</td>
<td>

Function to sign a message (returns signature hex string)

</td>
</tr>
<tr>
<td>

`embeddedWalletSigner?`

</td>
<td>

[`EmbeddedWalletSignerFn`](../type-aliases/EmbeddedWalletSignerFn.md)

</td>
<td>

Optional function for silent signing with embedded wallets

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`void`>

Promise that resolves when the key pair is available

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/resolveFilePlaceholders

# resolveFilePlaceholders

> **resolveFilePlaceholders**(`content`: `string`, `encryptionKey`: `CryptoKey`, `blobManager`: [`BlobUrlManager`](../classes/BlobUrlManager.md)): `Promise`<`string`>

Defined in: [src/lib/storage/opfs.ts:372](https://github.com/anuma-ai/sdk/blob/main/src/lib/storage/opfs.ts#372)

Resolves file placeholders in content to blob URLs.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`content`

</td>
<td>

`string`

</td>
<td>

The message content with placeholders

</td>
</tr>
<tr>
<td>

`encryptionKey`

</td>
<td>

`CryptoKey`

</td>
<td>

CryptoKey for decryption

</td>
</tr>
<tr>
<td>

`blobManager`

</td>
<td>

[`BlobUrlManager`](../classes/BlobUrlManager.md)

</td>
<td>

BlobUrlManager to track URLs

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`string`>

Content with placeholders replaced by blob URLs

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/resolveThemeColor

# resolveThemeColor

> **resolveThemeColor**(`value`: `unknown`, `theme`: [`AnumaTheme`](../interfaces/AnumaTheme.md)): `string` | `undefined`

Defined in: [src/react/anumaRuntime.tsx:150](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#150)

Resolve a color token against the theme. Pass-through for hex/rgb/named
CSS colors; theme tokens (`textPrimary`, `accent`, …) become their
contextual hex value.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`value`

</td>
<td>

`unknown`

</td>
</tr>
<tr>
<td>

`theme`

</td>
<td>

[`AnumaTheme`](../interfaces/AnumaTheme.md)

</td>
</tr>
</tbody>
</table>

## Returns

`string` | `undefined`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/revokeCalendarToken

# revokeCalendarToken

> **revokeCalendarToken**(`apiClient?`: `Client`, `walletAddress?`: `string`): `Promise`<`void`>

Defined in: [src/lib/auth/google-calendar.ts:418](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/google-calendar.ts#418)

Revoke the OAuth token

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`apiClient?`

</td>
<td>

`Client`

</td>
</tr>
<tr>
<td>

`walletAddress?`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`void`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/revokeDriveToken

# revokeDriveToken

> **revokeDriveToken**(`apiClient?`: `Client`, `walletAddress?`: `string`): `Promise`<`void`>

Defined in: [src/lib/auth/google-drive.ts:418](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/google-drive.ts#418)

Revoke the OAuth token

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`apiClient?`

</td>
<td>

`Client`

</td>
</tr>
<tr>
<td>

`walletAddress?`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`void`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/revokeGithubToken

# revokeGithubToken

> **revokeGithubToken**(`apiClient?`: `Client`, `walletAddress?`: `string`): `Promise`<`void`>

Defined in: [src/lib/auth/github.ts:420](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/github.ts#420)

Revoke the OAuth token

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`apiClient?`

</td>
<td>

`Client`

</td>
</tr>
<tr>
<td>

`walletAddress?`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`void`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/revokeNotionAccess

# revokeNotionAccess

> **revokeNotionAccess**(`walletAddress?`: `string`): `void`

Defined in: [src/lib/auth/notion.ts:979](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/notion.ts#979)

Revoke Notion access (clears local tokens)
Note: User must revoke via Notion settings for complete revocation

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`walletAddress?`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`void`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/savedToolToStored

# savedToolToStored

> **savedToolToStored**(`tool`: [`SavedToolModel`](../classes/SavedToolModel.md)): [`StoredSavedTool`](../interfaces/StoredSavedTool.md)

Defined in: [src/lib/db/savedTools/operations.ts:14](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/savedTools/operations.ts#14)

Convert a WatermelonDB SavedTool model to a plain StoredSavedTool object.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`tool`

</td>
<td>

[`SavedToolModel`](../classes/SavedToolModel.md)

</td>
</tr>
</tbody>
</table>

## Returns

[`StoredSavedTool`](../interfaces/StoredSavedTool.md)

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/searchChunksOp

# searchChunksOp

> **searchChunksOp**(`ctx`: [`StorageOperationsContext`](../interfaces/StorageOperationsContext.md), `queryVector`: `number`\[], `options?`: `object`): `Promise`<[`ChunkSearchResult`](../interfaces/ChunkSearchResult.md)\[]>

Defined in: [src/lib/db/chat/operations.ts:848](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/operations.ts#848)

Search through message chunks for fine-grained semantic search.
Returns the matching chunk text along with the parent message.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`StorageOperationsContext`](../interfaces/StorageOperationsContext.md)

</td>
</tr>
<tr>
<td>

`queryVector`

</td>
<td>

`number`\[]

</td>
</tr>
<tr>
<td>

`options?`

</td>
<td>

`object`

</td>
</tr>
<tr>
<td>

`options.conversationId?`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`options.limit?`

</td>
<td>

`number`

</td>
</tr>
<tr>
<td>

`options.minSimilarity?`

</td>
<td>

`number`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<[`ChunkSearchResult`](../interfaces/ChunkSearchResult.md)\[]>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/searchMediaOp

# searchMediaOp

> **searchMediaOp**(`ctx`: [`MediaOperationsContext`](../interfaces/MediaOperationsContext.md), `walletAddress`: `string`, `query`: `string`, `limit?`: `number`): `Promise`<[`StoredMedia`](../interfaces/StoredMedia.md)\[]>

Defined in: [src/lib/db/media/operations.ts:733](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/operations.ts#733)

Search media by name.
Handles both encrypted and plaintext names:

* First tries SQL LIKE for plaintext/legacy records
* Then fetches all records and filters decrypted names in memory
* Deduplicates and returns merged results

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`MediaOperationsContext`](../interfaces/MediaOperationsContext.md)

</td>
</tr>
<tr>
<td>

`walletAddress`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`query`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`limit?`

</td>
<td>

`number`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<[`StoredMedia`](../interfaces/StoredMedia.md)\[]>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/searchMessagesOp

# searchMessagesOp

> **searchMessagesOp**(`ctx`: [`StorageOperationsContext`](../interfaces/StorageOperationsContext.md), `queryVector`: `number`\[], `options?`: `object`): `Promise`<[`StoredMessageWithSimilarity`](../interfaces/StoredMessageWithSimilarity.md)\[]>

Defined in: [src/lib/db/chat/operations.ts:774](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/operations.ts#774)

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`StorageOperationsContext`](../interfaces/StorageOperationsContext.md)

</td>
</tr>
<tr>
<td>

`queryVector`

</td>
<td>

`number`\[]

</td>
</tr>
<tr>
<td>

`options?`

</td>
<td>

`object`

</td>
</tr>
<tr>
<td>

`options.conversationId?`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`options.limit?`

</td>
<td>

`number`

</td>
</tr>
<tr>
<td>

`options.minSimilarity?`

</td>
<td>

`number`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<[`StoredMessageWithSimilarity`](../interfaces/StoredMessageWithSimilarity.md)\[]>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/searchVaultMemories

# searchVaultMemories

> **searchVaultMemories**(`query`: `string`, `vaultCtx`: [`VaultMemoryOperationsContext`](../interfaces/VaultMemoryOperationsContext.md), `embeddingOptions`: [`MemoryEngineEmbeddingOptions`](../interfaces/MemoryEngineEmbeddingOptions.md), `cache`: [`VaultEmbeddingCache`](../type-aliases/VaultEmbeddingCache.md), `searchOptions?`: [`MemoryVaultSearchOptions`](../interfaces/MemoryVaultSearchOptions.md)): `Promise`<[`VaultSearchResult`](../interfaces/VaultSearchResult.md)\[]>

Defined in: [src/lib/memoryVault/searchTool.ts:391](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryVault/searchTool.ts#391)

Search vault memories by semantic similarity. Returns structured results
sorted by descending similarity, filtered by threshold and limit.

This is the standalone search logic extracted from `createMemoryVaultSearchTool`
so it can be called programmatically (e.g., for pre-retrieval injection).

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`query`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`vaultCtx`

</td>
<td>

[`VaultMemoryOperationsContext`](../interfaces/VaultMemoryOperationsContext.md)

</td>
</tr>
<tr>
<td>

`embeddingOptions`

</td>
<td>

[`MemoryEngineEmbeddingOptions`](../interfaces/MemoryEngineEmbeddingOptions.md)

</td>
</tr>
<tr>
<td>

`cache`

</td>
<td>

[`VaultEmbeddingCache`](../type-aliases/VaultEmbeddingCache.md)

</td>
</tr>
<tr>
<td>

`searchOptions?`

</td>
<td>

[`MemoryVaultSearchOptions`](../interfaces/MemoryVaultSearchOptions.md)

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<[`VaultSearchResult`](../interfaces/VaultSearchResult.md)\[]>

Sorted results (empty array on invalid input or empty vault)

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/selectServerToolsForPrompt

# selectServerToolsForPrompt

> **selectServerToolsForPrompt**(`options`: [`SelectServerToolsForPromptOptions`](../interfaces/SelectServerToolsForPromptOptions.md)): `Promise`<[`ServerTool`](../interfaces/ServerTool.md)\[]>

Defined in: [src/lib/tools/serverTools.ts:1177](https://github.com/anuma-ai/sdk/blob/main/src/lib/tools/serverTools.ts#1177)

Select server-side tools for a prompt using the same path
`useChatStorage` runs internally. Use this anywhere outside the chat
hook — background-task workers, server scripts, debug tools — that needs
the same selection the chat flow would produce.

Mirrors the responses-API branch of `sendMessage`: fetch catalog with
caching, optionally embed the prompt (only when the filter is a function),
apply the filter, return matching `ServerTool[]` (with embeddings and
descriptions intact for downstream serialization).

Returns `[]` on any of: undefined/empty filter, empty prompt for a
function filter, failed catalog fetch, or failed embedding.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`SelectServerToolsForPromptOptions`](../interfaces/SelectServerToolsForPromptOptions.md)

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<[`ServerTool`](../interfaces/ServerTool.md)\[]>

## Example

```ts
import { defaultServerToolsFilter, selectServerToolsForPrompt } from "@anuma/sdk/server";

const tools = await selectServerToolsForPrompt({
  prompt: "Generate a slide deck about AI",
  serverToolsFilter: defaultServerToolsFilter,
  getToken: async () => identityToken,
  baseUrl: process.env.API_URL,
});
```

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/serializeJsx

# serializeJsx

> **serializeJsx**(`node`: [`AnumaNode`](../interfaces/AnumaNode.md), `options`: `SerializeOptions`): `string`

Defined in: [src/tools/slides/jsx.ts:868](https://github.com/anuma-ai/sdk/blob/main/src/tools/slides/jsx.ts#868)

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`node`

</td>
<td>

[`AnumaNode`](../interfaces/AnumaNode.md)

</td>
</tr>
<tr>
<td>

`options`

</td>
<td>

`SerializeOptions`

</td>
</tr>
</tbody>
</table>

## Returns

`string`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/setLogger

# setLogger

> **setLogger**(`logger`: [`Logger`](../interfaces/Logger.md)): `void`

Defined in: [src/lib/logger.ts:52](https://github.com/anuma-ai/sdk/blob/main/src/lib/logger.ts#52)

Replace the active SDK logger. Pass [consoleLogger](../variables/consoleLogger.md) to restore defaults.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`logger`

</td>
<td>

[`Logger`](../interfaces/Logger.md)

</td>
</tr>
</tbody>
</table>

## Returns

`void`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/shouldChunkMessage

# shouldChunkMessage

> **shouldChunkMessage**(`content`: `string`, `chunkSize`: `number`): `boolean`

Defined in: [src/lib/memoryEngine/chunking.ts:212](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryEngine/chunking.ts#212)

Check if a message should be chunked based on its length.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Default value</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`content`

</td>
<td>

`string`

</td>
<td>

`undefined`

</td>
</tr>
<tr>
<td>

`chunkSize`

</td>
<td>

`number`

</td>
<td>

`DEFAULT_CHUNK_SIZE`

</td>
</tr>
</tbody>
</table>

## Returns

`boolean`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/shouldRefreshTools

# shouldRefreshTools

> **shouldRefreshTools**(`responseChecksum`: `string` | `undefined`): `boolean`

Defined in: [src/lib/tools/serverTools.ts:314](https://github.com/anuma-ai/sdk/blob/main/src/lib/tools/serverTools.ts#314)

Check if tools should be refreshed based on checksum comparison.
Returns true if:

* responseChecksum is provided and differs from cached checksum
* No cached checksum exists (first time with checksum support)

Returns false if:

* responseChecksum is not provided (legacy response)
* Checksums match

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`responseChecksum`

</td>
<td>

`string` | `undefined`

</td>
</tr>
</tbody>
</table>

## Returns

`boolean`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/startCalendarAuth

# startCalendarAuth

> **startCalendarAuth**(`clientId`: `string`, `callbackPath`: `string`): `Promise`<`never`>

Defined in: [src/lib/auth/google-calendar.ts:512](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/google-calendar.ts#512)

Start the OAuth flow - redirects to Google

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`clientId`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`callbackPath`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`never`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/startDriveAuth

# startDriveAuth

> **startDriveAuth**(`clientId`: `string`, `callbackPath`: `string`): `Promise`<`never`>

Defined in: [src/lib/auth/google-drive.ts:509](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/google-drive.ts#509)

Start the OAuth flow - redirects to Google

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`clientId`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`callbackPath`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`never`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/startGithubAuth

# startGithubAuth

> **startGithubAuth**(`clientId`: `string`, `callbackPath`: `string`): `Promise`<`never`>

Defined in: [src/lib/auth/github.ts:513](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/github.ts#513)

Start the OAuth flow - redirects to GitHub

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`clientId`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`callbackPath`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`never`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/startNotionAuth

# startNotionAuth

> **startNotionAuth**(`callbackPath`: `string`, `walletAddress?`: `string`): `Promise`<`never`>

Defined in: [src/lib/auth/notion.ts:674](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/notion.ts#674)

Start the Notion OAuth flow with PKCE and Dynamic Client Registration
Redirects to Notion authorization page

No client ID needed - uses dynamic registration (RFC 7591)

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`callbackPath`

</td>
<td>

`string`

</td>
<td>

The path for OAuth callback (e.g., "/auth/notion/callback")

</td>
</tr>
<tr>
<td>

`walletAddress?`

</td>
<td>

`string`

</td>
<td>

‐

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`never`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/storeCalendarPendingMessage

# storeCalendarPendingMessage

> **storeCalendarPendingMessage**(`message`: `string`): `void`

Defined in: [src/lib/auth/google-calendar.ts:494](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/google-calendar.ts#494)

Store a pending message to retry after OAuth completes

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`message`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`void`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/storeCalendarReturnUrl

# storeCalendarReturnUrl

> **storeCalendarReturnUrl**(): `void`

Defined in: [src/lib/auth/google-calendar.ts:476](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/google-calendar.ts#476)

Store the return URL for after OAuth completes

## Returns

`void`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/storeCalendarToken

# storeCalendarToken

> **storeCalendarToken**(`accessToken`: `string`, `expiresIn?`: `number`, `refreshToken?`: `string`, `scope?`: `string`, `walletAddress?`: `string`): `Promise`<`void`>

Defined in: [src/lib/auth/google-calendar.ts:547](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/google-calendar.ts#547)

Store Calendar token data (for external use)

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`accessToken`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`expiresIn?`

</td>
<td>

`number`

</td>
</tr>
<tr>
<td>

`refreshToken?`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`scope?`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`walletAddress?`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`void`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/storeDrivePendingMessage

# storeDrivePendingMessage

> **storeDrivePendingMessage**(`message`: `string`): `void`

Defined in: [src/lib/auth/google-drive.ts:491](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/google-drive.ts#491)

Store a pending message to retry after OAuth completes

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`message`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`void`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/storeDriveReturnUrl

# storeDriveReturnUrl

> **storeDriveReturnUrl**(): `void`

Defined in: [src/lib/auth/google-drive.ts:473](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/google-drive.ts#473)

Store the return URL for after OAuth completes

## Returns

`void`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/storeDriveToken

# storeDriveToken

> **storeDriveToken**(`accessToken`: `string`, `expiresIn?`: `number`, `refreshToken?`: `string`, `scope?`: `string`, `walletAddress?`: `string`): `Promise`<`void`>

Defined in: [src/lib/auth/google-drive.ts:544](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/google-drive.ts#544)

Store Drive token data (for external use)

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`accessToken`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`expiresIn?`

</td>
<td>

`number`

</td>
</tr>
<tr>
<td>

`refreshToken?`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`scope?`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`walletAddress?`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`void`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/storeGithubPendingMessage

# storeGithubPendingMessage

> **storeGithubPendingMessage**(`message`: `string`): `void`

Defined in: [src/lib/auth/github.ts:495](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/github.ts#495)

Store a pending message to retry after OAuth completes

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`message`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`void`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/storeGithubReturnUrl

# storeGithubReturnUrl

> **storeGithubReturnUrl**(): `void`

Defined in: [src/lib/auth/github.ts:477](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/github.ts#477)

Store the return URL for after OAuth completes

## Returns

`void`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/storeGithubToken

# storeGithubToken

> **storeGithubToken**(`accessToken`: `string`, `expiresIn?`: `number`, `refreshToken?`: `string`, `scope?`: `string`, `walletAddress?`: `string`): `Promise`<`void`>

Defined in: [src/lib/auth/github.ts:549](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/github.ts#549)

Store GitHub token data (for external use)

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`accessToken`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`expiresIn?`

</td>
<td>

`number`

</td>
</tr>
<tr>
<td>

`refreshToken?`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`scope?`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`walletAddress?`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`void`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/storeNotionPendingMessage

# storeNotionPendingMessage

> **storeNotionPendingMessage**(`message`: `string`): `void`

Defined in: [src/lib/auth/notion.ts:1022](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/notion.ts#1022)

Store a pending message to retry after OAuth completes

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`message`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`void`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/storeNotionReturnUrl

# storeNotionReturnUrl

> **storeNotionReturnUrl**(): `void`

Defined in: [src/lib/auth/notion.ts:1004](https://github.com/anuma-ai/sdk/blob/main/src/lib/auth/notion.ts#1004)

Store the return URL for after OAuth completes

## Returns

`void`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/UIInteractionProvider

# UIInteractionProvider

> **UIInteractionProvider**(`__namedParameters`: [`UIInteractionProviderProps`](../type-aliases/UIInteractionProviderProps.md)): `ReactElement`

Defined in: [src/react/useUIInteraction.ts:83](https://github.com/anuma-ai/sdk/blob/main/src/react/useUIInteraction.ts#83)

Provider for managing UI interactions between LLM tools and user.

This provider manages pending interactions that are created when the LLM
calls a UI interaction tool (like prompt\_user\_choice). The interactions
are rendered inline in the chat, and when the user responds, the provider
resolves the promise to send the result back to the LLM.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`__namedParameters`

</td>
<td>

[`UIInteractionProviderProps`](../type-aliases/UIInteractionProviderProps.md)

</td>
</tr>
</tbody>
</table>

## Returns

`ReactElement`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/updateAttrs

# updateAttrs

> **updateAttrs**(`node`: [`AnumaNode`](../interfaces/AnumaNode.md), `patch`: `Record`<`string`, `unknown`>): `void`

Defined in: [src/tools/slides/jsx.ts:1166](https://github.com/anuma-ai/sdk/blob/main/src/tools/slides/jsx.ts#1166)

Shallow-merge attrs onto `node`. Ignores prototype-pollution keys.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`node`

</td>
<td>

[`AnumaNode`](../interfaces/AnumaNode.md)

</td>
</tr>
<tr>
<td>

`patch`

</td>
<td>

`Record`<`string`, `unknown`>

</td>
</tr>
</tbody>
</table>

## Returns

`void`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/updateConversationProjectOp

# updateConversationProjectOp

> **updateConversationProjectOp**(`ctx`: [`StorageOperationsContext`](../interfaces/StorageOperationsContext.md), `id`: `string`, `projectId`: `string` | `null`): `Promise`<`boolean`>

Defined in: [src/lib/db/chat/operations.ts:352](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/operations.ts#352)

Update a conversation's project assignment.
Pass null to remove the conversation from any project.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`StorageOperationsContext`](../interfaces/StorageOperationsContext.md)

</td>
</tr>
<tr>
<td>

`id`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`projectId`

</td>
<td>

`string` | `null`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`boolean`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/updateMediaMessageIdBatchOp

# updateMediaMessageIdBatchOp

> **updateMediaMessageIdBatchOp**(`ctx`: [`MediaOperationsContext`](../interfaces/MediaOperationsContext.md), `mediaIds`: `string`\[], `messageId`: `string`): `Promise`<`number`>

Defined in: [src/lib/db/media/operations.ts:294](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/operations.ts#294)

Batch update media records with a messageId.
Used to associate media records with their message after message creation.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`MediaOperationsContext`](../interfaces/MediaOperationsContext.md)

</td>
<td>

Database context

</td>
</tr>
<tr>
<td>

`mediaIds`

</td>
<td>

`string`\[]

</td>
<td>

Array of mediaIds to update

</td>
</tr>
<tr>
<td>

`messageId`

</td>
<td>

`string`

</td>
<td>

The messageId to set on all records

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`number`>

Number of records updated

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/updateMediaOp

# updateMediaOp

> **updateMediaOp**(`ctx`: [`MediaOperationsContext`](../interfaces/MediaOperationsContext.md), `mediaId`: `string`, `options`: [`UpdateMediaOptions`](../interfaces/UpdateMediaOptions.md)): `Promise`<[`StoredMedia`](../interfaces/StoredMedia.md) | `null`>

Defined in: [src/lib/db/media/operations.ts:248](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/operations.ts#248)

Update a media record.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`MediaOperationsContext`](../interfaces/MediaOperationsContext.md)

</td>
</tr>
<tr>
<td>

`mediaId`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`options`

</td>
<td>

[`UpdateMediaOptions`](../interfaces/UpdateMediaOptions.md)

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<[`StoredMedia`](../interfaces/StoredMedia.md) | `null`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/updateMessageFeedbackOp

# updateMessageFeedbackOp

> **updateMessageFeedbackOp**(`ctx`: [`StorageOperationsContext`](../interfaces/StorageOperationsContext.md), `uniqueId`: `string`, `feedback`: [`MessageFeedback`](../type-aliases/MessageFeedback.md)): `Promise`<[`StoredMessage`](../interfaces/StoredMessage.md) | `null`>

Defined in: [src/lib/db/chat/operations.ts:627](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/operations.ts#627)

Update the feedback (like/dislike) for a message.
Each regenerated response can have its own independent feedback.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`StorageOperationsContext`](../interfaces/StorageOperationsContext.md)

</td>
<td>

Storage operations context

</td>
</tr>
<tr>
<td>

`uniqueId`

</td>
<td>

`string`

</td>
<td>

The unique ID of the message to update

</td>
</tr>
<tr>
<td>

`feedback`

</td>
<td>

[`MessageFeedback`](../type-aliases/MessageFeedback.md)

</td>
<td>

'like', 'dislike', or null to clear feedback

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<[`StoredMessage`](../interfaces/StoredMessage.md) | `null`>

The updated message or null if not found

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/updateProjectNameOp

# updateProjectNameOp

> **updateProjectNameOp**(`ctx`: [`ProjectOperationsContext`](../interfaces/ProjectOperationsContext.md), `id`: `string`, `name`: `string`): `Promise`<`boolean`>

Defined in: [src/lib/db/project/operations.ts:82](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/project/operations.ts#82)

Update a project's name.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`ProjectOperationsContext`](../interfaces/ProjectOperationsContext.md)

</td>
</tr>
<tr>
<td>

`id`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`name`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`boolean`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/updateProjectOp

# updateProjectOp

> **updateProjectOp**(`ctx`: [`ProjectOperationsContext`](../interfaces/ProjectOperationsContext.md), `id`: `string`, `opts`: [`UpdateProjectOptions`](../interfaces/UpdateProjectOptions.md)): `Promise`<`boolean`>

Defined in: [src/lib/db/project/operations.ts:105](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/project/operations.ts#105)

Update a project with partial options.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`ProjectOperationsContext`](../interfaces/ProjectOperationsContext.md)

</td>
</tr>
<tr>
<td>

`id`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`opts`

</td>
<td>

[`UpdateProjectOptions`](../interfaces/UpdateProjectOptions.md)

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`boolean`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/updateSavedToolOp

# updateSavedToolOp

> **updateSavedToolOp**(`ctx`: [`SavedToolOperationsContext`](../interfaces/SavedToolOperationsContext.md), `uniqueId`: `string`, `opts`: [`UpdateSavedToolOptions`](../interfaces/UpdateSavedToolOptions.md)): `Promise`<`boolean`>

Defined in: [src/lib/db/savedTools/operations.ts:79](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/savedTools/operations.ts#79)

Update an existing saved tool. Returns true if the record was found and updated.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`SavedToolOperationsContext`](../interfaces/SavedToolOperationsContext.md)

</td>
</tr>
<tr>
<td>

`uniqueId`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`opts`

</td>
<td>

[`UpdateSavedToolOptions`](../interfaces/UpdateSavedToolOptions.md)

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`boolean`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/updateVaultFolderContextOp

# updateVaultFolderContextOp

> **updateVaultFolderContextOp**(`ctx`: [`VaultFolderOperationsContext`](../interfaces/VaultFolderOperationsContext.md), `id`: `string`, `context`: `string` | `null`): `Promise`<[`StoredVaultFolder`](../interfaces/StoredVaultFolder.md) | `null`>

Defined in: [src/lib/db/vaultFolders/operations.ts:206](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/vaultFolders/operations.ts#206)

Update a vault folder's context summary.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`VaultFolderOperationsContext`](../interfaces/VaultFolderOperationsContext.md)

</td>
</tr>
<tr>
<td>

`id`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`context`

</td>
<td>

`string` | `null`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<[`StoredVaultFolder`](../interfaces/StoredVaultFolder.md) | `null`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/updateVaultFolderOp

# updateVaultFolderOp

> **updateVaultFolderOp**(`ctx`: [`VaultFolderOperationsContext`](../interfaces/VaultFolderOperationsContext.md), `id`: `string`, `opts`: [`UpdateVaultFolderOptions`](../interfaces/UpdateVaultFolderOptions.md)): `Promise`<[`StoredVaultFolder`](../interfaces/StoredVaultFolder.md) | `null`>

Defined in: [src/lib/db/vaultFolders/operations.ts:67](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/vaultFolders/operations.ts#67)

Update a vault folder's name and/or scope.
When scope changes, cascades to all contained memories atomically.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`VaultFolderOperationsContext`](../interfaces/VaultFolderOperationsContext.md)

</td>
</tr>
<tr>
<td>

`id`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`opts`

</td>
<td>

[`UpdateVaultFolderOptions`](../interfaces/UpdateVaultFolderOptions.md)

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<[`StoredVaultFolder`](../interfaces/StoredVaultFolder.md) | `null`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/updateVaultMemoryEmbeddingOp

# updateVaultMemoryEmbeddingOp

> **updateVaultMemoryEmbeddingOp**(`ctx`: [`VaultMemoryOperationsContext`](../interfaces/VaultMemoryOperationsContext.md), `id`: `string`, `embedding`: `string`): `Promise`<`boolean`>

Defined in: [src/lib/db/memoryVault/operations.ts:312](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/memoryVault/operations.ts#312)

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`VaultMemoryOperationsContext`](../interfaces/VaultMemoryOperationsContext.md)

</td>
</tr>
<tr>
<td>

`id`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`embedding`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`boolean`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/updateVaultMemoryOp

# updateVaultMemoryOp

> **updateVaultMemoryOp**(`ctx`: [`VaultMemoryOperationsContext`](../interfaces/VaultMemoryOperationsContext.md), `id`: `string`, `opts`: [`UpdateVaultMemoryOptions`](../interfaces/UpdateVaultMemoryOptions.md)): `Promise`<[`StoredVaultMemory`](../interfaces/StoredVaultMemory.md) | `null`>

Defined in: [src/lib/db/memoryVault/operations.ts:206](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/memoryVault/operations.ts#206)

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`ctx`

</td>
<td>

[`VaultMemoryOperationsContext`](../interfaces/VaultMemoryOperationsContext.md)

</td>
</tr>
<tr>
<td>

`id`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`opts`

</td>
<td>

[`UpdateVaultMemoryOptions`](../interfaces/UpdateVaultMemoryOptions.md)

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<[`StoredVaultMemory`](../interfaces/StoredVaultMemory.md) | `null`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/useAnumaTheme

# useAnumaTheme

> **useAnumaTheme**(): [`AnumaTheme`](../interfaces/AnumaTheme.md)

Defined in: [src/react/anumaRuntime.tsx:141](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#141)

Read the current Anuma theme from context.

## Returns

[`AnumaTheme`](../interfaces/AnumaTheme.md)

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/useDatabaseManager

# useDatabaseManager

> **useDatabaseManager**(`walletAddress`: `string` | `undefined`, `manager`: [`DatabaseManager`](../classes/DatabaseManager.md)): `Database`

Defined in: [src/react/useDatabaseManager.ts:50](https://github.com/anuma-ai/sdk/blob/main/src/react/useDatabaseManager.ts#50)

React hook that returns the correct WatermelonDB Database instance
for the current wallet address.

Replaces the common pattern of:

```typescript
const database = useMemo(() => getWatermelonDatabase(walletAddress), [walletAddress]);
```

When the wallet address changes, a new database instance is returned,
providing complete per-wallet data isolation.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`walletAddress`

</td>
<td>

`string` | `undefined`

</td>
<td>

The current user's wallet address, or undefined for guest mode

</td>
</tr>
<tr>
<td>

`manager`

</td>
<td>

[`DatabaseManager`](../classes/DatabaseManager.md)

</td>
<td>

A DatabaseManager instance (should be created once at app level)

</td>
</tr>
</tbody>
</table>

## Returns

`Database`

The WatermelonDB Database instance for the current wallet

## Example

```tsx
import { useDatabaseManager, DatabaseManager, webPlatformStorage } from '@anuma/sdk/react';
import LokiJSAdapter from '@nozbe/watermelondb/adapters/lokijs';

// Create once at app level
const dbManager = new DatabaseManager({
  dbNamePrefix: 'my-app',
  createAdapter: (dbName, schema, migrations) => new LokiJSAdapter({
    schema, migrations, dbName,
    useWebWorker: false,
    useIncrementalIndexedDB: true,
  }),
  storage: webPlatformStorage,
  onDestructiveMigration: () => window.location.reload(),
});

function MyComponent() {
  const { user } = usePrivy();
  const database = useDatabaseManager(user?.wallet?.address, dbManager);

  // Pass database to SDK hooks
  const { sendMessage } = useChatStorage({ database, ... });
}
```

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/useUIInteraction

# useUIInteraction

> **useUIInteraction**(): [`UIInteractionContextValue`](../type-aliases/UIInteractionContextValue.md)

Defined in: [src/react/useUIInteraction.ts:61](https://github.com/anuma-ai/sdk/blob/main/src/react/useUIInteraction.ts#61)

Hook to access UI interaction context

## Returns

[`UIInteractionContextValue`](../type-aliases/UIInteractionContextValue.md)

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/walk

# walk

> **walk**(`root`: [`AnumaNode`](../interfaces/AnumaNode.md), `visitor`: (`node`: [`AnumaNode`](../interfaces/AnumaNode.md), `parent`: [`AnumaNode`](../interfaces/AnumaNode.md) | `null`) => `false` | `void`): `void`

Defined in: [src/tools/slides/jsx.ts:1017](https://github.com/anuma-ai/sdk/blob/main/src/tools/slides/jsx.ts#1017)

Walk the tree depth-first. Visitor sees `(node, parent)` — parent is
`null` for the root. Return `false` from the visitor to skip descending
into a node's children.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`root`

</td>
<td>

[`AnumaNode`](../interfaces/AnumaNode.md)

</td>
</tr>
<tr>
<td>

`visitor`

</td>
<td>

(`node`: [`AnumaNode`](../interfaces/AnumaNode.md), `parent`: [`AnumaNode`](../interfaces/AnumaNode.md) | `null`) => `false` | `void`

</td>
</tr>
</tbody>
</table>

## Returns

`void`

---
Source: https://docs.anuma.ai/sdk/react/Internal/functions/writeEncryptedFile

# writeEncryptedFile

> **writeEncryptedFile**(`fileId`: `string`, `blob`: `Blob`, `encryptionKey`: `CryptoKey`, `metadata?`: `object`): `Promise`<`void`>

Defined in: [src/lib/storage/opfs.ts:186](https://github.com/anuma-ai/sdk/blob/main/src/lib/storage/opfs.ts#186)

Writes an encrypted file to OPFS.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`fileId`

</td>
<td>

`string`

</td>
<td>

Unique identifier for the file

</td>
</tr>
<tr>
<td>

`blob`

</td>
<td>

`Blob`

</td>
<td>

The file content

</td>
</tr>
<tr>
<td>

`encryptionKey`

</td>
<td>

`CryptoKey`

</td>
<td>

CryptoKey for encryption

</td>
</tr>
<tr>
<td>

`metadata?`

</td>
<td>

`object`

</td>
<td>

Optional metadata (name, type, sourceUrl)

</td>
</tr>
<tr>
<td>

`metadata.name?`

</td>
<td>

`string`

</td>
<td>

‐

</td>
</tr>
<tr>
<td>

`metadata.sourceUrl?`

</td>
<td>

`string`

</td>
<td>

‐

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`void`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/AnumaNode

# AnumaNode

Defined in: [src/tools/slides/jsx.ts:59](https://github.com/anuma-ai/sdk/blob/main/src/tools/slides/jsx.ts#59)

A node in the Anuma tree. `tag` is the local name after `Anuma.` (e.g.
`"Text"`, `"Slide"`). Children are other nodes for containers, or a
single string (the body text) for `<Anuma.Text>`.

## Properties

### attrs

> **attrs**: `Record`<`string`, [`AttrValue`](../type-aliases/AttrValue.md)>

Defined in: [src/tools/slides/jsx.ts:61](https://github.com/anuma-ai/sdk/blob/main/src/tools/slides/jsx.ts#61)

***

### children

> **children**: [`AnumaChild`](../type-aliases/AnumaChild.md)\[]

Defined in: [src/tools/slides/jsx.ts:62](https://github.com/anuma-ai/sdk/blob/main/src/tools/slides/jsx.ts#62)

***

### tag

> **tag**: `string`

Defined in: [src/tools/slides/jsx.ts:60](https://github.com/anuma-ai/sdk/blob/main/src/tools/slides/jsx.ts#60)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/AnumaShadowIsolationProviderProps

# AnumaShadowIsolationProviderProps

Defined in: [src/react/anumaRuntime.tsx:92](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#92)

## Properties

### children

> **children**: `ReactNode`

Defined in: [src/react/anumaRuntime.tsx:94](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#94)

***

### enabled?

> `optional` **enabled**: `boolean`

Defined in: [src/react/anumaRuntime.tsx:93](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#93)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/AnumaTheme

# AnumaTheme

Defined in: [src/react/anumaRuntime.tsx:58](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#58)

## Properties

### colors

> **colors**: `Partial`<`Record`<[`ThemeAttr`](../type-aliases/ThemeAttr.md), `string`>>

Defined in: [src/react/anumaRuntime.tsx:62](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#62)

Color tokens — keys are `THEME_ATTRS`.

***

### fontPreset

> **fontPreset**: `string`

Defined in: [src/react/anumaRuntime.tsx:60](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#60)

`FONT_PRESETS` key.

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/AnumaThemeProviderProps

# AnumaThemeProviderProps

Defined in: [src/react/anumaRuntime.tsx:113](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#113)

## Properties

### children

> **children**: `ReactNode`

Defined in: [src/react/anumaRuntime.tsx:118](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#118)

***

### colors?

> `optional` **colors**: `Partial`<`Record`<`"background"` | `"border"` | `"accent"` | `"slideBg"` | `"surfaceSecondary"` | `"textPrimary"` | `"textSecondary"` | `"textMuted"` | `"card"`, `string`>>

Defined in: [src/react/anumaRuntime.tsx:117](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#117)

Color token overrides. Merged with the built-in defaults.

***

### fontPreset?

> `optional` **fontPreset**: `string`

Defined in: [src/react/anumaRuntime.tsx:115](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#115)

Override the default font preset key.

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/AppFileOperationsContext

# AppFileOperationsContext

Defined in: [src/lib/db/appFiles/operations.ts:9](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/appFiles/operations.ts#9)

Context required by app file operations.

## Properties

### appFilesCollection

> **appFilesCollection**: `Collection`<[`AppFileModel`](../classes/AppFileModel.md)>

Defined in: [src/lib/db/appFiles/operations.ts:11](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/appFiles/operations.ts#11)

***

### database

> **database**: `Database`

Defined in: [src/lib/db/appFiles/operations.ts:10](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/appFiles/operations.ts#10)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/BackupAuthContextValue

# BackupAuthContextValue

Defined in: [src/react/useBackupAuth.ts:99](https://github.com/anuma-ai/sdk/blob/main/src/react/useBackupAuth.ts#99)

Context value for unified backup authentication

## Properties

### dropbox

> **dropbox**: [`ProviderAuthState`](ProviderAuthState.md)

Defined in: [src/react/useBackupAuth.ts:101](https://github.com/anuma-ai/sdk/blob/main/src/react/useBackupAuth.ts#101)

Dropbox authentication state and methods

***

### googleDrive

> **googleDrive**: [`ProviderAuthState`](ProviderAuthState.md)

Defined in: [src/react/useBackupAuth.ts:103](https://github.com/anuma-ai/sdk/blob/main/src/react/useBackupAuth.ts#103)

Google Drive authentication state and methods

***

### hasAnyAuthentication

> **hasAnyAuthentication**: `boolean`

Defined in: [src/react/useBackupAuth.ts:109](https://github.com/anuma-ai/sdk/blob/main/src/react/useBackupAuth.ts#109)

Check if any provider is authenticated

***

### hasAnyProvider

> **hasAnyProvider**: `boolean`

Defined in: [src/react/useBackupAuth.ts:107](https://github.com/anuma-ai/sdk/blob/main/src/react/useBackupAuth.ts#107)

Check if any provider is configured

***

### icloud

> **icloud**: [`ProviderAuthState`](ProviderAuthState.md)

Defined in: [src/react/useBackupAuth.ts:105](https://github.com/anuma-ai/sdk/blob/main/src/react/useBackupAuth.ts#105)

iCloud authentication state and methods

***

### logoutAll()

> **logoutAll**: () => `Promise`<`void`>

Defined in: [src/react/useBackupAuth.ts:111](https://github.com/anuma-ai/sdk/blob/main/src/react/useBackupAuth.ts#111)

Logout from all providers

**Returns**

`Promise`<`void`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/BackupAuthProviderProps

# BackupAuthProviderProps

Defined in: [src/react/useBackupAuth.ts:48](https://github.com/anuma-ai/sdk/blob/main/src/react/useBackupAuth.ts#48)

Props for BackupAuthProvider

At least one of `dropboxAppKey`, `googleClientId`, or `icloudApiToken` should be provided
for the provider to be useful. All are optional to allow using just one backup provider.

## Properties

### apiClient?

> `optional` **apiClient**: `Client`

Defined in: [src/react/useBackupAuth.ts:67](https://github.com/anuma-ai/sdk/blob/main/src/react/useBackupAuth.ts#67)

API client for backend OAuth requests. Optional - uses the default SDK client if not provided.
Only needed if you have a custom client configuration (e.g., different baseUrl).

***

### children

> **children**: `ReactNode`

Defined in: [src/react/useBackupAuth.ts:75](https://github.com/anuma-ai/sdk/blob/main/src/react/useBackupAuth.ts#75)

Children to render

***

### dropboxAppKey?

> `optional` **dropboxAppKey**: `string`

Defined in: [src/react/useBackupAuth.ts:50](https://github.com/anuma-ai/sdk/blob/main/src/react/useBackupAuth.ts#50)

Dropbox App Key (from Dropbox Developer Console). Optional - omit to disable Dropbox.

***

### dropboxCallbackPath?

> `optional` **dropboxCallbackPath**: `string`

Defined in: [src/react/useBackupAuth.ts:52](https://github.com/anuma-ai/sdk/blob/main/src/react/useBackupAuth.ts#52)

Dropbox OAuth callback path (default: "/auth/dropbox/callback")

***

### googleCallbackPath?

> `optional` **googleCallbackPath**: `string`

Defined in: [src/react/useBackupAuth.ts:56](https://github.com/anuma-ai/sdk/blob/main/src/react/useBackupAuth.ts#56)

Google OAuth callback path (default: "/auth/google/callback")

***

### googleClientId?

> `optional` **googleClientId**: `string`

Defined in: [src/react/useBackupAuth.ts:54](https://github.com/anuma-ai/sdk/blob/main/src/react/useBackupAuth.ts#54)

Google OAuth Client ID (from Google Cloud Console). Optional - omit to disable Google Drive.

***

### icloudApiToken?

> `optional` **icloudApiToken**: `string`

Defined in: [src/react/useBackupAuth.ts:58](https://github.com/anuma-ai/sdk/blob/main/src/react/useBackupAuth.ts#58)

CloudKit API token (from Apple Developer Console). Optional - omit to disable iCloud.

***

### icloudContainerIdentifier?

> `optional` **icloudContainerIdentifier**: `string`

Defined in: [src/react/useBackupAuth.ts:60](https://github.com/anuma-ai/sdk/blob/main/src/react/useBackupAuth.ts#60)

CloudKit container identifier (default: "iCloud.Memoryless")

***

### icloudEnvironment?

> `optional` **icloudEnvironment**: `"development"` | `"production"`

Defined in: [src/react/useBackupAuth.ts:62](https://github.com/anuma-ai/sdk/blob/main/src/react/useBackupAuth.ts#62)

CloudKit environment (default: "production")

***

### walletAddress?

> `optional` **walletAddress**: `string`

Defined in: [src/react/useBackupAuth.ts:73](https://github.com/anuma-ai/sdk/blob/main/src/react/useBackupAuth.ts#73)

Wallet address for encrypting OAuth tokens at rest.
If provided, tokens will be encrypted before storing in localStorage.
If omitted, tokens are stored temporarily in sessionStorage (cleared on page close).

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/BackupOperationOptions

# BackupOperationOptions

Defined in: [src/react/useBackup.ts:71](https://github.com/anuma-ai/sdk/blob/main/src/react/useBackup.ts#71)

Backup options for individual operations

## Properties

### onProgress?

> `optional` **onProgress**: [`ProgressCallback`](../type-aliases/ProgressCallback.md)

Defined in: [src/react/useBackup.ts:72](https://github.com/anuma-ai/sdk/blob/main/src/react/useBackup.ts#72)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/CachedServerTools

# CachedServerTools

Defined in: [src/lib/tools/serverTools.ts:81](https://github.com/anuma-ai/sdk/blob/main/src/lib/tools/serverTools.ts#81)

Cached tools structure stored in localStorage

## Properties

### checksum?

> `optional` **checksum**: `string`

Defined in: [src/lib/tools/serverTools.ts:86](https://github.com/anuma-ai/sdk/blob/main/src/lib/tools/serverTools.ts#86)

Checksum from the server for cache invalidation

***

### timestamp

> **timestamp**: `number`

Defined in: [src/lib/tools/serverTools.ts:83](https://github.com/anuma-ai/sdk/blob/main/src/lib/tools/serverTools.ts#83)

***

### tools

> **tools**: [`ServerTool`](ServerTool.md)\[]

Defined in: [src/lib/tools/serverTools.ts:82](https://github.com/anuma-ai/sdk/blob/main/src/lib/tools/serverTools.ts#82)

***

### version

> **version**: `string`

Defined in: [src/lib/tools/serverTools.ts:84](https://github.com/anuma-ai/sdk/blob/main/src/lib/tools/serverTools.ts#84)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/ChatStorageAdapter

# ChatStorageAdapter

Defined in: [src/lib/storage/ChatStorageAdapter.ts:95](https://github.com/anuma-ai/sdk/blob/main/src/lib/storage/ChatStorageAdapter.ts#95)

Backend-agnostic interface for chat/conversation storage.

The method set mirrors the operations we actually use across the SDK:
`*Op` functions in `src/lib/db/chat/operations.ts` plus the `observe*`
patterns used by react hooks. Targeted updates (e.g., `updateMessageError`)
are exposed as separate methods rather than a generic `update()` because
several of them have special semantics (encryption bypass for embeddings,
unique constraints on feedback, etc).

## Methods

### clearMessages()

> **clearMessages**(`conversationId`: `string`): `Promise`<`void`>

Defined in: [src/lib/storage/ChatStorageAdapter.ts:138](https://github.com/anuma-ai/sdk/blob/main/src/lib/storage/ChatStorageAdapter.ts#138)

Clears all messages in a conversation (used for the "clear chat" action).

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`conversationId`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`void`>

***

### createConversation()

> **createConversation**(`options?`: [`CreateConversationOptions`](CreateConversationOptions.md)): `Promise`<[`StoredConversation`](StoredConversation.md)>

Defined in: [src/lib/storage/ChatStorageAdapter.ts:102](https://github.com/anuma-ai/sdk/blob/main/src/lib/storage/ChatStorageAdapter.ts#102)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options?`

</td>
<td>

[`CreateConversationOptions`](CreateConversationOptions.md)

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`StoredConversation`](StoredConversation.md)>

***

### createMessage()

> **createMessage**(`options`: [`CreateMessageOptions`](CreateMessageOptions.md)): `Promise`<[`StoredMessage`](StoredMessage.md)>

Defined in: [src/lib/storage/ChatStorageAdapter.ts:119](https://github.com/anuma-ai/sdk/blob/main/src/lib/storage/ChatStorageAdapter.ts#119)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`CreateMessageOptions`](CreateMessageOptions.md)

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`StoredMessage`](StoredMessage.md)>

***

### deleteConversation()

> **deleteConversation**(`conversationId`: `string`): `Promise`<`boolean`>

Defined in: [src/lib/storage/ChatStorageAdapter.ts:109](https://github.com/anuma-ai/sdk/blob/main/src/lib/storage/ChatStorageAdapter.ts#109)

Soft delete. Implementations are responsible for cascading to messages/media.

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`conversationId`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`boolean`>

***

### getAllFiles()

> **getAllFiles**(): `Promise`<[`StoredFileWithContext`](StoredFileWithContext.md)\[]>

Defined in: [src/lib/storage/ChatStorageAdapter.ts:144](https://github.com/anuma-ai/sdk/blob/main/src/lib/storage/ChatStorageAdapter.ts#144)

**Returns**

`Promise`<[`StoredFileWithContext`](StoredFileWithContext.md)\[]>

***

### getConversation()

> **getConversation**(`conversationId`: `string`): `Promise`<[`StoredConversation`](StoredConversation.md) | `null`>

Defined in: [src/lib/storage/ChatStorageAdapter.ts:98](https://github.com/anuma-ai/sdk/blob/main/src/lib/storage/ChatStorageAdapter.ts#98)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`conversationId`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`StoredConversation`](StoredConversation.md) | `null`>

***

### getConversations()

> **getConversations**(`options?`: [`ConversationQueryOptions`](ConversationQueryOptions.md)): `Promise`<[`StoredConversation`](StoredConversation.md)\[]>

Defined in: [src/lib/storage/ChatStorageAdapter.ts:100](https://github.com/anuma-ai/sdk/blob/main/src/lib/storage/ChatStorageAdapter.ts#100)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options?`

</td>
<td>

[`ConversationQueryOptions`](ConversationQueryOptions.md)

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`StoredConversation`](StoredConversation.md)\[]>

***

### getMessages()

> **getMessages**(`conversationId`: `string`): `Promise`<[`StoredMessage`](StoredMessage.md)\[]>

Defined in: [src/lib/storage/ChatStorageAdapter.ts:117](https://github.com/anuma-ai/sdk/blob/main/src/lib/storage/ChatStorageAdapter.ts#117)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`conversationId`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`StoredMessage`](StoredMessage.md)\[]>

***

### observeConversations()

> **observeConversations**(`options?`: [`ConversationQueryOptions`](ConversationQueryOptions.md)): [`ChatStorageObservable`](ChatStorageObservable.md)<[`StoredConversation`](StoredConversation.md)\[]>

Defined in: [src/lib/storage/ChatStorageAdapter.ts:111](https://github.com/anuma-ai/sdk/blob/main/src/lib/storage/ChatStorageAdapter.ts#111)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options?`

</td>
<td>

[`ConversationQueryOptions`](ConversationQueryOptions.md)

</td>
</tr>
</tbody>
</table>

**Returns**

[`ChatStorageObservable`](ChatStorageObservable.md)<[`StoredConversation`](StoredConversation.md)\[]>

***

### observeMessages()

> **observeMessages**(`conversationId`: `string`): [`ChatStorageObservable`](ChatStorageObservable.md)<[`StoredMessage`](StoredMessage.md)\[]>

Defined in: [src/lib/storage/ChatStorageAdapter.ts:140](https://github.com/anuma-ai/sdk/blob/main/src/lib/storage/ChatStorageAdapter.ts#140)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`conversationId`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

[`ChatStorageObservable`](ChatStorageObservable.md)<[`StoredMessage`](StoredMessage.md)\[]>

***

### updateConversationProject()

> **updateConversationProject**(`conversationId`: `string`, `projectId`: `string` | `null`): `Promise`<`boolean`>

Defined in: [src/lib/storage/ChatStorageAdapter.ts:106](https://github.com/anuma-ai/sdk/blob/main/src/lib/storage/ChatStorageAdapter.ts#106)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`conversationId`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`projectId`

</td>
<td>

`string` | `null`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`boolean`>

***

### updateConversationTitle()

> **updateConversationTitle**(`conversationId`: `string`, `title`: `string`): `Promise`<`boolean`>

Defined in: [src/lib/storage/ChatStorageAdapter.ts:104](https://github.com/anuma-ai/sdk/blob/main/src/lib/storage/ChatStorageAdapter.ts#104)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`conversationId`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`title`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`boolean`>

***

### updateMessageChunks()

> **updateMessageChunks**(`uniqueId`: `string`, `chunks`: [`MessageChunk`](MessageChunk.md)\[], `embeddingModel`: `string`): `Promise`<[`StoredMessage`](StoredMessage.md) | `null`>

Defined in: [src/lib/storage/ChatStorageAdapter.ts:127](https://github.com/anuma-ai/sdk/blob/main/src/lib/storage/ChatStorageAdapter.ts#127)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`uniqueId`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`chunks`

</td>
<td>

[`MessageChunk`](MessageChunk.md)\[]

</td>
</tr>
<tr>
<td>

`embeddingModel`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`StoredMessage`](StoredMessage.md) | `null`>

***

### updateMessageEmbedding()

> **updateMessageEmbedding**(`uniqueId`: `string`, `vector`: `number`\[], `embeddingModel`: `string`): `Promise`<[`StoredMessage`](StoredMessage.md) | `null`>

Defined in: [src/lib/storage/ChatStorageAdapter.ts:121](https://github.com/anuma-ai/sdk/blob/main/src/lib/storage/ChatStorageAdapter.ts#121)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`uniqueId`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`vector`

</td>
<td>

`number`\[]

</td>
</tr>
<tr>
<td>

`embeddingModel`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`StoredMessage`](StoredMessage.md) | `null`>

***

### updateMessageError()

> **updateMessageError**(`uniqueId`: `string`, `error`: `string`): `Promise`<[`StoredMessage`](StoredMessage.md) | `null`>

Defined in: [src/lib/storage/ChatStorageAdapter.ts:133](https://github.com/anuma-ai/sdk/blob/main/src/lib/storage/ChatStorageAdapter.ts#133)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`uniqueId`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`error`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`StoredMessage`](StoredMessage.md) | `null`>

***

### updateMessageFeedback()

> **updateMessageFeedback**(`uniqueId`: `string`, `feedback`: [`MessageFeedback`](../type-aliases/MessageFeedback.md)): `Promise`<[`StoredMessage`](StoredMessage.md) | `null`>

Defined in: [src/lib/storage/ChatStorageAdapter.ts:135](https://github.com/anuma-ai/sdk/blob/main/src/lib/storage/ChatStorageAdapter.ts#135)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`uniqueId`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`feedback`

</td>
<td>

[`MessageFeedback`](../type-aliases/MessageFeedback.md)

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`StoredMessage`](StoredMessage.md) | `null`>

***

### write()

> **write**<`T`>(`fn`: (`adapter`: `ChatStorageAdapter`) => `Promise`<`T`>): `Promise`<`T`>

Defined in: [src/lib/storage/ChatStorageAdapter.ts:156](https://github.com/anuma-ai/sdk/blob/main/src/lib/storage/ChatStorageAdapter.ts#156)

Run a set of mutations inside a single write transaction. Any mutation
calls made on the adapter inside the callback are grouped into one atomic
write on backends that support it.

On backends without transaction support, this may fall back to sequential
writes. Implementations must document the guarantee they provide.

**Type Parameters**

<table>
<thead>
<tr>
<th>Type Parameter</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`T`

</td>
</tr>
</tbody>
</table>

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`fn`

</td>
<td>

(`adapter`: `ChatStorageAdapter`) => `Promise`<`T`>

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`T`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/ChatStorageObservable

# ChatStorageObservable\<T>

Defined in: [src/lib/storage/ChatStorageAdapter.ts:68](https://github.com/anuma-ai/sdk/blob/main/src/lib/storage/ChatStorageAdapter.ts#68)

Minimal interface for an observable (reactive) query result.

Shaped to be compatible with RxJS-style `Observable` (which is what
WatermelonDB returns) and with a simple polling fallback, so non-reactive
backends can implement it without depending on rxjs.

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`T`

</td>
</tr>
</tbody>
</table>

## Methods

### subscribe()

> **subscribe**(`observer`: `object`): `object`

Defined in: [src/lib/storage/ChatStorageAdapter.ts:69](https://github.com/anuma-ai/sdk/blob/main/src/lib/storage/ChatStorageAdapter.ts#69)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`observer`

</td>
<td>

`object`

</td>
</tr>
<tr>
<td>

`observer.complete?`

</td>
<td>

() => `void`

</td>
</tr>
<tr>
<td>

`observer.error?`

</td>
<td>

(`err`: `unknown`) => `void`

</td>
</tr>
<tr>
<td>

`observer.next`

</td>
<td>

(`value`: `T`) => `void`

</td>
</tr>
</tbody>
</table>

**Returns**

`object`

**unsubscribe()**

> **unsubscribe**: () => `void`

**Returns**

`void`

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/ChunkingOptions

# ChunkingOptions

Defined in: [src/lib/memoryEngine/chunking.ts:8](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryEngine/chunking.ts#8)

Text Chunking Utilities

Splits text into overlapping chunks for better semantic search.
Uses sentence boundaries when possible to preserve meaning.

## Properties

### chunkOverlap?

> `optional` **chunkOverlap**: `number`

Defined in: [src/lib/memoryEngine/chunking.ts:12](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryEngine/chunking.ts#12)

Overlap between chunks in characters (default: 50)

***

### chunkSize?

> `optional` **chunkSize**: `number`

Defined in: [src/lib/memoryEngine/chunking.ts:10](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryEngine/chunking.ts#10)

Target chunk size in characters (default: 400)

***

### minChunkSize?

> `optional` **minChunkSize**: `number`

Defined in: [src/lib/memoryEngine/chunking.ts:14](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryEngine/chunking.ts#14)

Minimum chunk size to create (default: 50)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/ChunkSearchResult

# ChunkSearchResult

Defined in: [src/lib/db/chat/types.ts:235](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#235)

Search result from chunk-based search

## Properties

### chunkText

> **chunkText**: `string`

Defined in: [src/lib/db/chat/types.ts:237](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#237)

The matching chunk text

***

### message

> **message**: [`StoredMessage`](StoredMessage.md)

Defined in: [src/lib/db/chat/types.ts:239](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#239)

The full message containing this chunk

***

### similarity

> **similarity**: `number`

Defined in: [src/lib/db/chat/types.ts:241](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#241)

Similarity score of the chunk

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/CircleProps

# CircleProps

Defined in: [src/react/anumaRuntime.tsx:556](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#556)

## Extends

* `CommonProps`

## Properties

### alignSelf?

> `optional` **alignSelf**: `string`

Defined in: [src/react/anumaRuntime.tsx:169](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#169)

**Inherited from**

`CommonProps.alignSelf`

***

### children?

> `optional` **children**: `ReactNode`

Defined in: [src/react/anumaRuntime.tsx:281](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#281)

**Inherited from**

`CommonProps.children`

***

### fill?

> `optional` **fill**: `string`

Defined in: [src/react/anumaRuntime.tsx:557](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#557)

***

### grow?

> `optional` **grow**: `number`

Defined in: [src/react/anumaRuntime.tsx:167](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#167)

**Inherited from**

`CommonProps.grow`

***

### h?

> `optional` **h**: `number`

Defined in: [src/react/anumaRuntime.tsx:165](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#165)

**Inherited from**

`CommonProps.h`

***

### id?

> `optional` **id**: `string`

Defined in: [src/react/anumaRuntime.tsx:279](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#279)

**Inherited from**

`CommonProps.id`

***

### rotation?

> `optional` **rotation**: `number`

Defined in: [src/react/anumaRuntime.tsx:166](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#166)

**Inherited from**

`CommonProps.rotation`

***

### shrink?

> `optional` **shrink**: `number`

Defined in: [src/react/anumaRuntime.tsx:168](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#168)

**Inherited from**

`CommonProps.shrink`

***

### stroke?

> `optional` **stroke**: `string`

Defined in: [src/react/anumaRuntime.tsx:558](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#558)

***

### strokeWidth?

> `optional` **strokeWidth**: `number`

Defined in: [src/react/anumaRuntime.tsx:559](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#559)

***

### style?

> `optional` **style**: `CSSProperties`

Defined in: [src/react/anumaRuntime.tsx:280](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#280)

**Inherited from**

`CommonProps.style`

***

### w?

> `optional` **w**: `number`

Defined in: [src/react/anumaRuntime.tsx:164](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#164)

**Inherited from**

`CommonProps.w`

***

### x?

> `optional` **x**: `number`

Defined in: [src/react/anumaRuntime.tsx:162](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#162)

**Inherited from**

`CommonProps.x`

***

### y?

> `optional` **y**: `number`

Defined in: [src/react/anumaRuntime.tsx:163](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#163)

**Inherited from**

`CommonProps.y`

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/ConversationQueryOptions

# ConversationQueryOptions

Defined in: [src/lib/storage/ChatStorageAdapter.ts:80](https://github.com/anuma-ai/sdk/blob/main/src/lib/storage/ChatStorageAdapter.ts#80)

Common filter options for conversation queries. Kept deliberately narrow —
most call sites only need these.

## Properties

### projectId?

> `optional` **projectId**: `string` | `null`

Defined in: [src/lib/storage/ChatStorageAdapter.ts:82](https://github.com/anuma-ai/sdk/blob/main/src/lib/storage/ChatStorageAdapter.ts#82)

If set, only return conversations in this project. `null` = no project.

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/CreateConversationOptions

# CreateConversationOptions

Defined in: [src/lib/db/chat/types.ts:293](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#293)

## Properties

### conversationId?

> `optional` **conversationId**: `string`

Defined in: [src/lib/db/chat/types.ts:294](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#294)

***

### projectId?

> `optional` **projectId**: `string`

Defined in: [src/lib/db/chat/types.ts:297](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#297)

Optional project ID to associate this conversation with

***

### title?

> `optional` **title**: `string`

Defined in: [src/lib/db/chat/types.ts:295](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#295)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/CreateMediaOptions

# CreateMediaOptions

Defined in: [src/lib/db/media/types.ts:108](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#108)

Options for creating a new media record.

## Properties

### conversationId?

> `optional` **conversationId**: `string`

Defined in: [src/lib/db/media/types.ts:116](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#116)

Associated conversation ID (optional)

***

### dimensions?

> `optional` **dimensions**: [`MediaDimensions`](MediaDimensions.md)

Defined in: [src/lib/db/media/types.ts:128](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#128)

***

### duration?

> `optional` **duration**: `number`

Defined in: [src/lib/db/media/types.ts:129](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#129)

***

### mediaId?

> `optional` **mediaId**: `string`

Defined in: [src/lib/db/media/types.ts:110](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#110)

Pre-generated media ID. If not provided, one will be generated.

***

### mediaType

> **mediaType**: [`MediaType`](../type-aliases/MediaType.md)

Defined in: [src/lib/db/media/types.ts:121](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#121)

***

### messageId?

> `optional` **messageId**: `string`

Defined in: [src/lib/db/media/types.ts:114](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#114)

Associated message ID (optional)

***

### metadata?

> `optional` **metadata**: [`MediaMetadata`](MediaMetadata.md)

Defined in: [src/lib/db/media/types.ts:130](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#130)

***

### mimeType

> **mimeType**: `string`

Defined in: [src/lib/db/media/types.ts:120](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#120)

***

### model?

> `optional` **model**: `string`

Defined in: [src/lib/db/media/types.ts:126](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#126)

***

### name

> **name**: `string`

Defined in: [src/lib/db/media/types.ts:119](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#119)

***

### role

> **role**: [`MediaRole`](../type-aliases/MediaRole.md)

Defined in: [src/lib/db/media/types.ts:123](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#123)

***

### size

> **size**: `number`

Defined in: [src/lib/db/media/types.ts:122](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#122)

***

### sourceUrl?

> `optional` **sourceUrl**: `string`

Defined in: [src/lib/db/media/types.ts:127](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#127)

***

### walletAddress

> **walletAddress**: `string`

Defined in: [src/lib/db/media/types.ts:112](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#112)

Wallet address of the user

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/CreateMessageOptions

# CreateMessageOptions

Defined in: [src/lib/db/chat/types.ts:257](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#257)

## Properties

### content

> **content**: `string`

Defined in: [src/lib/db/chat/types.ts:260](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#260)

***

### conversationId

> **conversationId**: `string`

Defined in: [src/lib/db/chat/types.ts:258](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#258)

***

### embeddingModel?

> `optional` **embeddingModel**: `string`

Defined in: [src/lib/db/chat/types.ts:272](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#272)

***

### error?

> `optional` **error**: `string`

Defined in: [src/lib/db/chat/types.ts:275](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#275)

If set, indicates the message failed with this error

***

### fileIds?

> `optional` **fileIds**: `string`\[]

Defined in: [src/lib/db/chat/types.ts:267](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#267)

Array of media\_id references for direct lookup in media table

***

### ~~files?~~

> `optional` **files**: [`FileMetadata`](FileMetadata.md)\[]

Defined in: [src/lib/db/chat/types.ts:265](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#265)

**Deprecated**

Use fileIds with media table instead

***

### imageModel?

> `optional` **imageModel**: `string`

Defined in: [src/lib/db/chat/types.ts:263](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#263)

Image generation model used for this message

***

### model?

> `optional` **model**: `string`

Defined in: [src/lib/db/chat/types.ts:261](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#261)

***

### parentMessageId?

> `optional` **parentMessageId**: `string`

Defined in: [src/lib/db/chat/types.ts:280](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#280)

Parent message ID for branching (edit/regenerate).

***

### responseDuration?

> `optional` **responseDuration**: `number`

Defined in: [src/lib/db/chat/types.ts:270](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#270)

***

### role

> **role**: [`ChatRole`](../type-aliases/ChatRole.md)

Defined in: [src/lib/db/chat/types.ts:259](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#259)

***

### sources?

> `optional` **sources**: [`SearchSource`](SearchSource.md)\[]

Defined in: [src/lib/db/chat/types.ts:269](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#269)

***

### thinking?

> `optional` **thinking**: `string`

Defined in: [src/lib/db/chat/types.ts:278](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#278)

Reasoning/thinking content from models that support extended thinking

***

### thoughtProcess?

> `optional` **thoughtProcess**: `ActivityPhase`\[]

Defined in: [src/lib/db/chat/types.ts:276](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#276)

***

### toolCallEvents?

> `optional` **toolCallEvents**: [`LlmapiToolCallEvent`](../../../client/Internal/type-aliases/LlmapiToolCallEvent.md)\[]

Defined in: [src/lib/db/chat/types.ts:282](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#282)

Tool call events from the backend response (for reconstructing tool call history)

***

### uniqueId?

> `optional` **uniqueId**: `string`

Defined in: [src/lib/db/chat/types.ts:290](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#290)

Optional pre-generated unique ID for this message.
When provided, used as the WatermelonDB record ID instead of auto-generating one.
Consumers can pre-allocate this ID before streaming starts so the in-flight
placeholder and the eventually-persisted message share the same React key,
eliminating the unmount/remount flash when streaming completes.

***

### usage?

> `optional` **usage**: [`StoredChatCompletionUsage`](StoredChatCompletionUsage.md)

Defined in: [src/lib/db/chat/types.ts:268](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#268)

***

### vector?

> `optional` **vector**: `number`\[]

Defined in: [src/lib/db/chat/types.ts:271](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#271)

***

### wasStopped?

> `optional` **wasStopped**: `boolean`

Defined in: [src/lib/db/chat/types.ts:273](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#273)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/CreateModelPreferenceOptions

# CreateModelPreferenceOptions

Defined in: [src/lib/db/settings/types.ts:11](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/settings/types.ts#11)

## Properties

### models?

> `optional` **models**: `string`

Defined in: [src/lib/db/settings/types.ts:13](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/settings/types.ts#13)

***

### walletAddress

> **walletAddress**: `string`

Defined in: [src/lib/db/settings/types.ts:12](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/settings/types.ts#12)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/CreateProjectOptions

# CreateProjectOptions

Defined in: [src/lib/db/project/types.ts:29](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/project/types.ts#29)

Options for creating a new project.

## Properties

### name?

> `optional` **name**: `string`

Defined in: [src/lib/db/project/types.ts:33](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/project/types.ts#33)

Name of the project (default: "New Project")

***

### projectId?

> `optional` **projectId**: `string`

Defined in: [src/lib/db/project/types.ts:31](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/project/types.ts#31)

Optional custom project ID (auto-generated if not provided)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/CreateSavedToolOptions

# CreateSavedToolOptions

Defined in: [src/lib/db/savedTools/types.ts:39](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/savedTools/types.ts#39)

Options for creating a new saved tool.

## Properties

### conversationId?

> `optional` **conversationId**: `string`

Defined in: [src/lib/db/savedTools/types.ts:45](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/savedTools/types.ts#45)

***

### description

> **description**: `string`

Defined in: [src/lib/db/savedTools/types.ts:42](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/savedTools/types.ts#42)

***

### displayName

> **displayName**: `string`

Defined in: [src/lib/db/savedTools/types.ts:41](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/savedTools/types.ts#41)

***

### html

> **html**: `string`

Defined in: [src/lib/db/savedTools/types.ts:44](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/savedTools/types.ts#44)

***

### name

> **name**: `string`

Defined in: [src/lib/db/savedTools/types.ts:40](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/savedTools/types.ts#40)

***

### parameters

> **parameters**: `Record`<`string`, [`SavedToolParameter`](SavedToolParameter.md)>

Defined in: [src/lib/db/savedTools/types.ts:43](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/savedTools/types.ts#43)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/CreateServerToolsFilterOptions

# CreateServerToolsFilterOptions

Defined in: [src/lib/tools/serverTools.ts:1003](https://github.com/anuma-ai/sdk/blob/main/src/lib/tools/serverTools.ts#1003)

Options for createServerToolsFilter.

## Properties

### excludeTools?

> `optional` **excludeTools**: `Iterable`<`string`, `any`, `any`>

Defined in: [src/lib/tools/serverTools.ts:1011](https://github.com/anuma-ai/sdk/blob/main/src/lib/tools/serverTools.ts#1011)

Tool names to always drop from results, even when they match.

***

### matchOptions?

> `optional` **matchOptions**: [`ToolMatchOptions`](ToolMatchOptions.md)

Defined in: [src/lib/tools/serverTools.ts:1013](https://github.com/anuma-ai/sdk/blob/main/src/lib/tools/serverTools.ts#1013)

Options forwarded to `findMatchingTools`.

***

### toolSets?

> `optional` **toolSets**: [`ToolSet`](ToolSet.md)\[]

Defined in: [src/lib/tools/serverTools.ts:1009](https://github.com/anuma-ai/sdk/blob/main/src/lib/tools/serverTools.ts#1009)

Tool sets to expand additively. When any anchor scores at or above the
set's `anchorMinSimilarity`, all members are included alongside the
original semantic matches.

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/CreateUserPreferenceOptions

# CreateUserPreferenceOptions

Defined in: [src/lib/db/userPreferences/types.ts:113](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/userPreferences/types.ts#113)

Options for creating a new user preference record

## Properties

### description?

> `optional` **description**: `string`

Defined in: [src/lib/db/userPreferences/types.ts:117](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/userPreferences/types.ts#117)

***

### models?

> `optional` **models**: `string`

Defined in: [src/lib/db/userPreferences/types.ts:118](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/userPreferences/types.ts#118)

***

### nickname?

> `optional` **nickname**: `string`

Defined in: [src/lib/db/userPreferences/types.ts:115](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/userPreferences/types.ts#115)

***

### occupation?

> `optional` **occupation**: `string`

Defined in: [src/lib/db/userPreferences/types.ts:116](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/userPreferences/types.ts#116)

***

### personality?

> `optional` **personality**: `string`

Defined in: [src/lib/db/userPreferences/types.ts:119](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/userPreferences/types.ts#119)

***

### walletAddress

> **walletAddress**: `string`

Defined in: [src/lib/db/userPreferences/types.ts:114](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/userPreferences/types.ts#114)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/CreateVaultFolderOptions

# CreateVaultFolderOptions

Defined in: [src/lib/db/vaultFolders/types.ts:17](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/vaultFolders/types.ts#17)

## Properties

### isSystem?

> `optional` **isSystem**: `boolean`

Defined in: [src/lib/db/vaultFolders/types.ts:22](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/vaultFolders/types.ts#22)

Whether this is a system-created default folder

***

### name

> **name**: `string`

Defined in: [src/lib/db/vaultFolders/types.ts:18](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/vaultFolders/types.ts#18)

***

### scope?

> `optional` **scope**: `string`

Defined in: [src/lib/db/vaultFolders/types.ts:20](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/vaultFolders/types.ts#20)

Defaults to "private" if omitted.

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/CreateVaultMemoryOptions

# CreateVaultMemoryOptions

Defined in: [src/lib/db/memoryVault/types.ts:19](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/memoryVault/types.ts#19)

## Properties

### content

> **content**: `string`

Defined in: [src/lib/db/memoryVault/types.ts:20](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/memoryVault/types.ts#20)

***

### embedding?

> `optional` **embedding**: `string`

Defined in: [src/lib/db/memoryVault/types.ts:26](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/memoryVault/types.ts#26)

JSON-stringified embedding vector to persist

***

### folderId?

> `optional` **folderId**: `string` | `null`

Defined in: [src/lib/db/memoryVault/types.ts:24](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/memoryVault/types.ts#24)

Folder ID for organization, null or omitted if unfiled

***

### scope?

> `optional` **scope**: `string`

Defined in: [src/lib/db/memoryVault/types.ts:22](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/memoryVault/types.ts#22)

Scope for the memory. Defaults to "private" if omitted.

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/DatabaseManagerLogger

# DatabaseManagerLogger

Defined in: [src/lib/db/manager.ts:37](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/manager.ts#37)

Optional logger interface for DatabaseManager.

## Properties

### debug()?

> `optional` **debug**: (`msg`: `string`, `ctx?`: `Record`<`string`, `unknown`>) => `void`

Defined in: [src/lib/db/manager.ts:38](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/manager.ts#38)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`msg`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`ctx?`

</td>
<td>

`Record`<`string`, `unknown`>

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

***

### info()?

> `optional` **info**: (`msg`: `string`, `ctx?`: `Record`<`string`, `unknown`>) => `void`

Defined in: [src/lib/db/manager.ts:40](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/manager.ts#40)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`msg`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`ctx?`

</td>
<td>

`Record`<`string`, `unknown`>

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

***

### warn()?

> `optional` **warn**: (`msg`: `string`, `ctx?`: `Record`<`string`, `unknown`>) => `void`

Defined in: [src/lib/db/manager.ts:39](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/manager.ts#39)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`msg`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`ctx?`

</td>
<td>

`Record`<`string`, `unknown`>

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/DatabaseManagerOptions

# DatabaseManagerOptions

Defined in: [src/lib/db/manager.ts:46](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/manager.ts#46)

Configuration options for DatabaseManager.

## Properties

### createAdapter()

> **createAdapter**: (`dbName`: `string`, `schema`: `Readonly`<{ `tables`: `TableMap`; `unsafeSql?`: (`_`: `string`, `__`: `AppSchemaUnsafeSqlKind`) => `string`; `version`: `number`; }>, `migrations`: `Readonly`<{ `maxVersion`: `number`; `minVersion`: `number`; `sortedMigrations`: `Readonly`<{ `steps`: `MigrationStep`\[]; `toVersion`: `number`; }>\[]; `validated`: `true`; }>) => `DatabaseAdapter`

Defined in: [src/lib/db/manager.ts:64](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/manager.ts#64)

Factory that creates a WatermelonDB adapter for a given database name.
The schema and migrations are provided for convenience.

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`dbName`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`schema`

</td>
<td>

`Readonly`<{ `tables`: `TableMap`; `unsafeSql?`: (`_`: `string`, `__`: `AppSchemaUnsafeSqlKind`) => `string`; `version`: `number`; }>

</td>
</tr>
<tr>
<td>

`migrations`

</td>
<td>

`Readonly`<{ `maxVersion`: `number`; `minVersion`: `number`; `sortedMigrations`: `Readonly`<{ `steps`: `MigrationStep`\[]; `toVersion`: `number`; }>\[]; `validated`: `true`; }>

</td>
</tr>
</tbody>
</table>

**Returns**

`DatabaseAdapter`

**Example**

```typescript
createAdapter: (dbName, schema, migrations) => new LokiJSAdapter({
  schema,
  migrations,
  dbName,
  useWebWorker: false,
  useIncrementalIndexedDB: true,
})
```

***

### dbNamePrefix

> **dbNamePrefix**: `string`

Defined in: [src/lib/db/manager.ts:48](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/manager.ts#48)

Prefix for database names, e.g. "anuma-watermelon". Each wallet gets `{prefix}-{address}`.

***

### logger?

> `optional` **logger**: [`DatabaseManagerLogger`](DatabaseManagerLogger.md)

Defined in: [src/lib/db/manager.ts:78](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/manager.ts#78)

Optional logger for debug/warn/info messages

***

### onDestructiveMigration()?

> `optional` **onDestructiveMigration**: () => `void`

Defined in: [src/lib/db/manager.ts:76](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/manager.ts#76)

Called when a destructive migration is needed (schema too old).
On web, this typically triggers `window.location.reload()`.
If not provided, the manager will throw an error instead.

**Returns**

`void`

***

### storage?

> `optional` **storage**: [`PlatformStorage`](PlatformStorage.md)

Defined in: [src/lib/db/manager.ts:70](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/manager.ts#70)

Platform storage implementation. Defaults to webPlatformStorage.

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/DeckProps

# DeckProps

Defined in: [src/react/anumaRuntime.tsx:288](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#288)

Top-level deck container. Provides the theme context (when any of the
theme attrs are set on this node) and renders Slides as flow children.

## Extends

* `CommonProps`

## Properties

### accent?

> `optional` **accent**: `string`

Defined in: [src/react/anumaRuntime.tsx:296](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#296)

***

### alignSelf?

> `optional` **alignSelf**: `string`

Defined in: [src/react/anumaRuntime.tsx:169](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#169)

**Inherited from**

`CommonProps.alignSelf`

***

### background?

> `optional` **background**: `string`

Defined in: [src/react/anumaRuntime.tsx:290](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#290)

***

### border?

> `optional` **border**: `string`

Defined in: [src/react/anumaRuntime.tsx:298](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#298)

***

### card?

> `optional` **card**: `string`

Defined in: [src/react/anumaRuntime.tsx:297](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#297)

***

### children?

> `optional` **children**: `ReactNode`

Defined in: [src/react/anumaRuntime.tsx:281](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#281)

**Inherited from**

`CommonProps.children`

***

### fontPreset?

> `optional` **fontPreset**: `string`

Defined in: [src/react/anumaRuntime.tsx:289](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#289)

***

### grow?

> `optional` **grow**: `number`

Defined in: [src/react/anumaRuntime.tsx:167](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#167)

**Inherited from**

`CommonProps.grow`

***

### h?

> `optional` **h**: `number`

Defined in: [src/react/anumaRuntime.tsx:165](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#165)

**Inherited from**

`CommonProps.h`

***

### id?

> `optional` **id**: `string`

Defined in: [src/react/anumaRuntime.tsx:279](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#279)

**Inherited from**

`CommonProps.id`

***

### rotation?

> `optional` **rotation**: `number`

Defined in: [src/react/anumaRuntime.tsx:166](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#166)

**Inherited from**

`CommonProps.rotation`

***

### shrink?

> `optional` **shrink**: `number`

Defined in: [src/react/anumaRuntime.tsx:168](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#168)

**Inherited from**

`CommonProps.shrink`

***

### slideBg?

> `optional` **slideBg**: `string`

Defined in: [src/react/anumaRuntime.tsx:291](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#291)

***

### style?

> `optional` **style**: `CSSProperties`

Defined in: [src/react/anumaRuntime.tsx:280](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#280)

**Inherited from**

`CommonProps.style`

***

### surfaceSecondary?

> `optional` **surfaceSecondary**: `string`

Defined in: [src/react/anumaRuntime.tsx:292](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#292)

***

### textMuted?

> `optional` **textMuted**: `string`

Defined in: [src/react/anumaRuntime.tsx:295](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#295)

***

### textPrimary?

> `optional` **textPrimary**: `string`

Defined in: [src/react/anumaRuntime.tsx:293](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#293)

***

### textSecondary?

> `optional` **textSecondary**: `string`

Defined in: [src/react/anumaRuntime.tsx:294](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#294)

***

### w?

> `optional` **w**: `number`

Defined in: [src/react/anumaRuntime.tsx:164](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#164)

**Inherited from**

`CommonProps.w`

***

### x?

> `optional` **x**: `number`

Defined in: [src/react/anumaRuntime.tsx:162](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#162)

**Inherited from**

`CommonProps.x`

***

### y?

> `optional` **y**: `number`

Defined in: [src/react/anumaRuntime.tsx:163](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#163)

**Inherited from**

`CommonProps.y`

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/DropboxAuthContextValue

# DropboxAuthContextValue

Defined in: [src/react/useDropboxAuth.ts:52](https://github.com/anuma-ai/sdk/blob/main/src/react/useDropboxAuth.ts#52)

Context value for Dropbox authentication

## Properties

### accessToken

> **accessToken**: `string` | `null`

Defined in: [src/react/useDropboxAuth.ts:54](https://github.com/anuma-ai/sdk/blob/main/src/react/useDropboxAuth.ts#54)

Current access token (null if not authenticated)

***

### isAuthenticated

> **isAuthenticated**: `boolean`

Defined in: [src/react/useDropboxAuth.ts:56](https://github.com/anuma-ai/sdk/blob/main/src/react/useDropboxAuth.ts#56)

Whether user has authenticated with Dropbox

***

### isConfigured

> **isConfigured**: `boolean`

Defined in: [src/react/useDropboxAuth.ts:58](https://github.com/anuma-ai/sdk/blob/main/src/react/useDropboxAuth.ts#58)

Whether Dropbox is configured (app key exists)

***

### logout()

> **logout**: () => `Promise`<`void`>

Defined in: [src/react/useDropboxAuth.ts:62](https://github.com/anuma-ai/sdk/blob/main/src/react/useDropboxAuth.ts#62)

Clear stored token and log out

**Returns**

`Promise`<`void`>

***

### refreshToken()

> **refreshToken**: () => `Promise`<`string` | `null`>

Defined in: [src/react/useDropboxAuth.ts:64](https://github.com/anuma-ai/sdk/blob/main/src/react/useDropboxAuth.ts#64)

Refresh the access token using the refresh token

**Returns**

`Promise`<`string` | `null`>

***

### requestAccess()

> **requestAccess**: () => `Promise`<`string`>

Defined in: [src/react/useDropboxAuth.ts:60](https://github.com/anuma-ai/sdk/blob/main/src/react/useDropboxAuth.ts#60)

Request Dropbox access - returns token or redirects to OAuth

**Returns**

`Promise`<`string`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/DropboxAuthProviderProps

# DropboxAuthProviderProps

Defined in: [src/react/useDropboxAuth.ts:29](https://github.com/anuma-ai/sdk/blob/main/src/react/useDropboxAuth.ts#29)

Props for DropboxAuthProvider

## Properties

### apiClient?

> `optional` **apiClient**: `Client`

Defined in: [src/react/useDropboxAuth.ts:38](https://github.com/anuma-ai/sdk/blob/main/src/react/useDropboxAuth.ts#38)

API client for backend OAuth requests. Optional - uses the default SDK client if not provided.
Only needed if you have a custom client configuration (e.g., different baseUrl).

***

### appKey

> **appKey**: `string` | `undefined`

Defined in: [src/react/useDropboxAuth.ts:31](https://github.com/anuma-ai/sdk/blob/main/src/react/useDropboxAuth.ts#31)

Dropbox App Key (from Dropbox Developer Console)

***

### callbackPath?

> `optional` **callbackPath**: `string`

Defined in: [src/react/useDropboxAuth.ts:33](https://github.com/anuma-ai/sdk/blob/main/src/react/useDropboxAuth.ts#33)

OAuth callback path (default: "/auth/dropbox/callback")

***

### children

> **children**: `ReactNode`

Defined in: [src/react/useDropboxAuth.ts:46](https://github.com/anuma-ai/sdk/blob/main/src/react/useDropboxAuth.ts#46)

Children to render

***

### walletAddress?

> `optional` **walletAddress**: `string`

Defined in: [src/react/useDropboxAuth.ts:44](https://github.com/anuma-ai/sdk/blob/main/src/react/useDropboxAuth.ts#44)

Wallet address for encrypting OAuth tokens at rest.
If provided, tokens will be encrypted before storing in localStorage.
If omitted, tokens are stored temporarily in sessionStorage (cleared on page close).

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/DropboxExportResult

# DropboxExportResult

Defined in: [src/lib/backup/dropbox/backup.ts:39](https://github.com/anuma-ai/sdk/blob/main/src/lib/backup/dropbox/backup.ts#39)

## Properties

### skipped

> **skipped**: `number`

Defined in: [src/lib/backup/dropbox/backup.ts:42](https://github.com/anuma-ai/sdk/blob/main/src/lib/backup/dropbox/backup.ts#42)

***

### success

> **success**: `boolean`

Defined in: [src/lib/backup/dropbox/backup.ts:40](https://github.com/anuma-ai/sdk/blob/main/src/lib/backup/dropbox/backup.ts#40)

***

### total

> **total**: `number`

Defined in: [src/lib/backup/dropbox/backup.ts:43](https://github.com/anuma-ai/sdk/blob/main/src/lib/backup/dropbox/backup.ts#43)

***

### uploaded

> **uploaded**: `number`

Defined in: [src/lib/backup/dropbox/backup.ts:41](https://github.com/anuma-ai/sdk/blob/main/src/lib/backup/dropbox/backup.ts#41)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/DropboxImportResult

# DropboxImportResult

Defined in: [src/lib/backup/dropbox/backup.ts:46](https://github.com/anuma-ai/sdk/blob/main/src/lib/backup/dropbox/backup.ts#46)

## Properties

### failed

> **failed**: `number`

Defined in: [src/lib/backup/dropbox/backup.ts:49](https://github.com/anuma-ai/sdk/blob/main/src/lib/backup/dropbox/backup.ts#49)

***

### noBackupsFound?

> `optional` **noBackupsFound**: `boolean`

Defined in: [src/lib/backup/dropbox/backup.ts:52](https://github.com/anuma-ai/sdk/blob/main/src/lib/backup/dropbox/backup.ts#52)

True if no backups were found in Dropbox

***

### restored

> **restored**: `number`

Defined in: [src/lib/backup/dropbox/backup.ts:48](https://github.com/anuma-ai/sdk/blob/main/src/lib/backup/dropbox/backup.ts#48)

***

### success

> **success**: `boolean`

Defined in: [src/lib/backup/dropbox/backup.ts:47](https://github.com/anuma-ai/sdk/blob/main/src/lib/backup/dropbox/backup.ts#47)

***

### total

> **total**: `number`

Defined in: [src/lib/backup/dropbox/backup.ts:50](https://github.com/anuma-ai/sdk/blob/main/src/lib/backup/dropbox/backup.ts#50)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/FileMetadata

# FileMetadata

Defined in: [src/lib/db/chat/types.ts:71](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#71)

Metadata for files attached to messages.

Note the distinction between `url` and `sourceUrl`:

* `url`: Content URL that gets sent to the AI as part of the message (e.g., data URIs for user uploads)
* `sourceUrl`: Original external URL for locally-cached files (for lookup only, never sent to AI)

## Extended by

* [`StoredFileWithContext`](StoredFileWithContext.md)
* [`FileWithData`](FileWithData.md)

## Properties

### id

> **id**: `string`

Defined in: [src/lib/db/chat/types.ts:73](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#73)

Unique identifier for the file (used as OPFS key for cached files)

***

### name

> **name**: `string`

Defined in: [src/lib/db/chat/types.ts:75](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#75)

Display name of the file

***

### size

> **size**: `number`

Defined in: [src/lib/db/chat/types.ts:79](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#79)

File size in bytes

***

### sourceUrl?

> `optional` **sourceUrl**: `string`

Defined in: [src/lib/db/chat/types.ts:95](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#95)

Original external URL for files downloaded and cached locally (e.g., from MCP R2).
Used purely for URL→OPFS mapping to enable fallback when the source returns 404.

This is metadata for local lookup only - it is NOT sent to the AI or rendered directly.
The file content is served from OPFS using the `id` field.

***

### type

> **type**: `string`

Defined in: [src/lib/db/chat/types.ts:77](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#77)

MIME type (e.g., "image/png")

***

### url?

> `optional` **url**: `string`

Defined in: [src/lib/db/chat/types.ts:87](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#87)

Content URL to include when sending this message to the AI.
When present, this URL is added as an `image_url` content part.
Typically used for user-uploaded files (data URIs) that should be sent with the message.

NOT used for MCP-cached files - those use `sourceUrl` for lookup and render from OPFS.

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/FileProcessor

# FileProcessor

Defined in: [src/lib/processors/types.ts:41](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/types.ts#41)

Interface that all file processors must implement

## Properties

### name

> `readonly` **name**: `string`

Defined in: [src/lib/processors/types.ts:43](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/types.ts#43)

Unique identifier for this processor

***

### supportedExtensions

> `readonly` **supportedExtensions**: `string`\[]

Defined in: [src/lib/processors/types.ts:49](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/types.ts#49)

File extensions this processor can handle (fallback if MIME type unavailable)

***

### supportedMimeTypes

> `readonly` **supportedMimeTypes**: `string`\[]

Defined in: [src/lib/processors/types.ts:46](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/types.ts#46)

MIME types this processor can handle

## Methods

### process()

> **process**(`file`: [`FileWithData`](FileWithData.md)): `Promise`<[`ProcessedFileResult`](ProcessedFileResult.md) | `null`>

Defined in: [src/lib/processors/types.ts:56](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/types.ts#56)

Process a file and extract text content

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`file`

</td>
<td>

[`FileWithData`](FileWithData.md)

</td>
<td>

File metadata with data URL

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`ProcessedFileResult`](ProcessedFileResult.md) | `null`>

Extracted text content and metadata, or null if processing fails/not applicable

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/FileTypeQuery

# FileTypeQuery

Defined in: [src/lib/processors/registry.ts:8](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/registry.ts#8)

Minimal file shape needed to look up or test for a processor.
Wider than `FileMetadata` so callers with `File`, `Blob`-like objects, or
just a `{ name, type }` pair from a drag-drop event can use the API.

## Properties

### name

> **name**: `string`

Defined in: [src/lib/processors/registry.ts:9](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/registry.ts#9)

***

### type

> **type**: `string`

Defined in: [src/lib/processors/registry.ts:10](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/registry.ts#10)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/FileWithData

# FileWithData

Defined in: [src/lib/processors/types.ts:6](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/types.ts#6)

Extended file metadata with data URL for processing

## Extends

* [`FileMetadata`](FileMetadata.md)

## Properties

### dataUrl

> **dataUrl**: `string`

Defined in: [src/lib/processors/types.ts:8](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/types.ts#8)

Data URL or blob URL containing file content

***

### id

> **id**: `string`

Defined in: [src/lib/db/chat/types.ts:73](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#73)

Unique identifier for the file (used as OPFS key for cached files)

**Inherited from**

[`FileMetadata`](FileMetadata.md).[`id`](FileMetadata.md#id)

***

### name

> **name**: `string`

Defined in: [src/lib/db/chat/types.ts:75](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#75)

Display name of the file

**Inherited from**

[`FileMetadata`](FileMetadata.md).[`name`](FileMetadata.md#name)

***

### size

> **size**: `number`

Defined in: [src/lib/db/chat/types.ts:79](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#79)

File size in bytes

**Inherited from**

[`FileMetadata`](FileMetadata.md).[`size`](FileMetadata.md#size)

***

### sourceUrl?

> `optional` **sourceUrl**: `string`

Defined in: [src/lib/db/chat/types.ts:95](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#95)

Original external URL for files downloaded and cached locally (e.g., from MCP R2).
Used purely for URL→OPFS mapping to enable fallback when the source returns 404.

This is metadata for local lookup only - it is NOT sent to the AI or rendered directly.
The file content is served from OPFS using the `id` field.

**Inherited from**

[`FileMetadata`](FileMetadata.md).[`sourceUrl`](FileMetadata.md#sourceurl)

***

### type

> **type**: `string`

Defined in: [src/lib/db/chat/types.ts:77](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#77)

MIME type (e.g., "image/png")

**Inherited from**

[`FileMetadata`](FileMetadata.md).[`type`](FileMetadata.md#type)

***

### url?

> `optional` **url**: `string`

Defined in: [src/lib/db/chat/types.ts:87](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#87)

Content URL to include when sending this message to the AI.
When present, this URL is added as an `image_url` content part.
Typically used for user-uploaded files (data URIs) that should be sent with the message.

NOT used for MCP-cached files - those use `sourceUrl` for lookup and render from OPFS.

**Inherited from**

[`FileMetadata`](FileMetadata.md).[`url`](FileMetadata.md#url)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/FlushResult

# FlushResult

Defined in: [src/lib/db/queue/types.ts:64](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/queue/types.ts#64)

Result of a flush operation.

## Properties

### failed

> **failed**: `object`\[]

Defined in: [src/lib/db/queue/types.ts:68](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/queue/types.ts#68)

Operations that failed with their errors

**error**

> **error**: `string`

**id**

> **id**: `string`

***

### succeeded

> **succeeded**: `string`\[]

Defined in: [src/lib/db/queue/types.ts:66](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/queue/types.ts#66)

IDs of operations that succeeded

***

### total

> **total**: `number`

Defined in: [src/lib/db/queue/types.ts:70](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/queue/types.ts#70)

Total number of operations attempted

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/GoogleDriveAuthContextValue

# GoogleDriveAuthContextValue

Defined in: [src/react/useGoogleDriveAuth.ts:52](https://github.com/anuma-ai/sdk/blob/main/src/react/useGoogleDriveAuth.ts#52)

Context value for Google Drive authentication

## Properties

### accessToken

> **accessToken**: `string` | `null`

Defined in: [src/react/useGoogleDriveAuth.ts:54](https://github.com/anuma-ai/sdk/blob/main/src/react/useGoogleDriveAuth.ts#54)

Current access token (null if not authenticated)

***

### isAuthenticated

> **isAuthenticated**: `boolean`

Defined in: [src/react/useGoogleDriveAuth.ts:56](https://github.com/anuma-ai/sdk/blob/main/src/react/useGoogleDriveAuth.ts#56)

Whether user has authenticated with Google Drive

***

### isConfigured

> **isConfigured**: `boolean`

Defined in: [src/react/useGoogleDriveAuth.ts:58](https://github.com/anuma-ai/sdk/blob/main/src/react/useGoogleDriveAuth.ts#58)

Whether Google Drive is configured (client ID exists)

***

### logout()

> **logout**: () => `Promise`<`void`>

Defined in: [src/react/useGoogleDriveAuth.ts:62](https://github.com/anuma-ai/sdk/blob/main/src/react/useGoogleDriveAuth.ts#62)

Clear stored token and log out

**Returns**

`Promise`<`void`>

***

### refreshToken()

> **refreshToken**: () => `Promise`<`string` | `null`>

Defined in: [src/react/useGoogleDriveAuth.ts:64](https://github.com/anuma-ai/sdk/blob/main/src/react/useGoogleDriveAuth.ts#64)

Refresh the access token using the refresh token

**Returns**

`Promise`<`string` | `null`>

***

### requestAccess()

> **requestAccess**: () => `Promise`<`string`>

Defined in: [src/react/useGoogleDriveAuth.ts:60](https://github.com/anuma-ai/sdk/blob/main/src/react/useGoogleDriveAuth.ts#60)

Request Google Drive access - returns token or redirects to OAuth

**Returns**

`Promise`<`string`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/GoogleDriveAuthProviderProps

# GoogleDriveAuthProviderProps

Defined in: [src/react/useGoogleDriveAuth.ts:29](https://github.com/anuma-ai/sdk/blob/main/src/react/useGoogleDriveAuth.ts#29)

Props for GoogleDriveAuthProvider

## Properties

### apiClient?

> `optional` **apiClient**: `Client`

Defined in: [src/react/useGoogleDriveAuth.ts:38](https://github.com/anuma-ai/sdk/blob/main/src/react/useGoogleDriveAuth.ts#38)

API client for backend OAuth requests. Optional - uses the default SDK client if not provided.
Only needed if you have a custom client configuration (e.g., different baseUrl).

***

### callbackPath?

> `optional` **callbackPath**: `string`

Defined in: [src/react/useGoogleDriveAuth.ts:33](https://github.com/anuma-ai/sdk/blob/main/src/react/useGoogleDriveAuth.ts#33)

OAuth callback path (default: "/auth/google/callback")

***

### children

> **children**: `ReactNode`

Defined in: [src/react/useGoogleDriveAuth.ts:46](https://github.com/anuma-ai/sdk/blob/main/src/react/useGoogleDriveAuth.ts#46)

Children to render

***

### clientId

> **clientId**: `string` | `undefined`

Defined in: [src/react/useGoogleDriveAuth.ts:31](https://github.com/anuma-ai/sdk/blob/main/src/react/useGoogleDriveAuth.ts#31)

Google OAuth Client ID (from Google Cloud Console)

***

### walletAddress?

> `optional` **walletAddress**: `string`

Defined in: [src/react/useGoogleDriveAuth.ts:44](https://github.com/anuma-ai/sdk/blob/main/src/react/useGoogleDriveAuth.ts#44)

Wallet address for encrypting OAuth tokens at rest.
If provided, tokens will be encrypted before storing in localStorage.
If omitted, tokens are stored temporarily in sessionStorage (cleared on page close).

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/GoogleDriveExportResult

# GoogleDriveExportResult

Defined in: [src/lib/backup/google/backup.ts:41](https://github.com/anuma-ai/sdk/blob/main/src/lib/backup/google/backup.ts#41)

## Properties

### skipped

> **skipped**: `number`

Defined in: [src/lib/backup/google/backup.ts:44](https://github.com/anuma-ai/sdk/blob/main/src/lib/backup/google/backup.ts#44)

***

### success

> **success**: `boolean`

Defined in: [src/lib/backup/google/backup.ts:42](https://github.com/anuma-ai/sdk/blob/main/src/lib/backup/google/backup.ts#42)

***

### total

> **total**: `number`

Defined in: [src/lib/backup/google/backup.ts:45](https://github.com/anuma-ai/sdk/blob/main/src/lib/backup/google/backup.ts#45)

***

### uploaded

> **uploaded**: `number`

Defined in: [src/lib/backup/google/backup.ts:43](https://github.com/anuma-ai/sdk/blob/main/src/lib/backup/google/backup.ts#43)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/GoogleDriveImportResult

# GoogleDriveImportResult

Defined in: [src/lib/backup/google/backup.ts:48](https://github.com/anuma-ai/sdk/blob/main/src/lib/backup/google/backup.ts#48)

## Properties

### failed

> **failed**: `number`

Defined in: [src/lib/backup/google/backup.ts:51](https://github.com/anuma-ai/sdk/blob/main/src/lib/backup/google/backup.ts#51)

***

### noBackupsFound?

> `optional` **noBackupsFound**: `boolean`

Defined in: [src/lib/backup/google/backup.ts:54](https://github.com/anuma-ai/sdk/blob/main/src/lib/backup/google/backup.ts#54)

True if no backups were found in Google Drive

***

### restored

> **restored**: `number`

Defined in: [src/lib/backup/google/backup.ts:50](https://github.com/anuma-ai/sdk/blob/main/src/lib/backup/google/backup.ts#50)

***

### success

> **success**: `boolean`

Defined in: [src/lib/backup/google/backup.ts:49](https://github.com/anuma-ai/sdk/blob/main/src/lib/backup/google/backup.ts#49)

***

### total

> **total**: `number`

Defined in: [src/lib/backup/google/backup.ts:52](https://github.com/anuma-ai/sdk/blob/main/src/lib/backup/google/backup.ts#52)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/GroupProps

# GroupProps

Defined in: [src/react/anumaRuntime.tsx:457](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#457)

Structural group. Defaults to absolute positioning of children;
opt into flex via `layout="row" | "column"`.

## Extends

* `CommonProps`.`ContainerLayoutProps`

## Properties

### align?

> `optional` **align**: `string`

Defined in: [src/react/anumaRuntime.tsx:177](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#177)

**Inherited from**

`ContainerLayoutProps.align`

***

### alignSelf?

> `optional` **alignSelf**: `string`

Defined in: [src/react/anumaRuntime.tsx:169](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#169)

**Inherited from**

`CommonProps.alignSelf`

***

### children?

> `optional` **children**: `ReactNode`

Defined in: [src/react/anumaRuntime.tsx:281](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#281)

**Inherited from**

`CommonProps.children`

***

### fill?

> `optional` **fill**: `string`

Defined in: [src/react/anumaRuntime.tsx:467](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#467)

Background fill, applied as `background-color` on the Group's
div. Resolves theme color tokens (e.g. "accent", "card") via
`resolveThemeColor`. Mirrors the `fill` prop on Rect/Circle/Line —
a Group is a layout container, but design-tool consumers
frequently want it to also carry a fill (auto-layout frames, card
surfaces, button bodies). `style.background` still works as an
override / for gradients.

***

### gap?

> `optional` **gap**: `number`

Defined in: [src/react/anumaRuntime.tsx:174](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#174)

**Inherited from**

`ContainerLayoutProps.gap`

***

### grow?

> `optional` **grow**: `number`

Defined in: [src/react/anumaRuntime.tsx:167](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#167)

**Inherited from**

`CommonProps.grow`

***

### h?

> `optional` **h**: `number`

Defined in: [src/react/anumaRuntime.tsx:165](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#165)

**Inherited from**

`CommonProps.h`

***

### id?

> `optional` **id**: `string`

Defined in: [src/react/anumaRuntime.tsx:279](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#279)

**Inherited from**

`CommonProps.id`

***

### justify?

> `optional` **justify**: `string`

Defined in: [src/react/anumaRuntime.tsx:176](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#176)

**Inherited from**

`ContainerLayoutProps.justify`

***

### layout?

> `optional` **layout**: `string`

Defined in: [src/react/anumaRuntime.tsx:173](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#173)

**Inherited from**

`ContainerLayoutProps.layout`

***

### padding?

> `optional` **padding**: `number`

Defined in: [src/react/anumaRuntime.tsx:175](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#175)

**Inherited from**

`ContainerLayoutProps.padding`

***

### rotation?

> `optional` **rotation**: `number`

Defined in: [src/react/anumaRuntime.tsx:166](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#166)

**Inherited from**

`CommonProps.rotation`

***

### shrink?

> `optional` **shrink**: `number`

Defined in: [src/react/anumaRuntime.tsx:168](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#168)

**Inherited from**

`CommonProps.shrink`

***

### style?

> `optional` **style**: `CSSProperties`

Defined in: [src/react/anumaRuntime.tsx:280](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#280)

**Inherited from**

`CommonProps.style`

***

### w?

> `optional` **w**: `number`

Defined in: [src/react/anumaRuntime.tsx:164](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#164)

**Inherited from**

`CommonProps.w`

***

### x?

> `optional` **x**: `number`

Defined in: [src/react/anumaRuntime.tsx:162](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#162)

**Inherited from**

`CommonProps.x`

***

### y?

> `optional` **y**: `number`

Defined in: [src/react/anumaRuntime.tsx:163](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#163)

**Inherited from**

`CommonProps.y`

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/ICloudAuthContextValue

# ICloudAuthContextValue

Defined in: [src/react/useICloudAuth.ts:41](https://github.com/anuma-ai/sdk/blob/main/src/react/useICloudAuth.ts#41)

Context value for iCloud authentication

## Properties

### isAuthenticated

> **isAuthenticated**: `boolean`

Defined in: [src/react/useICloudAuth.ts:43](https://github.com/anuma-ai/sdk/blob/main/src/react/useICloudAuth.ts#43)

Whether user is authenticated with iCloud

***

### isAvailable

> **isAvailable**: `boolean`

Defined in: [src/react/useICloudAuth.ts:47](https://github.com/anuma-ai/sdk/blob/main/src/react/useICloudAuth.ts#47)

Whether CloudKit JS is loaded

***

### isConfigured

> **isConfigured**: `boolean`

Defined in: [src/react/useICloudAuth.ts:45](https://github.com/anuma-ai/sdk/blob/main/src/react/useICloudAuth.ts#45)

Whether iCloud is configured and available

***

### logout()

> **logout**: () => `void`

Defined in: [src/react/useICloudAuth.ts:53](https://github.com/anuma-ai/sdk/blob/main/src/react/useICloudAuth.ts#53)

Sign out from iCloud

**Returns**

`void`

***

### requestAccess()

> **requestAccess**: () => `Promise`<`void`>

Defined in: [src/react/useICloudAuth.ts:51](https://github.com/anuma-ai/sdk/blob/main/src/react/useICloudAuth.ts#51)

Request access - triggers iCloud sign-in if needed

**Returns**

`Promise`<`void`>

***

### userRecordName

> **userRecordName**: `string` | `null`

Defined in: [src/react/useICloudAuth.ts:49](https://github.com/anuma-ai/sdk/blob/main/src/react/useICloudAuth.ts#49)

User record name (unique identifier)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/ICloudAuthProviderProps

# ICloudAuthProviderProps

Defined in: [src/react/useICloudAuth.ts:27](https://github.com/anuma-ai/sdk/blob/main/src/react/useICloudAuth.ts#27)

Props for ICloudAuthProvider

## Properties

### apiToken

> **apiToken**: `string`

Defined in: [src/react/useICloudAuth.ts:29](https://github.com/anuma-ai/sdk/blob/main/src/react/useICloudAuth.ts#29)

CloudKit API token (from Apple Developer Console)

***

### children

> **children**: `ReactNode`

Defined in: [src/react/useICloudAuth.ts:35](https://github.com/anuma-ai/sdk/blob/main/src/react/useICloudAuth.ts#35)

Children to render

***

### containerIdentifier?

> `optional` **containerIdentifier**: `string`

Defined in: [src/react/useICloudAuth.ts:31](https://github.com/anuma-ai/sdk/blob/main/src/react/useICloudAuth.ts#31)

CloudKit container identifier (default: "iCloud.Memoryless")

***

### environment?

> `optional` **environment**: `"development"` | `"production"`

Defined in: [src/react/useICloudAuth.ts:33](https://github.com/anuma-ai/sdk/blob/main/src/react/useICloudAuth.ts#33)

CloudKit environment (default: "production")

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/ICloudExportResult

# ICloudExportResult

Defined in: [src/lib/backup/icloud/backup.ts:41](https://github.com/anuma-ai/sdk/blob/main/src/lib/backup/icloud/backup.ts#41)

## Properties

### skipped

> **skipped**: `number`

Defined in: [src/lib/backup/icloud/backup.ts:44](https://github.com/anuma-ai/sdk/blob/main/src/lib/backup/icloud/backup.ts#44)

***

### success

> **success**: `boolean`

Defined in: [src/lib/backup/icloud/backup.ts:42](https://github.com/anuma-ai/sdk/blob/main/src/lib/backup/icloud/backup.ts#42)

***

### total

> **total**: `number`

Defined in: [src/lib/backup/icloud/backup.ts:45](https://github.com/anuma-ai/sdk/blob/main/src/lib/backup/icloud/backup.ts#45)

***

### uploaded

> **uploaded**: `number`

Defined in: [src/lib/backup/icloud/backup.ts:43](https://github.com/anuma-ai/sdk/blob/main/src/lib/backup/icloud/backup.ts#43)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/ICloudImportResult

# ICloudImportResult

Defined in: [src/lib/backup/icloud/backup.ts:48](https://github.com/anuma-ai/sdk/blob/main/src/lib/backup/icloud/backup.ts#48)

## Properties

### failed

> **failed**: `number`

Defined in: [src/lib/backup/icloud/backup.ts:51](https://github.com/anuma-ai/sdk/blob/main/src/lib/backup/icloud/backup.ts#51)

***

### noBackupsFound?

> `optional` **noBackupsFound**: `boolean`

Defined in: [src/lib/backup/icloud/backup.ts:54](https://github.com/anuma-ai/sdk/blob/main/src/lib/backup/icloud/backup.ts#54)

True if no backups were found in iCloud

***

### restored

> **restored**: `number`

Defined in: [src/lib/backup/icloud/backup.ts:50](https://github.com/anuma-ai/sdk/blob/main/src/lib/backup/icloud/backup.ts#50)

***

### success

> **success**: `boolean`

Defined in: [src/lib/backup/icloud/backup.ts:49](https://github.com/anuma-ai/sdk/blob/main/src/lib/backup/icloud/backup.ts#49)

***

### total

> **total**: `number`

Defined in: [src/lib/backup/icloud/backup.ts:52](https://github.com/anuma-ai/sdk/blob/main/src/lib/backup/icloud/backup.ts#52)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/IconProps

# IconProps

Defined in: [src/react/anumaRuntime.tsx:737](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#737)

## Extends

* `CommonProps`

## Properties

### alignSelf?

> `optional` **alignSelf**: `string`

Defined in: [src/react/anumaRuntime.tsx:169](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#169)

**Inherited from**

`CommonProps.alignSelf`

***

### children?

> `optional` **children**: `ReactNode`

Defined in: [src/react/anumaRuntime.tsx:281](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#281)

**Inherited from**

`CommonProps.children`

***

### grow?

> `optional` **grow**: `number`

Defined in: [src/react/anumaRuntime.tsx:167](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#167)

**Inherited from**

`CommonProps.grow`

***

### h?

> `optional` **h**: `number`

Defined in: [src/react/anumaRuntime.tsx:165](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#165)

**Inherited from**

`CommonProps.h`

***

### id?

> `optional` **id**: `string`

Defined in: [src/react/anumaRuntime.tsx:279](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#279)

**Inherited from**

`CommonProps.id`

***

### name?

> `optional` **name**: `string`

Defined in: [src/react/anumaRuntime.tsx:738](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#738)

***

### rotation?

> `optional` **rotation**: `number`

Defined in: [src/react/anumaRuntime.tsx:166](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#166)

**Inherited from**

`CommonProps.rotation`

***

### shrink?

> `optional` **shrink**: `number`

Defined in: [src/react/anumaRuntime.tsx:168](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#168)

**Inherited from**

`CommonProps.shrink`

***

### style?

> `optional` **style**: `CSSProperties`

Defined in: [src/react/anumaRuntime.tsx:280](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#280)

**Inherited from**

`CommonProps.style`

***

### w?

> `optional` **w**: `number`

Defined in: [src/react/anumaRuntime.tsx:164](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#164)

**Inherited from**

`CommonProps.w`

***

### x?

> `optional` **x**: `number`

Defined in: [src/react/anumaRuntime.tsx:162](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#162)

**Inherited from**

`CommonProps.x`

***

### y?

> `optional` **y**: `number`

Defined in: [src/react/anumaRuntime.tsx:163](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#163)

**Inherited from**

`CommonProps.y`

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/ImageProps

# ImageProps

Defined in: [src/react/anumaRuntime.tsx:680](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#680)

## Extends

* `CommonProps`

## Properties

### alignSelf?

> `optional` **alignSelf**: `string`

Defined in: [src/react/anumaRuntime.tsx:169](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#169)

**Inherited from**

`CommonProps.alignSelf`

***

### children?

> `optional` **children**: `ReactNode`

Defined in: [src/react/anumaRuntime.tsx:281](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#281)

**Inherited from**

`CommonProps.children`

***

### grow?

> `optional` **grow**: `number`

Defined in: [src/react/anumaRuntime.tsx:167](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#167)

**Inherited from**

`CommonProps.grow`

***

### h?

> `optional` **h**: `number`

Defined in: [src/react/anumaRuntime.tsx:165](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#165)

**Inherited from**

`CommonProps.h`

***

### id?

> `optional` **id**: `string`

Defined in: [src/react/anumaRuntime.tsx:279](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#279)

**Inherited from**

`CommonProps.id`

***

### rotation?

> `optional` **rotation**: `number`

Defined in: [src/react/anumaRuntime.tsx:166](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#166)

**Inherited from**

`CommonProps.rotation`

***

### shrink?

> `optional` **shrink**: `number`

Defined in: [src/react/anumaRuntime.tsx:168](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#168)

**Inherited from**

`CommonProps.shrink`

***

### src?

> `optional` **src**: `string`

Defined in: [src/react/anumaRuntime.tsx:681](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#681)

***

### style?

> `optional` **style**: `CSSProperties`

Defined in: [src/react/anumaRuntime.tsx:280](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#280)

**Inherited from**

`CommonProps.style`

***

### w?

> `optional` **w**: `number`

Defined in: [src/react/anumaRuntime.tsx:164](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#164)

**Inherited from**

`CommonProps.w`

***

### x?

> `optional` **x**: `number`

Defined in: [src/react/anumaRuntime.tsx:162](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#162)

**Inherited from**

`CommonProps.x`

***

### y?

> `optional` **y**: `number`

Defined in: [src/react/anumaRuntime.tsx:163](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#163)

**Inherited from**

`CommonProps.y`

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/LazyStoredConversation

# LazyStoredConversation

Defined in: [src/lib/db/chat/types.ts:183](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#183)

Lazy variant of [StoredConversation](StoredConversation.md).

Identical to `StoredConversation` except `title` is replaced with
`encryptedTitle` — the raw value as persisted in WatermelonDB. The
caller is responsible for decrypting the title when (and only when)
the row is actually rendered, typically via `decryptConversationTitle`
inside an IntersectionObserver callback or a virtualized list.

For users with thousands of conversations this means plaintext titles
for the off-screen rows never enter client RAM.

The string in `encryptedTitle` may also be plaintext (legacy/unencrypted
conversations); `decryptConversationTitle` handles both transparently.

## Extends

* `Omit`<[`StoredConversation`](StoredConversation.md), `"title"`>

## Properties

### conversationId

> **conversationId**: `string`

Defined in: [src/lib/db/chat/types.ts:159](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#159)

**Inherited from**

[`StoredConversation`](StoredConversation.md).[`conversationId`](StoredConversation.md#conversationid)

***

### createdAt

> **createdAt**: `Date`

Defined in: [src/lib/db/chat/types.ts:163](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#163)

**Inherited from**

[`StoredConversation`](StoredConversation.md).[`createdAt`](StoredConversation.md#createdat)

***

### encryptedTitle

> **encryptedTitle**: `string`

Defined in: [src/lib/db/chat/types.ts:189](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#189)

Raw stored title — either ciphertext (`enc:v3:...`) or plaintext for
legacy rows. Pass to `decryptConversationTitle(encryptedTitle, address)`
when the row needs to be rendered.

***

### isDeleted

> **isDeleted**: `boolean`

Defined in: [src/lib/db/chat/types.ts:165](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#165)

**Inherited from**

[`StoredConversation`](StoredConversation.md).[`isDeleted`](StoredConversation.md#isdeleted)

***

### projectId?

> `optional` **projectId**: `string`

Defined in: [src/lib/db/chat/types.ts:162](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#162)

Optional project ID this conversation belongs to

**Inherited from**

[`StoredConversation`](StoredConversation.md).[`projectId`](StoredConversation.md#projectid)

***

### uniqueId

> **uniqueId**: `string`

Defined in: [src/lib/db/chat/types.ts:158](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#158)

**Inherited from**

[`StoredConversation`](StoredConversation.md).[`uniqueId`](StoredConversation.md#uniqueid)

***

### updatedAt

> **updatedAt**: `Date`

Defined in: [src/lib/db/chat/types.ts:164](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#164)

**Inherited from**

[`StoredConversation`](StoredConversation.md).[`updatedAt`](StoredConversation.md#updatedat)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/LineProps

# LineProps

Defined in: [src/react/anumaRuntime.tsx:594](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#594)

## Extends

* `CommonProps`

## Properties

### alignSelf?

> `optional` **alignSelf**: `string`

Defined in: [src/react/anumaRuntime.tsx:169](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#169)

**Inherited from**

`CommonProps.alignSelf`

***

### children?

> `optional` **children**: `ReactNode`

Defined in: [src/react/anumaRuntime.tsx:281](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#281)

**Inherited from**

`CommonProps.children`

***

### grow?

> `optional` **grow**: `number`

Defined in: [src/react/anumaRuntime.tsx:167](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#167)

**Inherited from**

`CommonProps.grow`

***

### h?

> `optional` **h**: `number`

Defined in: [src/react/anumaRuntime.tsx:165](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#165)

**Inherited from**

`CommonProps.h`

***

### id?

> `optional` **id**: `string`

Defined in: [src/react/anumaRuntime.tsx:279](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#279)

**Inherited from**

`CommonProps.id`

***

### rotation?

> `optional` **rotation**: `number`

Defined in: [src/react/anumaRuntime.tsx:166](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#166)

**Inherited from**

`CommonProps.rotation`

***

### shrink?

> `optional` **shrink**: `number`

Defined in: [src/react/anumaRuntime.tsx:168](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#168)

**Inherited from**

`CommonProps.shrink`

***

### stroke?

> `optional` **stroke**: `string`

Defined in: [src/react/anumaRuntime.tsx:595](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#595)

***

### strokeWidth?

> `optional` **strokeWidth**: `number`

Defined in: [src/react/anumaRuntime.tsx:596](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#596)

***

### style?

> `optional` **style**: `CSSProperties`

Defined in: [src/react/anumaRuntime.tsx:280](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#280)

**Inherited from**

`CommonProps.style`

***

### w?

> `optional` **w**: `number`

Defined in: [src/react/anumaRuntime.tsx:164](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#164)

**Inherited from**

`CommonProps.w`

***

### x?

> `optional` **x**: `number`

Defined in: [src/react/anumaRuntime.tsx:162](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#162)

**Inherited from**

`CommonProps.x`

***

### y?

> `optional` **y**: `number`

Defined in: [src/react/anumaRuntime.tsx:163](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#163)

**Inherited from**

`CommonProps.y`

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/Logger

# Logger

Defined in: [src/lib/logger.ts:23](https://github.com/anuma-ai/sdk/blob/main/src/lib/logger.ts#23)

Pluggable logger for the Anuma SDK.

By default all SDK logging goes to `console`. Call [setLogger](../functions/setLogger.md) at app
init (or use `<LoggerProvider>` in React) to redirect output to your own
logging infrastructure (PostHog, Datadog, Sentry, etc.).

## Example

```ts
import { setLogger, type Logger } from "@anuma/sdk";

const myLogger: Logger = {
  debug: () => {},
  info: (...args) => posthog.capture("sdk_info", { message: args }),
  warn: (...args) => console.warn("[SDK]", ...args),
  error: (...args) => Sentry.captureMessage(args.join(" ")),
};

setLogger(myLogger);
```

## Properties

### debug()

> **debug**: (...`args`: `unknown`\[]) => `void`

Defined in: [src/lib/logger.ts:24](https://github.com/anuma-ai/sdk/blob/main/src/lib/logger.ts#24)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

...`args`

</td>
<td>

`unknown`\[]

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

***

### error()

> **error**: (...`args`: `unknown`\[]) => `void`

Defined in: [src/lib/logger.ts:28](https://github.com/anuma-ai/sdk/blob/main/src/lib/logger.ts#28)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

...`args`

</td>
<td>

`unknown`\[]

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

***

### info()

> **info**: (...`args`: `unknown`\[]) => `void`

Defined in: [src/lib/logger.ts:26](https://github.com/anuma-ai/sdk/blob/main/src/lib/logger.ts#26)

Not used internally by the SDK today, but included so custom loggers can receive all standard levels.

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

...`args`

</td>
<td>

`unknown`\[]

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

***

### warn()

> **warn**: (...`args`: `unknown`\[]) => `void`

Defined in: [src/lib/logger.ts:27](https://github.com/anuma-ai/sdk/blob/main/src/lib/logger.ts#27)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

...`args`

</td>
<td>

`unknown`\[]

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/LoggerProviderProps

# LoggerProviderProps

Defined in: [src/react/LoggerProvider.tsx:7](https://github.com/anuma-ai/sdk/blob/main/src/react/LoggerProvider.tsx#7)

## Properties

### children

> **children**: `ReactNode`

Defined in: [src/react/LoggerProvider.tsx:9](https://github.com/anuma-ai/sdk/blob/main/src/react/LoggerProvider.tsx#9)

***

### logger

> **logger**: [`Logger`](Logger.md)

Defined in: [src/react/LoggerProvider.tsx:8](https://github.com/anuma-ai/sdk/blob/main/src/react/LoggerProvider.tsx#8)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/MediaDimensions

# MediaDimensions

Defined in: [src/lib/db/media/types.ts:23](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#23)

Dimensions for images and videos.

## Properties

### height

> **height**: `number`

Defined in: [src/lib/db/media/types.ts:25](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#25)

***

### width

> **width**: `number`

Defined in: [src/lib/db/media/types.ts:24](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#24)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/MediaFilterOptions

# MediaFilterOptions

Defined in: [src/lib/db/media/types.ts:152](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#152)

Filter options for querying media.

## Properties

### conversationId?

> `optional` **conversationId**: `string`

Defined in: [src/lib/db/media/types.ts:160](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#160)

Filter by conversation

***

### includeDeleted?

> `optional` **includeDeleted**: `boolean`

Defined in: [src/lib/db/media/types.ts:164](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#164)

Include soft-deleted records

***

### limit?

> `optional` **limit**: `number`

Defined in: [src/lib/db/media/types.ts:166](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#166)

Limit number of results

***

### mediaType?

> `optional` **mediaType**: [`MediaType`](../type-aliases/MediaType.md)

Defined in: [src/lib/db/media/types.ts:156](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#156)

Filter by media type

***

### model?

> `optional` **model**: `string`

Defined in: [src/lib/db/media/types.ts:162](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#162)

Filter by AI model

***

### offset?

> `optional` **offset**: `number`

Defined in: [src/lib/db/media/types.ts:168](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#168)

Offset for pagination

***

### role?

> `optional` **role**: [`MediaRole`](../type-aliases/MediaRole.md)

Defined in: [src/lib/db/media/types.ts:158](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#158)

Filter by role (user uploads vs AI generated)

***

### walletAddress

> **walletAddress**: `string`

Defined in: [src/lib/db/media/types.ts:154](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#154)

Filter by wallet address (required for multi-user)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/MediaMetadata

# MediaMetadata

Defined in: [src/lib/db/media/types.ts:32](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#32)

Additional metadata that varies by media type.
Stored as JSON for flexibility.

## Indexable

\[`key`: `string`]: `unknown`

## Properties

### author?

> `optional` **author**: `string`

Defined in: [src/lib/db/media/types.ts:44](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#44)

***

### bitrate?

> `optional` **bitrate**: `number`

Defined in: [src/lib/db/media/types.ts:35](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#35)

***

### codec?

> `optional` **codec**: `string`

Defined in: [src/lib/db/media/types.ts:34](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#34)

***

### colorSpace?

> `optional` **colorSpace**: `string`

Defined in: [src/lib/db/media/types.ts:39](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#39)

***

### frameRate?

> `optional` **frameRate**: `number`

Defined in: [src/lib/db/media/types.ts:36](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#36)

***

### hasAlpha?

> `optional` **hasAlpha**: `boolean`

Defined in: [src/lib/db/media/types.ts:40](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#40)

***

### pageCount?

> `optional` **pageCount**: `number`

Defined in: [src/lib/db/media/types.ts:43](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#43)

***

### prompt?

> `optional` **prompt**: `string`

Defined in: [src/lib/db/media/types.ts:47](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#47)

***

### seed?

> `optional` **seed**: `number`

Defined in: [src/lib/db/media/types.ts:48](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#48)

***

### steps?

> `optional` **steps**: `number`

Defined in: [src/lib/db/media/types.ts:49](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#49)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/MediaOperationsContext

# MediaOperationsContext

Defined in: [src/lib/db/media/types.ts:183](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#183)

Context required for media database operations.

## Properties

### database

> **database**: `Database`

Defined in: [src/lib/db/media/types.ts:184](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#184)

***

### embeddedWalletSigner?

> `optional` **embeddedWalletSigner**: `MediaSignMessageFn`

Defined in: [src/lib/db/media/types.ts:190](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#190)

Function for silent signing with embedded wallets

***

### signMessage?

> `optional` **signMessage**: `MediaSignMessageFn`

Defined in: [src/lib/db/media/types.ts:188](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#188)

Function to sign a message for encryption key derivation

***

### walletAddress?

> `optional` **walletAddress**: `string`

Defined in: [src/lib/db/media/types.ts:186](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#186)

Wallet address for encryption (optional - when present, enables field-level encryption)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/MemoryEngineEmbeddingOptions

# MemoryEngineEmbeddingOptions

Defined in: [src/lib/memoryEngine/types.ts:63](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryEngine/types.ts#63)

Options for embedding generation

Supports two auth methods:

* `getToken`: For Privy identity tokens (uses Authorization: Bearer header)
* `apiKey`: For direct API keys (uses X-API-Key header)

At least one of `getToken` or `apiKey` must be provided.

## Properties

### apiKey?

> `optional` **apiKey**: `string`

Defined in: [src/lib/memoryEngine/types.ts:67](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryEngine/types.ts#67)

Direct API key for server-side usage. Uses X-API-Key header.

***

### baseUrl?

> `optional` **baseUrl**: `string`

Defined in: [src/lib/memoryEngine/types.ts:69](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryEngine/types.ts#69)

Base URL for the API

***

### batchSize?

> `optional` **batchSize**: `number`

Defined in: [src/lib/memoryEngine/types.ts:73](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryEngine/types.ts#73)

Max texts per API call for batch embeddings (default: 100). Larger arrays are split into chunks.

***

### cache?

> `optional` **cache**: `Map`<`string`, `number`\[]>

Defined in: [src/lib/memoryEngine/types.ts:80](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryEngine/types.ts#80)

Optional in-memory cache for embedding vectors. When provided, texts
are looked up in this map before calling the API, and new embeddings
are stored after generation. Useful when the same texts are embedded
repeatedly (e.g., across eval iterations or re-indexing runs).

***

### getToken()?

> `optional` **getToken**: () => `Promise`<`string` | `null`>

Defined in: [src/lib/memoryEngine/types.ts:65](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryEngine/types.ts#65)

Function to get auth token (e.g., Privy's getIdentityToken). Uses Authorization: Bearer header.

**Returns**

`Promise`<`string` | `null`>

***

### model?

> `optional` **model**: `string`

Defined in: [src/lib/memoryEngine/types.ts:71](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryEngine/types.ts#71)

Embedding model to use

***

### onUsage()?

> `optional` **onUsage**: (`usage`: `object`) => `void`

Defined in: [src/lib/memoryEngine/types.ts:82](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryEngine/types.ts#82)

Called after each embedding API call with the token usage from the response.

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`usage`

</td>
<td>

`object`

</td>
</tr>
<tr>
<td>

`usage.promptTokens`

</td>
<td>

`number`

</td>
</tr>
<tr>
<td>

`usage.totalTokens`

</td>
<td>

`number`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/MemoryEngineResult

# MemoryEngineResult

Defined in: [src/lib/memoryEngine/types.ts:39](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryEngine/types.ts#39)

A retrieved message with similarity score

## Properties

### content

> **content**: `string`

Defined in: [src/lib/memoryEngine/types.ts:41](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryEngine/types.ts#41)

Message content

***

### conversationId

> **conversationId**: `string`

Defined in: [src/lib/memoryEngine/types.ts:45](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryEngine/types.ts#45)

Conversation this message belongs to

***

### createdAt

> **createdAt**: `Date`

Defined in: [src/lib/memoryEngine/types.ts:49](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryEngine/types.ts#49)

When the message was created

***

### role

> **role**: `"user"` | `"assistant"`

Defined in: [src/lib/memoryEngine/types.ts:43](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryEngine/types.ts#43)

Role of the message sender

***

### similarity

> **similarity**: `number`

Defined in: [src/lib/memoryEngine/types.ts:47](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryEngine/types.ts#47)

Cosine similarity score (0-1)

***

### uniqueId

> **uniqueId**: `string`

Defined in: [src/lib/memoryEngine/types.ts:51](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryEngine/types.ts#51)

Unique message ID

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/MemoryEngineSearchOptions

# MemoryEngineSearchOptions

Defined in: [src/lib/memoryEngine/types.ts:13](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryEngine/types.ts#13)

Options for memory engine search

## Properties

### contextMessages?

> `optional` **contextMessages**: `number`

Defined in: [src/lib/memoryEngine/types.ts:33](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryEngine/types.ts#33)

Number of surrounding messages to include around each match when expanding to full sessions. 0 returns only matched chunks (no expansion), undefined returns the entire conversation. Default: undefined (full session).

***

### conversationId?

> `optional` **conversationId**: `string`

Defined in: [src/lib/memoryEngine/types.ts:23](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryEngine/types.ts#23)

Filter to a specific conversation

***

### endDate?

> `optional` **endDate**: `string`

Defined in: [src/lib/memoryEngine/types.ts:29](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryEngine/types.ts#29)

Inclusive end date filter (currently disabled)

***

### excludeConversationId?

> `optional` **excludeConversationId**: `string`

Defined in: [src/lib/memoryEngine/types.ts:25](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryEngine/types.ts#25)

Exclude messages from this conversation (e.g., the current conversation)

***

### includeAssistant?

> `optional` **includeAssistant**: `boolean`

Defined in: [src/lib/memoryEngine/types.ts:21](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryEngine/types.ts#21)

Include assistant messages in results (default: false)

***

### limit?

> `optional` **limit**: `number`

Defined in: [src/lib/memoryEngine/types.ts:15](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryEngine/types.ts#15)

Maximum number of results to return (default: 8)

***

### minSimilarity?

> `optional` **minSimilarity**: `number`

Defined in: [src/lib/memoryEngine/types.ts:19](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryEngine/types.ts#19)

Minimum similarity threshold 0-1 (default: 0.3)

***

### sortBy?

> `optional` **sortBy**: `"similarity"` | `"chronological"`

Defined in: [src/lib/memoryEngine/types.ts:31](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryEngine/types.ts#31)

Sort order for results: "similarity" (most relevant first) or "chronological" (oldest first). Default: "similarity"

***

### startDate?

> `optional` **startDate**: `string`

Defined in: [src/lib/memoryEngine/types.ts:27](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryEngine/types.ts#27)

Inclusive start date filter (currently disabled)

***

### topK?

> `optional` **topK**: `number`

Defined in: [src/lib/memoryEngine/types.ts:17](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryEngine/types.ts#17)

Alias for limit - number of chunks to return (default: 8)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/MemoryVaultSearchOptions

# MemoryVaultSearchOptions

Defined in: [src/lib/memoryVault/searchTool.ts:25](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryVault/searchTool.ts#25)

Options for the vault search tool.

## Properties

### folderId?

> `optional` **folderId**: `string` | `null`

Defined in: [src/lib/memoryVault/searchTool.ts:33](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryVault/searchTool.ts#33)

When provided, only search memories in this folder (null for unfiled)

***

### limit?

> `optional` **limit**: `number`

Defined in: [src/lib/memoryVault/searchTool.ts:27](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryVault/searchTool.ts#27)

Maximum number of results to return (default: 5)

***

### minSimilarity?

> `optional` **minSimilarity**: `number`

Defined in: [src/lib/memoryVault/searchTool.ts:29](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryVault/searchTool.ts#29)

Minimum similarity threshold below which results are discarded (default: 0.1)

***

### scopes?

> `optional` **scopes**: `string`\[]

Defined in: [src/lib/memoryVault/searchTool.ts:31](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryVault/searchTool.ts#31)

When provided, only search memories with these scopes

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/MemoryVaultToolOptions

# MemoryVaultToolOptions

Defined in: [src/lib/memoryVault/tool.ts:37](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryVault/tool.ts#37)

Options for creating a memory vault tool.

## Properties

### folderMap?

> `optional` **folderMap**: `Map`<`string`, `string`>

Defined in: [src/lib/memoryVault/tool.ts:58](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryVault/tool.ts#58)

Map of folder names to folder IDs for auto-classification.
When provided, the LLM can specify a folderName argument.

***

### onSave()?

> `optional` **onSave**: (`operation`: [`VaultSaveOperation`](VaultSaveOperation.md)) => `Promise`<`boolean`>

Defined in: [src/lib/memoryVault/tool.ts:46](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryVault/tool.ts#46)

Callback invoked before each save operation.
Return `true` to confirm the save, `false` to cancel it.

When provided, the confirmation is built into the executor.
When not provided, the tool has no executor and is emitted
via onToolCall so the host app can handle it.

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`operation`

</td>
<td>

[`VaultSaveOperation`](VaultSaveOperation.md)

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`boolean`>

***

### scope?

> `optional` **scope**: `string`

Defined in: [src/lib/memoryVault/tool.ts:52](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryVault/tool.ts#52)

Scope to assign to new memories. Defaults to "private".
This is injected by the client, not controlled by the LLM.

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/MessageChunk

# MessageChunk

Defined in: [src/lib/db/chat/types.ts:221](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#221)

A chunk of a message with its own embedding for fine-grained search

## Properties

### endOffset

> **endOffset**: `number`

Defined in: [src/lib/db/chat/types.ts:229](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#229)

Character offset where this chunk ends in the original message

***

### startOffset

> **startOffset**: `number`

Defined in: [src/lib/db/chat/types.ts:227](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#227)

Character offset where this chunk starts in the original message

***

### text

> **text**: `string`

Defined in: [src/lib/db/chat/types.ts:223](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#223)

The chunk text

***

### vector

> **vector**: `number`\[]

Defined in: [src/lib/db/chat/types.ts:225](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#225)

Embedding vector for this chunk

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/ModelLoadProgress

# ModelLoadProgress

Defined in: [src/lib/voice/types.ts:25](https://github.com/anuma-ai/sdk/blob/main/src/lib/voice/types.ts#25)

## Properties

### file

> **file**: `string`

Defined in: [src/lib/voice/types.ts:27](https://github.com/anuma-ai/sdk/blob/main/src/lib/voice/types.ts#27)

File being downloaded

***

### loaded

> **loaded**: `number`

Defined in: [src/lib/voice/types.ts:31](https://github.com/anuma-ai/sdk/blob/main/src/lib/voice/types.ts#31)

Bytes loaded

***

### progress

> **progress**: `number`

Defined in: [src/lib/voice/types.ts:29](https://github.com/anuma-ai/sdk/blob/main/src/lib/voice/types.ts#29)

Download progress 0-1

***

### total

> **total**: `number`

Defined in: [src/lib/voice/types.ts:33](https://github.com/anuma-ai/sdk/blob/main/src/lib/voice/types.ts#33)

Total bytes

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/OCRFile

# OCRFile

Defined in: [src/react/useOCR.ts:7](https://github.com/anuma-ai/sdk/blob/main/src/react/useOCR.ts#7)

## Properties

### filename?

> `optional` **filename**: `string`

Defined in: [src/react/useOCR.ts:9](https://github.com/anuma-ai/sdk/blob/main/src/react/useOCR.ts#9)

***

### language?

> `optional` **language**: `string`

Defined in: [src/react/useOCR.ts:10](https://github.com/anuma-ai/sdk/blob/main/src/react/useOCR.ts#10)

***

### url

> **url**: `string` | `Blob` | `File`

Defined in: [src/react/useOCR.ts:8](https://github.com/anuma-ai/sdk/blob/main/src/react/useOCR.ts#8)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/ParsedServerToolsResponse

# ParsedServerToolsResponse

Defined in: [src/lib/tools/serverTools.ts:140](https://github.com/anuma-ai/sdk/blob/main/src/lib/tools/serverTools.ts#140)

Result of parsing server tools response

## Properties

### checksum?

> `optional` **checksum**: `string`

Defined in: [src/lib/tools/serverTools.ts:142](https://github.com/anuma-ai/sdk/blob/main/src/lib/tools/serverTools.ts#142)

***

### tools

> **tools**: [`ServerTool`](ServerTool.md)\[]

Defined in: [src/lib/tools/serverTools.ts:141](https://github.com/anuma-ai/sdk/blob/main/src/lib/tools/serverTools.ts#141)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/PdfFile

# PdfFile

Defined in: [src/react/usePdf.ts:8](https://github.com/anuma-ai/sdk/blob/main/src/react/usePdf.ts#8)

## Properties

### filename?

> `optional` **filename**: `string`

Defined in: [src/react/usePdf.ts:11](https://github.com/anuma-ai/sdk/blob/main/src/react/usePdf.ts#11)

***

### mediaType?

> `optional` **mediaType**: `string`

Defined in: [src/react/usePdf.ts:10](https://github.com/anuma-ai/sdk/blob/main/src/react/usePdf.ts#10)

***

### url

> **url**: `string`

Defined in: [src/react/usePdf.ts:9](https://github.com/anuma-ai/sdk/blob/main/src/react/usePdf.ts#9)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/PersonalitySettings

# PersonalitySettings

Defined in: [src/lib/db/userPreferences/types.ts:35](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/userPreferences/types.ts#35)

Complete personality settings for AI communication style

## Properties

### customInstructions

> **customInstructions**: `string`

Defined in: [src/lib/db/userPreferences/types.ts:38](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/userPreferences/types.ts#38)

***

### sliders

> **sliders**: [`PersonalitySliders`](PersonalitySliders.md)

Defined in: [src/lib/db/userPreferences/types.ts:36](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/userPreferences/types.ts#36)

***

### style

> **style**: [`PersonalityStyle`](../type-aliases/PersonalityStyle.md)

Defined in: [src/lib/db/userPreferences/types.ts:37](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/userPreferences/types.ts#37)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/PersonalitySliders

# PersonalitySliders

Defined in: [src/lib/db/userPreferences/types.ts:8](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/userPreferences/types.ts#8)

Slider settings for personality customization (1-5 range)

## Properties

### depth

> **depth**: `number`

Defined in: [src/lib/db/userPreferences/types.ts:12](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/userPreferences/types.ts#12)

1 = high-level summary, 5 = deep-dive analysis

***

### emojis

> **emojis**: `number`

Defined in: [src/lib/db/userPreferences/types.ts:10](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/userPreferences/types.ts#10)

1 = no emojis, 5 = many emojis

***

### strictness

> **strictness**: `number`

Defined in: [src/lib/db/userPreferences/types.ts:14](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/userPreferences/types.ts#14)

1 = evidence-only, 5 = speculative

***

### verbosity

> **verbosity**: `number`

Defined in: [src/lib/db/userPreferences/types.ts:16](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/userPreferences/types.ts#16)

1 = concise, 5 = detailed

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/PlatformStorage

# PlatformStorage

Defined in: [src/lib/db/manager.ts:19](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/manager.ts#19)

Platform abstraction for persistent and session storage.

Web implementations use localStorage/sessionStorage/indexedDB.
Mobile implementations can use AsyncStorage/in-memory maps/SQLite cleanup.

## Methods

### deleteDatabase()

> **deleteDatabase**(`name`: `string`): `Promise`<`void`>

Defined in: [src/lib/db/manager.ts:31](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/manager.ts#31)

Delete an IndexedDB database by name

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`name`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`void`>

***

### getItem()

> **getItem**(`key`: `string`): `string` | `null`

Defined in: [src/lib/db/manager.ts:21](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/manager.ts#21)

Read a value from persistent storage (e.g. localStorage)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`key`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`string` | `null`

***

### getSessionItem()

> **getSessionItem**(`key`: `string`): `string` | `null`

Defined in: [src/lib/db/manager.ts:27](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/manager.ts#27)

Read a value from session-scoped storage (e.g. sessionStorage). Used to prevent reload loops.

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`key`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`string` | `null`

***

### removeItem()

> **removeItem**(`key`: `string`): `void`

Defined in: [src/lib/db/manager.ts:25](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/manager.ts#25)

Remove a value from persistent storage

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`key`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

***

### setItem()

> **setItem**(`key`: `string`, `value`: `string`): `void`

Defined in: [src/lib/db/manager.ts:23](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/manager.ts#23)

Write a value to persistent storage

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`key`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`value`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

***

### setSessionItem()

> **setSessionItem**(`key`: `string`, `value`: `string`): `void`

Defined in: [src/lib/db/manager.ts:29](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/manager.ts#29)

Write a value to session-scoped storage

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`key`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`value`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/PreprocessingOptions

# PreprocessingOptions

Defined in: [src/lib/processors/types.ts:62](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/types.ts#62)

Options for file preprocessing

## Properties

### keepOriginalFiles?

> `optional` **keepOriginalFiles**: `boolean`

Defined in: [src/lib/processors/types.ts:72](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/types.ts#72)

Whether to keep original file attachments (default: true)

***

### maxFileSizeBytes?

> `optional` **maxFileSizeBytes**: `number`

Defined in: [src/lib/processors/types.ts:75](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/types.ts#75)

Max file size to process in bytes (default: 10MB)

***

### onError()?

> `optional` **onError**: (`fileName`: `string`, `error`: `Error`) => `void`

Defined in: [src/lib/processors/types.ts:84](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/types.ts#84)

Callback for errors (non-fatal)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`fileName`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`error`

</td>
<td>

`Error`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

***

### onProgress()?

> `optional` **onProgress**: (`current`: `number`, `total`: `number`, `fileName`: `string`) => `void`

Defined in: [src/lib/processors/types.ts:81](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/types.ts#81)

Callback for progress updates

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`current`

</td>
<td>

`number`

</td>
</tr>
<tr>
<td>

`total`

</td>
<td>

`number`

</td>
</tr>
<tr>
<td>

`fileName`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

***

### processors?

> `optional` **processors**: [`FileProcessor`](FileProcessor.md)\[] | `null`

Defined in: [src/lib/processors/types.ts:69](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/types.ts#69)

Processors to use.

* undefined (default): Use all built-in processors
* null or \[]: Disable preprocessing
* FileProcessor\[]: Use specific processors

***

### timeoutMs?

> `optional` **timeoutMs**: `number`

Defined in: [src/lib/processors/types.ts:78](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/types.ts#78)

Timeout per file in milliseconds (default: 30000). Prevents hangs from slow CDN workers or large files.

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/PreprocessingResult

# PreprocessingResult

Defined in: [src/lib/processors/types.ts:90](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/types.ts#90)

Result from preprocessing files

## Properties

### extractedContent

> **extractedContent**: `string` | `null`

Defined in: [src/lib/processors/types.ts:92](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/types.ts#92)

Extracted content to prepend to user message

***

### imageContentUrls?

> `optional` **imageContentUrls**: `string`\[]

Defined in: [src/lib/processors/types.ts:99](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/types.ts#99)

Image data URLs for files where text extraction failed but page images were
rendered (e.g. scanned PDFs). The caller should inject these as `image_url`
content parts in the user message so the vision model can read the document.

***

### metadata

> **metadata**: `object`

Defined in: [src/lib/processors/types.ts:108](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/types.ts#108)

Processing metadata

**errorCount**

> **errorCount**: `number`

**processedCount**

> **processedCount**: `number`

**skippedCount**

> **skippedCount**: `number`

***

### originalFiles?

> `optional` **originalFiles**: [`FileMetadata`](FileMetadata.md)\[]

Defined in: [src/lib/processors/types.ts:102](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/types.ts#102)

Original files (if keepOriginalFiles = true)

***

### preprocessedFileIds

> **preprocessedFileIds**: `string`\[]

Defined in: [src/lib/processors/types.ts:105](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/types.ts#105)

IDs of files that were successfully preprocessed (used to remove from message)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/ProcessedFileResult

# ProcessedFileResult

Defined in: [src/lib/processors/types.ts:14](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/types.ts#14)

Result from processing a file

## Properties

### extractedText

> **extractedText**: `string`

Defined in: [src/lib/processors/types.ts:16](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/types.ts#16)

Extracted text content

***

### format

> **format**: `"json"` | `"plain"` | `"markdown"`

Defined in: [src/lib/processors/types.ts:19](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/types.ts#19)

Format hint for how text should be presented

***

### imageDataUrls?

> `optional` **imageDataUrls**: `string`\[]

Defined in: [src/lib/processors/types.ts:26](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/types.ts#26)

Fallback image data URLs (base64 PNG) when text extraction yields no content.
For example, scanned PDFs have no extractable text — rendering each page as an
image lets the vision model read the document instead.

***

### metadata?

> `optional` **metadata**: `object`

Defined in: [src/lib/processors/types.ts:29](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/types.ts#29)

Optional metadata about the extraction

**Index Signature**

\[`key`: `string`]: `unknown`

**pageCount?**

> `optional` **pageCount**: `number`

**sheetCount?**

> `optional` **sheetCount**: `number`

**sheetNames?**

> `optional` **sheetNames**: `string`\[]

**wordCount?**

> `optional` **wordCount**: `number`

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/ProfileUpdate

# ProfileUpdate

Defined in: [src/lib/db/userPreferences/types.ts:136](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/userPreferences/types.ts#136)

Profile-only update options

## Properties

### description?

> `optional` **description**: `string`

Defined in: [src/lib/db/userPreferences/types.ts:139](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/userPreferences/types.ts#139)

***

### nickname?

> `optional` **nickname**: `string`

Defined in: [src/lib/db/userPreferences/types.ts:137](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/userPreferences/types.ts#137)

***

### occupation?

> `optional` **occupation**: `string`

Defined in: [src/lib/db/userPreferences/types.ts:138](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/userPreferences/types.ts#138)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/ProjectOperationsContext

# ProjectOperationsContext

Defined in: [src/lib/db/project/operations.ts:26](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/project/operations.ts#26)

## Properties

### conversationsCollection

> **conversationsCollection**: `Collection`<[`ChatConversation`](../classes/ChatConversation.md)>

Defined in: [src/lib/db/project/operations.ts:29](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/project/operations.ts#29)

***

### database

> **database**: `Database`

Defined in: [src/lib/db/project/operations.ts:27](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/project/operations.ts#27)

***

### projectsCollection

> **projectsCollection**: `Collection`<[`Project`](../classes/Project.md)>

Defined in: [src/lib/db/project/operations.ts:28](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/project/operations.ts#28)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/ProviderAuthState

# ProviderAuthState

Defined in: [src/react/useBackupAuth.ts:81](https://github.com/anuma-ai/sdk/blob/main/src/react/useBackupAuth.ts#81)

Auth state for a single provider

## Properties

### accessToken

> **accessToken**: `string` | `null`

Defined in: [src/react/useBackupAuth.ts:83](https://github.com/anuma-ai/sdk/blob/main/src/react/useBackupAuth.ts#83)

Current access token (null if not authenticated)

***

### isAuthenticated

> **isAuthenticated**: `boolean`

Defined in: [src/react/useBackupAuth.ts:85](https://github.com/anuma-ai/sdk/blob/main/src/react/useBackupAuth.ts#85)

Whether user has authenticated with this provider

***

### isConfigured

> **isConfigured**: `boolean`

Defined in: [src/react/useBackupAuth.ts:87](https://github.com/anuma-ai/sdk/blob/main/src/react/useBackupAuth.ts#87)

Whether this provider is configured

***

### logout()

> **logout**: () => `Promise`<`void`>

Defined in: [src/react/useBackupAuth.ts:91](https://github.com/anuma-ai/sdk/blob/main/src/react/useBackupAuth.ts#91)

Clear stored token and log out

**Returns**

`Promise`<`void`>

***

### refreshToken()

> **refreshToken**: () => `Promise`<`string` | `null`>

Defined in: [src/react/useBackupAuth.ts:93](https://github.com/anuma-ai/sdk/blob/main/src/react/useBackupAuth.ts#93)

Refresh the access token using the refresh token

**Returns**

`Promise`<`string` | `null`>

***

### requestAccess()

> **requestAccess**: () => `Promise`<`string`>

Defined in: [src/react/useBackupAuth.ts:89](https://github.com/anuma-ai/sdk/blob/main/src/react/useBackupAuth.ts#89)

Request access - returns token or redirects to OAuth

**Returns**

`Promise`<`string`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/ProviderBackupState

# ProviderBackupState

Defined in: [src/react/useBackup.ts:78](https://github.com/anuma-ai/sdk/blob/main/src/react/useBackup.ts#78)

Provider-specific backup state

## Properties

### backup()

> **backup**: (`options?`: [`BackupOperationOptions`](BackupOperationOptions.md)) => `Promise`<[`DropboxExportResult`](DropboxExportResult.md) | [`GoogleDriveExportResult`](GoogleDriveExportResult.md) | [`ICloudExportResult`](ICloudExportResult.md) | { `error`: `string`; }>

Defined in: [src/react/useBackup.ts:84](https://github.com/anuma-ai/sdk/blob/main/src/react/useBackup.ts#84)

Backup all conversations to this provider

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options?`

</td>
<td>

[`BackupOperationOptions`](BackupOperationOptions.md)

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`DropboxExportResult`](DropboxExportResult.md) | [`GoogleDriveExportResult`](GoogleDriveExportResult.md) | [`ICloudExportResult`](ICloudExportResult.md) | { `error`: `string`; }>

***

### connect()

> **connect**: () => `Promise`<`string`>

Defined in: [src/react/useBackup.ts:96](https://github.com/anuma-ai/sdk/blob/main/src/react/useBackup.ts#96)

Request access to this provider (triggers OAuth if needed)

**Returns**

`Promise`<`string`>

***

### disconnect()

> **disconnect**: () => `Promise`<`void`>

Defined in: [src/react/useBackup.ts:98](https://github.com/anuma-ai/sdk/blob/main/src/react/useBackup.ts#98)

Disconnect from this provider

**Returns**

`Promise`<`void`>

***

### isAuthenticated

> **isAuthenticated**: `boolean`

Defined in: [src/react/useBackup.ts:82](https://github.com/anuma-ai/sdk/blob/main/src/react/useBackup.ts#82)

Whether user has authenticated with this provider

***

### isConfigured

> **isConfigured**: `boolean`

Defined in: [src/react/useBackup.ts:80](https://github.com/anuma-ai/sdk/blob/main/src/react/useBackup.ts#80)

Whether the provider is configured

***

### restore()

> **restore**: (`options?`: [`BackupOperationOptions`](BackupOperationOptions.md)) => `Promise`<[`DropboxImportResult`](DropboxImportResult.md) | [`GoogleDriveImportResult`](GoogleDriveImportResult.md) | [`ICloudImportResult`](ICloudImportResult.md) | { `error`: `string`; }>

Defined in: [src/react/useBackup.ts:90](https://github.com/anuma-ai/sdk/blob/main/src/react/useBackup.ts#90)

Restore conversations from this provider

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options?`

</td>
<td>

[`BackupOperationOptions`](BackupOperationOptions.md)

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`DropboxImportResult`](DropboxImportResult.md) | [`GoogleDriveImportResult`](GoogleDriveImportResult.md) | [`ICloudImportResult`](ICloudImportResult.md) | { `error`: `string`; }>

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/QuantizedEmbedding

# QuantizedEmbedding

Defined in: [src/lib/memoryEngine/quantization.ts:32](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryEngine/quantization.ts#32)

Result of quantizing a Float32 / number\[] embedding to Int8.

`data` holds the quantized values in \[-127, 127].
`scale` is the per-vector Float32 scaling factor; multiplying a
dequantized Int8 value by `scale / 127` recovers the original.

The Int8Array does not own a separate ArrayBuffer copy beyond the
one allocated here, and is plain transferable storage.

## Properties

### data

> **data**: `Int8Array`

Defined in: [src/lib/memoryEngine/quantization.ts:33](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryEngine/quantization.ts#33)

***

### scale

> **scale**: `number`

Defined in: [src/lib/memoryEngine/quantization.ts:34](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryEngine/quantization.ts#34)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/QueuedOperation

# QueuedOperation

Defined in: [src/lib/db/queue/types.ts:25](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/queue/types.ts#25)

A single queued database operation.

## Properties

### dependencies

> **dependencies**: `string`\[]

Defined in: [src/lib/db/queue/types.ts:37](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/queue/types.ts#37)

IDs of operations that must complete before this one

***

### id

> **id**: `string`

Defined in: [src/lib/db/queue/types.ts:27](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/queue/types.ts#27)

Unique ID for this operation

***

### maxRetries

> **maxRetries**: `number`

Defined in: [src/lib/db/queue/types.ts:44](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/queue/types.ts#44)

Maximum number of retries allowed

***

### payload

> **payload**: `Record`<`string`, `any`>

Defined in: [src/lib/db/queue/types.ts:40](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/queue/types.ts#40)

Operation-specific payload

***

### priority

> **priority**: `number`

Defined in: [src/lib/db/queue/types.ts:35](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/queue/types.ts#35)

Priority for ordering (lower = higher priority). Conversations=0, Messages=1, Media=2

***

### retryCount

> **retryCount**: `number`

Defined in: [src/lib/db/queue/types.ts:42](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/queue/types.ts#42)

Number of times this operation has been retried

***

### timestamp

> **timestamp**: `number`

Defined in: [src/lib/db/queue/types.ts:33](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/queue/types.ts#33)

When the operation was queued

***

### type

> **type**: [`QueuedOperationType`](../type-aliases/QueuedOperationType.md)

Defined in: [src/lib/db/queue/types.ts:29](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/queue/types.ts#29)

Type of operation

***

### walletAddress

> **walletAddress**: `string`

Defined in: [src/lib/db/queue/types.ts:31](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/queue/types.ts#31)

Wallet address this operation belongs to

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/QueueEncryptionContext

# QueueEncryptionContext

Defined in: [src/lib/db/queue/types.ts:76](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/queue/types.ts#76)

Encryption context needed to execute queued operations.

## Properties

### embeddedWalletSigner?

> `optional` **embeddedWalletSigner**: [`EmbeddedWalletSignerFn`](../type-aliases/EmbeddedWalletSignerFn.md)

Defined in: [src/lib/db/queue/types.ts:79](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/queue/types.ts#79)

***

### signMessage

> **signMessage**: [`SignMessageFn`](../type-aliases/SignMessageFn.md)

Defined in: [src/lib/db/queue/types.ts:78](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/queue/types.ts#78)

***

### walletAddress

> **walletAddress**: `string`

Defined in: [src/lib/db/queue/types.ts:77](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/queue/types.ts#77)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/QueueStatus

# QueueStatus

Defined in: [src/lib/db/queue/types.ts:50](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/queue/types.ts#50)

Status of a wallet's queue.

## Properties

### failed

> **failed**: `number`

Defined in: [src/lib/db/queue/types.ts:54](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/queue/types.ts#54)

Number of operations that failed all retries

***

### isFlushing

> **isFlushing**: `boolean`

Defined in: [src/lib/db/queue/types.ts:56](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/queue/types.ts#56)

Whether the queue is currently being flushed

***

### isPaused

> **isPaused**: `boolean`

Defined in: [src/lib/db/queue/types.ts:58](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/queue/types.ts#58)

Whether the queue is paused (e.g., wallet disconnected)

***

### pending

> **pending**: `number`

Defined in: [src/lib/db/queue/types.ts:52](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/queue/types.ts#52)

Number of pending operations

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/RectProps

# RectProps

Defined in: [src/react/anumaRuntime.tsx:516](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#516)

## Extends

* `CommonProps`

## Properties

### alignSelf?

> `optional` **alignSelf**: `string`

Defined in: [src/react/anumaRuntime.tsx:169](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#169)

**Inherited from**

`CommonProps.alignSelf`

***

### children?

> `optional` **children**: `ReactNode`

Defined in: [src/react/anumaRuntime.tsx:281](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#281)

**Inherited from**

`CommonProps.children`

***

### cornerRadius?

> `optional` **cornerRadius**: `number`

Defined in: [src/react/anumaRuntime.tsx:520](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#520)

***

### fill?

> `optional` **fill**: `string`

Defined in: [src/react/anumaRuntime.tsx:517](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#517)

***

### grow?

> `optional` **grow**: `number`

Defined in: [src/react/anumaRuntime.tsx:167](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#167)

**Inherited from**

`CommonProps.grow`

***

### h?

> `optional` **h**: `number`

Defined in: [src/react/anumaRuntime.tsx:165](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#165)

**Inherited from**

`CommonProps.h`

***

### id?

> `optional` **id**: `string`

Defined in: [src/react/anumaRuntime.tsx:279](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#279)

**Inherited from**

`CommonProps.id`

***

### rotation?

> `optional` **rotation**: `number`

Defined in: [src/react/anumaRuntime.tsx:166](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#166)

**Inherited from**

`CommonProps.rotation`

***

### shrink?

> `optional` **shrink**: `number`

Defined in: [src/react/anumaRuntime.tsx:168](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#168)

**Inherited from**

`CommonProps.shrink`

***

### stroke?

> `optional` **stroke**: `string`

Defined in: [src/react/anumaRuntime.tsx:518](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#518)

***

### strokeWidth?

> `optional` **strokeWidth**: `number`

Defined in: [src/react/anumaRuntime.tsx:519](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#519)

***

### style?

> `optional` **style**: `CSSProperties`

Defined in: [src/react/anumaRuntime.tsx:280](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#280)

**Inherited from**

`CommonProps.style`

***

### w?

> `optional` **w**: `number`

Defined in: [src/react/anumaRuntime.tsx:164](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#164)

**Inherited from**

`CommonProps.w`

***

### x?

> `optional` **x**: `number`

Defined in: [src/react/anumaRuntime.tsx:162](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#162)

**Inherited from**

`CommonProps.x`

***

### y?

> `optional` **y**: `number`

Defined in: [src/react/anumaRuntime.tsx:163](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#163)

**Inherited from**

`CommonProps.y`

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/SavedToolOperationsContext

# SavedToolOperationsContext

Defined in: [src/lib/db/savedTools/operations.ts:8](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/savedTools/operations.ts#8)

Context required by saved tool operations.

## Properties

### database

> **database**: `Database`

Defined in: [src/lib/db/savedTools/operations.ts:9](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/savedTools/operations.ts#9)

***

### savedToolsCollection

> **savedToolsCollection**: `Collection`<[`SavedToolModel`](../classes/SavedToolModel.md)>

Defined in: [src/lib/db/savedTools/operations.ts:10](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/savedTools/operations.ts#10)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/SavedToolParameter

# SavedToolParameter

Defined in: [src/lib/db/savedTools/types.ts:9](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/savedTools/types.ts#9)

A single parameter definition within a saved tool.

## Properties

### defaultValue?

> `optional` **defaultValue**: `string`

Defined in: [src/lib/db/savedTools/types.ts:14](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/savedTools/types.ts#14)

The default value currently in the HTML — replaced with the LLM-provided value at invocation.

***

### description

> **description**: `string`

Defined in: [src/lib/db/savedTools/types.ts:11](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/savedTools/types.ts#11)

***

### required?

> `optional` **required**: `boolean`

Defined in: [src/lib/db/savedTools/types.ts:12](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/savedTools/types.ts#12)

***

### type

> **type**: `"string"` | `"number"` | `"boolean"`

Defined in: [src/lib/db/savedTools/types.ts:10](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/savedTools/types.ts#10)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/ScreenProps

# ScreenProps

Defined in: [src/react/anumaRuntime.tsx:412](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#412)

App-mockup screen container. Like Slide but with configurable
dimensions (width/height default to a mobile preset).

## Extends

* `CommonProps`.`ContainerLayoutProps`

## Properties

### align?

> `optional` **align**: `string`

Defined in: [src/react/anumaRuntime.tsx:177](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#177)

**Inherited from**

`ContainerLayoutProps.align`

***

### alignSelf?

> `optional` **alignSelf**: `string`

Defined in: [src/react/anumaRuntime.tsx:169](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#169)

**Inherited from**

`CommonProps.alignSelf`

***

### background?

> `optional` **background**: `string`

Defined in: [src/react/anumaRuntime.tsx:413](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#413)

***

### children?

> `optional` **children**: `ReactNode`

Defined in: [src/react/anumaRuntime.tsx:281](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#281)

**Inherited from**

`CommonProps.children`

***

### gap?

> `optional` **gap**: `number`

Defined in: [src/react/anumaRuntime.tsx:174](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#174)

**Inherited from**

`ContainerLayoutProps.gap`

***

### grow?

> `optional` **grow**: `number`

Defined in: [src/react/anumaRuntime.tsx:167](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#167)

**Inherited from**

`CommonProps.grow`

***

### h?

> `optional` **h**: `number`

Defined in: [src/react/anumaRuntime.tsx:165](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#165)

**Inherited from**

`CommonProps.h`

***

### height?

> `optional` **height**: `number`

Defined in: [src/react/anumaRuntime.tsx:415](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#415)

***

### id?

> `optional` **id**: `string`

Defined in: [src/react/anumaRuntime.tsx:279](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#279)

**Inherited from**

`CommonProps.id`

***

### justify?

> `optional` **justify**: `string`

Defined in: [src/react/anumaRuntime.tsx:176](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#176)

**Inherited from**

`ContainerLayoutProps.justify`

***

### layout?

> `optional` **layout**: `string`

Defined in: [src/react/anumaRuntime.tsx:173](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#173)

**Inherited from**

`ContainerLayoutProps.layout`

***

### padding?

> `optional` **padding**: `number`

Defined in: [src/react/anumaRuntime.tsx:175](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#175)

**Inherited from**

`ContainerLayoutProps.padding`

***

### rotation?

> `optional` **rotation**: `number`

Defined in: [src/react/anumaRuntime.tsx:166](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#166)

**Inherited from**

`CommonProps.rotation`

***

### shrink?

> `optional` **shrink**: `number`

Defined in: [src/react/anumaRuntime.tsx:168](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#168)

**Inherited from**

`CommonProps.shrink`

***

### style?

> `optional` **style**: `CSSProperties`

Defined in: [src/react/anumaRuntime.tsx:280](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#280)

**Inherited from**

`CommonProps.style`

***

### w?

> `optional` **w**: `number`

Defined in: [src/react/anumaRuntime.tsx:164](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#164)

**Inherited from**

`CommonProps.w`

***

### width?

> `optional` **width**: `number`

Defined in: [src/react/anumaRuntime.tsx:414](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#414)

***

### x?

> `optional` **x**: `number`

Defined in: [src/react/anumaRuntime.tsx:162](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#162)

**Inherited from**

`CommonProps.x`

***

### y?

> `optional` **y**: `number`

Defined in: [src/react/anumaRuntime.tsx:163](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#163)

**Inherited from**

`CommonProps.y`

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/SearchMessagesOptions

# SearchMessagesOptions

Defined in: [src/react/useChatStorage.ts:746](https://github.com/anuma-ai/sdk/blob/main/src/react/useChatStorage.ts#746)

Options for searching messages

## Properties

### conversationId?

> `optional` **conversationId**: `string`

Defined in: [src/react/useChatStorage.ts:752](https://github.com/anuma-ai/sdk/blob/main/src/react/useChatStorage.ts#752)

Filter by conversation ID

***

### limit?

> `optional` **limit**: `number`

Defined in: [src/react/useChatStorage.ts:748](https://github.com/anuma-ai/sdk/blob/main/src/react/useChatStorage.ts#748)

Limit the number of results (default: 10)

***

### minSimilarity?

> `optional` **minSimilarity**: `number`

Defined in: [src/react/useChatStorage.ts:750](https://github.com/anuma-ai/sdk/blob/main/src/react/useChatStorage.ts#750)

Minimum similarity threshold (default: 0.5)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/SearchSource

# SearchSource

Defined in: [src/lib/db/chat/types.ts:106](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#106)

## Properties

### date?

> `optional` **date**: `string`

Defined in: [src/lib/db/chat/types.ts:110](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#110)

***

### snippet?

> `optional` **snippet**: `string`

Defined in: [src/lib/db/chat/types.ts:109](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#109)

***

### title?

> `optional` **title**: `string`

Defined in: [src/lib/db/chat/types.ts:107](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#107)

***

### url?

> `optional` **url**: `string`

Defined in: [src/lib/db/chat/types.ts:108](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#108)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/SelectServerToolsForPromptOptions

# SelectServerToolsForPromptOptions

Defined in: [src/lib/tools/serverTools.ts:1131](https://github.com/anuma-ai/sdk/blob/main/src/lib/tools/serverTools.ts#1131)

Options for `selectServerToolsForPrompt`.

## Properties

### baseUrl?

> `optional` **baseUrl**: `string`

Defined in: [src/lib/tools/serverTools.ts:1144](https://github.com/anuma-ai/sdk/blob/main/src/lib/tools/serverTools.ts#1144)

Base URL for the API.

***

### cacheExpirationMs?

> `optional` **cacheExpirationMs**: `number`

Defined in: [src/lib/tools/serverTools.ts:1148](https://github.com/anuma-ai/sdk/blob/main/src/lib/tools/serverTools.ts#1148)

Cache expiration in ms for the server-tools catalog fetch.

***

### embeddingModel?

> `optional` **embeddingModel**: `string`

Defined in: [src/lib/tools/serverTools.ts:1146](https://github.com/anuma-ai/sdk/blob/main/src/lib/tools/serverTools.ts#1146)

Embedding model override. Falls back to the SDK default.

***

### getToken()

> **getToken**: () => `Promise`<`string` | `null`>

Defined in: [src/lib/tools/serverTools.ts:1142](https://github.com/anuma-ai/sdk/blob/main/src/lib/tools/serverTools.ts#1142)

Function that resolves an auth token (Bearer).

**Returns**

`Promise`<`string` | `null`>

***

### prompt

> **prompt**: `string`

Defined in: [src/lib/tools/serverTools.ts:1133](https://github.com/anuma-ai/sdk/blob/main/src/lib/tools/serverTools.ts#1133)

User prompt to match tools against.

***

### serverToolsFilter?

> `optional` **serverToolsFilter**: `string`\[] | [`ServerToolsFilterFunction`](../type-aliases/ServerToolsFilterFunction.md)

Defined in: [src/lib/tools/serverTools.ts:1140](https://github.com/anuma-ai/sdk/blob/main/src/lib/tools/serverTools.ts#1140)

Filter to apply: either a function (called with the prompt embedding +
full catalog) or a static list of tool names. Same shape `useChatStorage`
accepts on its `serverTools` option. Pass `defaultServerToolsFilter` to
mirror the default chat-flow selection.

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/SendMessageWithStorageArgs

# SendMessageWithStorageArgs

Defined in: [src/react/useChatStorage.ts:690](https://github.com/anuma-ai/sdk/blob/main/src/react/useChatStorage.ts#690)

Arguments for sendMessage with storage (React version)

Extends base arguments with headers and apiType support.

## Extends

* `BaseSendMessageWithStorageArgs`

## Properties

### apiType?

> `optional` **apiType**: `ApiType`

Defined in: [src/react/useChatStorage.ts:704](https://github.com/anuma-ai/sdk/blob/main/src/react/useChatStorage.ts#704)

Override the API type for this specific request.

* "responses": OpenAI Responses API (supports thinking, reasoning, conversations)
* "completions": OpenAI Chat Completions API (wider model compatibility)

Useful when different models need different APIs within the same hook instance.

***

### assistantUniqueId?

> `optional` **assistantUniqueId**: `string`

Defined in: [src/lib/db/chat/types.ts:736](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#736)

Pre-generated unique ID for the assistant response message.
When provided, the persisted assistant message will use this ID instead of
an auto-generated one. This lets the consumer show an in-flight streaming
placeholder under the same React key, avoiding an unmount/remount flash
when streaming completes and the message is loaded from the database.

**Inherited from**

`BaseSendMessageWithStorageArgs.assistantUniqueId`

***

### clientTools?

> `optional` **clientTools**: [`LlmapiChatCompletionTool`](../../../client/Internal/type-aliases/LlmapiChatCompletionTool.md)\[]

Defined in: [src/lib/db/chat/types.ts:646](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#646)

Client-side tools with optional executors.
These tools run in the browser/app and can have JavaScript executor functions.

**Inherited from**

`BaseSendMessageWithStorageArgs.clientTools`

***

### clientToolsFilter?

> `optional` **clientToolsFilter**: [`ClientToolsFilterFn`](../type-aliases/ClientToolsFilterFn.md)

Defined in: [src/lib/db/chat/types.ts:683](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#683)

Dynamic filter for client-side tools based on prompt embeddings.
Receives the prompt embedding(s) (or null for short messages) and all client tools,
returns tool names to include. Tools not in the returned list are excluded from the request.

**Example**

```ts
clientToolsFilter: (embeddings, tools) => {
  if (!embeddings) return []; // Short message — no client tools
  const matches = findMatchingTools(embeddings, pseudoServerTools);
  return matches.map(m => m.tool.name);
}
```

**Inherited from**

`BaseSendMessageWithStorageArgs.clientToolsFilter`

***

### conversationId?

> `optional` **conversationId**: `string`

Defined in: [src/react/useChatStorage.ts:712](https://github.com/anuma-ai/sdk/blob/main/src/react/useChatStorage.ts#712)

Explicitly specify the conversation ID to send this message to.
If provided, bypasses the automatic conversation detection/creation.
Useful when sending a message immediately after creating a conversation,
to avoid race conditions with React state updates.

***

### fileContext?

> `optional` **fileContext**: `string`

Defined in: [src/lib/db/chat/types.ts:601](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#601)

Additional context from preprocessed file attachments.
Contains extracted text from Excel, Word, PDF, and other document files.
Injected as a system message so it's available throughout the conversation.

**Inherited from**

`BaseSendMessageWithStorageArgs.fileContext`

***

### files?

> `optional` **files**: [`FileMetadata`](FileMetadata.md)\[]

Defined in: [src/lib/db/chat/types.ts:575](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#575)

File attachments to include with the message (images, documents, etc.).
Files with image MIME types and URLs are sent as image content parts.
File metadata is stored with the message (URLs are stripped if they're data URIs).

**Inherited from**

`BaseSendMessageWithStorageArgs.files`

***

### getThoughtProcess()?

> `optional` **getThoughtProcess**: () => `ActivityPhase`\[]

Defined in: [src/lib/db/chat/types.ts:626](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#626)

Callback to get activity phases AFTER streaming completes.
Use this instead of `thoughtProcess` when phases are added dynamically during streaming
(e.g., via server tool call events like "Searching...", "Generating image...").

If both `thoughtProcess` and `getThoughtProcess` are provided, `getThoughtProcess` takes precedence.

**Returns**

`ActivityPhase`\[]

**Inherited from**

`BaseSendMessageWithStorageArgs.getThoughtProcess`

***

### headers?

> `optional` **headers**: `Record`<`string`, `string`>

Defined in: [src/react/useChatStorage.ts:695](https://github.com/anuma-ai/sdk/blob/main/src/react/useChatStorage.ts#695)

Custom HTTP headers to include with the API request.
Useful for passing additional authentication, tracking, or feature flags.

***

### imageModel?

> `optional` **imageModel**: `string`

Defined in: [src/lib/db/chat/types.ts:717](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#717)

User-selected image generation model for server-side enforcement.

**Inherited from**

`BaseSendMessageWithStorageArgs.imageModel`

***

### includeHistory?

> `optional` **includeHistory**: `boolean`

Defined in: [src/lib/db/chat/types.ts:510](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#510)

Whether to automatically include previous messages from the conversation as context.
When true, fetches stored messages and prepends them to the request.
Ignored if `messages` is provided.

**Default**

```ts
true
```

**Inherited from**

`BaseSendMessageWithStorageArgs.includeHistory`

***

### maxHistoryMessages?

> `optional` **maxHistoryMessages**: `number`

Defined in: [src/lib/db/chat/types.ts:517](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#517)

Maximum number of historical messages to include when `includeHistory` is true.
Only the most recent N messages are included to manage context window size.

**Default**

```ts
50
```

**Inherited from**

`BaseSendMessageWithStorageArgs.maxHistoryMessages`

***

### maxOutputTokens?

> `optional` **maxOutputTokens**: `number`

Defined in: [src/lib/db/chat/types.ts:640](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#640)

Maximum number of tokens to generate in the response.
Use this to limit response length and control costs.

**Inherited from**

`BaseSendMessageWithStorageArgs.maxOutputTokens`

***

### maxToolRounds?

> `optional` **maxToolRounds**: `number`

Defined in: [src/lib/db/chat/types.ts:701](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#701)

Maximum number of tool execution rounds before forcing the model to respond with text.
After this many rounds, `toolChoice` is set to `"none"` on the next continuation,
so the model produces a text answer using whatever tool results it has gathered.

**Default**

```ts
3
```

**Inherited from**

`BaseSendMessageWithStorageArgs.maxToolRounds`

***

### memoryContext?

> `optional` **memoryContext**: `string`

Defined in: [src/lib/db/chat/types.ts:588](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#588)

Additional context from memory/RAG system to include in the request.
Typically contains retrieved relevant information from past conversations.

**Inherited from**

`BaseSendMessageWithStorageArgs.memoryContext`

***

### messages

> **messages**: [`LlmapiMessage`](../../../client/Internal/type-aliases/LlmapiMessage.md)\[]

Defined in: [src/lib/db/chat/types.ts:470](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#470)

The message array to send to the AI.

Uses the modern array format that supports multimodal content (text, images, files).
The last user message in this array will be extracted and stored in the database.

When `includeHistory` is true (default), conversation history is prepended.
When `includeHistory` is false, only these messages are sent.

**Example**

```ts
// Simple usage
sendMessage({
  messages: [
    { role: "user", content: [{ type: "text", text: "Hello!" }] }
  ]
})

// With system prompt and history disabled
sendMessage({
  messages: [
    { role: "system", content: [{ type: "text", text: "You are helpful" }] },
    { role: "user", content: [{ type: "text", text: "Question" }] },
  ],
  includeHistory: false
})

// With images
sendMessage({
  messages: [
    { role: "user", content: [
      { type: "text", text: "What's in this image?" },
      { type: "image_url", image_url: { url: "data:image/png;base64,..." } }
    ]}
  ]
})
```

**Inherited from**

`BaseSendMessageWithStorageArgs.messages`

***

### model?

> `optional` **model**: `string`

Defined in: [src/lib/db/chat/types.ts:476](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#476)

The model identifier to use for this request (e.g., "fireworks/accounts/fireworks/models/kimi-k2p5").
If not specified, uses the default model configured on the server.

**Inherited from**

`BaseSendMessageWithStorageArgs.model`

***

### onData()?

> `optional` **onData**: (`chunk`: `string`) => `void`

Defined in: [src/lib/db/chat/types.ts:582](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#582)

Per-request callback invoked with each streamed response chunk.
Overrides the hook-level `onData` callback for this request only.
Use this to update UI as the response streams in.

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`chunk`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

**Inherited from**

`BaseSendMessageWithStorageArgs.onData`

***

### onThinking()?

> `optional` **onThinking**: (`chunk`: `string`) => `void`

Defined in: [src/lib/db/chat/types.ts:724](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#724)

Per-request callback for thinking/reasoning chunks.
Called with delta chunks as the model "thinks" through a problem.
Use this to display thinking progress in the UI.

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`chunk`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

**Inherited from**

`BaseSendMessageWithStorageArgs.onThinking`

***

### parentMessageId?

> `optional` **parentMessageId**: `string`

Defined in: [src/lib/db/chat/types.ts:727](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#727)

Parent message ID for branching (edit/regenerate). Sets on the user message.

**Inherited from**

`BaseSendMessageWithStorageArgs.parentMessageId`

***

### reasoning?

> `optional` **reasoning**: [`LlmapiResponseReasoning`](../../../client/Internal/type-aliases/LlmapiResponseReasoning.md)

Defined in: [src/lib/db/chat/types.ts:707](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#707)

Reasoning configuration for o-series and other reasoning models.
Controls reasoning effort level and whether to include reasoning summary.

**Inherited from**

`BaseSendMessageWithStorageArgs.reasoning`

***

### searchContext?

> `optional` **searchContext**: `string`

Defined in: [src/lib/db/chat/types.ts:594](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#594)

Additional context from search results to include in the request.
Typically contains relevant information from web or document searches.

**Inherited from**

`BaseSendMessageWithStorageArgs.searchContext`

***

### serverTools?

> `optional` **serverTools**: [`ServerToolsFilter`](../type-aliases/ServerToolsFilter.md)

Defined in: [src/lib/db/chat/types.ts:669](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#669)

Server-side tools to include from /api/v1/tools.

* undefined: Include all server-side tools (default)
* string\[]: Include only tools with these names
* \[]: Include no server-side tools
* function: Dynamic filter that receives prompt embedding(s) and all tools,
  returns tool names to include. Useful for semantic tool matching.

**Example**

```ts
// Include only specific server tools
serverTools: ["generate_cloud_image", "perplexity_search"]

// Disable server tools for this request
serverTools: []

// Semantic tool matching based on prompt
serverTools: (embeddings, tools) => {
  const matches = findMatchingTools(embeddings, tools, { limit: 5 });
  return matches.map(m => m.tool.name);
}
```

**Inherited from**

`BaseSendMessageWithStorageArgs.serverTools`

***

### skipStorage?

> `optional` **skipStorage**: `boolean`

Defined in: [src/lib/db/chat/types.ts:502](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#502)

Skip all storage operations (conversation, messages, embeddings, media).
Use this for one-off tasks like title generation where you don't want
to pollute the database with utility messages.

When true:

* No conversation is created or required
* Messages are not stored in the database
* No embeddings are generated
* No media/files are processed for storage
* Result will not include userMessage or assistantMessage

**Default**

```ts
false
```

**Example**

```ts
// Generate a title without storing anything
const { data } = await sendMessage({
  messages: [{ role: "user", content: [{ type: "text", text: "Generate a title for: ..." }] }],
  skipStorage: true,
  includeHistory: false,
});
```

**Inherited from**

`BaseSendMessageWithStorageArgs.skipStorage`

***

### sources?

> `optional` **sources**: [`SearchSource`](SearchSource.md)\[]

Defined in: [src/lib/db/chat/types.ts:607](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#607)

Search sources to attach to the stored message for citation/reference.
Note: Sources are also automatically extracted from tool\_call\_events in the response.

**Inherited from**

`BaseSendMessageWithStorageArgs.sources`

***

### summarizeHistory?

> `optional` **summarizeHistory**: `boolean`

Defined in: [src/lib/db/chat/types.ts:531](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#531)

Enable progressive summarization of conversation history.

When enabled, older messages are summarized into a compact text using a cheap
model, while recent messages are kept verbatim. This reduces input tokens by
50-70% for long conversations.

Requires `includeHistory` to be true (default). When `includeHistory` is false
or `summarizeHistory` is false, all history is sent verbatim (current behavior).

**Default**

```ts
false
```

**Inherited from**

`BaseSendMessageWithStorageArgs.summarizeHistory`

***

### summaryMinWindowMessages?

> `optional` **summaryMinWindowMessages**: `number`

Defined in: [src/lib/db/chat/types.ts:560](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#560)

Minimum number of recent messages to always keep verbatim (never summarized).
Ensures the LLM always has immediate conversational context.
Even if these messages exceed the token threshold, they are kept.

**Default**

```ts
4 (2 user-assistant turns)
```

**Inherited from**

`BaseSendMessageWithStorageArgs.summaryMinWindowMessages`

***

### summaryModel?

> `optional` **summaryModel**: `string`

Defined in: [src/lib/db/chat/types.ts:568](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#568)

Model to use for generating conversation summaries.
Should be a cheap, fast model since summarization is a straightforward task.

**Default**

```ts
'cerebras/qwen-3-235b-a22b-instruct-2507' ($0.60/1M input tokens)
```

**Inherited from**

`BaseSendMessageWithStorageArgs.summaryModel`

***

### summaryTokenThreshold?

> `optional` **summaryTokenThreshold**: `number`

Defined in: [src/lib/db/chat/types.ts:551](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#551)

Token threshold for conversation history before summarization triggers.

When the total token count of the cached summary + unsummarized messages
exceeds this value, older messages are summarized to fit within the budget.

How to choose a value:

* Lower (2000-3000): aggressive summarization, lowest cost, less verbatim context.
* Default (4000): balanced — keeps history under ~$0.01/message at typical pricing
  ($2.50/1M tokens). Triggers for most conversations after 5-10 turns.
* Higher (8000-16000): less frequent summarization, more context, higher cost.
  Good for code review or legal conversations needing precise recall.

The fixed overhead (system prompt + tools + memory ≈ 3,500 tokens) is NOT
included — it is additive. Total input ≈ overhead + threshold + current message.

**Default**

```ts
4000
```

**Inherited from**

`BaseSendMessageWithStorageArgs.summaryTokenThreshold`

***

### temperature?

> `optional` **temperature**: `number`

Defined in: [src/lib/db/chat/types.ts:634](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#634)

Controls randomness in the response (0.0 to 2.0).
Lower values make output more deterministic, higher values more creative.

**Inherited from**

`BaseSendMessageWithStorageArgs.temperature`

***

### thinking?

> `optional` **thinking**: [`LlmapiThinkingOptions`](../../../client/Internal/type-aliases/LlmapiThinkingOptions.md)

Defined in: [src/lib/db/chat/types.ts:714](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#714)

Extended thinking configuration for Anthropic models (Claude).
Enables the model to think through complex problems step by step
before generating the final response.

**Inherited from**

`BaseSendMessageWithStorageArgs.thinking`

***

### thoughtProcess?

> `optional` **thoughtProcess**: `ActivityPhase`\[]

Defined in: [src/lib/db/chat/types.ts:617](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#617)

Activity phases for tracking the request lifecycle in the UI.
Each phase represents a step like "Searching", "Thinking", "Generating".
The final phase is automatically marked as completed when stored.

Note: If you need activity phases that are added during streaming (e.g., server tool calls),
use `getThoughtProcess` callback instead, which captures phases AFTER streaming completes.

**Inherited from**

`BaseSendMessageWithStorageArgs.thoughtProcess`

***

### toolChoice?

> `optional` **toolChoice**: `string`

Defined in: [src/lib/db/chat/types.ts:693](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#693)

Controls which tool the model should use:

* "auto": Model decides whether to use a tool (default)
* "any": Model must use one of the provided tools
* "none": Model cannot use any tools
* "required": Model must use a tool
* Specific tool name: Model must use that specific tool

**Inherited from**

`BaseSendMessageWithStorageArgs.toolChoice`

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/ServerTool

# ServerTool

Defined in: [src/lib/tools/serverTools.ts:65](https://github.com/anuma-ai/sdk/blob/main/src/lib/tools/serverTools.ts#65)

Server tool definition with parameters field.
This is the neutral format stored in cache.
Strategies transform this to the correct API format.

## Properties

### description

> **description**: `string`

Defined in: [src/lib/tools/serverTools.ts:68](https://github.com/anuma-ai/sdk/blob/main/src/lib/tools/serverTools.ts#68)

***

### embedding?

> `optional` **embedding**: `number`\[]

Defined in: [src/lib/tools/serverTools.ts:75](https://github.com/anuma-ai/sdk/blob/main/src/lib/tools/serverTools.ts#75)

Optional embedding vector for semantic matching

***

### name

> **name**: `string`

Defined in: [src/lib/tools/serverTools.ts:67](https://github.com/anuma-ai/sdk/blob/main/src/lib/tools/serverTools.ts#67)

***

### parameters

> **parameters**: `object`

Defined in: [src/lib/tools/serverTools.ts:69](https://github.com/anuma-ai/sdk/blob/main/src/lib/tools/serverTools.ts#69)

**properties**

> **properties**: `Record`<`string`, `unknown`>

**required**

> **required**: `string`\[]

**type**

> **type**: `string`

***

### type

> **type**: `"function"`

Defined in: [src/lib/tools/serverTools.ts:66](https://github.com/anuma-ai/sdk/blob/main/src/lib/tools/serverTools.ts#66)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/ServerToolsOptions

# ServerToolsOptions

Defined in: [src/lib/tools/serverTools.ts:92](https://github.com/anuma-ai/sdk/blob/main/src/lib/tools/serverTools.ts#92)

Options for fetching server tools

## Properties

### apiKey?

> `optional` **apiKey**: `string`

Defined in: [src/lib/tools/serverTools.ts:102](https://github.com/anuma-ai/sdk/blob/main/src/lib/tools/serverTools.ts#102)

Direct API key for server-side usage (uses X-API-Key header)

***

### baseUrl?

> `optional` **baseUrl**: `string`

Defined in: [src/lib/tools/serverTools.ts:94](https://github.com/anuma-ai/sdk/blob/main/src/lib/tools/serverTools.ts#94)

Base URL for the API (defaults to BASE\_URL from clientConfig)

***

### cacheExpirationMs?

> `optional` **cacheExpirationMs**: `number`

Defined in: [src/lib/tools/serverTools.ts:96](https://github.com/anuma-ai/sdk/blob/main/src/lib/tools/serverTools.ts#96)

Cache expiration time in milliseconds (default: 5 minutes)

***

### forceRefresh?

> `optional` **forceRefresh**: `boolean`

Defined in: [src/lib/tools/serverTools.ts:98](https://github.com/anuma-ai/sdk/blob/main/src/lib/tools/serverTools.ts#98)

Force refresh even if cache is valid

***

### getToken()?

> `optional` **getToken**: () => `Promise`<`string` | `null`>

Defined in: [src/lib/tools/serverTools.ts:100](https://github.com/anuma-ai/sdk/blob/main/src/lib/tools/serverTools.ts#100)

Authentication token getter (uses Authorization: Bearer header)

**Returns**

`Promise`<`string` | `null`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/SignMessageOptions

# SignMessageOptions

Defined in: [src/react/useEncryption.ts:829](https://github.com/anuma-ai/sdk/blob/main/src/react/useEncryption.ts#829)

Options for signing messages.

## Properties

### showWalletUIs?

> `optional` **showWalletUIs**: `boolean`

Defined in: [src/react/useEncryption.ts:831](https://github.com/anuma-ai/sdk/blob/main/src/react/useEncryption.ts#831)

Whether to show wallet UI during signing. Default: true

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/SlideProps

# SlideProps

Defined in: [src/react/anumaRuntime.tsx:331](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#331)

A 960×540 slide canvas. Positioned children with `x`/`y`/`w`/`h` get
absolute positioning automatically. Opt into flex layout via
`layout="row" | "column"`.

## Extends

* `CommonProps`.`ContainerLayoutProps`

## Properties

### align?

> `optional` **align**: `string`

Defined in: [src/react/anumaRuntime.tsx:177](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#177)

**Inherited from**

`ContainerLayoutProps.align`

***

### alignSelf?

> `optional` **alignSelf**: `string`

Defined in: [src/react/anumaRuntime.tsx:169](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#169)

**Inherited from**

`CommonProps.alignSelf`

***

### background?

> `optional` **background**: `string`

Defined in: [src/react/anumaRuntime.tsx:332](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#332)

***

### children?

> `optional` **children**: `ReactNode`

Defined in: [src/react/anumaRuntime.tsx:281](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#281)

**Inherited from**

`CommonProps.children`

***

### gap?

> `optional` **gap**: `number`

Defined in: [src/react/anumaRuntime.tsx:174](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#174)

**Inherited from**

`ContainerLayoutProps.gap`

***

### grow?

> `optional` **grow**: `number`

Defined in: [src/react/anumaRuntime.tsx:167](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#167)

**Inherited from**

`CommonProps.grow`

***

### h?

> `optional` **h**: `number`

Defined in: [src/react/anumaRuntime.tsx:165](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#165)

**Inherited from**

`CommonProps.h`

***

### id?

> `optional` **id**: `string`

Defined in: [src/react/anumaRuntime.tsx:279](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#279)

**Inherited from**

`CommonProps.id`

***

### justify?

> `optional` **justify**: `string`

Defined in: [src/react/anumaRuntime.tsx:176](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#176)

**Inherited from**

`ContainerLayoutProps.justify`

***

### layout?

> `optional` **layout**: `string`

Defined in: [src/react/anumaRuntime.tsx:173](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#173)

**Inherited from**

`ContainerLayoutProps.layout`

***

### padding?

> `optional` **padding**: `number`

Defined in: [src/react/anumaRuntime.tsx:175](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#175)

**Inherited from**

`ContainerLayoutProps.padding`

***

### rotation?

> `optional` **rotation**: `number`

Defined in: [src/react/anumaRuntime.tsx:166](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#166)

**Inherited from**

`CommonProps.rotation`

***

### shrink?

> `optional` **shrink**: `number`

Defined in: [src/react/anumaRuntime.tsx:168](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#168)

**Inherited from**

`CommonProps.shrink`

***

### style?

> `optional` **style**: `CSSProperties`

Defined in: [src/react/anumaRuntime.tsx:280](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#280)

**Inherited from**

`CommonProps.style`

***

### w?

> `optional` **w**: `number`

Defined in: [src/react/anumaRuntime.tsx:164](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#164)

**Inherited from**

`CommonProps.w`

***

### x?

> `optional` **x**: `number`

Defined in: [src/react/anumaRuntime.tsx:162](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#162)

**Inherited from**

`CommonProps.x`

***

### y?

> `optional` **y**: `number`

Defined in: [src/react/anumaRuntime.tsx:163](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#163)

**Inherited from**

`CommonProps.y`

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/StorageOperationsContext

# StorageOperationsContext

Defined in: [src/lib/db/chat/operations.ts:139](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/operations.ts#139)

## Properties

### conversationsCollection

> **conversationsCollection**: `Collection`<[`ChatConversation`](../classes/ChatConversation.md)>

Defined in: [src/lib/db/chat/operations.ts:142](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/operations.ts#142)

***

### database

> **database**: `Database`

Defined in: [src/lib/db/chat/operations.ts:140](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/operations.ts#140)

***

### embeddedWalletSigner?

> `optional` **embeddedWalletSigner**: [`EmbeddedWalletSignerFn`](../type-aliases/EmbeddedWalletSignerFn.md)

Defined in: [src/lib/db/chat/operations.ts:148](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/operations.ts#148)

Function for silent signing with embedded wallets

***

### messagesCollection

> **messagesCollection**: `Collection`<[`ChatMessage`](../classes/ChatMessage.md)>

Defined in: [src/lib/db/chat/operations.ts:141](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/operations.ts#141)

***

### signMessage?

> `optional` **signMessage**: [`SignMessageFn`](../type-aliases/SignMessageFn.md)

Defined in: [src/lib/db/chat/operations.ts:146](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/operations.ts#146)

Function to sign a message for encryption key derivation

***

### walletAddress?

> `optional` **walletAddress**: `string`

Defined in: [src/lib/db/chat/operations.ts:144](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/operations.ts#144)

Wallet address for encryption (optional - when present, enables field-level encryption)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/StoredAppFile

# StoredAppFile

Defined in: [src/lib/db/appFiles/types.ts:9](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/appFiles/types.ts#9)

Plain object representation of an app file record.

## Properties

### content

> **content**: `string`

Defined in: [src/lib/db/appFiles/types.ts:17](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/appFiles/types.ts#17)

File content (UTF-8 text)

***

### conversationId

> **conversationId**: `string`

Defined in: [src/lib/db/appFiles/types.ts:13](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/appFiles/types.ts#13)

The conversation this file belongs to

***

### createdAt

> **createdAt**: `Date`

Defined in: [src/lib/db/appFiles/types.ts:18](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/appFiles/types.ts#18)

***

### path

> **path**: `string`

Defined in: [src/lib/db/appFiles/types.ts:15](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/appFiles/types.ts#15)

Normalized file path, no leading slash (e.g. "index.html", "src/App.tsx")

***

### uniqueId

> **uniqueId**: `string`

Defined in: [src/lib/db/appFiles/types.ts:11](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/appFiles/types.ts#11)

WatermelonDB internal ID

***

### updatedAt

> **updatedAt**: `Date`

Defined in: [src/lib/db/appFiles/types.ts:19](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/appFiles/types.ts#19)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/StoredChatCompletionUsage

# StoredChatCompletionUsage

Defined in: [src/lib/db/chat/types.ts:98](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#98)

## Properties

### completionTokens?

> `optional` **completionTokens**: `number`

Defined in: [src/lib/db/chat/types.ts:100](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#100)

***

### costMicroUsd?

> `optional` **costMicroUsd**: `number`

Defined in: [src/lib/db/chat/types.ts:102](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#102)

***

### creditsUsed?

> `optional` **creditsUsed**: `number`

Defined in: [src/lib/db/chat/types.ts:103](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#103)

***

### promptTokens?

> `optional` **promptTokens**: `number`

Defined in: [src/lib/db/chat/types.ts:99](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#99)

***

### totalTokens?

> `optional` **totalTokens**: `number`

Defined in: [src/lib/db/chat/types.ts:101](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#101)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/StoredConversation

# StoredConversation

Defined in: [src/lib/db/chat/types.ts:157](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#157)

## Properties

### conversationId

> **conversationId**: `string`

Defined in: [src/lib/db/chat/types.ts:159](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#159)

***

### createdAt

> **createdAt**: `Date`

Defined in: [src/lib/db/chat/types.ts:163](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#163)

***

### isDeleted

> **isDeleted**: `boolean`

Defined in: [src/lib/db/chat/types.ts:165](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#165)

***

### projectId?

> `optional` **projectId**: `string`

Defined in: [src/lib/db/chat/types.ts:162](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#162)

Optional project ID this conversation belongs to

***

### title

> **title**: `string`

Defined in: [src/lib/db/chat/types.ts:160](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#160)

***

### uniqueId

> **uniqueId**: `string`

Defined in: [src/lib/db/chat/types.ts:158](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#158)

***

### updatedAt

> **updatedAt**: `Date`

Defined in: [src/lib/db/chat/types.ts:164](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#164)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/StoredFileWithContext

# StoredFileWithContext

Defined in: [src/lib/db/chat/types.ts:248](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#248)

File metadata with conversation context for file browsing.
Extends FileMetadata with information about where the file was used.

## Extends

* [`FileMetadata`](FileMetadata.md)

## Properties

### conversationId

> **conversationId**: `string`

Defined in: [src/lib/db/chat/types.ts:250](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#250)

ID of the conversation where this file was attached

***

### createdAt

> **createdAt**: `Date`

Defined in: [src/lib/db/chat/types.ts:252](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#252)

Timestamp when the file was stored (from the message)

***

### id

> **id**: `string`

Defined in: [src/lib/db/chat/types.ts:73](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#73)

Unique identifier for the file (used as OPFS key for cached files)

**Inherited from**

[`FileMetadata`](FileMetadata.md).[`id`](FileMetadata.md#id)

***

### messageRole

> **messageRole**: [`ChatRole`](../type-aliases/ChatRole.md)

Defined in: [src/lib/db/chat/types.ts:254](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#254)

Role of the message that contains this file

***

### name

> **name**: `string`

Defined in: [src/lib/db/chat/types.ts:75](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#75)

Display name of the file

**Inherited from**

[`FileMetadata`](FileMetadata.md).[`name`](FileMetadata.md#name)

***

### size

> **size**: `number`

Defined in: [src/lib/db/chat/types.ts:79](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#79)

File size in bytes

**Inherited from**

[`FileMetadata`](FileMetadata.md).[`size`](FileMetadata.md#size)

***

### sourceUrl?

> `optional` **sourceUrl**: `string`

Defined in: [src/lib/db/chat/types.ts:95](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#95)

Original external URL for files downloaded and cached locally (e.g., from MCP R2).
Used purely for URL→OPFS mapping to enable fallback when the source returns 404.

This is metadata for local lookup only - it is NOT sent to the AI or rendered directly.
The file content is served from OPFS using the `id` field.

**Inherited from**

[`FileMetadata`](FileMetadata.md).[`sourceUrl`](FileMetadata.md#sourceurl)

***

### type

> **type**: `string`

Defined in: [src/lib/db/chat/types.ts:77](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#77)

MIME type (e.g., "image/png")

**Inherited from**

[`FileMetadata`](FileMetadata.md).[`type`](FileMetadata.md#type)

***

### url?

> `optional` **url**: `string`

Defined in: [src/lib/db/chat/types.ts:87](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#87)

Content URL to include when sending this message to the AI.
When present, this URL is added as an `image_url` content part.
Typically used for user-uploaded files (data URIs) that should be sent with the message.

NOT used for MCP-cached files - those use `sourceUrl` for lookup and render from OPFS.

**Inherited from**

[`FileMetadata`](FileMetadata.md).[`url`](FileMetadata.md#url)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/StoredMedia

# StoredMedia

Defined in: [src/lib/db/media/types.ts:58](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#58)

Stored media record as returned from the database.

## Properties

### conversationId?

> `optional` **conversationId**: `string`

Defined in: [src/lib/db/media/types.ts:68](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#68)

Associated conversation ID (for quick filtering)

***

### createdAt

> **createdAt**: `Date`

Defined in: [src/lib/db/media/types.ts:98](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#98)

***

### dimensions?

> `optional` **dimensions**: [`MediaDimensions`](MediaDimensions.md)

Defined in: [src/lib/db/media/types.ts:91](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#91)

Dimensions for images/videos

***

### duration?

> `optional` **duration**: `number`

Defined in: [src/lib/db/media/types.ts:93](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#93)

Duration in seconds for video/audio

***

### id

> **id**: `string`

Defined in: [src/lib/db/media/types.ts:60](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#60)

WatermelonDB record ID

***

### isDeleted

> **isDeleted**: `boolean`

Defined in: [src/lib/db/media/types.ts:102](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#102)

***

### mediaId

> **mediaId**: `string`

Defined in: [src/lib/db/media/types.ts:62](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#62)

Unique media ID (used as OPFS key)

***

### mediaType

> **mediaType**: [`MediaType`](../type-aliases/MediaType.md)

Defined in: [src/lib/db/media/types.ts:76](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#76)

Categorized media type for filtering

***

### messageId?

> `optional` **messageId**: `string`

Defined in: [src/lib/db/media/types.ts:66](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#66)

Associated message ID (if attached to a message)

***

### metadata?

> `optional` **metadata**: [`MediaMetadata`](MediaMetadata.md)

Defined in: [src/lib/db/media/types.ts:95](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#95)

Additional metadata

***

### mimeType

> **mimeType**: `string`

Defined in: [src/lib/db/media/types.ts:74](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#74)

MIME type (e.g., "image/png", "video/mp4")

***

### model?

> `optional` **model**: `string`

Defined in: [src/lib/db/media/types.ts:84](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#84)

AI model used for generation (if AI-generated)

***

### name

> **name**: `string`

Defined in: [src/lib/db/media/types.ts:72](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#72)

Display name of the file

***

### role

> **role**: [`MediaRole`](../type-aliases/MediaRole.md)

Defined in: [src/lib/db/media/types.ts:82](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#82)

Role of who attached this media

***

### size

> **size**: `number`

Defined in: [src/lib/db/media/types.ts:78](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#78)

File size in bytes

***

### sourceUrl?

> `optional` **sourceUrl**: `string`

Defined in: [src/lib/db/media/types.ts:87](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#87)

Original external URL for cached files (MCP R2, etc.)

***

### updatedAt

> **updatedAt**: `Date`

Defined in: [src/lib/db/media/types.ts:99](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#99)

***

### walletAddress

> **walletAddress**: `string`

Defined in: [src/lib/db/media/types.ts:64](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#64)

Wallet address of the user who owns this media

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/StoredMessage

# StoredMessage

Defined in: [src/lib/db/chat/types.ts:113](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#113)

## Extended by

* [`StoredMessageWithSimilarity`](StoredMessageWithSimilarity.md)

## Properties

### chunks?

> `optional` **chunks**: [`MessageChunk`](MessageChunk.md)\[]

Defined in: [src/lib/db/chat/types.ts:131](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#131)

Chunks of this message with individual embeddings for fine-grained search

***

### content

> **content**: `string`

Defined in: [src/lib/db/chat/types.ts:118](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#118)

***

### conversationId

> **conversationId**: `string`

Defined in: [src/lib/db/chat/types.ts:116](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#116)

***

### createdAt

> **createdAt**: `Date`

Defined in: [src/lib/db/chat/types.ts:126](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#126)

***

### embeddingModel?

> `optional` **embeddingModel**: `string`

Defined in: [src/lib/db/chat/types.ts:129](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#129)

***

### error?

> `optional` **error**: `string`

Defined in: [src/lib/db/chat/types.ts:137](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#137)

If set, indicates the message failed with this error

***

### feedback?

> `optional` **feedback**: [`MessageFeedback`](../type-aliases/MessageFeedback.md)

Defined in: [src/lib/db/chat/types.ts:144](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#144)

User feedback: 'like', 'dislike', or null for no feedback

***

### fileIds?

> `optional` **fileIds**: `string`\[]

Defined in: [src/lib/db/chat/types.ts:125](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#125)

Array of media\_id references for direct lookup in media table

***

### ~~files?~~

> `optional` **files**: [`FileMetadata`](FileMetadata.md)\[]

Defined in: [src/lib/db/chat/types.ts:123](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#123)

**Deprecated**

Use fileIds with media table instead

***

### imageModel?

> `optional` **imageModel**: `string`

Defined in: [src/lib/db/chat/types.ts:121](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#121)

Image generation model used for this message (e.g., "nano-banana-flash")

***

### messageId

> **messageId**: `number`

Defined in: [src/lib/db/chat/types.ts:115](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#115)

***

### model?

> `optional` **model**: `string`

Defined in: [src/lib/db/chat/types.ts:119](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#119)

***

### parentMessageId?

> `optional` **parentMessageId**: `string`

Defined in: [src/lib/db/chat/types.ts:142](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#142)

Parent message ID for branching (edit/regenerate). Null for root messages.

***

### responseDuration?

> `optional` **responseDuration**: `number`

Defined in: [src/lib/db/chat/types.ts:134](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#134)

***

### role

> **role**: [`ChatRole`](../type-aliases/ChatRole.md)

Defined in: [src/lib/db/chat/types.ts:117](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#117)

***

### sources?

> `optional` **sources**: [`SearchSource`](SearchSource.md)\[]

Defined in: [src/lib/db/chat/types.ts:133](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#133)

***

### thinking?

> `optional` **thinking**: `string`

Defined in: [src/lib/db/chat/types.ts:140](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#140)

Reasoning/thinking content from models that support extended thinking

***

### thoughtProcess?

> `optional` **thoughtProcess**: `ActivityPhase`\[]

Defined in: [src/lib/db/chat/types.ts:138](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#138)

***

### toolCallEvents?

> `optional` **toolCallEvents**: [`LlmapiToolCallEvent`](../../../client/Internal/type-aliases/LlmapiToolCallEvent.md)\[]

Defined in: [src/lib/db/chat/types.ts:146](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#146)

Tool call events from the backend response (for reconstructing tool call history)

***

### uniqueId

> **uniqueId**: `string`

Defined in: [src/lib/db/chat/types.ts:114](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#114)

***

### updatedAt

> **updatedAt**: `Date`

Defined in: [src/lib/db/chat/types.ts:127](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#127)

***

### usage?

> `optional` **usage**: [`StoredChatCompletionUsage`](StoredChatCompletionUsage.md)

Defined in: [src/lib/db/chat/types.ts:132](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#132)

***

### vector?

> `optional` **vector**: `number`\[]

Defined in: [src/lib/db/chat/types.ts:128](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#128)

***

### wasStopped?

> `optional` **wasStopped**: `boolean`

Defined in: [src/lib/db/chat/types.ts:135](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#135)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/StoredMessageWithSimilarity

# StoredMessageWithSimilarity

Defined in: [src/lib/db/chat/types.ts:192](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#192)

## Extends

* [`StoredMessage`](StoredMessage.md)

## Properties

### chunks?

> `optional` **chunks**: [`MessageChunk`](MessageChunk.md)\[]

Defined in: [src/lib/db/chat/types.ts:131](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#131)

Chunks of this message with individual embeddings for fine-grained search

**Inherited from**

[`StoredMessage`](StoredMessage.md).[`chunks`](StoredMessage.md#chunks)

***

### content

> **content**: `string`

Defined in: [src/lib/db/chat/types.ts:118](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#118)

**Inherited from**

[`StoredMessage`](StoredMessage.md).[`content`](StoredMessage.md#content)

***

### conversationId

> **conversationId**: `string`

Defined in: [src/lib/db/chat/types.ts:116](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#116)

**Inherited from**

[`StoredMessage`](StoredMessage.md).[`conversationId`](StoredMessage.md#conversationid)

***

### createdAt

> **createdAt**: `Date`

Defined in: [src/lib/db/chat/types.ts:126](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#126)

**Inherited from**

[`StoredMessage`](StoredMessage.md).[`createdAt`](StoredMessage.md#createdat)

***

### embeddingModel?

> `optional` **embeddingModel**: `string`

Defined in: [src/lib/db/chat/types.ts:129](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#129)

**Inherited from**

[`StoredMessage`](StoredMessage.md).[`embeddingModel`](StoredMessage.md#embeddingmodel)

***

### error?

> `optional` **error**: `string`

Defined in: [src/lib/db/chat/types.ts:137](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#137)

If set, indicates the message failed with this error

**Inherited from**

[`StoredMessage`](StoredMessage.md).[`error`](StoredMessage.md#error)

***

### feedback?

> `optional` **feedback**: [`MessageFeedback`](../type-aliases/MessageFeedback.md)

Defined in: [src/lib/db/chat/types.ts:144](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#144)

User feedback: 'like', 'dislike', or null for no feedback

**Inherited from**

[`StoredMessage`](StoredMessage.md).[`feedback`](StoredMessage.md#feedback)

***

### fileIds?

> `optional` **fileIds**: `string`\[]

Defined in: [src/lib/db/chat/types.ts:125](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#125)

Array of media\_id references for direct lookup in media table

**Inherited from**

[`StoredMessage`](StoredMessage.md).[`fileIds`](StoredMessage.md#fileids)

***

### ~~files?~~

> `optional` **files**: [`FileMetadata`](FileMetadata.md)\[]

Defined in: [src/lib/db/chat/types.ts:123](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#123)

**Deprecated**

Use fileIds with media table instead

**Inherited from**

[`StoredMessage`](StoredMessage.md).[`files`](StoredMessage.md#files)

***

### imageModel?

> `optional` **imageModel**: `string`

Defined in: [src/lib/db/chat/types.ts:121](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#121)

Image generation model used for this message (e.g., "nano-banana-flash")

**Inherited from**

[`StoredMessage`](StoredMessage.md).[`imageModel`](StoredMessage.md#imagemodel)

***

### messageId

> **messageId**: `number`

Defined in: [src/lib/db/chat/types.ts:115](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#115)

**Inherited from**

[`StoredMessage`](StoredMessage.md).[`messageId`](StoredMessage.md#messageid)

***

### model?

> `optional` **model**: `string`

Defined in: [src/lib/db/chat/types.ts:119](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#119)

**Inherited from**

[`StoredMessage`](StoredMessage.md).[`model`](StoredMessage.md#model)

***

### parentMessageId?

> `optional` **parentMessageId**: `string`

Defined in: [src/lib/db/chat/types.ts:142](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#142)

Parent message ID for branching (edit/regenerate). Null for root messages.

**Inherited from**

[`StoredMessage`](StoredMessage.md).[`parentMessageId`](StoredMessage.md#parentmessageid)

***

### responseDuration?

> `optional` **responseDuration**: `number`

Defined in: [src/lib/db/chat/types.ts:134](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#134)

**Inherited from**

[`StoredMessage`](StoredMessage.md).[`responseDuration`](StoredMessage.md#responseduration)

***

### role

> **role**: [`ChatRole`](../type-aliases/ChatRole.md)

Defined in: [src/lib/db/chat/types.ts:117](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#117)

**Inherited from**

[`StoredMessage`](StoredMessage.md).[`role`](StoredMessage.md#role)

***

### similarity

> **similarity**: `number`

Defined in: [src/lib/db/chat/types.ts:193](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#193)

***

### sources?

> `optional` **sources**: [`SearchSource`](SearchSource.md)\[]

Defined in: [src/lib/db/chat/types.ts:133](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#133)

**Inherited from**

[`StoredMessage`](StoredMessage.md).[`sources`](StoredMessage.md#sources)

***

### thinking?

> `optional` **thinking**: `string`

Defined in: [src/lib/db/chat/types.ts:140](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#140)

Reasoning/thinking content from models that support extended thinking

**Inherited from**

[`StoredMessage`](StoredMessage.md).[`thinking`](StoredMessage.md#thinking)

***

### thoughtProcess?

> `optional` **thoughtProcess**: `ActivityPhase`\[]

Defined in: [src/lib/db/chat/types.ts:138](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#138)

**Inherited from**

[`StoredMessage`](StoredMessage.md).[`thoughtProcess`](StoredMessage.md#thoughtprocess)

***

### toolCallEvents?

> `optional` **toolCallEvents**: [`LlmapiToolCallEvent`](../../../client/Internal/type-aliases/LlmapiToolCallEvent.md)\[]

Defined in: [src/lib/db/chat/types.ts:146](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#146)

Tool call events from the backend response (for reconstructing tool call history)

**Inherited from**

[`StoredMessage`](StoredMessage.md).[`toolCallEvents`](StoredMessage.md#toolcallevents)

***

### uniqueId

> **uniqueId**: `string`

Defined in: [src/lib/db/chat/types.ts:114](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#114)

**Inherited from**

[`StoredMessage`](StoredMessage.md).[`uniqueId`](StoredMessage.md#uniqueid)

***

### updatedAt

> **updatedAt**: `Date`

Defined in: [src/lib/db/chat/types.ts:127](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#127)

**Inherited from**

[`StoredMessage`](StoredMessage.md).[`updatedAt`](StoredMessage.md#updatedat)

***

### usage?

> `optional` **usage**: [`StoredChatCompletionUsage`](StoredChatCompletionUsage.md)

Defined in: [src/lib/db/chat/types.ts:132](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#132)

**Inherited from**

[`StoredMessage`](StoredMessage.md).[`usage`](StoredMessage.md#usage)

***

### vector?

> `optional` **vector**: `number`\[]

Defined in: [src/lib/db/chat/types.ts:128](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#128)

**Inherited from**

[`StoredMessage`](StoredMessage.md).[`vector`](StoredMessage.md#vector)

***

### wasStopped?

> `optional` **wasStopped**: `boolean`

Defined in: [src/lib/db/chat/types.ts:135](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#135)

**Inherited from**

[`StoredMessage`](StoredMessage.md).[`wasStopped`](StoredMessage.md#wasstopped)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/StoredModelPreference

# StoredModelPreference

Defined in: [src/lib/db/settings/types.ts:5](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/settings/types.ts#5)

## Properties

### models?

> `optional` **models**: `string`

Defined in: [src/lib/db/settings/types.ts:8](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/settings/types.ts#8)

***

### uniqueId

> **uniqueId**: `string`

Defined in: [src/lib/db/settings/types.ts:6](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/settings/types.ts#6)

***

### walletAddress

> **walletAddress**: `string`

Defined in: [src/lib/db/settings/types.ts:7](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/settings/types.ts#7)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/StoredProject

# StoredProject

Defined in: [src/lib/db/project/types.ts:11](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/project/types.ts#11)

Stored representation of a project in the database.

## Properties

### createdAt

> **createdAt**: `Date`

Defined in: [src/lib/db/project/types.ts:19](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/project/types.ts#19)

When the project was created

***

### isDeleted

> **isDeleted**: `boolean`

Defined in: [src/lib/db/project/types.ts:23](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/project/types.ts#23)

Soft delete flag

***

### name

> **name**: `string`

Defined in: [src/lib/db/project/types.ts:17](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/project/types.ts#17)

Display name of the project (editable)

***

### projectId

> **projectId**: `string`

Defined in: [src/lib/db/project/types.ts:15](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/project/types.ts#15)

User-facing project ID (indexed for queries)

***

### uniqueId

> **uniqueId**: `string`

Defined in: [src/lib/db/project/types.ts:13](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/project/types.ts#13)

WatermelonDB internal ID

***

### updatedAt

> **updatedAt**: `Date`

Defined in: [src/lib/db/project/types.ts:21](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/project/types.ts#21)

When the project was last updated

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/StoredSavedTool

# StoredSavedTool

Defined in: [src/lib/db/savedTools/types.ts:18](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/savedTools/types.ts#18)

Plain object representation of a saved tool record.

## Properties

### conversationId?

> `optional` **conversationId**: `string`

Defined in: [src/lib/db/savedTools/types.ts:32](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/savedTools/types.ts#32)

ID of the conversation where this app was originally created

***

### createdAt

> **createdAt**: `Date`

Defined in: [src/lib/db/savedTools/types.ts:33](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/savedTools/types.ts#33)

***

### description

> **description**: `string`

Defined in: [src/lib/db/savedTools/types.ts:26](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/savedTools/types.ts#26)

LLM-facing description — determines when the model invokes this tool

***

### displayName

> **displayName**: `string`

Defined in: [src/lib/db/savedTools/types.ts:24](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/savedTools/types.ts#24)

Human-readable display name (e.g. "Stock Price Tracker")

***

### html

> **html**: `string`

Defined in: [src/lib/db/savedTools/types.ts:30](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/savedTools/types.ts#30)

The saved HTML template

***

### isDeleted

> **isDeleted**: `boolean`

Defined in: [src/lib/db/savedTools/types.ts:35](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/savedTools/types.ts#35)

***

### name

> **name**: `string`

Defined in: [src/lib/db/savedTools/types.ts:22](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/savedTools/types.ts#22)

Internal name used in the tool function name (e.g. "stocks\_tracker")

***

### parameters

> **parameters**: `Record`<`string`, [`SavedToolParameter`](SavedToolParameter.md)>

Defined in: [src/lib/db/savedTools/types.ts:28](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/savedTools/types.ts#28)

Parameters the LLM can pass when calling this tool

***

### uniqueId

> **uniqueId**: `string`

Defined in: [src/lib/db/savedTools/types.ts:20](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/savedTools/types.ts#20)

WatermelonDB internal ID

***

### updatedAt

> **updatedAt**: `Date`

Defined in: [src/lib/db/savedTools/types.ts:34](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/savedTools/types.ts#34)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/StoredUserPreference

# StoredUserPreference

Defined in: [src/lib/db/userPreferences/types.ts:95](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/userPreferences/types.ts#95)

Stored user preference record from the database

## Properties

### createdAt

> **createdAt**: `number`

Defined in: [src/lib/db/userPreferences/types.ts:106](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/userPreferences/types.ts#106)

***

### description?

> `optional` **description**: `string`

Defined in: [src/lib/db/userPreferences/types.ts:101](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/userPreferences/types.ts#101)

***

### models?

> `optional` **models**: `string`

Defined in: [src/lib/db/userPreferences/types.ts:103](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/userPreferences/types.ts#103)

***

### nickname?

> `optional` **nickname**: `string`

Defined in: [src/lib/db/userPreferences/types.ts:99](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/userPreferences/types.ts#99)

***

### occupation?

> `optional` **occupation**: `string`

Defined in: [src/lib/db/userPreferences/types.ts:100](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/userPreferences/types.ts#100)

***

### personality?

> `optional` **personality**: `string`

Defined in: [src/lib/db/userPreferences/types.ts:104](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/userPreferences/types.ts#104)

***

### uniqueId

> **uniqueId**: `string`

Defined in: [src/lib/db/userPreferences/types.ts:96](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/userPreferences/types.ts#96)

***

### updatedAt

> **updatedAt**: `number`

Defined in: [src/lib/db/userPreferences/types.ts:107](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/userPreferences/types.ts#107)

***

### walletAddress

> **walletAddress**: `string`

Defined in: [src/lib/db/userPreferences/types.ts:97](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/userPreferences/types.ts#97)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/StoredVaultFolder

# StoredVaultFolder

Defined in: [src/lib/db/vaultFolders/types.ts:1](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/vaultFolders/types.ts#1)

## Properties

### context

> **context**: `string` | `null`

Defined in: [src/lib/db/vaultFolders/types.ts:14](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/vaultFolders/types.ts#14)

LLM-generated context summary for the folder

***

### createdAt

> **createdAt**: `Date`

Defined in: [src/lib/db/vaultFolders/types.ts:8](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/vaultFolders/types.ts#8)

***

### isDeleted

> **isDeleted**: `boolean`

Defined in: [src/lib/db/vaultFolders/types.ts:10](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/vaultFolders/types.ts#10)

***

### isSystem

> **isSystem**: `boolean`

Defined in: [src/lib/db/vaultFolders/types.ts:12](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/vaultFolders/types.ts#12)

Whether this is a system-created default folder

***

### name

> **name**: `string`

Defined in: [src/lib/db/vaultFolders/types.ts:5](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/vaultFolders/types.ts#5)

Folder display name

***

### scope

> **scope**: `string`

Defined in: [src/lib/db/vaultFolders/types.ts:7](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/vaultFolders/types.ts#7)

Scope for partitioning ("private" | "shared")

***

### uniqueId

> **uniqueId**: `string`

Defined in: [src/lib/db/vaultFolders/types.ts:3](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/vaultFolders/types.ts#3)

WatermelonDB internal ID

***

### updatedAt

> **updatedAt**: `Date`

Defined in: [src/lib/db/vaultFolders/types.ts:9](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/vaultFolders/types.ts#9)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/StoredVaultMemory

# StoredVaultMemory

Defined in: [src/lib/db/memoryVault/types.ts:1](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/memoryVault/types.ts#1)

## Properties

### content

> **content**: `string`

Defined in: [src/lib/db/memoryVault/types.ts:5](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/memoryVault/types.ts#5)

Plain text memory content

***

### createdAt

> **createdAt**: `Date`

Defined in: [src/lib/db/memoryVault/types.ts:14](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/memoryVault/types.ts#14)

***

### embedding

> **embedding**: `string` | `null`

Defined in: [src/lib/db/memoryVault/types.ts:13](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/memoryVault/types.ts#13)

JSON-stringified embedding vector, null if not yet computed

***

### folderId

> **folderId**: `string` | `null`

Defined in: [src/lib/db/memoryVault/types.ts:9](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/memoryVault/types.ts#9)

Folder ID for organization, null if unfiled

***

### isDeleted

> **isDeleted**: `boolean`

Defined in: [src/lib/db/memoryVault/types.ts:16](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/memoryVault/types.ts#16)

***

### scope

> **scope**: `string`

Defined in: [src/lib/db/memoryVault/types.ts:7](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/memoryVault/types.ts#7)

Scope for partitioning memories (e.g., "private", "shared")

***

### uniqueId

> **uniqueId**: `string`

Defined in: [src/lib/db/memoryVault/types.ts:3](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/memoryVault/types.ts#3)

WatermelonDB internal ID

***

### updatedAt

> **updatedAt**: `Date`

Defined in: [src/lib/db/memoryVault/types.ts:15](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/memoryVault/types.ts#15)

***

### userId

> **userId**: `string` | `null`

Defined in: [src/lib/db/memoryVault/types.ts:11](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/memoryVault/types.ts#11)

User ID for multi-user server-side scoping, null on client

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/TextChunk

# TextChunk

Defined in: [src/lib/memoryEngine/chunking.ts:17](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryEngine/chunking.ts#17)

## Properties

### endOffset

> **endOffset**: `number`

Defined in: [src/lib/memoryEngine/chunking.ts:23](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryEngine/chunking.ts#23)

Character offset where this chunk ends in the original text

***

### startOffset

> **startOffset**: `number`

Defined in: [src/lib/memoryEngine/chunking.ts:21](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryEngine/chunking.ts#21)

Character offset where this chunk starts in the original text

***

### text

> **text**: `string`

Defined in: [src/lib/memoryEngine/chunking.ts:19](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryEngine/chunking.ts#19)

The chunk text

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/TextProps

# TextProps

Defined in: [src/react/anumaRuntime.tsx:629](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#629)

## Extends

* `CommonProps`

## Properties

### alignSelf?

> `optional` **alignSelf**: `string`

Defined in: [src/react/anumaRuntime.tsx:169](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#169)

**Inherited from**

`CommonProps.alignSelf`

***

### children?

> `optional` **children**: `ReactNode`

Defined in: [src/react/anumaRuntime.tsx:281](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#281)

**Inherited from**

`CommonProps.children`

***

### fontRole?

> `optional` **fontRole**: `"body"` | `"heading"`

Defined in: [src/react/anumaRuntime.tsx:630](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#630)

***

### grow?

> `optional` **grow**: `number`

Defined in: [src/react/anumaRuntime.tsx:167](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#167)

**Inherited from**

`CommonProps.grow`

***

### h?

> `optional` **h**: `number`

Defined in: [src/react/anumaRuntime.tsx:165](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#165)

**Inherited from**

`CommonProps.h`

***

### id?

> `optional` **id**: `string`

Defined in: [src/react/anumaRuntime.tsx:279](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#279)

**Inherited from**

`CommonProps.id`

***

### rotation?

> `optional` **rotation**: `number`

Defined in: [src/react/anumaRuntime.tsx:166](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#166)

**Inherited from**

`CommonProps.rotation`

***

### shrink?

> `optional` **shrink**: `number`

Defined in: [src/react/anumaRuntime.tsx:168](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#168)

**Inherited from**

`CommonProps.shrink`

***

### style?

> `optional` **style**: `CSSProperties`

Defined in: [src/react/anumaRuntime.tsx:280](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#280)

**Inherited from**

`CommonProps.style`

***

### w?

> `optional` **w**: `number`

Defined in: [src/react/anumaRuntime.tsx:164](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#164)

**Inherited from**

`CommonProps.w`

***

### x?

> `optional` **x**: `number`

Defined in: [src/react/anumaRuntime.tsx:162](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#162)

**Inherited from**

`CommonProps.x`

***

### y?

> `optional` **y**: `number`

Defined in: [src/react/anumaRuntime.tsx:163](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#163)

**Inherited from**

`CommonProps.y`

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/ToolMatchOptions

# ToolMatchOptions

Defined in: [src/lib/tools/serverTools.ts:644](https://github.com/anuma-ai/sdk/blob/main/src/lib/tools/serverTools.ts#644)

Options for findMatchingTools

## Properties

### ambiguityThreshold?

> `optional` **ambiguityThreshold**: `number`

Defined in: [src/lib/tools/serverTools.ts:660](https://github.com/anuma-ai/sdk/blob/main/src/lib/tools/serverTools.ts#660)

Top score must be above this to skip the ambiguity check (default: 0.55)

***

### filterAmbiguous?

> `optional` **filterAmbiguous**: `boolean`

Defined in: [src/lib/tools/serverTools.ts:658](https://github.com/anuma-ai/sdk/blob/main/src/lib/tools/serverTools.ts#658)

When enabled, returns empty results if the top match doesn't clearly
stand out from the runner-up. This filters out generic prompts like
"hello" or "tell me a joke" where all tools score similarly low.

A match is considered ambiguous when:

* The top score is below `ambiguityThreshold` (default: 0.55), AND
* The gap between the top score and the runner-up is below `minLead` (default: 0.04)

***

### limit?

> `optional` **limit**: `number`

Defined in: [src/lib/tools/serverTools.ts:646](https://github.com/anuma-ai/sdk/blob/main/src/lib/tools/serverTools.ts#646)

Maximum number of tools to return (default: 5)

***

### minLead?

> `optional` **minLead**: `number`

Defined in: [src/lib/tools/serverTools.ts:662](https://github.com/anuma-ai/sdk/blob/main/src/lib/tools/serverTools.ts#662)

Minimum gap between top and runner-up scores (default: 0.04)

***

### minSimilarity?

> `optional` **minSimilarity**: `number`

Defined in: [src/lib/tools/serverTools.ts:648](https://github.com/anuma-ai/sdk/blob/main/src/lib/tools/serverTools.ts#648)

Minimum similarity threshold 0-1 (default: 0.3)

***

### relevanceRatio?

> `optional` **relevanceRatio**: `number`

Defined in: [src/lib/tools/serverTools.ts:669](https://github.com/anuma-ai/sdk/blob/main/src/lib/tools/serverTools.ts#669)

Only keep tools scoring at least this fraction of the top match's score.
Filters out the tail of weakly-related tools that fill up the limit.
For example, 0.85 means a tool must score within 85% of the top match.
Set to 0 to disable. Default: 0 (disabled).

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/ToolMatchResult

# ToolMatchResult

Defined in: [src/lib/tools/serverTools.ts:636](https://github.com/anuma-ai/sdk/blob/main/src/lib/tools/serverTools.ts#636)

Result of tool matching with similarity score

## Properties

### similarity

> **similarity**: `number`

Defined in: [src/lib/tools/serverTools.ts:638](https://github.com/anuma-ai/sdk/blob/main/src/lib/tools/serverTools.ts#638)

***

### tool

> **tool**: [`ServerTool`](ServerTool.md)

Defined in: [src/lib/tools/serverTools.ts:637](https://github.com/anuma-ai/sdk/blob/main/src/lib/tools/serverTools.ts#637)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/ToolSet

# ToolSet

Defined in: [src/lib/tools/serverTools.ts:833](https://github.com/anuma-ai/sdk/blob/main/src/lib/tools/serverTools.ts#833)

A tool set defines a group of tools that work together. When any "anchor"
tool in the set is matched semantically (with a score at or above
`anchorMinSimilarity`), the set is activated and all of its members are
pulled into the selection.

Two activation strategies consume this interface:

* `expandToolSetsAdditive` (used by `useChatStorage` and
  `createServerToolsFilter`) keeps all original matches and adds the
  set's members on top — non-set tools are never dropped.
* `applyToolSets` is exclusive: it keeps only set members plus non-set
  tools that scored above `independentThreshold`.

Pick `expandToolSetsAdditive` when you want recall over precision
(typical), and `applyToolSets` when you specifically want non-set
matches stripped on activation.

## Properties

### anchorMinSimilarity?

> `optional` **anchorMinSimilarity**: `number`

Defined in: [src/lib/tools/serverTools.ts:849](https://github.com/anuma-ai/sdk/blob/main/src/lib/tools/serverTools.ts#849)

Minimum similarity an anchor must reach to activate the set.
Prevents false activation on prompts where the anchor barely passes
the global minSimilarity threshold. Default: 0.60

***

### anchors

> **anchors**: `string`\[]

Defined in: [src/lib/tools/serverTools.ts:843](https://github.com/anuma-ai/sdk/blob/main/src/lib/tools/serverTools.ts#843)

Tools that trigger the set when selected. If any anchor appears in the
semantic match results with a score at or above `anchorMinSimilarity`,
all members are pulled in.

***

### members

> **members**: `string`\[]

Defined in: [src/lib/tools/serverTools.ts:837](https://github.com/anuma-ai/sdk/blob/main/src/lib/tools/serverTools.ts#837)

All tool names in the set

***

### name

> **name**: `string`

Defined in: [src/lib/tools/serverTools.ts:835](https://github.com/anuma-ai/sdk/blob/main/src/lib/tools/serverTools.ts#835)

Human-readable name for logging/debugging

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/TranscriptionResult

# TranscriptionResult

Defined in: [src/lib/voice/types.ts:18](https://github.com/anuma-ai/sdk/blob/main/src/lib/voice/types.ts#18)

## Properties

### chunks?

> `optional` **chunks**: `object`\[]

Defined in: [src/lib/voice/types.ts:22](https://github.com/anuma-ai/sdk/blob/main/src/lib/voice/types.ts#22)

Word/phrase-level timestamps if available

**text**

> **text**: `string`

**timestamp**

> **timestamp**: \[`number`, `number`]

***

### text

> **text**: `string`

Defined in: [src/lib/voice/types.ts:20](https://github.com/anuma-ai/sdk/blob/main/src/lib/voice/types.ts#20)

Transcribed text

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/UpdateMediaOptions

# UpdateMediaOptions

Defined in: [src/lib/db/media/types.ts:136](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#136)

Options for updating an existing media record.

## Properties

### dimensions?

> `optional` **dimensions**: [`MediaDimensions`](MediaDimensions.md)

Defined in: [src/lib/db/media/types.ts:143](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#143)

***

### duration?

> `optional` **duration**: `number`

Defined in: [src/lib/db/media/types.ts:144](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#144)

***

### isDeleted?

> `optional` **isDeleted**: `boolean`

Defined in: [src/lib/db/media/types.ts:146](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#146)

***

### mediaType?

> `optional` **mediaType**: [`MediaType`](../type-aliases/MediaType.md)

Defined in: [src/lib/db/media/types.ts:141](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#141)

Re-categorize the media (e.g. relinking a video mistakenly stored as image)

***

### messageId?

> `optional` **messageId**: `string`

Defined in: [src/lib/db/media/types.ts:139](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#139)

Update the associated message ID (set after message creation)

***

### metadata?

> `optional` **metadata**: [`MediaMetadata`](MediaMetadata.md)

Defined in: [src/lib/db/media/types.ts:145](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#145)

***

### name?

> `optional` **name**: `string`

Defined in: [src/lib/db/media/types.ts:137](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#137)

***

### sourceUrl?

> `optional` **sourceUrl**: `string`

Defined in: [src/lib/db/media/types.ts:142](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#142)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/UpdateModelPreferenceOptions

# UpdateModelPreferenceOptions

Defined in: [src/lib/db/settings/types.ts:16](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/settings/types.ts#16)

## Properties

### models?

> `optional` **models**: `string`

Defined in: [src/lib/db/settings/types.ts:17](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/settings/types.ts#17)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/UpdateProjectOptions

# UpdateProjectOptions

Defined in: [src/lib/db/project/types.ts:39](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/project/types.ts#39)

Options for updating a project.

## Properties

### name?

> `optional` **name**: `string`

Defined in: [src/lib/db/project/types.ts:41](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/project/types.ts#41)

New name for the project

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/UpdateSavedToolOptions

# UpdateSavedToolOptions

Defined in: [src/lib/db/savedTools/types.ts:49](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/savedTools/types.ts#49)

Options for updating an existing saved tool (all fields optional).

## Properties

### description?

> `optional` **description**: `string`

Defined in: [src/lib/db/savedTools/types.ts:52](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/savedTools/types.ts#52)

***

### displayName?

> `optional` **displayName**: `string`

Defined in: [src/lib/db/savedTools/types.ts:51](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/savedTools/types.ts#51)

***

### html?

> `optional` **html**: `string`

Defined in: [src/lib/db/savedTools/types.ts:54](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/savedTools/types.ts#54)

***

### name?

> `optional` **name**: `string`

Defined in: [src/lib/db/savedTools/types.ts:50](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/savedTools/types.ts#50)

***

### parameters?

> `optional` **parameters**: `Record`<`string`, [`SavedToolParameter`](SavedToolParameter.md)>

Defined in: [src/lib/db/savedTools/types.ts:53](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/savedTools/types.ts#53)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/UpdateUserPreferenceOptions

# UpdateUserPreferenceOptions

Defined in: [src/lib/db/userPreferences/types.ts:125](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/userPreferences/types.ts#125)

Options for updating an existing user preference record

## Properties

### description?

> `optional` **description**: `string`

Defined in: [src/lib/db/userPreferences/types.ts:128](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/userPreferences/types.ts#128)

***

### models?

> `optional` **models**: `string`

Defined in: [src/lib/db/userPreferences/types.ts:129](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/userPreferences/types.ts#129)

***

### nickname?

> `optional` **nickname**: `string`

Defined in: [src/lib/db/userPreferences/types.ts:126](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/userPreferences/types.ts#126)

***

### occupation?

> `optional` **occupation**: `string`

Defined in: [src/lib/db/userPreferences/types.ts:127](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/userPreferences/types.ts#127)

***

### personality?

> `optional` **personality**: `string`

Defined in: [src/lib/db/userPreferences/types.ts:130](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/userPreferences/types.ts#130)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/UpdateVaultFolderOptions

# UpdateVaultFolderOptions

Defined in: [src/lib/db/vaultFolders/types.ts:25](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/vaultFolders/types.ts#25)

## Properties

### name?

> `optional` **name**: `string`

Defined in: [src/lib/db/vaultFolders/types.ts:26](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/vaultFolders/types.ts#26)

***

### scope?

> `optional` **scope**: `string`

Defined in: [src/lib/db/vaultFolders/types.ts:28](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/vaultFolders/types.ts#28)

If provided, updates the folder's scope and cascades to all contained memories.

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/UpdateVaultMemoryOptions

# UpdateVaultMemoryOptions

Defined in: [src/lib/db/memoryVault/types.ts:29](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/memoryVault/types.ts#29)

## Properties

### content

> **content**: `string`

Defined in: [src/lib/db/memoryVault/types.ts:30](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/memoryVault/types.ts#30)

***

### embedding?

> `optional` **embedding**: `string` | `null`

Defined in: [src/lib/db/memoryVault/types.ts:36](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/memoryVault/types.ts#36)

JSON-stringified embedding vector to persist, or null to clear stale embedding

***

### folderId?

> `optional` **folderId**: `string` | `null`

Defined in: [src/lib/db/memoryVault/types.ts:34](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/memoryVault/types.ts#34)

If provided, moves the memory to this folder.

***

### scope?

> `optional` **scope**: `string`

Defined in: [src/lib/db/memoryVault/types.ts:32](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/memoryVault/types.ts#32)

If provided, updates the memory's scope.

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/UseBackupOptions

# UseBackupOptions

Defined in: [src/react/useBackup.ts:41](https://github.com/anuma-ai/sdk/blob/main/src/react/useBackup.ts#41)

Options for useBackup hook

## Properties

### database

> **database**: `Database`

Defined in: [src/react/useBackup.ts:43](https://github.com/anuma-ai/sdk/blob/main/src/react/useBackup.ts#43)

WatermelonDB database instance

***

### dropboxFolder?

> `optional` **dropboxFolder**: `string`

Defined in: [src/react/useBackup.ts:56](https://github.com/anuma-ai/sdk/blob/main/src/react/useBackup.ts#56)

Dropbox folder path for backups (default: '/ai-chat-app/conversations')

***

### exportConversation()

> **exportConversation**: (`conversationId`: `string`, `userAddress`: `string`) => `Promise`<{ `blob?`: `Blob`; `success`: `boolean`; }>

Defined in: [src/react/useBackup.ts:49](https://github.com/anuma-ai/sdk/blob/main/src/react/useBackup.ts#49)

Export a conversation to an encrypted blob

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`conversationId`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`userAddress`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<{ `blob?`: `Blob`; `success`: `boolean`; }>

***

### googleConversationsFolder?

> `optional` **googleConversationsFolder**: `string`

Defined in: [src/react/useBackup.ts:60](https://github.com/anuma-ai/sdk/blob/main/src/react/useBackup.ts#60)

Google Drive conversations subfolder (default: 'conversations')

***

### googleRootFolder?

> `optional` **googleRootFolder**: `string`

Defined in: [src/react/useBackup.ts:58](https://github.com/anuma-ai/sdk/blob/main/src/react/useBackup.ts#58)

Google Drive root folder name (default: 'ai-chat-app')

***

### importConversation()

> **importConversation**: (`blob`: `Blob`, `userAddress`: `string`) => `Promise`<{ `success`: `boolean`; }>

Defined in: [src/react/useBackup.ts:54](https://github.com/anuma-ai/sdk/blob/main/src/react/useBackup.ts#54)

Import a conversation from an encrypted blob

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`blob`

</td>
<td>

`Blob`

</td>
</tr>
<tr>
<td>

`userAddress`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<{ `success`: `boolean`; }>

***

### requestEncryptionKey()

> **requestEncryptionKey**: (`address`: `string`) => `Promise`<`void`>

Defined in: [src/react/useBackup.ts:47](https://github.com/anuma-ai/sdk/blob/main/src/react/useBackup.ts#47)

Request encryption key for the user address

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`address`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`void`>

***

### userAddress

> **userAddress**: `string` | `null`

Defined in: [src/react/useBackup.ts:45](https://github.com/anuma-ai/sdk/blob/main/src/react/useBackup.ts#45)

Current user address (null if not signed in)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/UseBackupResult

# UseBackupResult

Defined in: [src/react/useBackup.ts:104](https://github.com/anuma-ai/sdk/blob/main/src/react/useBackup.ts#104)

Result returned by useBackup hook

## Properties

### disconnectAll()

> **disconnectAll**: () => `Promise`<`void`>

Defined in: [src/react/useBackup.ts:116](https://github.com/anuma-ai/sdk/blob/main/src/react/useBackup.ts#116)

Disconnect from all providers

**Returns**

`Promise`<`void`>

***

### dropbox

> **dropbox**: [`ProviderBackupState`](ProviderBackupState.md)

Defined in: [src/react/useBackup.ts:106](https://github.com/anuma-ai/sdk/blob/main/src/react/useBackup.ts#106)

Dropbox backup state and methods

***

### googleDrive

> **googleDrive**: [`ProviderBackupState`](ProviderBackupState.md)

Defined in: [src/react/useBackup.ts:108](https://github.com/anuma-ai/sdk/blob/main/src/react/useBackup.ts#108)

Google Drive backup state and methods

***

### hasAnyAuthentication

> **hasAnyAuthentication**: `boolean`

Defined in: [src/react/useBackup.ts:114](https://github.com/anuma-ai/sdk/blob/main/src/react/useBackup.ts#114)

Whether any backup provider is authenticated

***

### hasAnyProvider

> **hasAnyProvider**: `boolean`

Defined in: [src/react/useBackup.ts:112](https://github.com/anuma-ai/sdk/blob/main/src/react/useBackup.ts#112)

Whether any backup provider is configured

***

### icloud

> **icloud**: [`ProviderBackupState`](ProviderBackupState.md)

Defined in: [src/react/useBackup.ts:110](https://github.com/anuma-ai/sdk/blob/main/src/react/useBackup.ts#110)

iCloud backup state and methods

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/UseChatStorageOptions

# UseChatStorageOptions

Defined in: [src/react/useChatStorage.ts:599](https://github.com/anuma-ai/sdk/blob/main/src/react/useChatStorage.ts#599)

Options for useChatStorage hook (React version)

Extends base options with apiType support.

## Extends

* `BaseUseChatStorageOptions`

## Properties

### activeToolSets?

> `optional` **activeToolSets**: `string`\[]

Defined in: [src/react/useChatStorage.ts:681](https://github.com/anuma-ai/sdk/blob/main/src/react/useChatStorage.ts#681)

Tool set names that should expand unconditionally for this request,
bypassing the anchor-similarity check. Use when conversation state
implies a set should be present regardless of how the prompt is phrased
— e.g., pass `["slides"]` when the conversation already contains a slide
deck artifact, so short follow-up prompts ("add a thank you slide",
"make it bigger") still get the full slide toolkit.

Read via a ref so updates are visible to in-flight `sendMessage` calls
without rebuilding the callback.

Names must match a set's `name` from `BUILT_IN_TOOL_SETS` or
`extraToolSets`. Unknown names are ignored.

***

### apiType?

> `optional` **apiType**: `ApiType`

Defined in: [src/react/useChatStorage.ts:605](https://github.com/anuma-ai/sdk/blob/main/src/react/useChatStorage.ts#605)

Which API endpoint to use. Default: "responses"

* "responses": OpenAI Responses API (supports thinking, reasoning, conversations)
* "completions": OpenAI Chat Completions API (wider model compatibility)

***

### autoCreateConversation?

> `optional` **autoCreateConversation**: `boolean`

Defined in: [src/lib/db/chat/types.ts:336](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#336)

Automatically create a new conversation if none is set (default: true)

**Inherited from**

`BaseUseChatStorageOptions.autoCreateConversation`

***

### autoEmbedMessages?

> `optional` **autoEmbedMessages**: `boolean`

Defined in: [src/lib/db/chat/types.ts:394](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#394)

Automatically generate embeddings for messages after saving.
Enables semantic search over past conversations via searchMessages().

**Default**

```ts
true
```

**Inherited from**

`BaseUseChatStorageOptions.autoEmbedMessages`

***

### autoFlushOnKeyAvailable?

> `optional` **autoFlushOnKeyAvailable**: `boolean`

Defined in: [src/react/useChatStorage.ts:654](https://github.com/anuma-ai/sdk/blob/main/src/react/useChatStorage.ts#654)

Automatically flush queued operations when the encryption key becomes
available. Requires `enableQueue` to be true.

**Default**

```ts
true
```

***

### baseUrl?

> `optional` **baseUrl**: `string`

Defined in: [src/lib/db/chat/types.ts:342](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#342)

Base URL for the chat API endpoint

**Inherited from**

`BaseUseChatStorageOptions.baseUrl`

***

### conversationId?

> `optional` **conversationId**: `string`

Defined in: [src/lib/db/chat/types.ts:334](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#334)

ID of an existing conversation to load and continue

**Inherited from**

`BaseUseChatStorageOptions.conversationId`

***

### database

> **database**: `Database`

Defined in: [src/lib/db/chat/types.ts:332](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#332)

WatermelonDB database instance for storing conversations and messages

**Inherited from**

`BaseUseChatStorageOptions.database`

***

### defaultConversationTitle?

> `optional` **defaultConversationTitle**: `string`

Defined in: [src/lib/db/chat/types.ts:338](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#338)

Title for auto-created conversations (default: "New conversation")

**Inherited from**

`BaseUseChatStorageOptions.defaultConversationTitle`

***

### embeddedWalletSigner?

> `optional` **embeddedWalletSigner**: [`EmbeddedWalletSignerFn`](../type-aliases/EmbeddedWalletSignerFn.md)

Defined in: [src/react/useChatStorage.ts:632](https://github.com/anuma-ai/sdk/blob/main/src/react/useChatStorage.ts#632)

Function for silent signing with Privy embedded wallets.
When provided, enables automatic encryption key derivation without
user confirmation modals.

***

### embeddingModel?

> `optional` **embeddingModel**: `string`

Defined in: [src/lib/db/chat/types.ts:399](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#399)

Embedding model to use when autoEmbedMessages is enabled.

**Default**

```ts
DEFAULT_API_EMBEDDING_MODEL
```

**Inherited from**

`BaseUseChatStorageOptions.embeddingModel`

***

### enableQueue?

> `optional` **enableQueue**: `boolean`

Defined in: [src/react/useChatStorage.ts:647](https://github.com/anuma-ai/sdk/blob/main/src/react/useChatStorage.ts#647)

Enable the in-memory write queue for operations when encryption key
isn't yet available. When enabled, operations are held in memory and
flushed to encrypted storage once the key becomes available.

**Default**

```ts
true
```

***

### extraToolSets?

> `optional` **extraToolSets**: [`ToolSet`](ToolSet.md)\[]

Defined in: [src/react/useChatStorage.ts:665](https://github.com/anuma-ai/sdk/blob/main/src/react/useChatStorage.ts#665)

Additional tool sets to apply on top of the built-in ones (app-generation,
slides, github). When any anchor tool in a custom set is selected by
semantic matching, all members of that set are included automatically.

Treated as static config — set once at hook setup. Changing it across
renders does not affect in-flight `sendMessage` calls; use
`activeToolSets` for dynamic, conversation-state-driven overrides.

***

### fileProcessingOptions?

> `optional` **fileProcessingOptions**: `object`

Defined in: [src/lib/db/chat/types.ts:371](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#371)

Options for file preprocessing behavior

**keepOriginalFiles?**

> `optional` **keepOriginalFiles**: `boolean`

Whether to keep original file attachments (default: true)

**maxFileSizeBytes?**

> `optional` **maxFileSizeBytes**: `number`

Max file size to process in bytes (default: 10MB)

**onError()?**

> `optional` **onError**: (`fileName`: `string`, `error`: `Error`) => `void`

Callback for errors (non-fatal)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`fileName`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`error`

</td>
<td>

`Error`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

**onProgress()?**

> `optional` **onProgress**: (`current`: `number`, `total`: `number`, `fileName`: `string`) => `void`

Callback for progress updates

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`current`

</td>
<td>

`number`

</td>
</tr>
<tr>
<td>

`total`

</td>
<td>

`number`

</td>
</tr>
<tr>
<td>

`fileName`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

**Inherited from**

`BaseUseChatStorageOptions.fileProcessingOptions`

***

### fileProcessors?

> `optional` **fileProcessors**: [`FileProcessor`](FileProcessor.md)\[] | `null`

Defined in: [src/lib/db/chat/types.ts:367](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#367)

File preprocessors to use for automatic text extraction.

* undefined (default): Use all built-in processors (PDF, Excel, Word)
* null or \[]: Disable preprocessing
* FileProcessor\[]: Use specific processors

**Inherited from**

`BaseUseChatStorageOptions.fileProcessors`

***

### getToken()?

> `optional` **getToken**: () => `Promise`<`string` | `null`>

Defined in: [src/lib/db/chat/types.ts:340](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#340)

Function to retrieve the auth token for API requests

**Returns**

`Promise`<`string` | `null`>

**Inherited from**

`BaseUseChatStorageOptions.getToken`

***

### getWalletAddress()?

> `optional` **getWalletAddress**: () => `Promise`<`string` | `null`>

Defined in: [src/react/useChatStorage.ts:639](https://github.com/anuma-ai/sdk/blob/main/src/react/useChatStorage.ts#639)

Async function that returns the wallet address when available.
Used for polling during Privy embedded wallet initialization.
When the wallet isn't ready yet, should return null.

**Returns**

`Promise`<`string` | `null`>

***

### mcpR2Domain?

> `optional` **mcpR2Domain**: `string`

Defined in: [src/lib/db/chat/types.ts:411](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#411)

R2 domain for identifying MCP-generated image URLs.
When set, enables OPFS caching of generated images.
Defaults to the hardcoded MCP\_R2\_DOMAIN from clientConfig.

**Inherited from**

`BaseUseChatStorageOptions.mcpR2Domain`

***

### minContentLength?

> `optional` **minContentLength**: `number`

Defined in: [src/lib/db/chat/types.ts:405](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#405)

Minimum content length required to generate embeddings.
Messages shorter than this are skipped as they provide limited semantic value.

**Default**

```ts
10
```

**Inherited from**

`BaseUseChatStorageOptions.minContentLength`

***

### onData()?

> `optional` **onData**: (`chunk`: `string`) => `void`

Defined in: [src/lib/db/chat/types.ts:344](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#344)

Callback invoked with each streamed response chunk

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`chunk`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

**Inherited from**

`BaseUseChatStorageOptions.onData`

***

### onError()?

> `optional` **onError**: (`error`: `Error`) => `void`

Defined in: [src/lib/db/chat/types.ts:350](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#350)

Callback invoked when an error occurs during the request

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`error`

</td>
<td>

`Error`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

**Inherited from**

`BaseUseChatStorageOptions.onError`

***

### onFinish()?

> `optional` **onFinish**: (`response`: [`LlmapiResponseResponse`](../../../client/Internal/type-aliases/LlmapiResponseResponse.md)) => `void`

Defined in: [src/lib/db/chat/types.ts:348](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#348)

Callback invoked when the response completes successfully

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`response`

</td>
<td>

[`LlmapiResponseResponse`](../../../client/Internal/type-aliases/LlmapiResponseResponse.md)

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

**Inherited from**

`BaseUseChatStorageOptions.onFinish`

***

### onServerToolCall()?

> `optional` **onServerToolCall**: (`toolCall`: `ServerToolCallEvent`) => `void`

Defined in: [src/lib/db/chat/types.ts:355](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#355)

Callback invoked when a server-side tool (MCP) is called during streaming.
Use this to show activity indicators like "Searching..." in the UI.

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`toolCall`

</td>
<td>

`ServerToolCallEvent`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

**Inherited from**

`BaseUseChatStorageOptions.onServerToolCall`

***

### onThinking()?

> `optional` **onThinking**: (`chunk`: `string`) => `void`

Defined in: [src/lib/db/chat/types.ts:346](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#346)

Callback invoked when thinking/reasoning content is received (from `<think>` tags or API reasoning)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`chunk`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

**Inherited from**

`BaseUseChatStorageOptions.onThinking`

***

### onToolCallArgumentsDelta()?

> `optional` **onToolCallArgumentsDelta**: (`event`: [`ToolCallArgumentsDeltaEvent`](../type-aliases/ToolCallArgumentsDeltaEvent.md)) => `void`

Defined in: [src/lib/db/chat/types.ts:360](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#360)

Called with partial tool call arguments as they stream in.
Use for live preview of artifacts (HTML, slides) being generated.

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`event`

</td>
<td>

[`ToolCallArgumentsDeltaEvent`](../type-aliases/ToolCallArgumentsDeltaEvent.md)

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

**Inherited from**

`BaseUseChatStorageOptions.onToolCallArgumentsDelta`

***

### preProcessors?

> `optional` **preProcessors**: `PromptPreProcessor`\[]

Defined in: [src/lib/db/chat/types.ts:421](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#421)

Pre-processors run after the last user message is received but before
the first LLM request. Each receives the prompt text and a shared
embedding (computed once per request) and may return messages to
enrich the conversation. Forwarded to the underlying `useChat` hook.
See `createWebSearchPreProcessor`, `createCryptoPricePreProcessor`,
`createStockPricePreProcessor`, `createWeatherPreProcessor`, or write
a custom one matching `PromptPreProcessor`.

**Inherited from**

`BaseUseChatStorageOptions.preProcessors`

***

### serverTools?

> `optional` **serverTools**: `object`

Defined in: [src/lib/db/chat/types.ts:385](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#385)

Configuration for server-side tools fetching and caching.
Server tools are fetched from /api/v1/tools and cached in localStorage.

**cacheExpirationMs?**

> `optional` **cacheExpirationMs**: `number`

Cache expiration time in milliseconds (default: 86400000 = 1 day)

**Inherited from**

`BaseUseChatStorageOptions.serverTools`

***

### signMessage?

> `optional` **signMessage**: [`SignMessageFn`](../type-aliases/SignMessageFn.md)

Defined in: [src/react/useChatStorage.ts:625](https://github.com/anuma-ai/sdk/blob/main/src/react/useChatStorage.ts#625)

Function to sign a message for encryption key derivation.
Typically from Privy's useSignMessage hook.
Required together with walletAddress for field-level encryption.

***

### walletAddress?

> `optional` **walletAddress**: `string`

Defined in: [src/react/useChatStorage.ts:618](https://github.com/anuma-ai/sdk/blob/main/src/react/useChatStorage.ts#618)

Wallet address for encrypted file storage and field-level encryption.
When provided with signMessage, all sensitive message content, conversation titles,
and media metadata are encrypted at rest using AES-GCM with wallet-derived keys.

Requires:

* OPFS browser support (for file storage)
* signMessage function (for encryption key derivation)

When not provided, data is stored in plaintext (backwards compatible).

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/UseChatStorageResult

# UseChatStorageResult

Defined in: [src/react/useChatStorage.ts:760](https://github.com/anuma-ai/sdk/blob/main/src/react/useChatStorage.ts#760)

Result returned by useChatStorage hook (React version)

Extends base result with React-specific sendMessage signature.

## Extends

* `BaseUseChatStorageResult`

## Properties

### clearQueue()

> **clearQueue**: () => `void`

Defined in: [src/react/useChatStorage.ts:896](https://github.com/anuma-ai/sdk/blob/main/src/react/useChatStorage.ts#896)

Clear all queued operations for the current wallet.
Discards pending operations without writing them.

**Returns**

`void`

***

### conversationId

> **conversationId**: `string` | `null`

Defined in: [src/lib/db/chat/types.ts:770](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#770)

**Inherited from**

`BaseUseChatStorageResult.conversationId`

***

### createConversation()

> **createConversation**: (`options?`: [`CreateConversationOptions`](CreateConversationOptions.md)) => `Promise`<[`StoredConversation`](StoredConversation.md)>

Defined in: [src/lib/db/chat/types.ts:772](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#772)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options?`

</td>
<td>

[`CreateConversationOptions`](CreateConversationOptions.md)

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`StoredConversation`](StoredConversation.md)>

**Inherited from**

`BaseUseChatStorageResult.createConversation`

***

### createMemoryEngineTool()

> **createMemoryEngineTool**: (`searchOptions?`: `Partial`<[`MemoryEngineSearchOptions`](MemoryEngineSearchOptions.md)>) => `ToolConfig`

Defined in: [src/react/useChatStorage.ts:814](https://github.com/anuma-ai/sdk/blob/main/src/react/useChatStorage.ts#814)

Create a memory engine tool for LLM to search past conversations.
The tool is pre-configured with the hook's storage context and auth.

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`searchOptions?`

</td>
<td>

`Partial`<[`MemoryEngineSearchOptions`](MemoryEngineSearchOptions.md)>

</td>
<td>

Optional search configuration (limit, minSimilarity, etc.)

</td>
</tr>
</tbody>
</table>

**Returns**

`ToolConfig`

A ToolConfig that can be passed to sendMessage's clientTools

**Example**

```ts
const memoryTool = createMemoryEngineTool({ limit: 5 });
await sendMessage({
  messages: [...],
  clientTools: [memoryTool],
});
```

***

### createMemoryVaultSearchTool()

> **createMemoryVaultSearchTool**: (`searchOptions?`: [`MemoryVaultSearchOptions`](MemoryVaultSearchOptions.md)) => `ToolConfig`

Defined in: [src/react/useChatStorage.ts:833](https://github.com/anuma-ai/sdk/blob/main/src/react/useChatStorage.ts#833)

Create a memory vault search tool for LLM to search vault memories
using semantic similarity. Pre-configured with vault context, auth, and
a shared embedding cache that is pre-populated on init.

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`searchOptions?`

</td>
<td>

[`MemoryVaultSearchOptions`](MemoryVaultSearchOptions.md)

</td>
<td>

Optional search configuration (limit, minSimilarity)

</td>
</tr>
</tbody>
</table>

**Returns**

`ToolConfig`

A ToolConfig that can be passed to sendMessage's clientTools

***

### createMemoryVaultTool()

> **createMemoryVaultTool**: (`options?`: [`MemoryVaultToolOptions`](MemoryVaultToolOptions.md)) => `ToolConfig`

Defined in: [src/react/useChatStorage.ts:823](https://github.com/anuma-ai/sdk/blob/main/src/react/useChatStorage.ts#823)

Create a memory vault tool for LLM to save/update persistent memories.
The tool is pre-configured with the hook's vault context and encryption.

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options?`

</td>
<td>

[`MemoryVaultToolOptions`](MemoryVaultToolOptions.md)

</td>
<td>

Optional configuration (onSave callback for confirmation)

</td>
</tr>
</tbody>
</table>

**Returns**

`ToolConfig`

A ToolConfig that can be passed to sendMessage's clientTools

***

### createVaultMemory()

> **createVaultMemory**: (`content`: `string`, `scope?`: `string`) => `Promise`<[`StoredVaultMemory`](StoredVaultMemory.md)>

Defined in: [src/react/useChatStorage.ts:866](https://github.com/anuma-ai/sdk/blob/main/src/react/useChatStorage.ts#866)

Create a new vault memory with the given content.

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`content`

</td>
<td>

`string`

</td>
<td>

The memory text

</td>
</tr>
<tr>
<td>

`scope?`

</td>
<td>

`string`

</td>
<td>

Optional scope (defaults to "private")

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`StoredVaultMemory`](StoredVaultMemory.md)>

***

### deleteConversation()

> **deleteConversation**: (`id`: `string`) => `Promise`<`boolean`>

Defined in: [src/lib/db/chat/types.ts:776](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#776)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`id`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`boolean`>

**Inherited from**

`BaseUseChatStorageResult.deleteConversation`

***

### deleteVaultMemory()

> **deleteVaultMemory**: (`id`: `string`) => `Promise`<`boolean`>

Defined in: [src/react/useChatStorage.ts:883](https://github.com/anuma-ai/sdk/blob/main/src/react/useChatStorage.ts#883)

Delete a vault memory by its ID (soft delete).

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`id`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`boolean`>

true if the memory was found and deleted

***

### flushQueue()

> **flushQueue**: () => `Promise`<[`FlushResult`](FlushResult.md)>

Defined in: [src/react/useChatStorage.ts:890](https://github.com/anuma-ai/sdk/blob/main/src/react/useChatStorage.ts#890)

Manually flush all queued operations for the current wallet.
Operations are encrypted and written to the database.
Requires the encryption key to be available.

**Returns**

`Promise`<[`FlushResult`](FlushResult.md)>

***

### getAllFiles()

> **getAllFiles**: (`options?`: `object`) => `Promise`<[`StoredFileWithContext`](StoredFileWithContext.md)\[]>

Defined in: [src/react/useChatStorage.ts:794](https://github.com/anuma-ai/sdk/blob/main/src/react/useChatStorage.ts#794)

Get all files from all conversations, sorted by creation date (newest first).
Returns files with conversation context for building file browser UIs.

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options?`

</td>
<td>

`object`

</td>
</tr>
<tr>
<td>

`options.conversationId?`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`options.limit?`

</td>
<td>

`number`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`StoredFileWithContext`](StoredFileWithContext.md)\[]>

***

### getConversation()

> **getConversation**: (`id`: `string`) => `Promise`<[`StoredConversation`](StoredConversation.md) | `null`>

Defined in: [src/lib/db/chat/types.ts:773](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#773)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`id`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`StoredConversation`](StoredConversation.md) | `null`>

**Inherited from**

`BaseUseChatStorageResult.getConversation`

***

### getConversations()

> **getConversations**: () => `Promise`<[`StoredConversation`](StoredConversation.md)\[]>

Defined in: [src/lib/db/chat/types.ts:774](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#774)

**Returns**

`Promise`<[`StoredConversation`](StoredConversation.md)\[]>

**Inherited from**

`BaseUseChatStorageResult.getConversations`

***

### getMessages()

> **getMessages**: (`conversationId`: `string`) => `Promise`<[`StoredMessage`](StoredMessage.md)\[]>

Defined in: [src/lib/db/chat/types.ts:777](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#777)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`conversationId`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`StoredMessage`](StoredMessage.md)\[]>

**Inherited from**

`BaseUseChatStorageResult.getMessages`

***

### getVaultMemories()

> **getVaultMemories**: (`options?`: `object`) => `Promise`<[`StoredVaultMemory`](StoredVaultMemory.md)\[]>

Defined in: [src/react/useChatStorage.ts:859](https://github.com/anuma-ai/sdk/blob/main/src/react/useChatStorage.ts#859)

Get all vault memories for context injection.
Returns non-deleted memories sorted by creation date (newest first).

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options?`

</td>
<td>

`object`

</td>
<td>

Optional filtering (scopes to include)

</td>
</tr>
<tr>
<td>

`options.scopes?`

</td>
<td>

`string`\[]

</td>
<td>

‐

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`StoredVaultMemory`](StoredVaultMemory.md)\[]>

***

### isLoading

> **isLoading**: `boolean`

Defined in: [src/lib/db/chat/types.ts:768](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#768)

**Inherited from**

`BaseUseChatStorageResult.isLoading`

***

### queueStatus

> **queueStatus**: [`QueueStatus`](QueueStatus.md)

Defined in: [src/react/useChatStorage.ts:901](https://github.com/anuma-ai/sdk/blob/main/src/react/useChatStorage.ts#901)

Current status of the write queue.

***

### searchVaultMemories()

> **searchVaultMemories**: (`query`: `string`, `searchOptions?`: [`MemoryVaultSearchOptions`](MemoryVaultSearchOptions.md)) => `Promise`<[`VaultSearchResult`](VaultSearchResult.md)\[]>

Defined in: [src/react/useChatStorage.ts:843](https://github.com/anuma-ai/sdk/blob/main/src/react/useChatStorage.ts#843)

Search vault memories programmatically using semantic similarity.
Returns structured results sorted by descending similarity.
Gracefully returns \[] when auth is unavailable.

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`query`

</td>
<td>

`string`

</td>
<td>

Natural language search query

</td>
</tr>
<tr>
<td>

`searchOptions?`

</td>
<td>

[`MemoryVaultSearchOptions`](MemoryVaultSearchOptions.md)

</td>
<td>

Optional search configuration (limit, minSimilarity, scopes)

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`VaultSearchResult`](VaultSearchResult.md)\[]>

***

### sendMessage()

> **sendMessage**: (`args`: `object`) => `Promise`<[`SendMessageWithStorageResult`](../type-aliases/SendMessageWithStorageResult.md)>

Defined in: [src/react/useChatStorage.ts:789](https://github.com/anuma-ai/sdk/blob/main/src/react/useChatStorage.ts#789)

Sends a message to the AI and automatically persists both the user message
and assistant response to the database.

This method handles the complete message lifecycle:

1. Ensures a conversation exists (creates one if `autoCreateConversation` is enabled)
2. Optionally includes conversation history for context
3. Stores the user message before sending
4. Streams the response via the underlying `useChat` hook
5. Stores the assistant response (including usage stats, sources, and thinking)
6. Handles abort/error states gracefully

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`args`

</td>
<td>

`object`

</td>
<td>

‐

</td>
</tr>
<tr>
<td>

`args.apiType?`

</td>
<td>

`ApiType`

</td>
<td>

Override the API type for this specific request.

* "responses": OpenAI Responses API (supports thinking, reasoning, conversations)
* "completions": OpenAI Chat Completions API (wider model compatibility)

Useful when different models need different APIs within the same hook instance.

</td>
</tr>
<tr>
<td>

`args.assistantUniqueId?`

</td>
<td>

`string`

</td>
<td>

Pre-generated unique ID for the assistant response message.
When provided, the persisted assistant message will use this ID instead of
an auto-generated one. This lets the consumer show an in-flight streaming
placeholder under the same React key, avoiding an unmount/remount flash
when streaming completes and the message is loaded from the database.

</td>
</tr>
<tr>
<td>

`args.clientTools?`

</td>
<td>

[`LlmapiChatCompletionTool`](../../../client/Internal/type-aliases/LlmapiChatCompletionTool.md)\[]

</td>
<td>

Client-side tools with optional executors.
These tools run in the browser/app and can have JavaScript executor functions.

</td>
</tr>
<tr>
<td>

`args.clientToolsFilter?`

</td>
<td>

[`ClientToolsFilterFn`](../type-aliases/ClientToolsFilterFn.md)

</td>
<td>

Dynamic filter for client-side tools based on prompt embeddings.
Receives the prompt embedding(s) (or null for short messages) and all client tools,
returns tool names to include. Tools not in the returned list are excluded from the request.

**Example**

```ts
clientToolsFilter: (embeddings, tools) => {
  if (!embeddings) return []; // Short message — no client tools
  const matches = findMatchingTools(embeddings, pseudoServerTools);
  return matches.map(m => m.tool.name);
}
```

</td>
</tr>
<tr>
<td>

`args.conversationId?`

</td>
<td>

`string`

</td>
<td>

Explicitly specify the conversation ID to send this message to.
If provided, bypasses the automatic conversation detection/creation.
Useful when sending a message immediately after creating a conversation,
to avoid race conditions with React state updates.

</td>
</tr>
<tr>
<td>

`args.fileContext?`

</td>
<td>

`string`

</td>
<td>

Additional context from preprocessed file attachments.
Contains extracted text from Excel, Word, PDF, and other document files.
Injected as a system message so it's available throughout the conversation.

</td>
</tr>
<tr>
<td>

`args.files?`

</td>
<td>

[`FileMetadata`](FileMetadata.md)\[]

</td>
<td>

File attachments to include with the message (images, documents, etc.).
Files with image MIME types and URLs are sent as image content parts.
File metadata is stored with the message (URLs are stripped if they're data URIs).

</td>
</tr>
<tr>
<td>

`args.getThoughtProcess?`

</td>
<td>

() => `ActivityPhase`\[]

</td>
<td>

Callback to get activity phases AFTER streaming completes.
Use this instead of `thoughtProcess` when phases are added dynamically during streaming
(e.g., via server tool call events like "Searching...", "Generating image...").

If both `thoughtProcess` and `getThoughtProcess` are provided, `getThoughtProcess` takes precedence.

</td>
</tr>
<tr>
<td>

`args.headers?`

</td>
<td>

`Record`<`string`, `string`>

</td>
<td>

Custom HTTP headers to include with the API request.
Useful for passing additional authentication, tracking, or feature flags.

</td>
</tr>
<tr>
<td>

`args.imageModel?`

</td>
<td>

`string`

</td>
<td>

User-selected image generation model for server-side enforcement.

</td>
</tr>
<tr>
<td>

`args.includeHistory?`

</td>
<td>

`boolean`

</td>
<td>

Whether to automatically include previous messages from the conversation as context.
When true, fetches stored messages and prepends them to the request.
Ignored if `messages` is provided.

**Default**

```ts
true
```

</td>
</tr>
<tr>
<td>

`args.maxHistoryMessages?`

</td>
<td>

`number`

</td>
<td>

Maximum number of historical messages to include when `includeHistory` is true.
Only the most recent N messages are included to manage context window size.

**Default**

```ts
50
```

</td>
</tr>
<tr>
<td>

`args.maxOutputTokens?`

</td>
<td>

`number`

</td>
<td>

Maximum number of tokens to generate in the response.
Use this to limit response length and control costs.

</td>
</tr>
<tr>
<td>

`args.maxToolRounds?`

</td>
<td>

`number`

</td>
<td>

Maximum number of tool execution rounds before forcing the model to respond with text.
After this many rounds, `toolChoice` is set to `"none"` on the next continuation,
so the model produces a text answer using whatever tool results it has gathered.

**Default**

```ts
3
```

</td>
</tr>
<tr>
<td>

`args.memoryContext?`

</td>
<td>

`string`

</td>
<td>

Additional context from memory/RAG system to include in the request.
Typically contains retrieved relevant information from past conversations.

</td>
</tr>
<tr>
<td>

`args.messages`

</td>
<td>

[`LlmapiMessage`](../../../client/Internal/type-aliases/LlmapiMessage.md)\[]

</td>
<td>

The message array to send to the AI.

Uses the modern array format that supports multimodal content (text, images, files).
The last user message in this array will be extracted and stored in the database.

When `includeHistory` is true (default), conversation history is prepended.
When `includeHistory` is false, only these messages are sent.

**Example**

```ts
// Simple usage
sendMessage({
  messages: [
    { role: "user", content: [{ type: "text", text: "Hello!" }] }
  ]
})

// With system prompt and history disabled
sendMessage({
  messages: [
    { role: "system", content: [{ type: "text", text: "You are helpful" }] },
    { role: "user", content: [{ type: "text", text: "Question" }] },
  ],
  includeHistory: false
})

// With images
sendMessage({
  messages: [
    { role: "user", content: [
      { type: "text", text: "What's in this image?" },
      { type: "image_url", image_url: { url: "data:image/png;base64,..." } }
    ]}
  ]
})
```

</td>
</tr>
<tr>
<td>

`args.model?`

</td>
<td>

`string`

</td>
<td>

The model identifier to use for this request (e.g., "fireworks/accounts/fireworks/models/kimi-k2p5").
If not specified, uses the default model configured on the server.

</td>
</tr>
<tr>
<td>

`args.onData?`

</td>
<td>

(`chunk`: `string`) => `void`

</td>
<td>

Per-request callback invoked with each streamed response chunk.
Overrides the hook-level `onData` callback for this request only.
Use this to update UI as the response streams in.

</td>
</tr>
<tr>
<td>

`args.onThinking?`

</td>
<td>

(`chunk`: `string`) => `void`

</td>
<td>

Per-request callback for thinking/reasoning chunks.
Called with delta chunks as the model "thinks" through a problem.
Use this to display thinking progress in the UI.

</td>
</tr>
<tr>
<td>

`args.parentMessageId?`

</td>
<td>

`string`

</td>
<td>

Parent message ID for branching (edit/regenerate). Sets on the user message.

</td>
</tr>
<tr>
<td>

`args.reasoning?`

</td>
<td>

[`LlmapiResponseReasoning`](../../../client/Internal/type-aliases/LlmapiResponseReasoning.md)

</td>
<td>

Reasoning configuration for o-series and other reasoning models.
Controls reasoning effort level and whether to include reasoning summary.

</td>
</tr>
<tr>
<td>

`args.searchContext?`

</td>
<td>

`string`

</td>
<td>

Additional context from search results to include in the request.
Typically contains relevant information from web or document searches.

</td>
</tr>
<tr>
<td>

`args.serverTools?`

</td>
<td>

[`ServerToolsFilter`](../type-aliases/ServerToolsFilter.md)

</td>
<td>

Server-side tools to include from /api/v1/tools.

* undefined: Include all server-side tools (default)
* string\[]: Include only tools with these names
* \[]: Include no server-side tools
* function: Dynamic filter that receives prompt embedding(s) and all tools,
  returns tool names to include. Useful for semantic tool matching.

**Example**

```ts
// Include only specific server tools
serverTools: ["generate_cloud_image", "perplexity_search"]

// Disable server tools for this request
serverTools: []

// Semantic tool matching based on prompt
serverTools: (embeddings, tools) => {
  const matches = findMatchingTools(embeddings, tools, { limit: 5 });
  return matches.map(m => m.tool.name);
}
```

</td>
</tr>
<tr>
<td>

`args.skipStorage?`

</td>
<td>

`boolean`

</td>
<td>

Skip all storage operations (conversation, messages, embeddings, media).
Use this for one-off tasks like title generation where you don't want
to pollute the database with utility messages.

When true:

* No conversation is created or required
* Messages are not stored in the database
* No embeddings are generated
* No media/files are processed for storage
* Result will not include userMessage or assistantMessage

**Default**

```ts
false
```

**Example**

```ts
// Generate a title without storing anything
const { data } = await sendMessage({
  messages: [{ role: "user", content: [{ type: "text", text: "Generate a title for: ..." }] }],
  skipStorage: true,
  includeHistory: false,
});
```

</td>
</tr>
<tr>
<td>

`args.sources?`

</td>
<td>

[`SearchSource`](SearchSource.md)\[]

</td>
<td>

Search sources to attach to the stored message for citation/reference.
Note: Sources are also automatically extracted from tool\_call\_events in the response.

</td>
</tr>
<tr>
<td>

`args.summarizeHistory?`

</td>
<td>

`boolean`

</td>
<td>

Enable progressive summarization of conversation history.

When enabled, older messages are summarized into a compact text using a cheap
model, while recent messages are kept verbatim. This reduces input tokens by
50-70% for long conversations.

Requires `includeHistory` to be true (default). When `includeHistory` is false
or `summarizeHistory` is false, all history is sent verbatim (current behavior).

**Default**

```ts
false
```

</td>
</tr>
<tr>
<td>

`args.summaryMinWindowMessages?`

</td>
<td>

`number`

</td>
<td>

Minimum number of recent messages to always keep verbatim (never summarized).
Ensures the LLM always has immediate conversational context.
Even if these messages exceed the token threshold, they are kept.

**Default**

```ts
4 (2 user-assistant turns)
```

</td>
</tr>
<tr>
<td>

`args.summaryModel?`

</td>
<td>

`string`

</td>
<td>

Model to use for generating conversation summaries.
Should be a cheap, fast model since summarization is a straightforward task.

**Default**

```ts
'cerebras/qwen-3-235b-a22b-instruct-2507' ($0.60/1M input tokens)
```

</td>
</tr>
<tr>
<td>

`args.summaryTokenThreshold?`

</td>
<td>

`number`

</td>
<td>

Token threshold for conversation history before summarization triggers.

When the total token count of the cached summary + unsummarized messages
exceeds this value, older messages are summarized to fit within the budget.

How to choose a value:

* Lower (2000-3000): aggressive summarization, lowest cost, less verbatim context.
* Default (4000): balanced — keeps history under ~$0.01/message at typical pricing
  ($2.50/1M tokens). Triggers for most conversations after 5-10 turns.
* Higher (8000-16000): less frequent summarization, more context, higher cost.
  Good for code review or legal conversations needing precise recall.

The fixed overhead (system prompt + tools + memory ≈ 3,500 tokens) is NOT
included — it is additive. Total input ≈ overhead + threshold + current message.

**Default**

```ts
4000
```

</td>
</tr>
<tr>
<td>

`args.temperature?`

</td>
<td>

`number`

</td>
<td>

Controls randomness in the response (0.0 to 2.0).
Lower values make output more deterministic, higher values more creative.

</td>
</tr>
<tr>
<td>

`args.thinking?`

</td>
<td>

[`LlmapiThinkingOptions`](../../../client/Internal/type-aliases/LlmapiThinkingOptions.md)

</td>
<td>

Extended thinking configuration for Anthropic models (Claude).
Enables the model to think through complex problems step by step
before generating the final response.

</td>
</tr>
<tr>
<td>

`args.thoughtProcess?`

</td>
<td>

`ActivityPhase`\[]

</td>
<td>

Activity phases for tracking the request lifecycle in the UI.
Each phase represents a step like "Searching", "Thinking", "Generating".
The final phase is automatically marked as completed when stored.

Note: If you need activity phases that are added during streaming (e.g., server tool calls),
use `getThoughtProcess` callback instead, which captures phases AFTER streaming completes.

</td>
</tr>
<tr>
<td>

`args.toolChoice?`

</td>
<td>

`string`

</td>
<td>

Controls which tool the model should use:

* "auto": Model decides whether to use a tool (default)
* "any": Model must use one of the provided tools
* "none": Model cannot use any tools
* "required": Model must use a tool
* Specific tool name: Model must use that specific tool

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`SendMessageWithStorageResult`](../type-aliases/SendMessageWithStorageResult.md)>

**Example**

```ts
const result = await sendMessage({
  content: "Explain quantum computing",
  model: "fireworks/accounts/fireworks/models/kimi-k2p5",
  includeHistory: true,
  onData: (chunk) => setStreamingText(prev => prev + chunk),
});

if (result.error) {
  console.error("Failed:", result.error);
} else {
  console.log("Stored message ID:", result.assistantMessage.uniqueId);
}
```

***

### setConversationId()

> **setConversationId**: (`id`: `string` | `null`) => `void`

Defined in: [src/lib/db/chat/types.ts:771](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#771)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`id`

</td>
<td>

`string` | `null`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

**Inherited from**

`BaseUseChatStorageResult.setConversationId`

***

### stop()

> **stop**: () => `void`

Defined in: [src/lib/db/chat/types.ts:769](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#769)

**Returns**

`void`

**Inherited from**

`BaseUseChatStorageResult.stop`

***

### updateConversationTitle()

> **updateConversationTitle**: (`id`: `string`, `title`: `string`) => `Promise`<`boolean`>

Defined in: [src/lib/db/chat/types.ts:775](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#775)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`id`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`title`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`boolean`>

**Inherited from**

`BaseUseChatStorageResult.updateConversationTitle`

***

### updateVaultMemory()

> **updateVaultMemory**: (`id`: `string`, `content`: `string`, `scope?`: `string`) => `Promise`<[`StoredVaultMemory`](StoredVaultMemory.md) | `null`>

Defined in: [src/react/useChatStorage.ts:873](https://github.com/anuma-ai/sdk/blob/main/src/react/useChatStorage.ts#873)

Update an existing vault memory's content.

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`id`

</td>
<td>

`string`

</td>
<td>

‐

</td>
</tr>
<tr>
<td>

`content`

</td>
<td>

`string`

</td>
<td>

‐

</td>
</tr>
<tr>
<td>

`scope?`

</td>
<td>

`string`

</td>
<td>

Optional new scope for the memory

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`StoredVaultMemory`](StoredVaultMemory.md) | `null`>

the updated memory, or null if not found

***

### vaultEmbeddingCache

> **vaultEmbeddingCache**: [`VaultEmbeddingCache`](../type-aliases/VaultEmbeddingCache.md)

Defined in: [src/react/useChatStorage.ts:852](https://github.com/anuma-ai/sdk/blob/main/src/react/useChatStorage.ts#852)

The shared vault embedding cache. Use this to eagerly embed content
when saving vault memories (via eagerEmbedContent).

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/UseDropboxBackupOptions

# UseDropboxBackupOptions

Defined in: [src/react/useDropboxBackup.ts:21](https://github.com/anuma-ai/sdk/blob/main/src/react/useDropboxBackup.ts#21)

Options for useDropboxBackup hook

## Properties

### backupFolder?

> `optional` **backupFolder**: `string`

Defined in: [src/react/useDropboxBackup.ts:36](https://github.com/anuma-ai/sdk/blob/main/src/react/useDropboxBackup.ts#36)

Dropbox folder path for backups (default: '/ai-chat-app/conversations')

***

### database

> **database**: `Database`

Defined in: [src/react/useDropboxBackup.ts:23](https://github.com/anuma-ai/sdk/blob/main/src/react/useDropboxBackup.ts#23)

WatermelonDB database instance

***

### exportConversation()

> **exportConversation**: (`conversationId`: `string`, `userAddress`: `string`) => `Promise`<{ `blob?`: `Blob`; `success`: `boolean`; }>

Defined in: [src/react/useDropboxBackup.ts:29](https://github.com/anuma-ai/sdk/blob/main/src/react/useDropboxBackup.ts#29)

Export a conversation to an encrypted blob

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`conversationId`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`userAddress`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<{ `blob?`: `Blob`; `success`: `boolean`; }>

***

### importConversation()

> **importConversation**: (`blob`: `Blob`, `userAddress`: `string`) => `Promise`<{ `success`: `boolean`; }>

Defined in: [src/react/useDropboxBackup.ts:34](https://github.com/anuma-ai/sdk/blob/main/src/react/useDropboxBackup.ts#34)

Import a conversation from an encrypted blob

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`blob`

</td>
<td>

`Blob`

</td>
</tr>
<tr>
<td>

`userAddress`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<{ `success`: `boolean`; }>

***

### requestEncryptionKey()

> **requestEncryptionKey**: (`address`: `string`) => `Promise`<`void`>

Defined in: [src/react/useDropboxBackup.ts:27](https://github.com/anuma-ai/sdk/blob/main/src/react/useDropboxBackup.ts#27)

Request encryption key for the user address

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`address`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`void`>

***

### userAddress

> **userAddress**: `string` | `null`

Defined in: [src/react/useDropboxBackup.ts:25](https://github.com/anuma-ai/sdk/blob/main/src/react/useDropboxBackup.ts#25)

Current user address (null if not signed in)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/UseDropboxBackupResult

# UseDropboxBackupResult

Defined in: [src/react/useDropboxBackup.ts:42](https://github.com/anuma-ai/sdk/blob/main/src/react/useDropboxBackup.ts#42)

Result returned by useDropboxBackup hook

## Properties

### backup()

> **backup**: (`options?`: `object`) => `Promise`<[`DropboxExportResult`](DropboxExportResult.md) | { `error`: `string`; }>

Defined in: [src/react/useDropboxBackup.ts:44](https://github.com/anuma-ai/sdk/blob/main/src/react/useDropboxBackup.ts#44)

Backup all conversations to Dropbox

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options?`

</td>
<td>

`object`

</td>
</tr>
<tr>
<td>

`options.onProgress?`

</td>
<td>

(`current`: `number`, `total`: `number`) => `void`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`DropboxExportResult`](DropboxExportResult.md) | { `error`: `string`; }>

***

### isAuthenticated

> **isAuthenticated**: `boolean`

Defined in: [src/react/useDropboxBackup.ts:54](https://github.com/anuma-ai/sdk/blob/main/src/react/useDropboxBackup.ts#54)

Whether user has a Dropbox token

***

### isConfigured

> **isConfigured**: `boolean`

Defined in: [src/react/useDropboxBackup.ts:52](https://github.com/anuma-ai/sdk/blob/main/src/react/useDropboxBackup.ts#52)

Whether Dropbox is configured

***

### restore()

> **restore**: (`options?`: `object`) => `Promise`<[`DropboxImportResult`](DropboxImportResult.md) | { `error`: `string`; }>

Defined in: [src/react/useDropboxBackup.ts:48](https://github.com/anuma-ai/sdk/blob/main/src/react/useDropboxBackup.ts#48)

Restore conversations from Dropbox

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options?`

</td>
<td>

`object`

</td>
</tr>
<tr>
<td>

`options.onProgress?`

</td>
<td>

(`current`: `number`, `total`: `number`) => `void`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`DropboxImportResult`](DropboxImportResult.md) | { `error`: `string`; }>

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/UseFilesOptions

# UseFilesOptions

Defined in: [src/react/useFiles.ts:57](https://github.com/anuma-ai/sdk/blob/main/src/react/useFiles.ts#57)

Options for useFiles hook.

## Properties

### database

> **database**: `Database`

Defined in: [src/react/useFiles.ts:59](https://github.com/anuma-ai/sdk/blob/main/src/react/useFiles.ts#59)

WatermelonDB database instance

***

### walletAddress?

> `optional` **walletAddress**: `string`

Defined in: [src/react/useFiles.ts:61](https://github.com/anuma-ai/sdk/blob/main/src/react/useFiles.ts#61)

Wallet address for user context (required for most operations and file decryption)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/UseFilesResult

# UseFilesResult

Defined in: [src/react/useFiles.ts:67](https://github.com/anuma-ai/sdk/blob/main/src/react/useFiles.ts#67)

Result returned by useFiles hook.

## Properties

### createBlobUrl()

> **createBlobUrl**: (`mediaId`: `string`) => `Promise`<`string` | `null`>

Defined in: [src/react/useFiles.ts:142](https://github.com/anuma-ai/sdk/blob/main/src/react/useFiles.ts#142)

Create a blob URL for a file (auto-managed lifecycle)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`mediaId`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`string` | `null`>

***

### createMedia()

> **createMedia**: (`options`: [`CreateMediaOptions`](CreateMediaOptions.md)) => `Promise`<[`StoredMedia`](StoredMedia.md)>

Defined in: [src/react/useFiles.ts:76](https://github.com/anuma-ai/sdk/blob/main/src/react/useFiles.ts#76)

Create a new file record

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options`

</td>
<td>

[`CreateMediaOptions`](CreateMediaOptions.md)

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`StoredMedia`](StoredMedia.md)>

***

### createMediaBatch()

> **createMediaBatch**: (`optionsArray`: [`CreateMediaOptions`](CreateMediaOptions.md)\[]) => `Promise`<[`StoredMedia`](StoredMedia.md)\[]>

Defined in: [src/react/useFiles.ts:78](https://github.com/anuma-ai/sdk/blob/main/src/react/useFiles.ts#78)

Create multiple file records in a batch

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`optionsArray`

</td>
<td>

[`CreateMediaOptions`](CreateMediaOptions.md)\[]

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`StoredMedia`](StoredMedia.md)\[]>

***

### deleteMedia()

> **deleteMedia**: (`mediaId`: `string`) => `Promise`<`boolean`>

Defined in: [src/react/useFiles.ts:98](https://github.com/anuma-ai/sdk/blob/main/src/react/useFiles.ts#98)

Soft delete a file record

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`mediaId`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`boolean`>

***

### deleteMediaByConversation()

> **deleteMediaByConversation**: (`conversationId`: `string`) => `Promise`<`number`>

Defined in: [src/react/useFiles.ts:134](https://github.com/anuma-ai/sdk/blob/main/src/react/useFiles.ts#134)

Delete all files for a conversation

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`conversationId`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`number`>

***

### deleteMediaByMessage()

> **deleteMediaByMessage**: (`messageId`: `string`) => `Promise`<`number`>

Defined in: [src/react/useFiles.ts:136](https://github.com/anuma-ai/sdk/blob/main/src/react/useFiles.ts#136)

Delete all files for a message

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`messageId`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`number`>

***

### getAIGeneratedMedia()

> **getAIGeneratedMedia**: (`limit?`: `number`) => `Promise`<[`StoredMedia`](StoredMedia.md)\[]>

Defined in: [src/react/useFiles.ts:120](https://github.com/anuma-ai/sdk/blob/main/src/react/useFiles.ts#120)

Get AI-generated files

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`limit?`

</td>
<td>

`number`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`StoredMedia`](StoredMedia.md)\[]>

***

### getAudio()

> **getAudio**: (`limit?`: `number`) => `Promise`<[`StoredMedia`](StoredMedia.md)\[]>

Defined in: [src/react/useFiles.ts:112](https://github.com/anuma-ai/sdk/blob/main/src/react/useFiles.ts#112)

Get all audio files

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`limit?`

</td>
<td>

`number`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`StoredMedia`](StoredMedia.md)\[]>

***

### getDocuments()

> **getDocuments**: (`limit?`: `number`) => `Promise`<[`StoredMedia`](StoredMedia.md)\[]>

Defined in: [src/react/useFiles.ts:114](https://github.com/anuma-ai/sdk/blob/main/src/react/useFiles.ts#114)

Get all documents

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`limit?`

</td>
<td>

`number`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`StoredMedia`](StoredMedia.md)\[]>

***

### getImages()

> **getImages**: (`limit?`: `number`) => `Promise`<[`StoredMedia`](StoredMedia.md)\[]>

Defined in: [src/react/useFiles.ts:108](https://github.com/anuma-ai/sdk/blob/main/src/react/useFiles.ts#108)

Get all images

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`limit?`

</td>
<td>

`number`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`StoredMedia`](StoredMedia.md)\[]>

***

### getMedia()

> **getMedia**: (`filters`: [`MediaFilterOptions`](MediaFilterOptions.md)) => `Promise`<[`StoredMedia`](StoredMedia.md)\[]>

Defined in: [src/react/useFiles.ts:104](https://github.com/anuma-ai/sdk/blob/main/src/react/useFiles.ts#104)

Get all files with optional filters

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`filters`

</td>
<td>

[`MediaFilterOptions`](MediaFilterOptions.md)

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`StoredMedia`](StoredMedia.md)\[]>

***

### getMediaByConversation()

> **getMediaByConversation**: (`conversationId`: `string`, `limit?`: `number`) => `Promise`<[`StoredMedia`](StoredMedia.md)\[]>

Defined in: [src/react/useFiles.ts:116](https://github.com/anuma-ai/sdk/blob/main/src/react/useFiles.ts#116)

Get files by conversation

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`conversationId`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`limit?`

</td>
<td>

`number`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`StoredMedia`](StoredMedia.md)\[]>

***

### getMediaById()

> **getMediaById**: (`mediaId`: `string`) => `Promise`<[`StoredMedia`](StoredMedia.md) | `null`>

Defined in: [src/react/useFiles.ts:80](https://github.com/anuma-ai/sdk/blob/main/src/react/useFiles.ts#80)

Get a file record by its media\_id

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`mediaId`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`StoredMedia`](StoredMedia.md) | `null`>

***

### getMediaByIds()

> **getMediaByIds**: (`mediaIds`: `string`\[], `includeDeleted?`: `boolean`) => `Promise`<[`StoredMedia`](StoredMedia.md)\[]>

Defined in: [src/react/useFiles.ts:84](https://github.com/anuma-ai/sdk/blob/main/src/react/useFiles.ts#84)

Get files by an array of media IDs

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`mediaIds`

</td>
<td>

`string`\[]

</td>
</tr>
<tr>
<td>

`includeDeleted?`

</td>
<td>

`boolean`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`StoredMedia`](StoredMedia.md)\[]>

***

### getMediaByMessage()

> **getMediaByMessage**: (`messageId`: `string`) => `Promise`<[`StoredMedia`](StoredMedia.md)\[]>

Defined in: [src/react/useFiles.ts:86](https://github.com/anuma-ai/sdk/blob/main/src/react/useFiles.ts#86)

Get files by message ID

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`messageId`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`StoredMedia`](StoredMedia.md)\[]>

***

### getMediaByModel()

> **getMediaByModel**: (`model`: `string`, `limit?`: `number`) => `Promise`<[`StoredMedia`](StoredMedia.md)\[]>

Defined in: [src/react/useFiles.ts:124](https://github.com/anuma-ai/sdk/blob/main/src/react/useFiles.ts#124)

Get files by AI model

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`model`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`limit?`

</td>
<td>

`number`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`StoredMedia`](StoredMedia.md)\[]>

***

### getMediaByRole()

> **getMediaByRole**: (`role`: [`MediaRole`](../type-aliases/MediaRole.md), `limit?`: `number`) => `Promise`<[`StoredMedia`](StoredMedia.md)\[]>

Defined in: [src/react/useFiles.ts:118](https://github.com/anuma-ai/sdk/blob/main/src/react/useFiles.ts#118)

Get files by role (user uploads vs AI generated)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`role`

</td>
<td>

[`MediaRole`](../type-aliases/MediaRole.md)

</td>
</tr>
<tr>
<td>

`limit?`

</td>
<td>

`number`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`StoredMedia`](StoredMedia.md)\[]>

***

### getMediaBySourceUrl()

> **getMediaBySourceUrl**: (`sourceUrl`: `string`) => `Promise`<[`StoredMedia`](StoredMedia.md) | `null`>

Defined in: [src/react/useFiles.ts:82](https://github.com/anuma-ai/sdk/blob/main/src/react/useFiles.ts#82)

Get a file record by its source URL

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`sourceUrl`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`StoredMedia`](StoredMedia.md) | `null`>

***

### getMediaByType()

> **getMediaByType**: (`mediaType`: [`MediaType`](../type-aliases/MediaType.md), `limit?`: `number`) => `Promise`<[`StoredMedia`](StoredMedia.md)\[]>

Defined in: [src/react/useFiles.ts:106](https://github.com/anuma-ai/sdk/blob/main/src/react/useFiles.ts#106)

Get files by type

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`mediaType`

</td>
<td>

[`MediaType`](../type-aliases/MediaType.md)

</td>
</tr>
<tr>
<td>

`limit?`

</td>
<td>

`number`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`StoredMedia`](StoredMedia.md)\[]>

***

### getMediaCount()

> **getMediaCount**: (`mediaType?`: [`MediaType`](../type-aliases/MediaType.md)) => `Promise`<`number`>

Defined in: [src/react/useFiles.ts:130](https://github.com/anuma-ai/sdk/blob/main/src/react/useFiles.ts#130)

Get file count

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`mediaType?`

</td>
<td>

[`MediaType`](../type-aliases/MediaType.md)

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`number`>

***

### getMediaCountsByType()

> **getMediaCountsByType**: () => `Promise`<`Record`<[`MediaType`](../type-aliases/MediaType.md), `number`>>

Defined in: [src/react/useFiles.ts:132](https://github.com/anuma-ai/sdk/blob/main/src/react/useFiles.ts#132)

Get file counts by type

**Returns**

`Promise`<`Record`<[`MediaType`](../type-aliases/MediaType.md), `number`>>

***

### getRecentMedia()

> **getRecentMedia**: (`limit?`: `number`) => `Promise`<[`StoredMedia`](StoredMedia.md)\[]>

Defined in: [src/react/useFiles.ts:126](https://github.com/anuma-ai/sdk/blob/main/src/react/useFiles.ts#126)

Get recent files for library homepage

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`limit?`

</td>
<td>

`number`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`StoredMedia`](StoredMedia.md)\[]>

***

### getUserUploadedMedia()

> **getUserUploadedMedia**: (`limit?`: `number`) => `Promise`<[`StoredMedia`](StoredMedia.md)\[]>

Defined in: [src/react/useFiles.ts:122](https://github.com/anuma-ai/sdk/blob/main/src/react/useFiles.ts#122)

Get user-uploaded files

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`limit?`

</td>
<td>

`number`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`StoredMedia`](StoredMedia.md)\[]>

***

### getVideos()

> **getVideos**: (`limit?`: `number`) => `Promise`<[`StoredMedia`](StoredMedia.md)\[]>

Defined in: [src/react/useFiles.ts:110](https://github.com/anuma-ai/sdk/blob/main/src/react/useFiles.ts#110)

Get all videos

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`limit?`

</td>
<td>

`number`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`StoredMedia`](StoredMedia.md)\[]>

***

### hardDeleteMedia()

> **hardDeleteMedia**: (`mediaId`: `string`) => `Promise`<`boolean`>

Defined in: [src/react/useFiles.ts:100](https://github.com/anuma-ai/sdk/blob/main/src/react/useFiles.ts#100)

Permanently delete a file record

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`mediaId`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`boolean`>

***

### isLoading

> **isLoading**: `boolean`

Defined in: [src/react/useFiles.ts:72](https://github.com/anuma-ai/sdk/blob/main/src/react/useFiles.ts#72)

Whether files are being loaded

***

### isReady

> **isReady**: `boolean`

Defined in: [src/react/useFiles.ts:70](https://github.com/anuma-ai/sdk/blob/main/src/react/useFiles.ts#70)

Whether the file system is ready (database table exists)

***

### readFile()

> **readFile**: (`mediaId`: `string`) => `Promise`<`File`>

Defined in: [src/react/useFiles.ts:140](https://github.com/anuma-ai/sdk/blob/main/src/react/useFiles.ts#140)

Read a file from OPFS by its media ID

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`mediaId`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`File`>

***

### relinkMisclassifiedVideos()

> **relinkMisclassifiedVideos**: () => `Promise`<`number`>

Defined in: [src/react/useFiles.ts:96](https://github.com/anuma-ai/sdk/blob/main/src/react/useFiles.ts#96)

One-time recovery: relink videos previously stored as images (media\_type
"image" but a video/\* mime) so they appear in the Videos tab and resolve in
the video player's OPFS fallback. Idempotent. Returns count relinked.

**Returns**

`Promise`<`number`>

***

### resolveFilePlaceholders()

> **resolveFilePlaceholders**: (`content`: `string`) => `Promise`<`string`>

Defined in: [src/react/useFiles.ts:148](https://github.com/anuma-ai/sdk/blob/main/src/react/useFiles.ts#148)

Resolve **SDKFILE** placeholders in content to blob URLs

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`content`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`string`>

***

### revokeAllBlobUrls()

> **revokeAllBlobUrls**: () => `void`

Defined in: [src/react/useFiles.ts:146](https://github.com/anuma-ai/sdk/blob/main/src/react/useFiles.ts#146)

Revoke all blob URLs (cleanup)

**Returns**

`void`

***

### revokeBlobUrl()

> **revokeBlobUrl**: (`mediaId`: `string`) => `void`

Defined in: [src/react/useFiles.ts:144](https://github.com/anuma-ai/sdk/blob/main/src/react/useFiles.ts#144)

Revoke a specific blob URL

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`mediaId`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

***

### searchMedia()

> **searchMedia**: (`query`: `string`, `limit?`: `number`) => `Promise`<[`StoredMedia`](StoredMedia.md)\[]>

Defined in: [src/react/useFiles.ts:128](https://github.com/anuma-ai/sdk/blob/main/src/react/useFiles.ts#128)

Search files by name

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`query`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`limit?`

</td>
<td>

`number`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`StoredMedia`](StoredMedia.md)\[]>

***

### updateMedia()

> **updateMedia**: (`mediaId`: `string`, `options`: [`UpdateMediaOptions`](UpdateMediaOptions.md)) => `Promise`<[`StoredMedia`](StoredMedia.md) | `null`>

Defined in: [src/react/useFiles.ts:88](https://github.com/anuma-ai/sdk/blob/main/src/react/useFiles.ts#88)

Update a file record

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`mediaId`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`options`

</td>
<td>

[`UpdateMediaOptions`](UpdateMediaOptions.md)

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`StoredMedia`](StoredMedia.md) | `null`>

***

### updateMediaMessageIdBatch()

> **updateMediaMessageIdBatch**: (`mediaIds`: `string`\[], `messageId`: `string`) => `Promise`<`number`>

Defined in: [src/react/useFiles.ts:90](https://github.com/anuma-ai/sdk/blob/main/src/react/useFiles.ts#90)

Batch update file records with a messageId

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`mediaIds`

</td>
<td>

`string`\[]

</td>
</tr>
<tr>
<td>

`messageId`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`number`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/UseGoogleDriveBackupOptions

# UseGoogleDriveBackupOptions

Defined in: [src/react/useGoogleDriveBackup.ts:22](https://github.com/anuma-ai/sdk/blob/main/src/react/useGoogleDriveBackup.ts#22)

Options for useGoogleDriveBackup hook

## Properties

### conversationsFolder?

> `optional` **conversationsFolder**: `string`

Defined in: [src/react/useGoogleDriveBackup.ts:39](https://github.com/anuma-ai/sdk/blob/main/src/react/useGoogleDriveBackup.ts#39)

Subfolder for conversations (default: 'conversations')

***

### database

> **database**: `Database`

Defined in: [src/react/useGoogleDriveBackup.ts:24](https://github.com/anuma-ai/sdk/blob/main/src/react/useGoogleDriveBackup.ts#24)

WatermelonDB database instance

***

### exportConversation()

> **exportConversation**: (`conversationId`: `string`, `userAddress`: `string`) => `Promise`<{ `blob?`: `Blob`; `success`: `boolean`; }>

Defined in: [src/react/useGoogleDriveBackup.ts:30](https://github.com/anuma-ai/sdk/blob/main/src/react/useGoogleDriveBackup.ts#30)

Export a conversation to an encrypted blob

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`conversationId`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`userAddress`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<{ `blob?`: `Blob`; `success`: `boolean`; }>

***

### importConversation()

> **importConversation**: (`blob`: `Blob`, `userAddress`: `string`) => `Promise`<{ `success`: `boolean`; }>

Defined in: [src/react/useGoogleDriveBackup.ts:35](https://github.com/anuma-ai/sdk/blob/main/src/react/useGoogleDriveBackup.ts#35)

Import a conversation from an encrypted blob

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`blob`

</td>
<td>

`Blob`

</td>
</tr>
<tr>
<td>

`userAddress`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<{ `success`: `boolean`; }>

***

### requestEncryptionKey()

> **requestEncryptionKey**: (`address`: `string`) => `Promise`<`void`>

Defined in: [src/react/useGoogleDriveBackup.ts:28](https://github.com/anuma-ai/sdk/blob/main/src/react/useGoogleDriveBackup.ts#28)

Request encryption key for the user address

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`address`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`void`>

***

### rootFolder?

> `optional` **rootFolder**: `string`

Defined in: [src/react/useGoogleDriveBackup.ts:37](https://github.com/anuma-ai/sdk/blob/main/src/react/useGoogleDriveBackup.ts#37)

Root folder name in Google Drive (default: 'ai-chat-app')

***

### userAddress

> **userAddress**: `string` | `null`

Defined in: [src/react/useGoogleDriveBackup.ts:26](https://github.com/anuma-ai/sdk/blob/main/src/react/useGoogleDriveBackup.ts#26)

Current user address (null if not signed in)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/UseGoogleDriveBackupResult

# UseGoogleDriveBackupResult

Defined in: [src/react/useGoogleDriveBackup.ts:45](https://github.com/anuma-ai/sdk/blob/main/src/react/useGoogleDriveBackup.ts#45)

Result returned by useGoogleDriveBackup hook

## Properties

### backup()

> **backup**: (`options?`: `object`) => `Promise`<[`GoogleDriveExportResult`](GoogleDriveExportResult.md) | { `error`: `string`; }>

Defined in: [src/react/useGoogleDriveBackup.ts:47](https://github.com/anuma-ai/sdk/blob/main/src/react/useGoogleDriveBackup.ts#47)

Backup all conversations to Google Drive

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options?`

</td>
<td>

`object`

</td>
</tr>
<tr>
<td>

`options.onProgress?`

</td>
<td>

(`current`: `number`, `total`: `number`) => `void`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`GoogleDriveExportResult`](GoogleDriveExportResult.md) | { `error`: `string`; }>

***

### isAuthenticated

> **isAuthenticated**: `boolean`

Defined in: [src/react/useGoogleDriveBackup.ts:57](https://github.com/anuma-ai/sdk/blob/main/src/react/useGoogleDriveBackup.ts#57)

Whether user has a Google Drive token

***

### isConfigured

> **isConfigured**: `boolean`

Defined in: [src/react/useGoogleDriveBackup.ts:55](https://github.com/anuma-ai/sdk/blob/main/src/react/useGoogleDriveBackup.ts#55)

Whether Google Drive is configured

***

### restore()

> **restore**: (`options?`: `object`) => `Promise`<[`GoogleDriveImportResult`](GoogleDriveImportResult.md) | { `error`: `string`; }>

Defined in: [src/react/useGoogleDriveBackup.ts:51](https://github.com/anuma-ai/sdk/blob/main/src/react/useGoogleDriveBackup.ts#51)

Restore conversations from Google Drive

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options?`

</td>
<td>

`object`

</td>
</tr>
<tr>
<td>

`options.onProgress?`

</td>
<td>

(`current`: `number`, `total`: `number`) => `void`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`GoogleDriveImportResult`](GoogleDriveImportResult.md) | { `error`: `string`; }>

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/UseICloudBackupOptions

# UseICloudBackupOptions

Defined in: [src/react/useICloudBackup.ts:21](https://github.com/anuma-ai/sdk/blob/main/src/react/useICloudBackup.ts#21)

Options for useICloudBackup hook

## Properties

### database

> **database**: `Database`

Defined in: [src/react/useICloudBackup.ts:23](https://github.com/anuma-ai/sdk/blob/main/src/react/useICloudBackup.ts#23)

WatermelonDB database instance

***

### exportConversation()

> **exportConversation**: (`conversationId`: `string`, `userAddress`: `string`) => `Promise`<{ `blob?`: `Blob`; `success`: `boolean`; }>

Defined in: [src/react/useICloudBackup.ts:29](https://github.com/anuma-ai/sdk/blob/main/src/react/useICloudBackup.ts#29)

Export a conversation to an encrypted blob

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`conversationId`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`userAddress`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<{ `blob?`: `Blob`; `success`: `boolean`; }>

***

### importConversation()

> **importConversation**: (`blob`: `Blob`, `userAddress`: `string`) => `Promise`<{ `success`: `boolean`; }>

Defined in: [src/react/useICloudBackup.ts:34](https://github.com/anuma-ai/sdk/blob/main/src/react/useICloudBackup.ts#34)

Import a conversation from an encrypted blob

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`blob`

</td>
<td>

`Blob`

</td>
</tr>
<tr>
<td>

`userAddress`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<{ `success`: `boolean`; }>

***

### requestEncryptionKey()

> **requestEncryptionKey**: (`address`: `string`) => `Promise`<`void`>

Defined in: [src/react/useICloudBackup.ts:27](https://github.com/anuma-ai/sdk/blob/main/src/react/useICloudBackup.ts#27)

Request encryption key for the user address

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`address`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`void`>

***

### userAddress

> **userAddress**: `string` | `null`

Defined in: [src/react/useICloudBackup.ts:25](https://github.com/anuma-ai/sdk/blob/main/src/react/useICloudBackup.ts#25)

Current user address (null if not signed in)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/UseICloudBackupResult

# UseICloudBackupResult

Defined in: [src/react/useICloudBackup.ts:40](https://github.com/anuma-ai/sdk/blob/main/src/react/useICloudBackup.ts#40)

Result returned by useICloudBackup hook

## Properties

### backup()

> **backup**: (`options?`: `object`) => `Promise`<[`ICloudExportResult`](ICloudExportResult.md) | { `error`: `string`; }>

Defined in: [src/react/useICloudBackup.ts:42](https://github.com/anuma-ai/sdk/blob/main/src/react/useICloudBackup.ts#42)

Backup all conversations to iCloud

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options?`

</td>
<td>

`object`

</td>
</tr>
<tr>
<td>

`options.onProgress?`

</td>
<td>

(`current`: `number`, `total`: `number`) => `void`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`ICloudExportResult`](ICloudExportResult.md) | { `error`: `string`; }>

***

### isAuthenticated

> **isAuthenticated**: `boolean`

Defined in: [src/react/useICloudBackup.ts:52](https://github.com/anuma-ai/sdk/blob/main/src/react/useICloudBackup.ts#52)

Whether user has signed in to iCloud

***

### isAvailable

> **isAvailable**: `boolean`

Defined in: [src/react/useICloudBackup.ts:54](https://github.com/anuma-ai/sdk/blob/main/src/react/useICloudBackup.ts#54)

Whether CloudKit JS is available

***

### isConfigured

> **isConfigured**: `boolean`

Defined in: [src/react/useICloudBackup.ts:50](https://github.com/anuma-ai/sdk/blob/main/src/react/useICloudBackup.ts#50)

Whether iCloud is configured

***

### restore()

> **restore**: (`options?`: `object`) => `Promise`<[`ICloudImportResult`](ICloudImportResult.md) | { `error`: `string`; }>

Defined in: [src/react/useICloudBackup.ts:46](https://github.com/anuma-ai/sdk/blob/main/src/react/useICloudBackup.ts#46)

Restore conversations from iCloud

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options?`

</td>
<td>

`object`

</td>
</tr>
<tr>
<td>

`options.onProgress?`

</td>
<td>

(`current`: `number`, `total`: `number`) => `void`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`ICloudImportResult`](ICloudImportResult.md) | { `error`: `string`; }>

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/UseProjectsOptions

# UseProjectsOptions

Defined in: [src/react/useProjects.ts:36](https://github.com/anuma-ai/sdk/blob/main/src/react/useProjects.ts#36)

Options for useProjects hook.

## Properties

### database

> **database**: `Database`

Defined in: [src/react/useProjects.ts:38](https://github.com/anuma-ai/sdk/blob/main/src/react/useProjects.ts#38)

WatermelonDB database instance

***

### initialProjectId?

> `optional` **initialProjectId**: `string`

Defined in: [src/react/useProjects.ts:40](https://github.com/anuma-ai/sdk/blob/main/src/react/useProjects.ts#40)

Initial project ID to select (optional)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/UseProjectsResult

# UseProjectsResult

Defined in: [src/react/useProjects.ts:46](https://github.com/anuma-ai/sdk/blob/main/src/react/useProjects.ts#46)

Result returned by useProjects hook.

## Properties

### createProject()

> **createProject**: (`opts?`: [`CreateProjectOptions`](CreateProjectOptions.md)) => `Promise`<[`StoredProject`](StoredProject.md)>

Defined in: [src/react/useProjects.ts:61](https://github.com/anuma-ai/sdk/blob/main/src/react/useProjects.ts#61)

Create a new project

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`opts?`

</td>
<td>

[`CreateProjectOptions`](CreateProjectOptions.md)

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`StoredProject`](StoredProject.md)>

***

### currentProjectId

> **currentProjectId**: `string` | `null`

Defined in: [src/react/useProjects.ts:51](https://github.com/anuma-ai/sdk/blob/main/src/react/useProjects.ts#51)

Currently selected project ID

***

### deleteProject()

> **deleteProject**: (`projectId`: `string`) => `Promise`<`boolean`>

Defined in: [src/react/useProjects.ts:71](https://github.com/anuma-ai/sdk/blob/main/src/react/useProjects.ts#71)

Delete a project (soft delete)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`projectId`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`boolean`>

***

### getConversationsByProject()

> **getConversationsByProject**: (`projectId`: `string` | `null`) => `Promise`<[`StoredConversation`](StoredConversation.md)\[]>

Defined in: [src/react/useProjects.ts:81](https://github.com/anuma-ai/sdk/blob/main/src/react/useProjects.ts#81)

Get conversations by project (null = no project)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`projectId`

</td>
<td>

`string` | `null`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`StoredConversation`](StoredConversation.md)\[]>

***

### getProject()

> **getProject**: (`projectId`: `string`) => `Promise`<[`StoredProject`](StoredProject.md) | `null`>

Defined in: [src/react/useProjects.ts:63](https://github.com/anuma-ai/sdk/blob/main/src/react/useProjects.ts#63)

Get a single project by ID

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`projectId`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`StoredProject`](StoredProject.md) | `null`>

***

### getProjectConversationCount()

> **getProjectConversationCount**: (`projectId`: `string`) => `Promise`<`number`>

Defined in: [src/react/useProjects.ts:77](https://github.com/anuma-ai/sdk/blob/main/src/react/useProjects.ts#77)

Get count of conversations in a project

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`projectId`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`number`>

***

### getProjectConversations()

> **getProjectConversations**: (`projectId`: `string`) => `Promise`<[`StoredConversation`](StoredConversation.md)\[]>

Defined in: [src/react/useProjects.ts:75](https://github.com/anuma-ai/sdk/blob/main/src/react/useProjects.ts#75)

Get all conversations in a project

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`projectId`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`StoredConversation`](StoredConversation.md)\[]>

***

### getProjects()

> **getProjects**: () => `Promise`<[`StoredProject`](StoredProject.md)\[]>

Defined in: [src/react/useProjects.ts:65](https://github.com/anuma-ai/sdk/blob/main/src/react/useProjects.ts#65)

Get all projects

**Returns**

`Promise`<[`StoredProject`](StoredProject.md)\[]>

***

### inboxProjectId

> **inboxProjectId**: `string` | `null`

Defined in: [src/react/useProjects.ts:87](https://github.com/anuma-ai/sdk/blob/main/src/react/useProjects.ts#87)

The ID of the default Inbox project (auto-created)

***

### isLoading

> **isLoading**: `boolean`

Defined in: [src/react/useProjects.ts:55](https://github.com/anuma-ai/sdk/blob/main/src/react/useProjects.ts#55)

Whether projects are being loaded

***

### isReady

> **isReady**: `boolean`

Defined in: [src/react/useProjects.ts:57](https://github.com/anuma-ai/sdk/blob/main/src/react/useProjects.ts#57)

Whether the projects system is ready (database table exists)

***

### projects

> **projects**: [`StoredProject`](StoredProject.md)\[]

Defined in: [src/react/useProjects.ts:49](https://github.com/anuma-ai/sdk/blob/main/src/react/useProjects.ts#49)

List of all projects

***

### refreshProjects()

> **refreshProjects**: () => `Promise`<`void`>

Defined in: [src/react/useProjects.ts:85](https://github.com/anuma-ai/sdk/blob/main/src/react/useProjects.ts#85)

Refresh the projects list from database

**Returns**

`Promise`<`void`>

***

### setCurrentProjectId()

> **setCurrentProjectId**: (`id`: `string` | `null`) => `void`

Defined in: [src/react/useProjects.ts:53](https://github.com/anuma-ai/sdk/blob/main/src/react/useProjects.ts#53)

Set the current project ID

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`id`

</td>
<td>

`string` | `null`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

***

### updateConversationProject()

> **updateConversationProject**: (`conversationId`: `string`, `projectId`: `string` | `null`) => `Promise`<`boolean`>

Defined in: [src/react/useProjects.ts:79](https://github.com/anuma-ai/sdk/blob/main/src/react/useProjects.ts#79)

Move a conversation to a project (or remove with null)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`conversationId`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`projectId`

</td>
<td>

`string` | `null`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`boolean`>

***

### updateProject()

> **updateProject**: (`projectId`: `string`, `opts`: [`UpdateProjectOptions`](UpdateProjectOptions.md)) => `Promise`<`boolean`>

Defined in: [src/react/useProjects.ts:69](https://github.com/anuma-ai/sdk/blob/main/src/react/useProjects.ts#69)

Update a project with partial options

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`projectId`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`opts`

</td>
<td>

[`UpdateProjectOptions`](UpdateProjectOptions.md)

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`boolean`>

***

### updateProjectName()

> **updateProjectName**: (`projectId`: `string`, `name`: `string`) => `Promise`<`boolean`>

Defined in: [src/react/useProjects.ts:67](https://github.com/anuma-ai/sdk/blob/main/src/react/useProjects.ts#67)

Update a project's name

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`projectId`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`name`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`boolean`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/UseSettingsResult

# UseSettingsResult

Defined in: [src/react/useSettings.ts:42](https://github.com/anuma-ai/sdk/blob/main/src/react/useSettings.ts#42)

Extended result returned by useSettings hook (React version)
Includes both legacy modelPreference API and new userPreference API

## Extends

* `BaseUseSettingsResult`

## Properties

### deleteModelPreference()

> **deleteModelPreference**: (`walletAddress`: `string`) => `Promise`<`boolean`>

Defined in: [src/lib/db/settings/types.ts:38](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/settings/types.ts#38)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`walletAddress`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`boolean`>

**Inherited from**

`BaseUseSettingsResult.deleteModelPreference`

***

### deleteUserPreference()

> **deleteUserPreference**: (`walletAddress`: `string`) => `Promise`<`boolean`>

Defined in: [src/react/useSettings.ts:59](https://github.com/anuma-ai/sdk/blob/main/src/react/useSettings.ts#59)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`walletAddress`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`boolean`>

***

### getModelPreference()

> **getModelPreference**: (`walletAddress`: `string`) => `Promise`<[`StoredModelPreference`](StoredModelPreference.md) | `null`>

Defined in: [src/lib/db/settings/types.ts:33](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/settings/types.ts#33)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`walletAddress`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`StoredModelPreference`](StoredModelPreference.md) | `null`>

**Inherited from**

`BaseUseSettingsResult.getModelPreference`

***

### getUserPreference()

> **getUserPreference**: (`walletAddress`: `string`) => `Promise`<[`StoredUserPreference`](StoredUserPreference.md) | `null`>

Defined in: [src/react/useSettings.ts:45](https://github.com/anuma-ai/sdk/blob/main/src/react/useSettings.ts#45)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`walletAddress`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`StoredUserPreference`](StoredUserPreference.md) | `null`>

***

### isLoading

> **isLoading**: `boolean`

Defined in: [src/lib/db/settings/types.ts:32](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/settings/types.ts#32)

**Inherited from**

`BaseUseSettingsResult.isLoading`

***

### modelPreference

> **modelPreference**: [`StoredModelPreference`](StoredModelPreference.md) | `null`

Defined in: [src/lib/db/settings/types.ts:31](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/settings/types.ts#31)

**Inherited from**

`BaseUseSettingsResult.modelPreference`

***

### setModelPreference()

> **setModelPreference**: (`walletAddress`: `string`, `models?`: `string`) => `Promise`<[`StoredModelPreference`](StoredModelPreference.md) | `null`>

Defined in: [src/lib/db/settings/types.ts:34](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/settings/types.ts#34)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`walletAddress`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`models?`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`StoredModelPreference`](StoredModelPreference.md) | `null`>

**Inherited from**

`BaseUseSettingsResult.setModelPreference`

***

### setUserPreference()

> **setUserPreference**: (`walletAddress`: `string`, `options`: [`UpdateUserPreferenceOptions`](UpdateUserPreferenceOptions.md)) => `Promise`<[`StoredUserPreference`](StoredUserPreference.md)>

Defined in: [src/react/useSettings.ts:46](https://github.com/anuma-ai/sdk/blob/main/src/react/useSettings.ts#46)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`walletAddress`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`options`

</td>
<td>

[`UpdateUserPreferenceOptions`](UpdateUserPreferenceOptions.md)

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`StoredUserPreference`](StoredUserPreference.md)>

***

### updateModels()

> **updateModels**: (`walletAddress`: `string`, `models`: `string`) => `Promise`<[`StoredUserPreference`](StoredUserPreference.md) | `null`>

Defined in: [src/react/useSettings.ts:58](https://github.com/anuma-ai/sdk/blob/main/src/react/useSettings.ts#58)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`walletAddress`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`models`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`StoredUserPreference`](StoredUserPreference.md) | `null`>

***

### updatePersonality()

> **updatePersonality**: (`walletAddress`: `string`, `personality`: [`PersonalitySettings`](PersonalitySettings.md)) => `Promise`<[`StoredUserPreference`](StoredUserPreference.md) | `null`>

Defined in: [src/react/useSettings.ts:54](https://github.com/anuma-ai/sdk/blob/main/src/react/useSettings.ts#54)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`walletAddress`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`personality`

</td>
<td>

[`PersonalitySettings`](PersonalitySettings.md)

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`StoredUserPreference`](StoredUserPreference.md) | `null`>

***

### updateProfile()

> **updateProfile**: (`walletAddress`: `string`, `profile`: [`ProfileUpdate`](ProfileUpdate.md)) => `Promise`<[`StoredUserPreference`](StoredUserPreference.md) | `null`>

Defined in: [src/react/useSettings.ts:50](https://github.com/anuma-ai/sdk/blob/main/src/react/useSettings.ts#50)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`walletAddress`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`profile`

</td>
<td>

[`ProfileUpdate`](ProfileUpdate.md)

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`StoredUserPreference`](StoredUserPreference.md) | `null`>

***

### userPreference

> **userPreference**: [`StoredUserPreference`](StoredUserPreference.md) | `null`

Defined in: [src/react/useSettings.ts:44](https://github.com/anuma-ai/sdk/blob/main/src/react/useSettings.ts#44)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/VaultFolderOperationsContext

# VaultFolderOperationsContext

Defined in: [src/lib/db/vaultFolders/operations.ts:12](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/vaultFolders/operations.ts#12)

## Properties

### database

> **database**: `Database`

Defined in: [src/lib/db/vaultFolders/operations.ts:13](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/vaultFolders/operations.ts#13)

***

### vaultFolderCollection

> **vaultFolderCollection**: `Collection`<[`StoredVaultFolderModel`](../classes/StoredVaultFolderModel.md)>

Defined in: [src/lib/db/vaultFolders/operations.ts:14](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/vaultFolders/operations.ts#14)

***

### vaultMemoryCollection

> **vaultMemoryCollection**: `Collection`<[`StoredVaultMemoryModel`](../classes/StoredVaultMemoryModel.md)>

Defined in: [src/lib/db/vaultFolders/operations.ts:15](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/vaultFolders/operations.ts#15)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/VaultMemoryOperationsContext

# VaultMemoryOperationsContext

Defined in: [src/lib/db/memoryVault/operations.ts:13](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/memoryVault/operations.ts#13)

## Properties

### database

> **database**: `Database`

Defined in: [src/lib/db/memoryVault/operations.ts:14](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/memoryVault/operations.ts#14)

***

### embeddedWalletSigner?

> `optional` **embeddedWalletSigner**: [`EmbeddedWalletSignerFn`](../type-aliases/EmbeddedWalletSignerFn.md)

Defined in: [src/lib/db/memoryVault/operations.ts:18](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/memoryVault/operations.ts#18)

***

### signMessage?

> `optional` **signMessage**: [`SignMessageFn`](../type-aliases/SignMessageFn.md)

Defined in: [src/lib/db/memoryVault/operations.ts:17](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/memoryVault/operations.ts#17)

***

### userId?

> `optional` **userId**: `string`

Defined in: [src/lib/db/memoryVault/operations.ts:20](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/memoryVault/operations.ts#20)

When set, operations scope to this user (server-side multi-user).

***

### vaultMemoryCollection

> **vaultMemoryCollection**: `Collection`<[`StoredVaultMemoryModel`](../classes/StoredVaultMemoryModel.md)>

Defined in: [src/lib/db/memoryVault/operations.ts:15](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/memoryVault/operations.ts#15)

***

### walletAddress?

> `optional` **walletAddress**: `string`

Defined in: [src/lib/db/memoryVault/operations.ts:16](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/memoryVault/operations.ts#16)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/VaultSaveOperation

# VaultSaveOperation

Defined in: [src/lib/memoryVault/tool.ts:21](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryVault/tool.ts#21)

Describes a pending vault save operation for UI confirmation.

## Properties

### action

> **action**: `"update"` | `"add"`

Defined in: [src/lib/memoryVault/tool.ts:23](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryVault/tool.ts#23)

Whether this is a new memory or an update to an existing one

***

### content

> **content**: `string`

Defined in: [src/lib/memoryVault/tool.ts:25](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryVault/tool.ts#25)

The memory content to save

***

### id?

> `optional` **id**: `string`

Defined in: [src/lib/memoryVault/tool.ts:29](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryVault/tool.ts#29)

The ID of the memory being updated (only present for updates)

***

### previousContent?

> `optional` **previousContent**: `string`

Defined in: [src/lib/memoryVault/tool.ts:31](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryVault/tool.ts#31)

The previous content of the memory (only present for updates, for diff display)

***

### scope?

> `optional` **scope**: `string`

Defined in: [src/lib/memoryVault/tool.ts:27](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryVault/tool.ts#27)

The scope of the memory (only present for add operations)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/VaultSearchResult

# VaultSearchResult

Defined in: [src/lib/memoryVault/searchTool.ts:289](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryVault/searchTool.ts#289)

A single vault search result with its similarity score.

## Properties

### content

> **content**: `string`

Defined in: [src/lib/memoryVault/searchTool.ts:291](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryVault/searchTool.ts#291)

***

### similarity

> **similarity**: `number`

Defined in: [src/lib/memoryVault/searchTool.ts:292](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryVault/searchTool.ts#292)

***

### uniqueId

> **uniqueId**: `string`

Defined in: [src/lib/memoryVault/searchTool.ts:290](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryVault/searchTool.ts#290)

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/VoiceRecording

# VoiceRecording

Defined in: [src/lib/voice/types.ts:9](https://github.com/anuma-ai/sdk/blob/main/src/lib/voice/types.ts#9)

## Properties

### blob

> **blob**: `Blob`

Defined in: [src/lib/voice/types.ts:11](https://github.com/anuma-ai/sdk/blob/main/src/lib/voice/types.ts#11)

Audio blob from MediaRecorder

***

### duration

> **duration**: `number`

Defined in: [src/lib/voice/types.ts:13](https://github.com/anuma-ai/sdk/blob/main/src/lib/voice/types.ts#13)

Recording duration in milliseconds

***

### mimeType

> **mimeType**: `string`

Defined in: [src/lib/voice/types.ts:15](https://github.com/anuma-ai/sdk/blob/main/src/lib/voice/types.ts#15)

MIME type of the recording (e.g. "audio/webm")

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/WatermelonChatStorageAdapterOptions

# WatermelonChatStorageAdapterOptions

Defined in: [src/lib/storage/WatermelonChatStorageAdapter.ts:59](https://github.com/anuma-ai/sdk/blob/main/src/lib/storage/WatermelonChatStorageAdapter.ts#59)

Context needed to construct a `WatermelonChatStorageAdapter`.

Mirrors `StorageOperationsContext` but exposes only the `Database` — the
adapter resolves the required collections itself so callers don't have to
know the table names.

## Properties

### database

> **database**: `Database`

Defined in: [src/lib/storage/WatermelonChatStorageAdapter.ts:60](https://github.com/anuma-ai/sdk/blob/main/src/lib/storage/WatermelonChatStorageAdapter.ts#60)

***

### embeddedWalletSigner?

> `optional` **embeddedWalletSigner**: [`EmbeddedWalletSignerFn`](../type-aliases/EmbeddedWalletSignerFn.md)

Defined in: [src/lib/storage/WatermelonChatStorageAdapter.ts:66](https://github.com/anuma-ai/sdk/blob/main/src/lib/storage/WatermelonChatStorageAdapter.ts#66)

Silent signing function for embedded wallets (optional).

***

### signMessage?

> `optional` **signMessage**: [`SignMessageFn`](../type-aliases/SignMessageFn.md)

Defined in: [src/lib/storage/WatermelonChatStorageAdapter.ts:64](https://github.com/anuma-ai/sdk/blob/main/src/lib/storage/WatermelonChatStorageAdapter.ts#64)

Signing function for deriving encryption keys (optional).

***

### walletAddress?

> `optional` **walletAddress**: `string`

Defined in: [src/lib/storage/WatermelonChatStorageAdapter.ts:62](https://github.com/anuma-ai/sdk/blob/main/src/lib/storage/WatermelonChatStorageAdapter.ts#62)

Wallet address for field-level encryption (optional).

---
Source: https://docs.anuma.ai/sdk/react/Internal/interfaces/ZipProcessorOptions

# ZipProcessorOptions

Defined in: [src/lib/processors/ZipProcessor.ts:12](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/ZipProcessor.ts#12)

Options for configuring ZipProcessor behavior

## Properties

### includeHidden?

> `optional` **includeHidden**: `boolean`

Defined in: [src/lib/processors/ZipProcessor.ts:17](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/ZipProcessor.ts#17)

Whether to include hidden files and directories (default: false)

***

### maxFileSize?

> `optional` **maxFileSize**: `number`

Defined in: [src/lib/processors/ZipProcessor.ts:14](https://github.com/anuma-ai/sdk/blob/main/src/lib/processors/ZipProcessor.ts#14)

Maximum size (in bytes) for processing individual files (default: 10MB)

---
Source: https://docs.anuma.ai/sdk/react/Internal/type-aliases/AnumaChild

# AnumaChild

> **AnumaChild** = [`AnumaNode`](../interfaces/AnumaNode.md) | `string`

Defined in: [src/tools/slides/jsx.ts:52](https://github.com/anuma-ai/sdk/blob/main/src/tools/slides/jsx.ts#52)

---
Source: https://docs.anuma.ai/sdk/react/Internal/type-aliases/AttrValue

# AttrValue

> **AttrValue** = `AttrScalar` | `AttrObject`

Defined in: [src/tools/slides/jsx.ts:50](https://github.com/anuma-ai/sdk/blob/main/src/tools/slides/jsx.ts#50)

---
Source: https://docs.anuma.ai/sdk/react/Internal/type-aliases/ChartCardProps

# ChartCardProps

> **ChartCardProps** = `object`

Defined in: [src/react/chart.tsx:344](https://github.com/anuma-ai/sdk/blob/main/src/react/chart.tsx#344)

## Properties

### data

> **data**: `DisplayChartResult`

Defined in: [src/react/chart.tsx:345](https://github.com/anuma-ai/sdk/blob/main/src/react/chart.tsx#345)

---
Source: https://docs.anuma.ai/sdk/react/Internal/type-aliases/ChartConfig

# ChartConfig

> **ChartConfig** = { \[k in string]: { icon?: React.ComponentType; label?: React.ReactNode } & ({ color?: string; theme?: never } | { color?: never; theme: Record\<keyof typeof THEMES, string> }) }

Defined in: [src/react/chart.tsx:36](https://github.com/anuma-ai/sdk/blob/main/src/react/chart.tsx#36)

---
Source: https://docs.anuma.ai/sdk/react/Internal/type-aliases/ChatRole

# ChatRole

> **ChatRole** = `"user"` | `"assistant"` | `"system"`

Defined in: [src/lib/db/chat/types.ts:54](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#54)

---
Source: https://docs.anuma.ai/sdk/react/Internal/type-aliases/ClientToolsFilterFn

# ClientToolsFilterFn

> **ClientToolsFilterFn** = (`embeddings`: `number`\[] | `number`\[]\[] | `null`, `tools`: [`LlmapiChatCompletionTool`](../../../client/Internal/type-aliases/LlmapiChatCompletionTool.md)\[]) => `string`\[]

Defined in: [src/lib/db/chat/types.ts:47](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#47)

Function type for dynamic client tools filtering based on prompt embeddings.
Receives the prompt embedding(s) (or null for short messages where no embedding
was generated) and all client tools, returns tool names to include.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`embeddings`

</td>
<td>

`number`\[] | `number`\[]\[] | `null`

</td>
<td>

Single embedding, array of embeddings, or null (short message)

</td>
</tr>
<tr>
<td>

`tools`

</td>
<td>

[`LlmapiChatCompletionTool`](../../../client/Internal/type-aliases/LlmapiChatCompletionTool.md)\[]

</td>
<td>

All client tools passed to sendMessage

</td>
</tr>
</tbody>
</table>

## Returns

`string`\[]

Array of tool names to include

---
Source: https://docs.anuma.ai/sdk/react/Internal/type-aliases/DisplayToolMigrations

# DisplayToolMigrations

> **DisplayToolMigrations** = `object`

Defined in: [src/tools/uiInteraction.ts:71](https://github.com/anuma-ai/sdk/blob/main/src/tools/uiInteraction.ts#71)

Migration map for a display tool.
Keys are "fromVersion->toVersion" strings (e.g. "1->2").
Each function receives the stored result at fromVersion and returns the
result upgraded to toVersion.

## Index Signature

\[`key`: `` `${number}->${number}` ``]: (`data`: `unknown`) => `unknown`

## Example

```typescript
migrations: {
  "1->2": (old) => ({ ...old, newField: old.legacyField ?? defaultValue }),
}
```

---
Source: https://docs.anuma.ai/sdk/react/Internal/type-aliases/EmbeddedWalletSignerFn

# EmbeddedWalletSignerFn

> **EmbeddedWalletSignerFn** = (`message`: `string`, `options?`: [`SignMessageOptions`](../interfaces/SignMessageOptions.md)) => `Promise`<`string`>

Defined in: [src/react/useEncryption.ts:845](https://github.com/anuma-ai/sdk/blob/main/src/react/useEncryption.ts#845)

Type for embedded wallet signer function that enables silent signing.
For Privy embedded wallets, this can sign programmatically without user interaction
when configured correctly in the Privy dashboard.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`message`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`options?`

</td>
<td>

[`SignMessageOptions`](../interfaces/SignMessageOptions.md)

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`string`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/type-aliases/InteractionType

# InteractionType

> **InteractionType** = `"choice"` | `"form"` | `"display"` | `string` & `object`

Defined in: [src/react/useUIInteraction.ts:16](https://github.com/anuma-ai/sdk/blob/main/src/react/useUIInteraction.ts#16)

Extensible interaction type - includes built-in types and allows custom strings

---
Source: https://docs.anuma.ai/sdk/react/Internal/type-aliases/KnownTag

# KnownTag

> **KnownTag** = *typeof* `ANUMA_TAGS`\[`number`]

Defined in: [src/tools/slides/jsx.ts:117](https://github.com/anuma-ai/sdk/blob/main/src/tools/slides/jsx.ts#117)

---
Source: https://docs.anuma.ai/sdk/react/Internal/type-aliases/MediaRole

# MediaRole

> **MediaRole** = `"user"` | `"assistant"`

Defined in: [src/lib/db/media/types.ts:18](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#18)

Role indicating who attached the media.

* user: Uploaded by the user
* assistant: Generated/attached by the AI

---
Source: https://docs.anuma.ai/sdk/react/Internal/type-aliases/MediaType

# MediaType

> **MediaType** = `"image"` | `"video"` | `"audio"` | `"document"`

Defined in: [src/lib/db/media/types.ts:11](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/media/types.ts#11)

Media type categorization for library filtering.

* image: PNG, JPG, GIF, WebP, SVG, etc.
* video: MP4, WebM, MOV, etc.
* audio: MP3, WAV, OGG, etc.
* document: PDF, DOCX, XLSX, TXT, etc.

---
Source: https://docs.anuma.ai/sdk/react/Internal/type-aliases/MessageFeedback

# MessageFeedback

> **MessageFeedback** = `"like"` | `"dislike"` | `null`

Defined in: [src/lib/db/chat/types.ts:62](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#62)

Feedback type for message like/dislike.

* 'like': User liked the response (thumbs up)
* 'dislike': User disliked the response (thumbs down)
* null/undefined: No feedback given

---
Source: https://docs.anuma.ai/sdk/react/Internal/type-aliases/OperationExecutor

# OperationExecutor

> **OperationExecutor** = (`operation`: [`QueuedOperation`](../interfaces/QueuedOperation.md), `encryptionContext`: [`QueueEncryptionContext`](../interfaces/QueueEncryptionContext.md)) => `Promise`<`void`>

Defined in: [src/lib/db/queue/types.ts:86](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/queue/types.ts#86)

Executor function that runs a single queued operation.
Provided by the consumer (e.g., useChatStorage) during flush.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`operation`

</td>
<td>

[`QueuedOperation`](../interfaces/QueuedOperation.md)

</td>
</tr>
<tr>
<td>

`encryptionContext`

</td>
<td>

[`QueueEncryptionContext`](../interfaces/QueueEncryptionContext.md)

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`void`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/type-aliases/PendingInteraction

# PendingInteraction\<TData, TResult>

> **PendingInteraction**<`TData`, `TResult`> = `object`

Defined in: [src/react/useUIInteraction.ts:21](https://github.com/anuma-ai/sdk/blob/main/src/react/useUIInteraction.ts#21)

Represents a pending user interaction that needs to be resolved

## Type Parameters

<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`TData`

</td>
<td>

`unknown`

</td>
</tr>
<tr>
<td>

`TResult`

</td>
<td>

`unknown`

</td>
</tr>
</tbody>
</table>

## Properties

### createdAt

> **createdAt**: `number`

Defined in: [src/react/useUIInteraction.ts:27](https://github.com/anuma-ai/sdk/blob/main/src/react/useUIInteraction.ts#27)

***

### data

> **data**: `TData`

Defined in: [src/react/useUIInteraction.ts:24](https://github.com/anuma-ai/sdk/blob/main/src/react/useUIInteraction.ts#24)

***

### id

> **id**: `string`

Defined in: [src/react/useUIInteraction.ts:22](https://github.com/anuma-ai/sdk/blob/main/src/react/useUIInteraction.ts#22)

***

### reject()

> **reject**: (`error`: `Error`) => `void`

Defined in: [src/react/useUIInteraction.ts:26](https://github.com/anuma-ai/sdk/blob/main/src/react/useUIInteraction.ts#26)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`error`

</td>
<td>

`Error`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

***

### replacesInteractionId?

> `optional` **replacesInteractionId**: `string`

Defined in: [src/react/useUIInteraction.ts:33](https://github.com/anuma-ai/sdk/blob/main/src/react/useUIInteraction.ts#33)

If set, this interaction replaces a previous one (e.g. an updated app)

***

### resolve()

> **resolve**: (`result`: `TResult`) => `void`

Defined in: [src/react/useUIInteraction.ts:25](https://github.com/anuma-ai/sdk/blob/main/src/react/useUIInteraction.ts#25)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`result`

</td>
<td>

`TResult`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

***

### resolved?

> `optional` **resolved**: `boolean`

Defined in: [src/react/useUIInteraction.ts:28](https://github.com/anuma-ai/sdk/blob/main/src/react/useUIInteraction.ts#28)

***

### result?

> `optional` **result**: `TResult`

Defined in: [src/react/useUIInteraction.ts:29](https://github.com/anuma-ai/sdk/blob/main/src/react/useUIInteraction.ts#29)

***

### toolVersion?

> `optional` **toolVersion**: `number`

Defined in: [src/react/useUIInteraction.ts:31](https://github.com/anuma-ai/sdk/blob/main/src/react/useUIInteraction.ts#31)

Version of the display tool that produced this interaction (for migration on restore)

***

### type

> **type**: [`InteractionType`](InteractionType.md)

Defined in: [src/react/useUIInteraction.ts:23](https://github.com/anuma-ai/sdk/blob/main/src/react/useUIInteraction.ts#23)

---
Source: https://docs.anuma.ai/sdk/react/Internal/type-aliases/PersonalityStyle

# PersonalityStyle

> **PersonalityStyle** = `"default"` | `"professional"` | `"friendly"` | `"candid"` | `"quirky"` | `"efficient"` | `"nerdy"` | `"cynical"`

Defined in: [src/lib/db/userPreferences/types.ts:22](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/userPreferences/types.ts#22)

Base communication style (mutually exclusive)

---
Source: https://docs.anuma.ai/sdk/react/Internal/type-aliases/PhoneCallPollingOptions

# PhoneCallPollingOptions

> **PhoneCallPollingOptions** = `object`

Defined in: [src/react/usePhoneCalls.ts:44](https://github.com/anuma-ai/sdk/blob/main/src/react/usePhoneCalls.ts#44)

## Properties

### intervalMs?

> `optional` **intervalMs**: `number`

Defined in: [src/react/usePhoneCalls.ts:48](https://github.com/anuma-ai/sdk/blob/main/src/react/usePhoneCalls.ts#48)

Poll interval in milliseconds.

***

### maxAttempts?

> `optional` **maxAttempts**: `number`

Defined in: [src/react/usePhoneCalls.ts:52](https://github.com/anuma-ai/sdk/blob/main/src/react/usePhoneCalls.ts#52)

Maximum number of polling attempts before stopping.

***

### onUpdate()?

> `optional` **onUpdate**: (`call`: [`HandlersPhoneCallResponse`](../../../client/Internal/type-aliases/HandlersPhoneCallResponse.md)) => `void`

Defined in: [src/react/usePhoneCalls.ts:60](https://github.com/anuma-ai/sdk/blob/main/src/react/usePhoneCalls.ts#60)

Optional callback after each successful poll response.

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`call`

</td>
<td>

[`HandlersPhoneCallResponse`](../../../client/Internal/type-aliases/HandlersPhoneCallResponse.md)

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

***

### stopWhenCompleted?

> `optional` **stopWhenCompleted**: `boolean`

Defined in: [src/react/usePhoneCalls.ts:56](https://github.com/anuma-ai/sdk/blob/main/src/react/usePhoneCalls.ts#56)

Stop automatically when the call reaches a terminal state.

---
Source: https://docs.anuma.ai/sdk/react/Internal/type-aliases/ProgressCallback

# ProgressCallback

> **ProgressCallback** = (`current`: `number`, `total`: `number`) => `void`

Defined in: [src/react/useBackup.ts:66](https://github.com/anuma-ai/sdk/blob/main/src/react/useBackup.ts#66)

Progress callback type

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`current`

</td>
<td>

`number`

</td>
</tr>
<tr>
<td>

`total`

</td>
<td>

`number`

</td>
</tr>
</tbody>
</table>

## Returns

`void`

---
Source: https://docs.anuma.ai/sdk/react/Internal/type-aliases/QueuedOperationType

# QueuedOperationType

> **QueuedOperationType** = `"createConversation"` | `"updateConversationTitle"` | `"createMessage"` | `"updateMessage"` | `"createMedia"` | `"createMediaBatch"` | `"updateMediaMessageId"`

Defined in: [src/lib/db/queue/types.ts:13](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/queue/types.ts#13)

Types of database operations that can be queued.

---
Source: https://docs.anuma.ai/sdk/react/Internal/type-aliases/SendMessageWithStorageResult

# SendMessageWithStorageResult

> **SendMessageWithStorageResult** = { `assistantMessage`: [`StoredMessage`](../interfaces/StoredMessage.md); `autoExecutedToolResults?`: `object`\[]; `data`: `ApiResponse`; `error`: `null`; `userMessage`: [`StoredMessage`](../interfaces/StoredMessage.md); } | { `assistantMessage?`: `undefined`; `data`: `ApiResponse`; `error`: `null`; `skipped`: `true`; `userMessage?`: `undefined`; } | { `assistantMessage?`: `undefined`; `data`: `null`; `error`: `string`; `userMessage?`: [`StoredMessage`](../interfaces/StoredMessage.md); }

Defined in: [src/react/useChatStorage.ts:719](https://github.com/anuma-ai/sdk/blob/main/src/react/useChatStorage.ts#719)

Result from sendMessage with storage (React version)
The `data` field contains the raw server response which includes `tools_checksum`.

## Type Declaration

{ `assistantMessage`: [`StoredMessage`](../interfaces/StoredMessage.md); `autoExecutedToolResults?`: `object`\[]; `data`: `ApiResponse`; `error`: `null`; `userMessage`: [`StoredMessage`](../interfaces/StoredMessage.md); }

### assistantMessage

> **assistantMessage**: [`StoredMessage`](../interfaces/StoredMessage.md)

### autoExecutedToolResults?

> `optional` **autoExecutedToolResults**: `object`\[]

Results from tools that were auto-executed by the SDK (e.g. display tools)

### data

> **data**: `ApiResponse`

### error

> **error**: `null`

### userMessage

> **userMessage**: [`StoredMessage`](../interfaces/StoredMessage.md)

{ `assistantMessage?`: `undefined`; `data`: `ApiResponse`; `error`: `null`; `skipped`: `true`; `userMessage?`: `undefined`; }

### assistantMessage?

> `optional` **assistantMessage**: `undefined`

### data

> **data**: `ApiResponse`

### error

> **error**: `null`

### skipped

> **skipped**: `true`

Indicates this was a skipStorage request - no messages were persisted

### userMessage?

> `optional` **userMessage**: `undefined`

{ `assistantMessage?`: `undefined`; `data`: `null`; `error`: `string`; `userMessage?`: [`StoredMessage`](../interfaces/StoredMessage.md); }

### assistantMessage?

> `optional` **assistantMessage**: `undefined`

### data

> **data**: `null`

### error

> **error**: `string`

### userMessage?

> `optional` **userMessage**: [`StoredMessage`](../interfaces/StoredMessage.md)

---
Source: https://docs.anuma.ai/sdk/react/Internal/type-aliases/ServerToolsFilter

# ServerToolsFilter

> **ServerToolsFilter** = `string`\[] | [`ServerToolsFilterFn`](ServerToolsFilterFn.md)

Defined in: [src/lib/db/chat/types.ts:36](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#36)

Server tools filter: static list of names or dynamic function.

* string\[]: Static list of tool names to include
* ServerToolsFilterFn: Dynamic filter based on prompt embeddings

---
Source: https://docs.anuma.ai/sdk/react/Internal/type-aliases/ServerToolsFilterFn

# ServerToolsFilterFn

> **ServerToolsFilterFn** = (`embeddings`: `number`\[] | `number`\[]\[], `tools`: [`ServerTool`](../interfaces/ServerTool.md)\[]) => `string`\[]

Defined in: [src/lib/db/chat/types.ts:26](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/types.ts#26)

Function type for dynamic server tools filtering based on prompt embeddings.
Receives the prompt embedding(s) and all available tools, returns tool names to include.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`embeddings`

</td>
<td>

`number`\[] | `number`\[]\[]

</td>
<td>

Single embedding or array of embeddings (for chunked messages)

</td>
</tr>
<tr>
<td>

`tools`

</td>
<td>

[`ServerTool`](../interfaces/ServerTool.md)\[]

</td>
<td>

All available server tools with embeddings

</td>
</tr>
</tbody>
</table>

## Returns

`string`\[]

Array of tool names to include

---
Source: https://docs.anuma.ai/sdk/react/Internal/type-aliases/ServerToolsFilterFunction

# ServerToolsFilterFunction

> **ServerToolsFilterFunction** = (`embeddings`: `number`\[] | `number`\[]\[], `tools`: [`ServerTool`](../interfaces/ServerTool.md)\[]) => `string`\[]

Defined in: [src/lib/tools/serverTools.ts:1123](https://github.com/anuma-ai/sdk/blob/main/src/lib/tools/serverTools.ts#1123)

Type for a server-tools filter — a function that takes prompt embeddings
and the full server tool catalog and returns the names of tools to keep.
Matches `useChatStorage`'s `serverTools` callback signature.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`embeddings`

</td>
<td>

`number`\[] | `number`\[]\[]

</td>
</tr>
<tr>
<td>

`tools`

</td>
<td>

[`ServerTool`](../interfaces/ServerTool.md)\[]

</td>
</tr>
</tbody>
</table>

## Returns

`string`\[]

---
Source: https://docs.anuma.ai/sdk/react/Internal/type-aliases/ServerToolsResponse

# ServerToolsResponse

> **ServerToolsResponse** = { `checksum`: `string`; `tools`: `ServerToolsMap`; } | `ServerToolsMap`

Defined in: [src/lib/tools/serverTools.ts:53](https://github.com/anuma-ai/sdk/blob/main/src/lib/tools/serverTools.ts#53)

Response format from /api/v1/tools endpoint.
New format includes checksum and tools wrapper.
Legacy format is just the tools map directly.

---
Source: https://docs.anuma.ai/sdk/react/Internal/type-aliases/SignMessageFn

# SignMessageFn

> **SignMessageFn** = (`message`: `string`, `options?`: [`SignMessageOptions`](../interfaces/SignMessageOptions.md)) => `Promise`<`string`>

Defined in: [src/react/useEncryption.ts:838](https://github.com/anuma-ai/sdk/blob/main/src/react/useEncryption.ts#838)

Type for the signMessage function that client must provide.
This is typically from Privy's useSignMessage hook.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`message`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`options?`

</td>
<td>

[`SignMessageOptions`](../interfaces/SignMessageOptions.md)

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`string`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/type-aliases/StepFinishEvent

# StepFinishEvent

> **StepFinishEvent** = `object`

Defined in: [src/lib/chat/toolLoop.ts:377](https://github.com/anuma-ai/sdk/blob/main/src/lib/chat/toolLoop.ts#377)

Information emitted after each tool execution round completes.

## Properties

### content

> **content**: `string`

Defined in: [src/lib/chat/toolLoop.ts:381](https://github.com/anuma-ai/sdk/blob/main/src/lib/chat/toolLoop.ts#381)

Text content the model produced in this round (may be empty if the model only called tools).

***

### stepIndex

> **stepIndex**: `number`

Defined in: [src/lib/chat/toolLoop.ts:379](https://github.com/anuma-ai/sdk/blob/main/src/lib/chat/toolLoop.ts#379)

1-based index of this tool round.

***

### toolCalls

> **toolCalls**: `object`\[]

Defined in: [src/lib/chat/toolLoop.ts:383](https://github.com/anuma-ai/sdk/blob/main/src/lib/chat/toolLoop.ts#383)

Tool calls the model made in this round.

**arguments**

> **arguments**: `string`

**name**

> **name**: `string`

***

### toolResults

> **toolResults**: `object`\[]

Defined in: [src/lib/chat/toolLoop.ts:385](https://github.com/anuma-ai/sdk/blob/main/src/lib/chat/toolLoop.ts#385)

Results from auto-executed tools in this round.

**error?**

> `optional` **error**: `string`

**errorType?**

> `optional` **errorType**: `ToolExecutionErrorType`

**name**

> **name**: `string`

**result**

> **result**: `unknown`

***

### usage

> **usage**: `object`

Defined in: [src/lib/chat/toolLoop.ts:392](https://github.com/anuma-ai/sdk/blob/main/src/lib/chat/toolLoop.ts#392)

Token usage for this round, if available.

**inputTokens?**

> `optional` **inputTokens**: `number`

**outputTokens?**

> `optional` **outputTokens**: `number`

---
Source: https://docs.anuma.ai/sdk/react/Internal/type-aliases/ThemeAttr

# ThemeAttr

> **ThemeAttr** = *typeof* [`THEME_ATTRS`](../variables/THEME_ATTRS.md)\[`number`]

Defined in: [src/tools/slides/index.ts:123](https://github.com/anuma-ai/sdk/blob/main/src/tools/slides/index.ts#123)

---
Source: https://docs.anuma.ai/sdk/react/Internal/type-aliases/ToolCallArgumentsDeltaEvent

# ToolCallArgumentsDeltaEvent

> **ToolCallArgumentsDeltaEvent** = `object`

Defined in: [src/lib/chat/useChat/utils.ts:454](https://github.com/anuma-ai/sdk/blob/main/src/lib/chat/useChat/utils.ts#454)

Event emitted when tool call arguments are being streamed.

## Properties

### accumulatedArguments

> **accumulatedArguments**: `string`

Defined in: [src/lib/chat/useChat/utils.ts:458](https://github.com/anuma-ai/sdk/blob/main/src/lib/chat/useChat/utils.ts#458)

***

### argumentsDelta

> **argumentsDelta**: `string`

Defined in: [src/lib/chat/useChat/utils.ts:457](https://github.com/anuma-ai/sdk/blob/main/src/lib/chat/useChat/utils.ts#457)

***

### toolCallId

> **toolCallId**: `string`

Defined in: [src/lib/chat/useChat/utils.ts:455](https://github.com/anuma-ai/sdk/blob/main/src/lib/chat/useChat/utils.ts#455)

***

### toolName

> **toolName**: `string`

Defined in: [src/lib/chat/useChat/utils.ts:456](https://github.com/anuma-ai/sdk/blob/main/src/lib/chat/useChat/utils.ts#456)

---
Source: https://docs.anuma.ai/sdk/react/Internal/type-aliases/UIInteractionContextValue

# UIInteractionContextValue

> **UIInteractionContextValue** = `object`

Defined in: [src/react/useUIInteraction.ts:39](https://github.com/anuma-ai/sdk/blob/main/src/react/useUIInteraction.ts#39)

Context value for UI interactions

## Properties

### cancelInteraction()

> **cancelInteraction**: (`id`: `string`) => `void`

Defined in: [src/react/useUIInteraction.ts:51](https://github.com/anuma-ai/sdk/blob/main/src/react/useUIInteraction.ts#51)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`id`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

***

### clearInteractions()

> **clearInteractions**: () => `void`

Defined in: [src/react/useUIInteraction.ts:52](https://github.com/anuma-ai/sdk/blob/main/src/react/useUIInteraction.ts#52)

**Returns**

`void`

***

### createDisplayInteraction()

> **createDisplayInteraction**: (`id`: `string`, `displayType`: `string`, `data`: `unknown`, `result`: `unknown`, `toolVersion?`: `number`, `replacesInteractionId?`: `string`) => `void`

Defined in: [src/react/useUIInteraction.ts:42](https://github.com/anuma-ai/sdk/blob/main/src/react/useUIInteraction.ts#42)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`id`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`displayType`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`data`

</td>
<td>

`unknown`

</td>
</tr>
<tr>
<td>

`result`

</td>
<td>

`unknown`

</td>
</tr>
<tr>
<td>

`toolVersion?`

</td>
<td>

`number`

</td>
</tr>
<tr>
<td>

`replacesInteractionId?`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

***

### createInteraction()

> **createInteraction**: (`id`: `string`, `type`: [`InteractionType`](InteractionType.md), `data`: `unknown`) => `Promise`<`unknown`>

Defined in: [src/react/useUIInteraction.ts:41](https://github.com/anuma-ai/sdk/blob/main/src/react/useUIInteraction.ts#41)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`id`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`type`

</td>
<td>

[`InteractionType`](InteractionType.md)

</td>
</tr>
<tr>
<td>

`data`

</td>
<td>

`unknown`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`unknown`>

***

### getInteraction()

> **getInteraction**: (`id`: `string`) => [`PendingInteraction`](PendingInteraction.md) | `undefined`

Defined in: [src/react/useUIInteraction.ts:53](https://github.com/anuma-ai/sdk/blob/main/src/react/useUIInteraction.ts#53)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`id`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

[`PendingInteraction`](PendingInteraction.md) | `undefined`

***

### pendingInteractions

> **pendingInteractions**: `Map`<`string`, [`PendingInteraction`](PendingInteraction.md)>

Defined in: [src/react/useUIInteraction.ts:40](https://github.com/anuma-ai/sdk/blob/main/src/react/useUIInteraction.ts#40)

***

### resolveInteraction()

> **resolveInteraction**: (`id`: `string`, `result`: `unknown`) => `void`

Defined in: [src/react/useUIInteraction.ts:50](https://github.com/anuma-ai/sdk/blob/main/src/react/useUIInteraction.ts#50)

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`id`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`result`

</td>
<td>

`unknown`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

---
Source: https://docs.anuma.ai/sdk/react/Internal/type-aliases/UIInteractionProviderProps

# UIInteractionProviderProps

> **UIInteractionProviderProps** = `object`

Defined in: [src/react/useUIInteraction.ts:69](https://github.com/anuma-ai/sdk/blob/main/src/react/useUIInteraction.ts#69)

## Properties

### children

> **children**: `ReactNode`

Defined in: [src/react/useUIInteraction.ts:70](https://github.com/anuma-ai/sdk/blob/main/src/react/useUIInteraction.ts#70)

***

### timeout?

> `optional` **timeout**: `number`

Defined in: [src/react/useUIInteraction.ts:72](https://github.com/anuma-ai/sdk/blob/main/src/react/useUIInteraction.ts#72)

Timeout in ms for pending interactions. Default: 300000 (5 minutes)

---
Source: https://docs.anuma.ai/sdk/react/Internal/type-aliases/UseCreditsOptions

# UseCreditsOptions

> **UseCreditsOptions** = `object`

Defined in: [src/react/useCredits.ts:16](https://github.com/anuma-ai/sdk/blob/main/src/react/useCredits.ts#16)

## Properties

### autoFetch?

> `optional` **autoFetch**: `boolean`

Defined in: [src/react/useCredits.ts:28](https://github.com/anuma-ai/sdk/blob/main/src/react/useCredits.ts#28)

Whether to fetch credit balance automatically on mount (default: true)

***

### baseUrl?

> `optional` **baseUrl**: `string`

Defined in: [src/react/useCredits.ts:24](https://github.com/anuma-ai/sdk/blob/main/src/react/useCredits.ts#24)

Optional base URL for the API requests.

***

### getToken()?

> `optional` **getToken**: () => `Promise`<`string` | `null`>

Defined in: [src/react/useCredits.ts:20](https://github.com/anuma-ai/sdk/blob/main/src/react/useCredits.ts#20)

Custom function to get auth token for API calls

**Returns**

`Promise`<`string` | `null`>

***

### onError()?

> `optional` **onError**: (`error`: `Error`) => `void`

Defined in: [src/react/useCredits.ts:32](https://github.com/anuma-ai/sdk/blob/main/src/react/useCredits.ts#32)

Optional callback for error handling

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`error`

</td>
<td>

`Error`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

---
Source: https://docs.anuma.ai/sdk/react/Internal/type-aliases/UseCreditsResult

# UseCreditsResult

> **UseCreditsResult** = `object`

Defined in: [src/react/useCredits.ts:35](https://github.com/anuma-ai/sdk/blob/main/src/react/useCredits.ts#35)

## Properties

### balance

> **balance**: [`HandlersCreditBalanceResponse`](../../../client/Internal/type-aliases/HandlersCreditBalanceResponse.md) | `null`

Defined in: [src/react/useCredits.ts:39](https://github.com/anuma-ai/sdk/blob/main/src/react/useCredits.ts#39)

Current credit balance and related info

***

### error

> **error**: `Error` | `null`

Defined in: [src/react/useCredits.ts:51](https://github.com/anuma-ai/sdk/blob/main/src/react/useCredits.ts#51)

Error from the last operation

***

### fetchPacks()

> **fetchPacks**: () => `Promise`<`void`>

Defined in: [src/react/useCredits.ts:59](https://github.com/anuma-ai/sdk/blob/main/src/react/useCredits.ts#59)

Fetch available credit packs

**Returns**

`Promise`<`void`>

***

### isLoading

> **isLoading**: `boolean`

Defined in: [src/react/useCredits.ts:47](https://github.com/anuma-ai/sdk/blob/main/src/react/useCredits.ts#47)

Whether any operation is in progress

***

### packs

> **packs**: [`HandlersCreditPack`](../../../client/Internal/type-aliases/HandlersCreditPack.md)\[]

Defined in: [src/react/useCredits.ts:43](https://github.com/anuma-ai/sdk/blob/main/src/react/useCredits.ts#43)

Available credit packs for purchase

***

### purchaseCredits()

> **purchaseCredits**: (`credits`: `number`, `options?`: `object`) => `Promise`<`string` | `null`>

Defined in: [src/react/useCredits.ts:65](https://github.com/anuma-ai/sdk/blob/main/src/react/useCredits.ts#65)

Create a Stripe checkout session for purchasing a credit pack

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`credits`

</td>
<td>

`number`

</td>
<td>

Number of credits to purchase

</td>
</tr>
<tr>
<td>

`options?`

</td>
<td>

`object`

</td>
<td>

‐

</td>
</tr>
<tr>
<td>

`options.cancelUrl?`

</td>
<td>

`string`

</td>
<td>

‐

</td>
</tr>
<tr>
<td>

`options.successUrl?`

</td>
<td>

`string`

</td>
<td>

‐

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`string` | `null`>

The checkout URL or null on error

***

### refetch()

> **refetch**: () => `Promise`<`void`>

Defined in: [src/react/useCredits.ts:55](https://github.com/anuma-ai/sdk/blob/main/src/react/useCredits.ts#55)

Refetch the credit balance

**Returns**

`Promise`<`void`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/type-aliases/UseModelsResult

# UseModelsResult

> **UseModelsResult** = `object`

Defined in: [src/react/useModels.ts:31](https://github.com/anuma-ai/sdk/blob/main/src/react/useModels.ts#31)

## Properties

### error

> **error**: `Error` | `null`

Defined in: [src/react/useModels.ts:34](https://github.com/anuma-ai/sdk/blob/main/src/react/useModels.ts#34)

***

### isLoading

> **isLoading**: `boolean`

Defined in: [src/react/useModels.ts:33](https://github.com/anuma-ai/sdk/blob/main/src/react/useModels.ts#33)

***

### models

> **models**: [`LlmapiModel`](../../../client/Internal/type-aliases/LlmapiModel.md)\[]

Defined in: [src/react/useModels.ts:32](https://github.com/anuma-ai/sdk/blob/main/src/react/useModels.ts#32)

***

### refetch()

> **refetch**: () => `Promise`<`void`>

Defined in: [src/react/useModels.ts:35](https://github.com/anuma-ai/sdk/blob/main/src/react/useModels.ts#35)

**Returns**

`Promise`<`void`>

---
Source: https://docs.anuma.ai/sdk/react/Internal/type-aliases/UsePhoneCallsOptions

# UsePhoneCallsOptions

> **UsePhoneCallsOptions** = `object`

Defined in: [src/react/usePhoneCalls.ts:25](https://github.com/anuma-ai/sdk/blob/main/src/react/usePhoneCalls.ts#25)

## Properties

### autoFetchAvailability?

> `optional` **autoFetchAvailability**: `boolean`

Defined in: [src/react/usePhoneCalls.ts:37](https://github.com/anuma-ai/sdk/blob/main/src/react/usePhoneCalls.ts#37)

Whether to fetch feature availability automatically on mount (default: true)

***

### baseUrl?

> `optional` **baseUrl**: `string`

Defined in: [src/react/usePhoneCalls.ts:33](https://github.com/anuma-ai/sdk/blob/main/src/react/usePhoneCalls.ts#33)

Optional base URL for the API requests.

***

### getToken()?

> `optional` **getToken**: () => `Promise`<`string` | `null`>

Defined in: [src/react/usePhoneCalls.ts:29](https://github.com/anuma-ai/sdk/blob/main/src/react/usePhoneCalls.ts#29)

Custom function to get auth token for API calls

**Returns**

`Promise`<`string` | `null`>

***

### onError()?

> `optional` **onError**: (`error`: `Error`) => `void`

Defined in: [src/react/usePhoneCalls.ts:41](https://github.com/anuma-ai/sdk/blob/main/src/react/usePhoneCalls.ts#41)

Optional callback for error handling

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`error`

</td>
<td>

`Error`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

---
Source: https://docs.anuma.ai/sdk/react/Internal/type-aliases/UsePhoneCallsResult

# UsePhoneCallsResult

> **UsePhoneCallsResult** = `object`

Defined in: [src/react/usePhoneCalls.ts:63](https://github.com/anuma-ai/sdk/blob/main/src/react/usePhoneCalls.ts#63)

## Properties

### createPhoneCall()

> **createPhoneCall**: (`request`: [`HandlersCreatePhoneCallRequest`](../../../client/Internal/type-aliases/HandlersCreatePhoneCallRequest.md)) => `Promise`<[`HandlersPhoneCallResponse`](../../../client/Internal/type-aliases/HandlersPhoneCallResponse.md) | `null`>

Defined in: [src/react/usePhoneCalls.ts:91](https://github.com/anuma-ai/sdk/blob/main/src/react/usePhoneCalls.ts#91)

Create a phone call.

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`request`

</td>
<td>

[`HandlersCreatePhoneCallRequest`](../../../client/Internal/type-aliases/HandlersCreatePhoneCallRequest.md)

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`HandlersPhoneCallResponse`](../../../client/Internal/type-aliases/HandlersPhoneCallResponse.md) | `null`>

***

### currentCall

> **currentCall**: [`HandlersPhoneCallResponse`](../../../client/Internal/type-aliases/HandlersPhoneCallResponse.md) | `null`

Defined in: [src/react/usePhoneCalls.ts:71](https://github.com/anuma-ai/sdk/blob/main/src/react/usePhoneCalls.ts#71)

The latest phone call loaded by this hook.

***

### error

> **error**: `Error` | `null`

Defined in: [src/react/usePhoneCalls.ts:83](https://github.com/anuma-ai/sdk/blob/main/src/react/usePhoneCalls.ts#83)

Error from the last operation.

***

### fetchAvailability()

> **fetchAvailability**: () => `Promise`<`boolean` | `null`>

Defined in: [src/react/usePhoneCalls.ts:87](https://github.com/anuma-ai/sdk/blob/main/src/react/usePhoneCalls.ts#87)

Fetch whether phone calling is enabled.

**Returns**

`Promise`<`boolean` | `null`>

***

### getPhoneCall()

> **getPhoneCall**: (`callId`: `string`) => `Promise`<[`HandlersPhoneCallResponse`](../../../client/Internal/type-aliases/HandlersPhoneCallResponse.md) | `null`>

Defined in: [src/react/usePhoneCalls.ts:97](https://github.com/anuma-ai/sdk/blob/main/src/react/usePhoneCalls.ts#97)

Fetch a phone call by call ID.

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`callId`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`HandlersPhoneCallResponse`](../../../client/Internal/type-aliases/HandlersPhoneCallResponse.md) | `null`>

***

### isEnabled

> **isEnabled**: `boolean` | `null`

Defined in: [src/react/usePhoneCalls.ts:67](https://github.com/anuma-ai/sdk/blob/main/src/react/usePhoneCalls.ts#67)

Whether phone calling is enabled on the connected portal.

***

### isLoading

> **isLoading**: `boolean`

Defined in: [src/react/usePhoneCalls.ts:75](https://github.com/anuma-ai/sdk/blob/main/src/react/usePhoneCalls.ts#75)

Whether a non-polling request is in flight.

***

### isPolling

> **isPolling**: `boolean`

Defined in: [src/react/usePhoneCalls.ts:79](https://github.com/anuma-ai/sdk/blob/main/src/react/usePhoneCalls.ts#79)

Whether a polling loop is currently active.

***

### pollPhoneCall()

> **pollPhoneCall**: (`callId`: `string`, `options?`: [`PhoneCallPollingOptions`](PhoneCallPollingOptions.md)) => `Promise`<[`HandlersPhoneCallResponse`](../../../client/Internal/type-aliases/HandlersPhoneCallResponse.md) | `null`>

Defined in: [src/react/usePhoneCalls.ts:101](https://github.com/anuma-ai/sdk/blob/main/src/react/usePhoneCalls.ts#101)

Poll a phone call until completion or the polling limit is reached.

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`callId`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`options?`

</td>
<td>

[`PhoneCallPollingOptions`](PhoneCallPollingOptions.md)

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<[`HandlersPhoneCallResponse`](../../../client/Internal/type-aliases/HandlersPhoneCallResponse.md) | `null`>

***

### reset()

> **reset**: () => `void`

Defined in: [src/react/usePhoneCalls.ts:112](https://github.com/anuma-ai/sdk/blob/main/src/react/usePhoneCalls.ts#112)

Clear the current call and last error.

**Returns**

`void`

***

### stopPolling()

> **stopPolling**: () => `void`

Defined in: [src/react/usePhoneCalls.ts:108](https://github.com/anuma-ai/sdk/blob/main/src/react/usePhoneCalls.ts#108)

Stop any active polling loop.

**Returns**

`void`

---
Source: https://docs.anuma.ai/sdk/react/Internal/type-aliases/UseSettingsOptions

# UseSettingsOptions

> **UseSettingsOptions** = `BaseUseSettingsOptions`

Defined in: [src/react/useSettings.ts:36](https://github.com/anuma-ai/sdk/blob/main/src/react/useSettings.ts#36)

Options for useSettings hook (React version)

---
Source: https://docs.anuma.ai/sdk/react/Internal/type-aliases/UseSubscriptionOptions

# UseSubscriptionOptions

> **UseSubscriptionOptions** = `object`

Defined in: [src/react/useSubscription.ts:22](https://github.com/anuma-ai/sdk/blob/main/src/react/useSubscription.ts#22)

## Properties

### autoFetch?

> `optional` **autoFetch**: `boolean`

Defined in: [src/react/useSubscription.ts:34](https://github.com/anuma-ai/sdk/blob/main/src/react/useSubscription.ts#34)

Whether to fetch subscription status automatically on mount (default: true)

***

### baseUrl?

> `optional` **baseUrl**: `string`

Defined in: [src/react/useSubscription.ts:30](https://github.com/anuma-ai/sdk/blob/main/src/react/useSubscription.ts#30)

Optional base URL for the API requests.

***

### getToken()?

> `optional` **getToken**: () => `Promise`<`string` | `null`>

Defined in: [src/react/useSubscription.ts:26](https://github.com/anuma-ai/sdk/blob/main/src/react/useSubscription.ts#26)

Custom function to get auth token for API calls

**Returns**

`Promise`<`string` | `null`>

***

### onError()?

> `optional` **onError**: (`error`: `Error`) => `void`

Defined in: [src/react/useSubscription.ts:38](https://github.com/anuma-ai/sdk/blob/main/src/react/useSubscription.ts#38)

Optional callback for error handling

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`error`

</td>
<td>

`Error`

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

---
Source: https://docs.anuma.ai/sdk/react/Internal/type-aliases/UseSubscriptionResult

# UseSubscriptionResult

> **UseSubscriptionResult** = `object`

Defined in: [src/react/useSubscription.ts:41](https://github.com/anuma-ai/sdk/blob/main/src/react/useSubscription.ts#41)

## Properties

### cancelSubscription()

> **cancelSubscription**: () => `Promise`<[`HandlersCancelSubscriptionResponse`](../../../client/Internal/type-aliases/HandlersCancelSubscriptionResponse.md) | `null`>

Defined in: [src/react/useSubscription.ts:77](https://github.com/anuma-ai/sdk/blob/main/src/react/useSubscription.ts#77)

Cancel the subscription at the end of the current period

**Returns**

`Promise`<[`HandlersCancelSubscriptionResponse`](../../../client/Internal/type-aliases/HandlersCancelSubscriptionResponse.md) | `null`>

The cancellation response or null on error

***

### createCheckoutSession()

> **createCheckoutSession**: (`options?`: `object`) => `Promise`<`string` | `null`>

Defined in: [src/react/useSubscription.ts:62](https://github.com/anuma-ai/sdk/blob/main/src/react/useSubscription.ts#62)

Create a Stripe checkout session for a subscription plan

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options?`

</td>
<td>

`object`

</td>
</tr>
<tr>
<td>

`options.cancelUrl?`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`options.interval?`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`options.successUrl?`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`options.tier?`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`string` | `null`>

The checkout URL or null on error

***

### error

> **error**: `Error` | `null`

Defined in: [src/react/useSubscription.ts:53](https://github.com/anuma-ai/sdk/blob/main/src/react/useSubscription.ts#53)

Error from the last operation

***

### isLoading

> **isLoading**: `boolean`

Defined in: [src/react/useSubscription.ts:49](https://github.com/anuma-ai/sdk/blob/main/src/react/useSubscription.ts#49)

Whether any operation is in progress

***

### openCustomerPortal()

> **openCustomerPortal**: (`options?`: `object`) => `Promise`<`string` | `null`>

Defined in: [src/react/useSubscription.ts:72](https://github.com/anuma-ai/sdk/blob/main/src/react/useSubscription.ts#72)

Open the Stripe customer portal for managing billing

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`options?`

</td>
<td>

`object`

</td>
</tr>
<tr>
<td>

`options.returnUrl?`

</td>
<td>

`string`

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`string` | `null`>

The portal URL or null on error

***

### refetch()

> **refetch**: () => `Promise`<`void`>

Defined in: [src/react/useSubscription.ts:57](https://github.com/anuma-ai/sdk/blob/main/src/react/useSubscription.ts#57)

Refetch the subscription status

**Returns**

`Promise`<`void`>

***

### renewSubscription()

> **renewSubscription**: () => `Promise`<[`HandlersRenewSubscriptionResponse`](../../../client/Internal/type-aliases/HandlersRenewSubscriptionResponse.md) | `null`>

Defined in: [src/react/useSubscription.ts:82](https://github.com/anuma-ai/sdk/blob/main/src/react/useSubscription.ts#82)

Reactivate a cancelled subscription

**Returns**

`Promise`<[`HandlersRenewSubscriptionResponse`](../../../client/Internal/type-aliases/HandlersRenewSubscriptionResponse.md) | `null`>

The renewal response or null on error

***

### status

> **status**: [`HandlersSubscriptionStatusResponse`](../../../client/Internal/type-aliases/HandlersSubscriptionStatusResponse.md) | `null`

Defined in: [src/react/useSubscription.ts:45](https://github.com/anuma-ai/sdk/blob/main/src/react/useSubscription.ts#45)

Current subscription status

---
Source: https://docs.anuma.ai/sdk/react/Internal/type-aliases/UseToolsOptions

# UseToolsOptions

> **UseToolsOptions** = `object`

Defined in: [src/react/useTools.ts:17](https://github.com/anuma-ai/sdk/blob/main/src/react/useTools.ts#17)

## Properties

### autoFetch?

> `optional` **autoFetch**: `boolean`

Defined in: [src/react/useTools.ts:36](https://github.com/anuma-ai/sdk/blob/main/src/react/useTools.ts#36)

Whether to fetch tools automatically on mount (default: true)

***

### baseUrl?

> `optional` **baseUrl**: `string`

Defined in: [src/react/useTools.ts:25](https://github.com/anuma-ai/sdk/blob/main/src/react/useTools.ts#25)

Optional base URL for the API requests.

***

### getToken()

> **getToken**: () => `Promise`<`string` | `null`>

Defined in: [src/react/useTools.ts:21](https://github.com/anuma-ai/sdk/blob/main/src/react/useTools.ts#21)

Custom function to get auth token for API calls

**Returns**

`Promise`<`string` | `null`>

***

### includeTools?

> `optional` **includeTools**: `string`\[]

Defined in: [src/react/useTools.ts:32](https://github.com/anuma-ai/sdk/blob/main/src/react/useTools.ts#32)

Filter to include only specific tools by name.

* undefined: include all tools
* \[]: include no tools
* \['tool1', 'tool2']: include only named tools

---
Source: https://docs.anuma.ai/sdk/react/Internal/type-aliases/UseToolsResult

# UseToolsResult

> **UseToolsResult** = `object`

Defined in: [src/react/useTools.ts:39](https://github.com/anuma-ai/sdk/blob/main/src/react/useTools.ts#39)

## Properties

### checkForUpdates()

> **checkForUpdates**: (`responseChecksum`: `string` | `undefined`) => `boolean`

Defined in: [src/react/useTools.ts:59](https://github.com/anuma-ai/sdk/blob/main/src/react/useTools.ts#59)

Check if tools need to be refreshed based on a response checksum.
If the checksum differs from cached, automatically triggers a refresh.

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`responseChecksum`

</td>
<td>

`string` | `undefined`

</td>
<td>

Checksum from a chat response

</td>
</tr>
</tbody>
</table>

**Returns**

`boolean`

true if refresh was triggered

***

### checksum

> **checksum**: `string` | `undefined`

Defined in: [src/react/useTools.ts:43](https://github.com/anuma-ai/sdk/blob/main/src/react/useTools.ts#43)

Current tools checksum from cache

***

### error

> **error**: `Error` | `null`

Defined in: [src/react/useTools.ts:47](https://github.com/anuma-ai/sdk/blob/main/src/react/useTools.ts#47)

Error from the last fetch attempt

***

### isLoading

> **isLoading**: `boolean`

Defined in: [src/react/useTools.ts:45](https://github.com/anuma-ai/sdk/blob/main/src/react/useTools.ts#45)

Whether tools are being fetched

***

### refresh()

> **refresh**: (`force?`: `boolean`) => `Promise`<`void`>

Defined in: [src/react/useTools.ts:52](https://github.com/anuma-ai/sdk/blob/main/src/react/useTools.ts#52)

Refresh tools from the server.

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`force?`

</td>
<td>

`boolean`

</td>
<td>

Force refresh even if cache is valid

</td>
</tr>
</tbody>
</table>

**Returns**

`Promise`<`void`>

***

### tools

> **tools**: [`ServerTool`](../interfaces/ServerTool.md)\[]

Defined in: [src/react/useTools.ts:41](https://github.com/anuma-ai/sdk/blob/main/src/react/useTools.ts#41)

Available server tools

---
Source: https://docs.anuma.ai/sdk/react/Internal/type-aliases/VaultEmbeddingCache

# VaultEmbeddingCache

> **VaultEmbeddingCache** = `Map`<`string`, `number`\[]>

Defined in: [src/lib/memoryVault/searchTool.ts:20](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryVault/searchTool.ts#20)

Embedding cache keyed by content string. Stores pre-computed embeddings
so that search only needs to embed the query, not the vault entries.

---
Source: https://docs.anuma.ai/sdk/react/Internal/type-aliases/WhisperModel

# WhisperModel

> **WhisperModel** = `"whisper-tiny"` | `"whisper-tiny.en"` | `"whisper-base"` | `"whisper-base.en"` | `"whisper-small"` | `"whisper-small.en"`

Defined in: [src/lib/voice/types.ts:1](https://github.com/anuma-ai/sdk/blob/main/src/lib/voice/types.ts#1)

---
Source: https://docs.anuma.ai/sdk/react/Internal/variables/Anuma

# Anuma

> `const` **Anuma**: `object`

Defined in: [src/react/anumaRuntime.tsx:782](https://github.com/anuma-ai/sdk/blob/main/src/react/anumaRuntime.tsx#782)

Anuma primitive components, namespaced. Use as `<Anuma.Slide>`,
`<Anuma.Rect>`, etc.

## Type Declaration

### Circle()

> **Circle**: (`__namedParameters`: [`CircleProps`](../interfaces/CircleProps.md)) => `ReactElement`

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`__namedParameters`

</td>
<td>

[`CircleProps`](../interfaces/CircleProps.md)

</td>
</tr>
</tbody>
</table>

**Returns**

`ReactElement`

### Deck()

> **Deck**: (`__namedParameters`: [`DeckProps`](../interfaces/DeckProps.md)) => `ReactElement`

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`__namedParameters`

</td>
<td>

[`DeckProps`](../interfaces/DeckProps.md)

</td>
</tr>
</tbody>
</table>

**Returns**

`ReactElement`

### Group()

> **Group**: (`__namedParameters`: [`GroupProps`](../interfaces/GroupProps.md)) => `ReactElement`

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`__namedParameters`

</td>
<td>

[`GroupProps`](../interfaces/GroupProps.md)

</td>
</tr>
</tbody>
</table>

**Returns**

`ReactElement`

### Icon()

> **Icon**: (`__namedParameters`: [`IconProps`](../interfaces/IconProps.md)) => `ReactElement`

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`__namedParameters`

</td>
<td>

[`IconProps`](../interfaces/IconProps.md)

</td>
</tr>
</tbody>
</table>

**Returns**

`ReactElement`

### Image()

> **Image**: (`__namedParameters`: [`ImageProps`](../interfaces/ImageProps.md)) => `ReactElement`

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`__namedParameters`

</td>
<td>

[`ImageProps`](../interfaces/ImageProps.md)

</td>
</tr>
</tbody>
</table>

**Returns**

`ReactElement`

### Line()

> **Line**: (`__namedParameters`: [`LineProps`](../interfaces/LineProps.md)) => `ReactElement`

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`__namedParameters`

</td>
<td>

[`LineProps`](../interfaces/LineProps.md)

</td>
</tr>
</tbody>
</table>

**Returns**

`ReactElement`

### Rect()

> **Rect**: (`__namedParameters`: [`RectProps`](../interfaces/RectProps.md)) => `ReactElement`

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`__namedParameters`

</td>
<td>

[`RectProps`](../interfaces/RectProps.md)

</td>
</tr>
</tbody>
</table>

**Returns**

`ReactElement`

### Screen()

> **Screen**: (`__namedParameters`: [`ScreenProps`](../interfaces/ScreenProps.md)) => `ReactElement`

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`__namedParameters`

</td>
<td>

[`ScreenProps`](../interfaces/ScreenProps.md)

</td>
</tr>
</tbody>
</table>

**Returns**

`ReactElement`

### Slide()

> **Slide**: (`__namedParameters`: [`SlideProps`](../interfaces/SlideProps.md)) => `ReactElement`

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`__namedParameters`

</td>
<td>

[`SlideProps`](../interfaces/SlideProps.md)

</td>
</tr>
</tbody>
</table>

**Returns**

`ReactElement`

### Text()

> **Text**: (`__namedParameters`: [`TextProps`](../interfaces/TextProps.md)) => `ReactElement`

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`__namedParameters`

</td>
<td>

[`TextProps`](../interfaces/TextProps.md)

</td>
</tr>
</tbody>
</table>

**Returns**

`ReactElement`

---
Source: https://docs.anuma.ai/sdk/react/Internal/variables/BUILT_IN_TOOL_SETS

# BUILT\_IN\_TOOL\_SETS

> `const` **BUILT\_IN\_TOOL\_SETS**: [`ToolSet`](../interfaces/ToolSet.md)\[]

Defined in: [src/lib/tools/serverTools.ts:853](https://github.com/anuma-ai/sdk/blob/main/src/lib/tools/serverTools.ts#853)

Built-in tool sets. Consumers can extend this with their own.

---
Source: https://docs.anuma.ai/sdk/react/Internal/variables/ChartLegend

# ChartLegend

> `const` **ChartLegend**: *typeof* `Legend` = `RechartsPrimitive.Legend`

Defined in: [src/react/chart.tsx:261](https://github.com/anuma-ai/sdk/blob/main/src/react/chart.tsx#261)

---
Source: https://docs.anuma.ai/sdk/react/Internal/variables/ChartTooltip

# ChartTooltip

> `const` **ChartTooltip**: *typeof* `Tooltip` = `RechartsPrimitive.Tooltip`

Defined in: [src/react/chart.tsx:128](https://github.com/anuma-ai/sdk/blob/main/src/react/chart.tsx#128)

---
Source: https://docs.anuma.ai/sdk/react/Internal/variables/chatStorageMigrations

# chatStorageMigrations

> `const` **chatStorageMigrations**: `Readonly`<{ `maxVersion`: `number`; `minVersion`: `number`; `sortedMigrations`: `Readonly`<{ `steps`: `MigrationStep`\[]; `toVersion`: `number`; }>\[]; `validated`: `true`; }>

Defined in: [src/lib/db/chat/schema.ts:44](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/schema.ts#44)

---
Source: https://docs.anuma.ai/sdk/react/Internal/variables/chatStorageSchema

# chatStorageSchema

> `const` **chatStorageSchema**: `Readonly`<{ `tables`: `TableMap`; `unsafeSql?`: (`_`: `string`, `__`: `AppSchemaUnsafeSqlKind`) => `string`; `version`: `number`; }>

Defined in: [src/lib/db/chat/schema.ts:4](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/chat/schema.ts#4)

---
Source: https://docs.anuma.ai/sdk/react/Internal/variables/consoleLogger

# consoleLogger

> `const` **consoleLogger**: [`Logger`](../interfaces/Logger.md)

Defined in: [src/lib/logger.ts:33](https://github.com/anuma-ai/sdk/blob/main/src/lib/logger.ts#33)

Default logger that delegates to the global `console` object.

---
Source: https://docs.anuma.ai/sdk/react/Internal/variables/DEFAULT_BACKUP_FOLDER

# DEFAULT\_BACKUP\_FOLDER

> `const` **DEFAULT\_BACKUP\_FOLDER**: `"/ai-chat-app/conversations"` = `"/ai-chat-app/conversations"`

Defined in: [src/lib/backup/dropbox/api.ts:12](https://github.com/anuma-ai/sdk/blob/main/src/lib/backup/dropbox/api.ts#12)

Default folder path for Dropbox backups

---
Source: https://docs.anuma.ai/sdk/react/Internal/variables/DEFAULT_CACHE_EXPIRATION_MS

# DEFAULT\_CACHE\_EXPIRATION\_MS

> `const` **DEFAULT\_CACHE\_EXPIRATION\_MS**: `number`

Defined in: [src/lib/tools/serverTools.ts:106](https://github.com/anuma-ai/sdk/blob/main/src/lib/tools/serverTools.ts#106)

Default cache expiration: 1 day

---
Source: https://docs.anuma.ai/sdk/react/Internal/variables/DEFAULT_CHUNK_OVERLAP

# DEFAULT\_CHUNK\_OVERLAP

> `const` **DEFAULT\_CHUNK\_OVERLAP**: `50` = `50`

Defined in: [src/lib/memoryEngine/chunking.ts:27](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryEngine/chunking.ts#27)

---
Source: https://docs.anuma.ai/sdk/react/Internal/variables/DEFAULT_CHUNK_SIZE

# DEFAULT\_CHUNK\_SIZE

> `const` **DEFAULT\_CHUNK\_SIZE**: `400` = `400`

Defined in: [src/lib/memoryEngine/chunking.ts:26](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryEngine/chunking.ts#26)

---
Source: https://docs.anuma.ai/sdk/react/Internal/variables/DEFAULT_DRIVE_CONVERSATIONS_FOLDER

# DEFAULT\_DRIVE\_CONVERSATIONS\_FOLDER

> `const` **DEFAULT\_DRIVE\_CONVERSATIONS\_FOLDER**: `"conversations"` = `"conversations"`

Defined in: [src/lib/backup/google/api.ts:23](https://github.com/anuma-ai/sdk/blob/main/src/lib/backup/google/api.ts#23)

Default subfolder for conversation backups

---
Source: https://docs.anuma.ai/sdk/react/Internal/variables/DEFAULT_DRIVE_ROOT_FOLDER

# DEFAULT\_DRIVE\_ROOT\_FOLDER

> `const` **DEFAULT\_DRIVE\_ROOT\_FOLDER**: `"ai-chat-app"` = `"ai-chat-app"`

Defined in: [src/lib/backup/google/api.ts:21](https://github.com/anuma-ai/sdk/blob/main/src/lib/backup/google/api.ts#21)

Default root folder name for backups

---
Source: https://docs.anuma.ai/sdk/react/Internal/variables/DEFAULT_EXCLUDED_SERVER_TOOLS

# DEFAULT\_EXCLUDED\_SERVER\_TOOLS

> `const` **DEFAULT\_EXCLUDED\_SERVER\_TOOLS**: readonly `string`\[]

Defined in: [src/lib/tools/serverTools.ts:1083](https://github.com/anuma-ai/sdk/blob/main/src/lib/tools/serverTools.ts#1083)

Default exclusions baked into `defaultServerToolsFilter`.

* `AnumaVisionMCP-anuma_analyze_image`: modern frontier models have native
  vision via image content blocks; routing through a server-side vision
  tool just adds a hop.
* `OpenMeteoMCP-weather_forecast` + `OpenMeteoMCP-geocoding`: redundant when
  the consumer registers `createWeatherTool` (the client-side display tool
  handles geocoding internally and renders a card inline). Including the
  server-side equivalents causes the model to prefer raw data over the card.
  Consumers who don't register `createWeatherTool` should instead build
  their own filter via `createServerToolsFilter`.

---
Source: https://docs.anuma.ai/sdk/react/Internal/variables/DEFAULT_ICLOUD_BACKUP_FOLDER

# DEFAULT\_ICLOUD\_BACKUP\_FOLDER

> `const` **DEFAULT\_ICLOUD\_BACKUP\_FOLDER**: `"conversations"` = `"conversations"`

Defined in: [src/lib/backup/icloud/api.ts:16](https://github.com/anuma-ai/sdk/blob/main/src/lib/backup/icloud/api.ts#16)

Default folder path for iCloud backups

---
Source: https://docs.anuma.ai/sdk/react/Internal/variables/DEFAULT_MIN_CHUNK_SIZE

# DEFAULT\_MIN\_CHUNK\_SIZE

> `const` **DEFAULT\_MIN\_CHUNK\_SIZE**: `50` = `50`

Defined in: [src/lib/memoryEngine/chunking.ts:28](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryEngine/chunking.ts#28)

---
Source: https://docs.anuma.ai/sdk/react/Internal/variables/DEFAULT_PERSONALITY_SETTINGS

# DEFAULT\_PERSONALITY\_SETTINGS

> `const` **DEFAULT\_PERSONALITY\_SETTINGS**: [`PersonalitySettings`](../interfaces/PersonalitySettings.md)

Defined in: [src/lib/db/userPreferences/types.ts:44](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/userPreferences/types.ts#44)

Default personality settings (all neutral/empty)

---
Source: https://docs.anuma.ai/sdk/react/Internal/variables/DEFAULT_SERVER_TOOLS_MATCH_OPTIONS

# DEFAULT\_SERVER\_TOOLS\_MATCH\_OPTIONS

> `const` **DEFAULT\_SERVER\_TOOLS\_MATCH\_OPTIONS**: [`ToolMatchOptions`](../interfaces/ToolMatchOptions.md)

Defined in: [src/lib/tools/serverTools.ts:1090](https://github.com/anuma-ai/sdk/blob/main/src/lib/tools/serverTools.ts#1090)

Default match options for the server-tools filter (limit 5, minSim 0.5).

---
Source: https://docs.anuma.ai/sdk/react/Internal/variables/DEFAULT_VAULT_CACHE_SIZE

# DEFAULT\_VAULT\_CACHE\_SIZE

> `const` **DEFAULT\_VAULT\_CACHE\_SIZE**: `5000` = `5000`

Defined in: [src/lib/memoryVault/lruCache.ts:3](https://github.com/anuma-ai/sdk/blob/main/src/lib/memoryVault/lruCache.ts#3)

---
Source: https://docs.anuma.ai/sdk/react/Internal/variables/defaultServerToolsFilter

# defaultServerToolsFilter

> `const` **defaultServerToolsFilter**: (`embeddings`: `number`\[] | `number`\[]\[], `tools`: [`ServerTool`](../interfaces/ServerTool.md)\[]) => `string`\[]

Defined in: [src/lib/tools/serverTools.ts:1113](https://github.com/anuma-ai/sdk/blob/main/src/lib/tools/serverTools.ts#1113)

Pre-configured server-tools filter ready to drop into `useChatStorage`'s
`serverTools` option. Pure semantic matching against the user prompt with
the default exclusion list applied.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`embeddings`

</td>
<td>

`number`\[] | `number`\[]\[]

</td>
</tr>
<tr>
<td>

`tools`

</td>
<td>

[`ServerTool`](../interfaces/ServerTool.md)\[]

</td>
</tr>
</tbody>
</table>

## Returns

`string`\[]

## Example

```ts
import { defaultServerToolsFilter, useChatStorage } from "@anuma/sdk/react";

useChatStorage({
  ...,
  serverTools: defaultServerToolsFilter,
});
```

If you need to customize (extra excludes, different limits, opt into
tool-set expansion), call `createServerToolsFilter` directly.

---
Source: https://docs.anuma.ai/sdk/react/Internal/variables/FILE_PLACEHOLDER_PREFIX

# FILE\_PLACEHOLDER\_PREFIX

> `const` **FILE\_PLACEHOLDER\_PREFIX**: `"__SDKFILE__"` = `"__SDKFILE__"`

Defined in: [src/lib/storage/opfs.ts:12](https://github.com/anuma-ai/sdk/blob/main/src/lib/storage/opfs.ts#12)

---
Source: https://docs.anuma.ai/sdk/react/Internal/variables/FILE_PLACEHOLDER_REGEX

# FILE\_PLACEHOLDER\_REGEX

> `const` **FILE\_PLACEHOLDER\_REGEX**: `RegExp`

Defined in: [src/lib/storage/opfs.ts:15](https://github.com/anuma-ai/sdk/blob/main/src/lib/storage/opfs.ts#15)

---
Source: https://docs.anuma.ai/sdk/react/Internal/variables/noopLogger

# noopLogger

> `const` **noopLogger**: [`Logger`](../interfaces/Logger.md)

Defined in: [src/lib/logger.ts:42](https://github.com/anuma-ai/sdk/blob/main/src/lib/logger.ts#42)

Silent logger that discards all output.

---
Source: https://docs.anuma.ai/sdk/react/Internal/variables/queueManager

# queueManager

> `const` **queueManager**: [`QueueManager`](../classes/QueueManager.md)

Defined in: [src/lib/db/queue/manager.ts:395](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/queue/manager.ts#395)

Singleton queue manager instance

---
Source: https://docs.anuma.ai/sdk/react/Internal/variables/R2_DEFAULT_TTL_MS

# R2\_DEFAULT\_TTL\_MS

> `const` **R2\_DEFAULT\_TTL\_MS**: `number`

Defined in: [src/lib/storage/r2Expiry.ts:10](https://github.com/anuma-ai/sdk/blob/main/src/lib/storage/r2Expiry.ts#10)

Default TTL for R2 presigned URLs (7 days).

---
Source: https://docs.anuma.ai/sdk/react/Internal/variables/SDK_SCHEMA_VERSION

# SDK\_SCHEMA\_VERSION

> `const` **SDK\_SCHEMA\_VERSION**: `27` = `27`

Defined in: [src/lib/db/schema.ts:52](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/schema.ts#52)

Current combined schema version for all SDK storage modules.

Version history:

* v2: Baseline (chat + memory tables) - minimum supported version for migrations
* v3: Added was\_stopped column to history table
* v4: Added modelPreferences table for settings storage
* v5: Added error column to history table for error persistence
* v6: Added thought\_process column to history table for activity tracking
* v7: Added userPreferences table for unified user settings storage
* v8: BREAKING - Clear all data (switching embedding model from OpenAI to Fireworks)
* v9: Added thinking column to history table for reasoning/thinking content
* v10: Added projects table and project\_id column to conversations table
* v11: Added media table for library feature, added file\_ids column to history table
* v12: Added chunks column to history table for sub-message semantic search
* v13: Added parent\_message\_id column to history table for message branching (edit/regenerate)
* v14: Added feedback column to history table for like/dislike on responses
* v15: Replaced memories table with memory\_vault table for persistent memory vault
* v16: Added scope column to memory\_vault table for memory partitioning
* v17: Added image\_model column to history table for AI-generated image model tracking
* v18: Added vault\_folders table and folder\_id column to memory\_vault for folder organization
* v19: Added user\_id column to memory\_vault for multi-user server-side scoping
* v20: Added index on updated\_at column of memory\_vault for efficient since-based filtering
* v21: Added embedding column to memory\_vault for persisted embedding vectors
* v22: Added is\_system column to vault\_folders for default system folders
* v23: Added conversation\_summaries table for progressive history summarization
* v24: Added context column to vault\_folders for LLM-generated folder summaries
* v25: Added saved\_tools table for user-saved display apps exposed as LLM tools
* v26: Added app\_files table for LLM-generated app source files (HTML/CSS/JS)
* v27: Added tool\_call\_events column to history for reconstructing tool call history

---
Source: https://docs.anuma.ai/sdk/react/Internal/variables/sdkMigrations

# sdkMigrations

> `const` **sdkMigrations**: `Readonly`<{ `maxVersion`: `number`; `minVersion`: `number`; `sortedMigrations`: `Readonly`<{ `steps`: `MigrationStep`\[]; `toVersion`: `number`; }>\[]; `validated`: `true`; }>

Defined in: [src/lib/db/schema.ts:300](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/schema.ts#300)

Combined migrations for all SDK storage modules.

These migrations handle database schema upgrades from any previous version
to the current version. The SDK manages all migration logic internally,
so consumer apps don't need to handle version arithmetic or migration merging.

**Minimum supported version: v2**
Migrations from v1 are not supported. Databases at v1 require a fresh install.

Migration history:

* v2 → v3: Added `was_stopped` column to history table
* v3 → v4: Added `modelPreferences` table for settings storage
* v4 → v5: Added `error` column to history table for error persistence
* v5 → v6: Added `thought_process` column to history table for activity tracking
* v6 → v7: Added `userPreferences` table for unified user settings storage
* v7 → v8: BREAKING - Clear all data (embedding model change)
* v8 → v9: Added `thinking` column to history table for reasoning/thinking content
* v9 → v10: Added `projects` table and `project_id` column to conversations
* v10 → v11: Added `media` table for library feature, added `file_ids` column to history
* v11 → v12: Added `chunks` column to history table for sub-message semantic search
* v12 → v13: Added `parent_message_id` column to history table for message branching
* v13 → v14: Added `feedback` column to history table for like/dislike on responses
* v14 → v15: Replaced `memories` table with `memory_vault` table for persistent memory vault
* v15 → v16: Added `scope` column to memory\_vault table for memory partitioning
* v16 → v17: Added `image_model` column to history table for AI-generated image model tracking
* v17 → v18: Added `vault_folders` table (with scope) and `folder_id` column to memory\_vault for folder organization
* v18 → v19: Added `user_id` column to memory\_vault for multi-user server-side scoping
* v19 → v20: Added index on `updated_at` column of memory\_vault for efficient since-based filtering
* v20 → v21: Added `embedding` column to memory\_vault for persisted embedding vectors
* v21 → v22: Added `is_system` column to vault\_folders for default system folders
* v22 → v23: Added `conversation_summaries` table for progressive history summarization
* v23 → v24: Added `context` column to vault\_folders for LLM-generated folder summaries
* v24 → v25: Added `saved_tools` table for user-saved display apps exposed as LLM tools
* v25 → v26: Added `app_files` table for LLM-generated app source files (HTML/CSS/JS)
* v26 → v27: Added `tool_call_events` column to history for reconstructing tool call history

---
Source: https://docs.anuma.ai/sdk/react/Internal/variables/sdkModelClasses

# sdkModelClasses

> `const` **sdkModelClasses**: `Class`<`Model`>\[]

Defined in: [src/lib/db/schema.ts:668](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/schema.ts#668)

Model classes to register with the WatermelonDB database.

Pass this array directly to the `modelClasses` option when creating
your Database instance.

## Example

```typescript
import { Database } from '@nozbe/watermelondb';
import { sdkSchema, sdkMigrations, sdkModelClasses } from '@anuma/sdk/react';

const database = new Database({
  adapter,
  modelClasses: sdkModelClasses,
});
```

---
Source: https://docs.anuma.ai/sdk/react/Internal/variables/sdkSchema

# sdkSchema

> `const` **sdkSchema**: `Readonly`<{ `tables`: `TableMap`; `unsafeSql?`: (`_`: `string`, `__`: `AppSchemaUnsafeSqlKind`) => `string`; `version`: `number`; }>

Defined in: [src/lib/db/schema.ts:84](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/schema.ts#84)

Combined WatermelonDB schema for all SDK storage modules.

This unified schema includes all tables needed by the SDK:

* `history`: Chat message storage with embeddings and metadata
* `conversations`: Conversation metadata and organization
* `memory_vault`: Persistent memory vault for curated facts
* `modelPreferences`: User model preferences (deprecated, use userPreferences)
* `userPreferences`: Unified user preferences (profile, personality, models)

## Example

```typescript
import { Database } from '@nozbe/watermelondb';
import LokiJSAdapter from '@nozbe/watermelondb/adapters/lokijs';
import { sdkSchema, sdkMigrations, sdkModelClasses } from '@anuma/sdk/react';

const adapter = new LokiJSAdapter({
  schema: sdkSchema,
  migrations: sdkMigrations,
  dbName: 'my-app-db',
  useWebWorker: false,
  useIncrementalIndexedDB: true,
});

const database = new Database({
  adapter,
  modelClasses: sdkModelClasses,
});
```

---
Source: https://docs.anuma.ai/sdk/react/Internal/variables/settingsStorageSchema

# settingsStorageSchema

> `const` **settingsStorageSchema**: `Readonly`<{ `tables`: `TableMap`; `unsafeSql?`: (`_`: `string`, `__`: `AppSchemaUnsafeSqlKind`) => `string`; `version`: `number`; }>

Defined in: [src/lib/db/settings/schema.ts:3](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/settings/schema.ts#3)

---
Source: https://docs.anuma.ai/sdk/react/Internal/variables/SLIDE_CANVAS_HEIGHT

# SLIDE\_CANVAS\_HEIGHT

> `const` **SLIDE\_CANVAS\_HEIGHT**: `540` = `540`

Defined in: [src/tools/slides/index.ts:104](https://github.com/anuma-ai/sdk/blob/main/src/tools/slides/index.ts#104)

---
Source: https://docs.anuma.ai/sdk/react/Internal/variables/SLIDE_CANVAS_WIDTH

# SLIDE\_CANVAS\_WIDTH

> `const` **SLIDE\_CANVAS\_WIDTH**: `960` = `960`

Defined in: [src/tools/slides/index.ts:103](https://github.com/anuma-ai/sdk/blob/main/src/tools/slides/index.ts#103)

---
Source: https://docs.anuma.ai/sdk/react/Internal/variables/SLIDER_CONFIG

# SLIDER\_CONFIG

> `const` **SLIDER\_CONFIG**: `object`\[]

Defined in: [src/lib/db/userPreferences/types.ts:58](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/userPreferences/types.ts#58)

Slider configuration for UI rendering

## Type Declaration

### key

> **key**: keyof [`PersonalitySliders`](../interfaces/PersonalitySliders.md)

### label

> **label**: `string`

### leftLabel

> **leftLabel**: `string`

### rightLabel

> **rightLabel**: `string`

---
Source: https://docs.anuma.ai/sdk/react/Internal/variables/SLIDES_FILE_PATH

# SLIDES\_FILE\_PATH

> `const` **SLIDES\_FILE\_PATH**: `"slides.jsx"` = `"slides.jsx"`

Defined in: [src/tools/slides/index.ts:426](https://github.com/anuma-ai/sdk/blob/main/src/tools/slides/index.ts#426)

Canonical storage path for the slide deck, relative to a conversation.

---
Source: https://docs.anuma.ai/sdk/react/Internal/variables/THEME_ATTRS

# THEME\_ATTRS

> `const` **THEME\_ATTRS**: readonly \[`"background"`, `"slideBg"`, `"surfaceSecondary"`, `"textPrimary"`, `"textSecondary"`, `"textMuted"`, `"accent"`, `"card"`, `"border"`]

Defined in: [src/tools/slides/index.ts:111](https://github.com/anuma-ai/sdk/blob/main/src/tools/slides/index.ts#111)

---
Source: https://docs.anuma.ai/sdk/react/Internal/variables/userPreferencesStorageSchema

# userPreferencesStorageSchema

> `const` **userPreferencesStorageSchema**: `Readonly`<{ `tables`: `TableMap`; `unsafeSql?`: (`_`: `string`, `__`: `AppSchemaUnsafeSqlKind`) => `string`; `version`: `number`; }>

Defined in: [src/lib/db/userPreferences/schema.ts:10](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/userPreferences/schema.ts#10)

User preferences table schema definition.

This schema is used internally by the SDK and merged into the main sdkSchema.
It stores unified user preferences including profile data, model preferences,
and personality settings.

---
Source: https://docs.anuma.ai/sdk/react/Internal/variables/webPlatformStorage

# webPlatformStorage

> `const` **webPlatformStorage**: [`PlatformStorage`](../interfaces/PlatformStorage.md)

Defined in: [src/lib/db/manager.ts:86](https://github.com/anuma-ai/sdk/blob/main/src/lib/db/manager.ts#86)

Default PlatformStorage implementation for web browsers.
Uses localStorage for persistent storage, sessionStorage for session-scoped storage,
and indexedDB.deleteDatabase for database deletion.

---
Source: https://docs.anuma.ai/sdk/react/PDF-Export/exportElementToPdf

# exportElementToPdf

> **exportElementToPdf**(`element`: `HTMLElement`, `options?`: [`PdfExportOptions`](PdfExportOptions.md)): `Promise`<`Blob`>

Defined in: [src/lib/pdf-export.ts:325](https://github.com/anuma-ai/sdk/blob/main/src/lib/pdf-export.ts#325)

Capture a rendered HTML element as a high-fidelity PDF.

Uses [renderElementToCanvas](renderElementToCanvas.md) for the DOM snapshot, then embeds the
canvas image into a jsPDF document. Multi-page content is automatically
split.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`element`

</td>
<td>

`HTMLElement`

</td>
</tr>
<tr>
<td>

`options?`

</td>
<td>

[`PdfExportOptions`](PdfExportOptions.md)

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`Blob`>

---
Source: https://docs.anuma.ai/sdk/react/PDF-Export/exportMarkdownToPdf

# exportMarkdownToPdf

> **exportMarkdownToPdf**(`markdown`: `string`, `options?`: [`PdfExportOptions`](PdfExportOptions.md)): `Promise`<`Blob`>

Defined in: [src/lib/pdf-export.ts:407](https://github.com/anuma-ai/sdk/blob/main/src/lib/pdf-export.ts#407)

Convert a markdown string to a PDF. No DOM required.

Uses `marked` to tokenize the markdown and `jsPDF` to render block-level
elements (headings, paragraphs, code blocks, lists, blockquotes, tables,
horizontal rules). Inline formatting (bold/italic) within paragraphs is
stripped in v1.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`markdown`

</td>
<td>

`string`

</td>
</tr>
<tr>
<td>

`options?`

</td>
<td>

[`PdfExportOptions`](PdfExportOptions.md)

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`Blob`>

---
Source: https://docs.anuma.ai/sdk/react/PDF-Export/PdfExportOptions

# PdfExportOptions

Defined in: [src/lib/pdf-export.ts:25](https://github.com/anuma-ai/sdk/blob/main/src/lib/pdf-export.ts#25)

Options for PDF export.

## Properties

### filename?

> `optional` **filename**: `string`

Defined in: [src/lib/pdf-export.ts:42](https://github.com/anuma-ai/sdk/blob/main/src/lib/pdf-export.ts#42)

Filename used by the download helpers (default: "document.pdf")

***

### fontSize?

> `optional` **fontSize**: `number`

Defined in: [src/lib/pdf-export.ts:29](https://github.com/anuma-ai/sdk/blob/main/src/lib/pdf-export.ts#29)

Font size in points for body text (default: 12)

***

### margins?

> `optional` **margins**: `object`

Defined in: [src/lib/pdf-export.ts:33](https://github.com/anuma-ai/sdk/blob/main/src/lib/pdf-export.ts#33)

Page margins in mm (default: 20 on all sides)

**bottom?**

> `optional` **bottom**: `number`

**left?**

> `optional` **left**: `number`

**right?**

> `optional` **right**: `number`

**top?**

> `optional` **top**: `number`

***

### onProgress()?

> `optional` **onProgress**: (`progress`: [`PdfExportProgress`](PdfExportProgress.md)) => `void`

Defined in: [src/lib/pdf-export.ts:44](https://github.com/anuma-ai/sdk/blob/main/src/lib/pdf-export.ts#44)

Callback for progress updates during export

**Parameters**

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`progress`

</td>
<td>

[`PdfExportProgress`](PdfExportProgress.md)

</td>
</tr>
</tbody>
</table>

**Returns**

`void`

***

### pageNumbers?

> `optional` **pageNumbers**: `boolean`

Defined in: [src/lib/pdf-export.ts:40](https://github.com/anuma-ai/sdk/blob/main/src/lib/pdf-export.ts#40)

Whether to include page numbers (default: true)

***

### pageSize?

> `optional` **pageSize**: `"a4"` | `"letter"` | `"legal"`

Defined in: [src/lib/pdf-export.ts:27](https://github.com/anuma-ai/sdk/blob/main/src/lib/pdf-export.ts#27)

Page size (default: "a4")

***

### title?

> `optional` **title**: `string`

Defined in: [src/lib/pdf-export.ts:31](https://github.com/anuma-ai/sdk/blob/main/src/lib/pdf-export.ts#31)

Document title rendered at top of first page

---
Source: https://docs.anuma.ai/sdk/react/PDF-Export/PdfExportProgress

# PdfExportProgress

Defined in: [src/lib/pdf-export.ts:12](https://github.com/anuma-ai/sdk/blob/main/src/lib/pdf-export.ts#12)

Progress event emitted during PDF export.

## Properties

### detail?

> `optional` **detail**: `string`

Defined in: [src/lib/pdf-export.ts:18](https://github.com/anuma-ai/sdk/blob/main/src/lib/pdf-export.ts#18)

Optional human-readable detail, e.g. "Page 2 of 5"

***

### percent

> **percent**: `number`

Defined in: [src/lib/pdf-export.ts:16](https://github.com/anuma-ai/sdk/blob/main/src/lib/pdf-export.ts#16)

Overall progress from 0 to 100

***

### stage

> **stage**: [`PdfExportStage`](PdfExportStage.md)

Defined in: [src/lib/pdf-export.ts:14](https://github.com/anuma-ai/sdk/blob/main/src/lib/pdf-export.ts#14)

Current pipeline stage

---
Source: https://docs.anuma.ai/sdk/react/PDF-Export/PdfExportStage

# PdfExportStage

> **PdfExportStage** = `"preparing"` | `"rendering"` | `"building"` | `"complete"`

Defined in: [src/lib/pdf-export.ts:9](https://github.com/anuma-ai/sdk/blob/main/src/lib/pdf-export.ts#9)

Stages of the PDF export pipeline.

---
Source: https://docs.anuma.ai/sdk/react/PDF-Export/renderElementToCanvas

# renderElementToCanvas

> **renderElementToCanvas**(`element`: `HTMLElement`, `options?`: `Pick`<[`PdfExportOptions`](PdfExportOptions.md), `"onProgress"`>): `Promise`<`HTMLCanvasElement`>

Defined in: [src/lib/pdf-export.ts:230](https://github.com/anuma-ai/sdk/blob/main/src/lib/pdf-export.ts#230)

Render a DOM element to a canvas using iframe isolation.

This is the first half of the DOM capture pipeline: it clones the element
into an isolated iframe (to avoid affecting dark mode), copies stylesheets,
and uses html2canvas to produce a high-fidelity snapshot. The returned
canvas can be displayed as a preview before building the final PDF.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`element`

</td>
<td>

`HTMLElement`

</td>
</tr>
<tr>
<td>

`options?`

</td>
<td>

`Pick`<[`PdfExportOptions`](PdfExportOptions.md), `"onProgress"`>

</td>
</tr>
</tbody>
</table>

## Returns

`Promise`<`HTMLCanvasElement`>

---
Source: https://docs.anuma.ai/sdk/schema

# Database Schema

Current version: **v27**

```mermaid
graph LR
    history -- "belongs to" --> conversations
    history -- "has many" --> media
    conversations -- "belongs to" --> projects
    conversation_summaries -- "belongs to" --> conversations
    media -- "belongs to" --> conversations
```

## Tables

- [history](#history)
- [conversations](#conversations)
- [projects](#projects)
- [modelPreferences](#modelPreferences)
- [userPreferences](#userPreferences)
- [memory_vault](#memory_vault)
- [vault_folders](#vault_folders)
- [conversation_summaries](#conversation_summaries)
- [media](#media)
- [app_files](#app_files)
- [saved_tools](#saved_tools)

## history

| Column | Type | Indexed | Optional |
|--------|------|---------|----------|
| `message_id` | number |  |  |
| `conversation_id` | string | ✓ |  |
| `role` | string | ✓ |  |
| `content` | string |  |  |
| `model` | string |  | ✓ |
| `image_model` | string |  | ✓ |
| `files` | string |  | ✓ |
| `file_ids` | string |  | ✓ |
| `created_at` | number | ✓ |  |
| `updated_at` | number |  |  |
| `vector` | string |  | ✓ |
| `embedding_model` | string |  | ✓ |
| `chunks` | string |  | ✓ |
| `usage` | string |  | ✓ |
| `sources` | string |  | ✓ |
| `response_duration` | number |  | ✓ |
| `was_stopped` | boolean |  | ✓ |
| `error` | string |  | ✓ |
| `thought_process` | string |  | ✓ |
| `thinking` | string |  | ✓ |
| `parent_message_id` | string |  | ✓ |
| `feedback` | string |  | ✓ |
| `tool_call_events` | string |  | ✓ |

## conversations

| Column | Type | Indexed | Optional |
|--------|------|---------|----------|
| `conversation_id` | string | ✓ |  |
| `title` | string |  |  |
| `project_id` | string | ✓ | ✓ |
| `created_at` | number |  |  |
| `updated_at` | number |  |  |
| `is_deleted` | boolean | ✓ |  |

## projects

| Column | Type | Indexed | Optional |
|--------|------|---------|----------|
| `project_id` | string | ✓ |  |
| `name` | string |  |  |
| `created_at` | number |  |  |
| `updated_at` | number |  |  |
| `is_deleted` | boolean | ✓ |  |

## modelPreferences

| Column | Type | Indexed | Optional |
|--------|------|---------|----------|
| `wallet_address` | string | ✓ |  |
| `models` | string |  | ✓ |

## userPreferences

| Column | Type | Indexed | Optional |
|--------|------|---------|----------|
| `wallet_address` | string | ✓ |  |
| `nickname` | string |  | ✓ |
| `occupation` | string |  | ✓ |
| `description` | string |  | ✓ |
| `models` | string |  | ✓ |
| `personality` | string |  | ✓ |
| `created_at` | number |  |  |
| `updated_at` | number |  |  |

## memory_vault

| Column | Type | Indexed | Optional |
|--------|------|---------|----------|
| `content` | string |  |  |
| `scope` | string | ✓ |  |
| `folder_id` | string | ✓ | ✓ |
| `created_at` | number | ✓ |  |
| `updated_at` | number | ✓ |  |
| `is_deleted` | boolean | ✓ |  |
| `user_id` | string | ✓ | ✓ |
| `embedding` | string |  | ✓ |

## vault_folders

| Column | Type | Indexed | Optional |
|--------|------|---------|----------|
| `name` | string |  |  |
| `scope` | string |  |  |
| `created_at` | number | ✓ |  |
| `updated_at` | number |  |  |
| `is_deleted` | boolean | ✓ |  |
| `is_system` | boolean |  | ✓ |
| `context` | string |  | ✓ |

## conversation_summaries

| Column | Type | Indexed | Optional |
|--------|------|---------|----------|
| `conversation_id` | string | ✓ |  |
| `summary` | string |  |  |
| `summarized_up_to` | string |  |  |
| `token_count` | number |  |  |
| `created_at` | number |  |  |
| `updated_at` | number |  |  |

## media

| Column | Type | Indexed | Optional |
|--------|------|---------|----------|
| `media_id` | string | ✓ |  |
| `wallet_address` | string | ✓ |  |
| `message_id` | string | ✓ | ✓ |
| `conversation_id` | string | ✓ | ✓ |
| `name` | string |  |  |
| `mime_type` | string | ✓ |  |
| `media_type` | string | ✓ |  |
| `size` | number |  |  |
| `role` | string | ✓ |  |
| `model` | string | ✓ | ✓ |
| `source_url` | string |  | ✓ |
| `dimensions` | string |  | ✓ |
| `duration` | number |  | ✓ |
| `metadata` | string |  | ✓ |
| `created_at` | number | ✓ |  |
| `updated_at` | number |  |  |
| `is_deleted` | boolean | ✓ |  |

## app_files

| Column | Type | Indexed | Optional |
|--------|------|---------|----------|
| `conversation_id` | string | ✓ |  |
| `path` | string |  |  |
| `content` | string |  |  |
| `created_at` | number | ✓ |  |
| `updated_at` | number |  |  |

## saved_tools

| Column | Type | Indexed | Optional |
|--------|------|---------|----------|
| `name` | string |  |  |
| `display_name` | string |  |  |
| `description` | string |  |  |
| `parameters` | string |  |  |
| `html` | string |  |  |
| `conversation_id` | string |  | ✓ |
| `created_at` | number | ✓ |  |
| `updated_at` | number |  |  |
| `is_deleted` | boolean | ✓ |  |

## Migration History

| Version | Changes |
|---------|---------|
| v27 | Added `tool_call_events` to `history` |
| v26 | Added `app_files` table |
| v25 | Added `saved_tools` table |
| v24 | Added `context` to `vault_folders` |
| v23 | Added `conversation_summaries` table |
| v22 | Added `is_system` to `vault_folders` |
| v21 | Added `embedding` to `memory_vault` |
| v20 | `CREATE INDEX IF NOT EXISTS memory_vault_updated_at ON memory_vault (updated_at);` |
| v19 | Added `user_id` to `memory_vault` |
| v18 | Added `vault_folders` table; Added `folder_id` to `memory_vault` |
| v17 | Added `image_model` to `history` |
| v16 | Added `scope` to `memory_vault`; `UPDATE memory_vault SET scope = 'private' WHERE scope IS NULL OR scope = '';` |
| v15 | `DROP TABLE IF EXISTS memories;`; Added `memory_vault` table |
| v14 | Added `feedback` to `history` |
| v13 | Added `parent_message_id` to `history` |
| v12 | Added `chunks` to `history` |
| v11 | Added `media` table; Added `file_ids` to `history` |
| v10 | Added `projects` table; Added `project_id` to `conversations` |
| v9 | Added `thinking` to `history` |
| v8 | `DELETE FROM history;`; `DELETE FROM conversations;`; `DELETE FROM memories;` |
| v7 | Added `userPreferences` table |
| v6 | Added `thought_process` to `history` |
| v5 | Added `error` to `history` |
| v4 | Added `modelPreferences` table |
| v3 | Added `was_stopped` to `history` |
| v2 | Baseline — `history`, `conversations`, and `memories` tables |

---
Source: https://docs.anuma.ai/sdk/vercel

# Overview

Helper utilities for integrating the `useChat` hook and
[Vercel AI Elements](https://ai-sdk.dev/elements).

The `@anuma/sdk/vercel` package provides utilities to bridge the
Portal API with Vercel's AI SDK streaming format. This enables you to
use Vercel's AI Elements components with the SDK's `useChat` hook.

## Why Use These Utilities?

Vercel's AI components expect a specific stream format for real-time UI updates.
These utilities handle the conversion between Portal API responses and the
Vercel stream format, so you can:

* Use Vercel AI Elements with the SDK's `useChat` hook
* Render responses with AI Elements components
* Handle errors gracefully in the streaming UI

## Functions

| Function | Description |
| ------ | ------ |
| [createAssistantStream](Internal/functions/createAssistantStream.md) | Creates a `ReadableStream` that emits the sequence of events expected by Vercel's `createUIMessageStreamResponse` helper for a successful assistant reply. |
| [createErrorStream](Internal/functions/createErrorStream.md) | Creates a `ReadableStream` that emits a single `error` event compatible with the Vercel AI stream contract. This allows Portal API errors to be surfaced directly in UI components that expect streamed assistant output. |
| [mapMessagesToCompletionPayload](Internal/functions/mapMessagesToCompletionPayload.md) | Converts an array of Vercel AI UIMessage objects into the `LlmapiMessage` format that the Portal API expects. |

---
Source: https://docs.anuma.ai/sdk/vercel/Internal/functions/createAssistantStream

# createAssistantStream

> **createAssistantStream**(`text`: `string`): `ReadableStream`<`AssistantStreamEvent`>

Defined in: [src/vercel/streams.ts:18](https://github.com/anuma-ai/sdk/blob/main/src/vercel/streams.ts#18)

Creates a `ReadableStream` that emits the sequence of events expected by
Vercel's `createUIMessageStreamResponse` helper for a successful assistant reply.

The stream emits `text-start`, an optional `text-delta` containing the
provided `text`, and finally `text-end`, allowing Portal completions to be
piped directly into UI components that consume the AI SDK stream contract.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`text`

</td>
<td>

`string`

</td>
<td>

The assistant response text returned by the Portal API.

</td>
</tr>
</tbody>
</table>

## Returns

`ReadableStream`<`AssistantStreamEvent`>

A stream ready to be passed to `createUIMessageStreamResponse`.

---
Source: https://docs.anuma.ai/sdk/vercel/Internal/functions/createErrorStream

# createErrorStream

> **createErrorStream**(`errorText`: `string`): `ReadableStream`<`AssistantStreamEvent`>

Defined in: [src/vercel/streams.ts:54](https://github.com/anuma-ai/sdk/blob/main/src/vercel/streams.ts#54)

Creates a `ReadableStream` that emits a single `error` event compatible
with the Vercel AI stream contract. This allows Portal API errors to be
surfaced directly in UI components that expect streamed assistant output.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`errorText`

</td>
<td>

`string`

</td>
<td>

A human-readable error message to display in the UI.

</td>
</tr>
</tbody>
</table>

## Returns

`ReadableStream`<`AssistantStreamEvent`>

A stream that, when consumed, immediately emits the error event.

---
Source: https://docs.anuma.ai/sdk/vercel/Internal/functions/mapMessagesToCompletionPayload

# mapMessagesToCompletionPayload

> **mapMessagesToCompletionPayload**(`messages`: `UIMessage`<`unknown`, `UIDataTypes`, `UITools`>\[]): [`LlmapiMessage`](../../../client/Internal/type-aliases/LlmapiMessage.md)\[]

Defined in: [src/vercel/messages.ts:16](https://github.com/anuma-ai/sdk/blob/main/src/vercel/messages.ts#16)

Converts an array of Vercel AI UIMessage objects into the
`LlmapiMessage` format that the Portal API expects.

* Non text-only parts and unsupported roles are ignored.
* Text parts are merged with double newlines, matching the structure that
  `postApiV1ChatCompletions` accepts.

## Parameters

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>

`messages`

</td>
<td>

`UIMessage`<`unknown`, `UIDataTypes`, `UITools`>\[]

</td>
<td>

The UI layer conversation history received from `createUIMessageStreamResponse`.

</td>
</tr>
</tbody>
</table>

## Returns

[`LlmapiMessage`](../../../client/Internal/type-aliases/LlmapiMessage.md)\[]

A clean array of Portal-ready messages, filtered to user, assistant, and system roles.

---
Source: https://docs.anuma.ai/streaming

# Streaming

Users expect to see responses as they're generated, not after a long wait. The SDK streams responses back from the API in chunks, enabling real-time UI updates where text appears word by word.

## Callbacks

The SDK provides [callbacks](/sdk/react/Hooks/useChat#parameters) for each phase of the streaming lifecycle. The `onData` callback receives each content chunk as it arrives — use this to append to a displayed response. When streaming completes, `onFinish` is called with the full response object. If something goes wrong, `onError` handles it.

You can cancel streaming at any time by calling [`stop()`](/sdk/react/Hooks/useChat#returns). Partial responses are automatically saved to the conversation, so nothing is lost.

## Usage

All chat hooks support streaming out of the box. For basic streaming without persistence, use [`useChat`](/sdk/react/Hooks/useChat). For streaming with automatic message storage, use [`useChatStorage`](/sdk/react/Hooks/useChatStorage).

The [Chat with Storage](/tutorials/nextjs/conversations) tutorial shows a complete streaming chat UI implementation.

## Extended Thinking

Some models like OpenAI's o-series or Claude with extended thinking emit their reasoning process separately from the final answer. The `onThinking` callback surfaces this, letting you show users how the model works through a problem before delivering the response.

---
Source: https://docs.anuma.ai/tools/client

# Client-Side Tools

When a tool needs access to local data, user permissions, or browser APIs, it has to run in your app rather than on the server. Client-side tools let you define custom functions that the model can call during a conversation.

## How It Works

You send a message with tool definitions attached. When the model decides to call a tool, the SDK executes your function locally, sends the result back to the model, and the model continues with that information. In auto-execute mode, the SDK handles this entire flow automatically.

## Tool Definition

Each tool needs a name and description to help the model decide when to use it, a parameters schema using JSON Schema, and an executor function with your code:

```tsx
const tools = [{
  type: "function",
  name: "get_weather",
  description: "Get current weather for a location",
  parameters: {
    type: "object",
    properties: {
      location: { type: "string", description: "City name" }
    },
    required: ["location"]
  },
  executor: async (args) => {
    const response = await fetch(`/api/weather?city=${args.location}`);
    return response.json();
  }
}];

await sendMessage({
  content: "What's the weather in SF?",
  clientTools: tools,
});
```

Pass tools through [`useChat`](/sdk/react/Hooks/useChat) for basic tool calling, or [`useChatStorage`](/sdk/react/Hooks/useChatStorage) for tool calling with message persistence.

## Execution Modes

By default, auto-execute mode runs your function automatically and continues the conversation seamlessly.

For cases where you want user confirmation before executing a tool, use manual mode. The [`onToolCall`](/sdk/react/Hooks/useChat#parameters) callback gives you control over whether and how the tool runs:

```tsx
const { sendMessage } = useChat({
  onToolCall: (toolCall) => {
    if (confirm(`Allow ${toolCall.name}?`)) {
      // Execute and continue manually
    }
  },
});
```

## Pre-Built Tools

The SDK includes tools for Google Calendar (list, create, update events) and Google Drive (search, read files). These require user OAuth and run client-side only.

---
Source: https://docs.anuma.ai/tools/list

# Tools List

This is a complete list of server-side tools available through the Portal API.

---
Source: https://docs.anuma.ai/tools/overview

# Tools

Sometimes a model needs more than its training data to answer a question — it might need to search the web, check a calendar, or query a database. Tools give models the ability to take actions and incorporate real-time results into their responses.

## Server-Side vs Client-Side

[Server-side tools](/tools/server) run on the Portal API. The entire flow happens in a single request with no client-side handling needed. You just specify which tools to enable by name. Examples include web search and image generation.

[Client-side tools](/tools/client) run in your app. You define the tool with a JSON Schema for parameters and provide an executor function that runs locally. These are useful when the tool needs access to local data, user permissions, or browser APIs.

Server tools are simpler to integrate since everything happens API-side. Client tools give you full control but require a multi-turn request flow where the SDK sends tool results back to the model automatically.

## Multiple Tool Calls

Models can call multiple tools in one turn. For server tools, the API handles parallel execution internally. For client tools, the SDK executes them in parallel and sends all results together before the model continues.

## Available Tools

Browse [all server tools](/tools/list) for a live list from the API. The SDK also includes pre-built client tools for Google Calendar and Google Drive.

---
Source: https://docs.anuma.ai/tools/server

# Server-Side Tools

Server-side tools are the simplest way to give models additional capabilities. They run entirely on the Portal API — your app doesn't need to handle tool execution at all.

## How It Works

When you send a message with server tools enabled, the model decides whether to call a tool like web search. The API executes the tool internally, the model sees the result and continues generating, then you receive the final response. Even though tool execution happened in the middle, the response arrives as one streaming response.

Common server tools include web search and image generation. Check out the [full list of server tools](/tools/list) for all available options.

## Usage

Specify which tools to enable by name when sending a message through [`useChat`](/sdk/react/Hooks/useChat) or [`useChatStorage`](/sdk/react/Hooks/useChatStorage):

```tsx
await sendMessage({
  content: "Search for latest AI news",
  model: "gpt-4o-mini",
  serverTools: ["web_search"],
});
```

To fetch available tools dynamically at runtime, use [`useTools`](/sdk/react/Hooks/useTools).

---
Source: https://docs.anuma.ai/tutorials/agent

# Anuma Starter Agent

An interactive CLI chat agent built with the [Anuma SDK](https://github.com/anuma-ai/sdk). Supports streaming responses, model switching, and client-side tool execution via the SDK's `runToolLoop`.

## Getting Started

### Create an Anuma app

Sign in at [dashboard.anuma.ai](https://dashboard.anuma.ai/) and create an app.
This provisions the API account that powers AI responses.

### Clone and install

```bash
git clone https://github.com/anuma-ai/starter-agent.git
cd starter-agent
pnpm install
```

### Save your API key

Copy the API key from the dashboard and save it:

```bash
pnpm agent login --api-key <your-key>
```

## Usage

Start a chat session:

```bash
pnpm agent chat
```

Options:

```
--model <name>      Model to use (default: "openai/gpt-4o")
--system <prompt>   System prompt
--api-url <url>     API base URL
--no-tools          Disable client-side tools
```

### Chat commands

- `/model` — open the model picker (fuzzy search)
- `/model <name>` — switch to a model by name
- `/exit` — quit the session

## Adding tools

Tools live in `src/tools/`. Each tool is a `ToolConfig` object with a function schema and an `executor` that runs locally when the model calls it.

Create a new file in `src/tools/`:

```typescript
import type { ToolConfig } from "@anuma/sdk/server";

export const myTool: ToolConfig = {
  type: "function",
  function: {
    name: "my_tool",
    description: "What this tool does",
    parameters: {
      type: "object",
      properties: {
        arg: { type: "string", description: "Argument description" },
      },
      required: ["arg"],
    },
  },
  executor: async ({ arg }) => {
    // Your logic here — runs on the user's machine
    return { result: "..." };
  },
};
```

Then register it in `src/tools/index.ts`:

```typescript
import { myTool } from "./my-tool.js";

export const tools: ToolConfig[] = [listFiles, myTool];
```

The included `list_files` tool demonstrates this pattern — it reads the local filesystem, something only a client-side tool can do.

## Build

```bash
pnpm build
```

After building, the CLI is available as `anuma-agent` (via the `bin` field in package.json).

---
Source: https://docs.anuma.ai/tutorials/agent/chat

# Chat

The `chat` command starts an interactive session that streams responses from the Anuma Portal API. It uses `runToolLoop` from `@anuma/sdk/server` to handle the full request cycle: sending messages, streaming tokens, executing client-side tools, and feeding results back to the model.

## The Tool Loop

Each user message goes through `runToolLoop`, which manages streaming and multi-turn tool execution in a single call. The SDK handles SSE parsing, tool call detection, executor dispatch, and continuation requests internally.

```ts
        const result = await runToolLoop({
          messages: messages as any,
          model,
          token: apiKey,
          baseUrl,
          headers: sdkHeaders(apiKey),
          apiType: "completions",
          ...(opts.tools && { tools }),
          onData: (chunk: string) => {
            if (firstToken) {
              spinner.stop();
              firstToken = false;
            }
            process.stdout.write(chunk);
          },
          onError: () => {
            if (firstToken) {
              spinner.stop();
              firstToken = false;
            }
          },
        });
```

[src/commands/chat.ts](https://github.com/anuma-ai/starter-agent/blob/main/src/commands/chat.ts#L326-L347)

The key options:

- `messages` is the full conversation history, formatted as content arrays
- `token` and `headers` handle authentication (the Portal API uses `X-API-Key`)
- `apiType: "completions"` targets the `/api/v1/chat/completions` endpoint
- `tools` are only included when `--no-tools` is not set
- `onData` streams tokens to stdout as they arrive

When the model calls a tool that has an `executor`, the SDK runs it automatically and sends the result back. This loop continues until the model responds with text or hits the max rounds limit (default 3).

## Command Definition

The full command handles the REPL loop, model switching, and error display:

```ts
export const chat = new Command("chat")
  .description("Start an interactive chat session")
  .option("--api-url <url>", "API base URL")
  .option("--model <name>", "Model to use", "openai/gpt-4o")
  .option("--system <prompt>", "System prompt")
  .option("--no-tools", "Disable client-side tools")
  .option("--resume <id>", "Resume a previous conversation by ID")
  .option("--reset", "Delete all conversations and start fresh")
  .action(async (opts: { model: string; system?: string; apiUrl?: string; tools: boolean; resume?: string; reset?: boolean }) => {
    if (opts.reset) {
      rmSync(DATA_DIR, { recursive: true, force: true });
      console.log(chalk.dim("All conversations deleted.\n"));
    }

    const baseUrl = opts.apiUrl ?? getApiUrl();
    const apiKey = getApiKey();
    const ctx = getStorageContext();
    const messages: Message[] = [];

    // Resolve or lazily create a conversation
    let conversationId: string | null = null;
    let isNewConversation = false;

    if (opts.system) {
      messages.push({ role: "system", content: [{ type: "text", text: opts.system }] });
    }

    if (opts.resume) {
      const conv = await getConversationOp(ctx, opts.resume);
      if (!conv) {
        console.error(chalk.red(`Conversation not found: ${opts.resume}`));
        process.exit(1);
      }
      conversationId = conv.conversationId;
      const restored = await loadConversation(conversationId);
      messages.push(...restored);
      console.log(chalk.dim(`Resumed "${conv.title}" (${restored.length} messages)\n`));
    }

    let model = opts.model;

    console.log(
      chalk.dim(`Model: ${model}. Type /new, /history, /model, /exit.\n`),
    );

    let rl = createInterface({
      input: process.stdin,
      output: process.stdout,
    });

    let closed = false;
    rl.on("close", () => {
      closed = true;
    });

    const prompt = (): Promise<string | null> =>
      new Promise((resolve) => {
        if (closed) return resolve(null);
        rl.question(chalk.green("> "), (answer) => resolve(answer));
      });

    while (true) {
      const input = await prompt();
      if (input === null) break;
      if (!input.trim()) continue;
      if (input.trim() === "/exit") {
        rl.close();
        break;
      }

      if (input.trim() === "/history") {
        rl.close();
        const picked = await pickConversation();
        if (picked?.action === "resume") {
          conversationId = picked.conversation.conversationId;
          messages.length = 0;
          if (opts.system) {
            messages.push({ role: "system", content: [{ type: "text", text: opts.system }] });
          }
          const restored = await loadConversation(conversationId);
          messages.push(...restored);
          console.log(chalk.dim(`Switched to "${picked.conversation.title}" (${restored.length} messages)\n`));
        } else if (picked?.action === "delete") {
          await deleteConversationOp(ctx, picked.conversation.conversationId);
          if (conversationId === picked.conversation.conversationId) {
            conversationId = null;
            isNewConversation = false;
            messages.length = 0;
            if (opts.system) {
              messages.push({ role: "system", content: [{ type: "text", text: opts.system }] });
            }
          }
          console.log(chalk.dim(`Deleted "${picked.conversation.title}"\n`));
        }
        rl = createInterface({ input: process.stdin, output: process.stdout });
        closed = false;
        rl.on("close", () => { closed = true; });
        continue;
      }
      if (input.trim() === "/new") {
        conversationId = null;
        isNewConversation = false;
        messages.length = 0;
        if (opts.system) {
          messages.push({ role: "system", content: [{ type: "text", text: opts.system }] });
        }
        console.log(chalk.dim("Started new conversation.\n"));
        continue;
      }

      if (input.trim().startsWith("/model")) {
        const name = input.trim().slice(6).trim();
        if (name) {
          model = name;
        } else {
          rl.close();
          model = await pickModel(model, baseUrl);
          rl = createInterface({
            input: process.stdin,
            output: process.stdout,
          });
          closed = false;
          rl.on("close", () => {
            closed = true;
          });
        }
        console.log(chalk.dim(`Model: ${model}\n`));
        continue;
      }

      messages.push({ role: "user", content: [{ type: "text", text: input }] });

      // Lazily create a conversation on first user message.
      if (!conversationId) {
        const truncated = input.length > 60 ? input.slice(0, 57) + "…" : input;
        const conv = await createConversationOp(ctx, undefined, truncated);
        conversationId = conv.conversationId;
        isNewConversation = true;
      }

      // Generate a proper title in the background after the first message.
      if (isNewConversation) {
        isNewConversation = false;

        const targetConversationId = conversationId!;
        postApiV1ChatCompletions({
          baseUrl,
          headers: sdkHeaders(apiKey),
          body: {
            model,
            messages: [
              { role: "system", content: [{ type: "text", text: "Generate a short (max 6 words) conversation title for the user message below. Reply with the title only, no quotes or punctuation." }] },
              { role: "user", content: [{ type: "text", text: input }] },
            ],
          },
        }).then(async (res) => {
          const title = (res.data as any)?.choices?.[0]?.message?.content?.trim();
          if (title) {
            await updateConversationTitleOp(ctx, targetConversationId, title);
          }
        }).catch(() => {});
      }

      process.stdout.write("\n");
      const spinner = ora({ color: "cyan" }).start();
      let firstToken = true;

      // Store user message
      const userText = input;
      await createMessageOp(ctx, { conversationId: conversationId!, role: "user", content: userText, model });

      try {
        const result = await runToolLoop({
          messages: messages as any,
          model,
          token: apiKey,
          baseUrl,
          headers: sdkHeaders(apiKey),
          apiType: "completions",
          ...(opts.tools && { tools }),
          onData: (chunk: string) => {
            if (firstToken) {
              spinner.stop();
              firstToken = false;
            }
            process.stdout.write(chunk);
          },
          onError: () => {
            if (firstToken) {
              spinner.stop();
              firstToken = false;
            }
          },
        });

        if (firstToken) spinner.stop();

        if (result.error) {
          console.error(chalk.red(`Error: ${String(result.error)}`));
        } else {
          process.stdout.write("\n");
          const d = result.data as any;
          const text: string =
            d?.choices?.[0]?.message?.content ??
            d?.output?.find?.((o: any) => o.type === "message")?.content
              ?.find?.((c: any) => c.type === "output_text")?.text ??
            "";

          messages.push({ role: "assistant", content: text });

          // Store assistant message
          if (text) {
            await createMessageOp(ctx, { conversationId: conversationId!, role: "assistant", content: text, model });
          }

          if ("autoExecutedToolResults" in result && result.autoExecutedToolResults?.length) {
            for (const tr of result.autoExecutedToolResults) {
              console.log(chalk.dim(`  [tool: ${tr.name}] → ${JSON.stringify(tr.result)}`));
            }
          }
        }

        console.log();
      } catch (err: any) {
        spinner.stop();
        console.error(chalk.red(`Error: ${err.message}`));
      }
    }
  });
```

[src/commands/chat.ts](https://github.com/anuma-ai/starter-agent/blob/main/src/commands/chat.ts#L147-L383)

The REPL supports two slash commands: `/model` opens a fuzzy-search picker (or sets a model by name), and `/exit` quits the session.

## Streaming

Tokens stream directly to stdout via the `onData` callback. A spinner shows while waiting for the first token, then stops as soon as content arrives. This gives immediate feedback without buffering the full response.

---
Source: https://docs.anuma.ai/tutorials/agent/models

# Models

The agent defaults to `openai/gpt-4o` but can switch models at any time. You can set a model on startup with `--model` or change it mid-session with the `/model` command.

## Fetching Available Models

The `fetchModelIds` function queries the Portal API for all available models using the generated SDK client:

```ts
async function fetchModelIds(baseUrl: string): Promise<string[]> {
  const apiKey = getApiKey();

  const { data, error } = await getApiV1Models({
    baseUrl,
    headers: sdkHeaders(apiKey),
  });

  if (error) throw new Error(`Failed to fetch models: ${JSON.stringify(error)}`);

  const models = (data as any)?.models ?? (data as any)?.data ?? data;
  if (!Array.isArray(models)) return [];
  return models.map((m: any) => m.id ?? m.name).filter(Boolean);
}
```

[src/commands/chat.ts](https://github.com/anuma-ai/starter-agent/blob/main/src/commands/chat.ts#L31-L44)

This uses `getApiV1Models` from `@anuma/sdk/client`, which hits the `/api/v1/models` endpoint.

## Interactive Picker

When you type `/model` without a name, the agent opens a fuzzy-search picker powered by `@inquirer/search`:

```ts
async function pickModel(current: string, baseUrl: string): Promise<string> {
  const spinner = ora({ text: "Loading models…", color: "cyan" }).start();
  let modelIds: string[];
  try {
    modelIds = await fetchModelIds(baseUrl);
  } catch (err: any) {
    spinner.stop();
    console.error(chalk.red(`Error: ${err.message}`));
    return current;
  }
  spinner.stop();

  if (modelIds.length === 0) {
    console.log(chalk.dim("No models available"));
    return current;
  }

  try {
    return await search({
      message: "Select a model",
      source: (input) => {
        const term = (input ?? "").toLowerCase();
        return modelIds
          .filter((id) => id.toLowerCase().includes(term))
          .map((id) => ({ name: id, value: id }));
      },
    });
  } catch {
    return current;
  }
}
```

[src/commands/chat.ts](https://github.com/anuma-ai/starter-agent/blob/main/src/commands/chat.ts#L48-L78)

The picker fetches the full model list, then filters in real time as you type. Select a model to switch to it for the rest of the session.

## Setting a Model

There are three ways to choose a model:

```bash
# At startup
anuma-agent chat --model anthropic/claude-3-7-sonnet

# During a session — interactive picker
> /model

# During a session — by name
> /model anthropic/claude-3-7-sonnet
```

---
Source: https://docs.anuma.ai/tutorials/agent/setup

# Setup

The starter agent stores its configuration in `~/.anuma/config.json`. The config module reads and writes this file and provides helpers used by every command.

## Configuration

```ts
import { readFileSync, writeFileSync, mkdirSync } from "node:fs";
import { join, dirname } from "node:path";
import { homedir } from "node:os";
const CONFIG_FILE = join(homedir(), ".anuma", "config.json");
const DEFAULT_BASE_URL = "https://portal.anuma-dev.ai";

interface Config {
  apiKey?: string;
  apiUrl?: string;
}

function readConfig(): Config {
  try {
    return JSON.parse(readFileSync(CONFIG_FILE, "utf-8"));
  } catch {
    return {};
  }
}

export function getApiKey(): string {
  const config = readConfig();
  if (!config.apiKey) {
    console.error(
      "No API key configured. Run: anuma auth login --api-key <key>",
    );
    process.exit(1);
  }
  return config.apiKey;
}

export function setApiKey(apiKey: string): void {
  const config = readConfig();
  config.apiKey = apiKey;
  mkdirSync(dirname(CONFIG_FILE), { recursive: true });
  writeFileSync(CONFIG_FILE, JSON.stringify(config, null, 2) + "\n");
}

export function getApiUrl(): string {
  const config = readConfig();
  return config.apiUrl ?? DEFAULT_BASE_URL;
}
```

[src/config.ts](https://github.com/anuma-ai/starter-agent/blob/main/src/config.ts#L2-L42)

`getApiKey` exits the process if no key is found, so commands that need authentication fail early with a helpful message. `getApiUrl` falls back to the default Portal URL when no override is configured.

## Authentication

To get an API key, sign in at [dashboard.anuma.ai](https://dashboard.anuma.ai/) and create an app. This provisions the API account that powers AI responses.

The `login` command saves an API key to the config file:

```ts
import { Command } from "commander";
import chalk from "chalk";
import { setApiKey } from "../config.js";

export const login = new Command("login")
  .description("Save your API key")
  .requiredOption("--api-key <key>", "API key")
  .action((opts: { apiKey: string }) => {
    setApiKey(opts.apiKey);
    console.log(chalk.green("API key saved."));
  });
```

[src/commands/login.ts](https://github.com/anuma-ai/starter-agent/blob/main/src/commands/login.ts#L2-L12)

Run it once to authenticate:

```bash
anuma-agent login --api-key <your-key>
```

## Entry Point

The CLI entry point wires up the commands with [Commander](https://github.com/tj/commander.js):

```ts
import { Command } from "commander";
import { login } from "./commands/login.js";
import { chat } from "./commands/chat.js";

const program = new Command();

program
  .name("anuma-agent")
  .description("Anuma starter agent – interactive chat CLI")
  .version("0.1.0");

program.addCommand(login);
program.addCommand(chat);

program.parse();
```

[src/index.ts](https://github.com/anuma-ai/starter-agent/blob/main/src/index.ts#L4-L18)

---
Source: https://docs.anuma.ai/tutorials/agent/tools

# Tools

Client-side tools let the model interact with the user's local environment. Each tool has a JSON schema that the model sees, and an `executor` function that runs on the user's machine when the model calls it. The SDK's `runToolLoop` handles execution automatically.

## Tool Definition

A tool is a `ToolConfig` object that combines an OpenAI-compatible function schema with a local executor. Here's the included `list_files` tool:

```ts
import { readdirSync, statSync } from "node:fs";
import { join } from "node:path";
import type { ToolConfig } from "@anuma/sdk/server";

export const listFiles: ToolConfig = {
  type: "function",
  function: {
    name: "list_files",
    description:
      "List files and directories in a given path on the user's machine. Returns names, types, and sizes.",
    parameters: {
      type: "object",
      properties: {
        path: {
          type: "string",
          description: "Absolute or relative directory path. Defaults to the current working directory.",
        },
      },
    },
  },
  executor: async ({ path }) => {
    const dir = String(path || ".");
    try {
      const entries = readdirSync(dir).map((name) => {
        try {
          const stat = statSync(join(dir, name));
          return {
            name,
            type: stat.isDirectory() ? "directory" : "file",
            size: stat.size,
          };
        } catch {
          return { name, type: "unknown", size: 0 };
        }
      });
      return { path: dir, entries };
    } catch (err: any) {
      return { error: err.message };
    }
  },
};
```

[src/tools/list-files.ts](https://github.com/anuma-ai/starter-agent/blob/main/src/tools/list-files.ts#L2-L44)

The `function` object describes the tool to the model: its name, what it does, and what arguments it accepts. The `executor` receives parsed arguments and returns a result that gets sent back to the model as a tool response.

## Executor

The executor runs locally and can do anything a Node.js process can. In this case it reads the filesystem, but you could call local APIs, run shell commands, query databases, or interact with hardware.

```ts
  executor: async ({ path }) => {
    const dir = String(path || ".");
    try {
      const entries = readdirSync(dir).map((name) => {
        try {
          const stat = statSync(join(dir, name));
          return {
            name,
            type: stat.isDirectory() ? "directory" : "file",
            size: stat.size,
          };
        } catch {
          return { name, type: "unknown", size: 0 };
        }
      });
      return { path: dir, entries };
    } catch (err: any) {
      return { error: err.message };
    }
  },
```

[src/tools/list-files.ts](https://github.com/anuma-ai/starter-agent/blob/main/src/tools/list-files.ts#L23-L42)

Return values are serialized to JSON and sent back to the model. Returning an `error` field is a convention that helps the model understand failures.

## Tool Registry

All tools are collected in a single array and passed to `runToolLoop`:

```ts
import type { ToolConfig } from "@anuma/sdk/server";
import { listFiles } from "./list-files.js";

export const tools: ToolConfig[] = [listFiles];
```

[src/tools/index.ts](https://github.com/anuma-ai/starter-agent/blob/main/src/tools/index.ts#L2-L5)

To add a new tool, create a file in `src/tools/`, define a `ToolConfig`, and add it to this array. The model will see it in the next request.

## Disabling Tools

Pass `--no-tools` to run without client-side tools:

```bash
anuma-agent chat --no-tools
```

This omits the `tools` array from the request entirely, so the model won't attempt any tool calls. Server-side tools (if configured on the Portal) still work regardless of this flag.

---
Source: https://docs.anuma.ai/tutorials/expo

# Expo Starter

A starter template for building mobile AI chat apps with
[Expo](https://expo.dev/), React Native, and the
[Anuma SDK](https://www.npmjs.com/package/@anuma/sdk). Includes Google OAuth
authentication, real-time streaming chat with model selection, conversation
history, image attachments, and embedded wallet support.

## Getting Started

### Create an Anuma app

Sign in at [dashboard.anuma.ai](https://dashboard.anuma.ai/) and create an app.
This provisions the API account that powers AI responses.

### Clone and install

```bash
git clone https://github.com/anuma-ai/starter-expo.git
cd starter-expo
pnpm install
```

This app uses native modules and requires a development client — it won't work
with Expo Go. You'll need an iOS Simulator or Android Emulator.

### Configure environment variables

```bash
cp .env.example .env.local
```

At minimum you need `EXPO_PUBLIC_PRIVY_APP_ID` and
`EXPO_PUBLIC_PRIVY_CLIENT_ID` from the
[Privy Dashboard](https://dashboard.privy.io/). For iOS builds, also set
`EXPO_PUBLIC_APPLE_TEAM_ID`.

The API base URL defaults to `https://portal.anuma-dev.ai` in
`constants/api.ts`.

### Run the app

Build and run on iOS:

```bash
pnpm run ios
```

Build and run on Android:

```bash
pnpm run android
```

## Features

- Google OAuth authentication via Privy
- Real-time streaming AI chat with model selection
- Conversation history with local persistence (WatermelonDB)
- Image attachments in messages
- Gesture-driven conversation drawer
- Embedded wallet support (EVM)

## Key Patterns

The app uses the Anuma SDK's `useChatStorage` hook for message persistence.
Messages are stored locally in WatermelonDB and synced with the API. Streaming
responses arrive via SSE, which requires polyfills configured in
`entrypoint.js`.

Authentication tokens from Privy are passed to the SDK via `getIdentityToken`,
so the SDK can authenticate API requests on behalf of the user.

## License

MIT

---
Source: https://docs.anuma.ai/tutorials/expo/chat

# Chat Hook

`useChatStorageSetup` is the main hook that wires together the SDK's storage
layer, streaming callbacks, and model fetching. It wraps `useChatStorage` and
`useModels` from `@anuma/sdk/expo` into a single setup function.

## Hook Initialization

Pass the database, auth token, and streaming callbacks into `useChatStorage`.
The `onData` callback accumulates streamed chunks in a ref and forwards the
full text to the parent component on each token. `onFinish` and `onError`
reset the accumulator.

```ts
  const chatStorage = useChatStorage({
    database,
    conversationId,
    getToken: getIdentityToken,
    baseUrl: API_BASE_URL,
    onData: (chunk: string) => {
      accumulatedContentRef.current += chunk;
      onStreamingContentRef.current?.(accumulatedContentRef.current);
    },
    onFinish: async () => {
      accumulatedContentRef.current = "";
      onStreamingContentRef.current?.("");
    },
    onError: (error: Error) => {
      console.error("Chat error:", error);
      accumulatedContentRef.current = "";
      onStreamingContentRef.current?.("");
      onErrorRef.current?.(error);
    },
  });
```

## Models

The `useModels` hook fetches available LLM models from the API. It takes the
same `getToken` and `baseUrl` as the chat hook.

```ts
  const { models, isLoading: isLoadingModels } = useModels({
    getToken: getIdentityToken,
    baseUrl: API_BASE_URL,
  });
```

## Return Value

The hook spreads the SDK's chat storage methods and adds model data.

```ts
  return {
    ...chatStorage,
    models,
    isLoadingModels,
    accumulatedContentRef,
  };
```

## What's Next

- [Sending Messages](messages) — optimistic UI, content parts, and the send flow
- [Conversations](conversations) — switching, creating, and deleting conversations
- [Streaming](streaming) — how streamed tokens reach the UI
- [Fetching Models](models) — model picker integration

---
Source: https://docs.anuma.ai/tutorials/expo/conversations

# Conversation Management

The SDK's `useChatStorage` hook exposes methods for managing conversations. The
app wires these into a gesture-driven drawer that lists all conversations with
search, selection, creation, and deletion.

## Switching Conversations

When the user selects a conversation from the drawer, messages are loaded from the
database and the drawer closes. The `toUIMessage` helper converts stored messages
into the format the chat view expects.

```tsx
  const handleSelectConversation = async (conversation: Conversation) => {
    setCurrentConversationId(conversation.id);
    setStreamingContent("");
    setDrawerOpen(false);
    // Load messages for selected conversation
    try {
      const storedMessages = await getMessagesRef.current(conversation.id);
      setMessages(storedMessages.map(toUIMessage));
    } catch (error) {
      console.error("Failed to load messages:", error);
      setMessages([]);
    }
  };
```

## Creating a Conversation

Starting a new conversation clears the current state. The SDK creates the actual
conversation record on the first `sendMessage` call when no `conversationId` is
set (auto-create mode).

```tsx
  const handleNewConversation = () => {
    setCurrentConversationId(null);
    setMessages([]);
    setStreamingContent("");
    setDrawerOpen(false);
  };
```

## Deleting a Conversation

Deletion removes the conversation from the database via the SDK's
`deleteConversation` method. If the deleted conversation is the one currently
active, the UI is reset.

```tsx
  const handleDeleteConversation = async (conversation: Conversation) => {
    try {
      await deleteConversationRef.current(conversation.id);
      // If we're deleting the current conversation, clear it
      if (currentConversationId === conversation.id) {
        setCurrentConversationId(null);
        setMessages([]);
        setStreamingContent("");
      }
      // Refresh the conversation list
      loadConversations();
    } catch (error) {
      console.error("Failed to delete conversation:", error);
    }
  };
```

## Conversation Format

`StoredConversation` from the SDK is converted to a UI-friendly shape for the
conversation list component.

```tsx
// Convert StoredConversation to UI Conversation format
const toUIConversation = (conv: StoredConversation): Conversation => ({
  id: conv.conversationId,
  title: conv.title || "New Chat",
  createdAt: conv.createdAt.getTime(),
  updatedAt: conv.updatedAt.getTime(),
});
```

---
Source: https://docs.anuma.ai/tutorials/expo/messages

# Sending Messages

The `ChatInput` component handles composing and sending messages, including text,
image attachments, and optimistic UI updates.

## Optimistic UI Updates

Add the user's message to the UI immediately before the API responds. This
creates a snappy experience by showing the message right away. On error, the
optimistic update is reverted by reloading from the database.

```tsx
    // Optimistic update: show the user's message in the UI immediately rather
    // than waiting for the API round-trip. On error we revert to the DB state.
    // After success we merge stored messages with the optimistic file URLs,
    // because the DB strips data URIs from attachments.
    const existingMessages = currentConversationId
      ? await getMessages(currentConversationId)
      : [];
    onMessagesChange([
      ...existingMessages,
      {
        uniqueId: "temp",
        messageId: 0,
        conversationId: "",
        role: "user",
        content: prompt,
        files: optimisticFiles,
        createdAt: new Date(),
        updatedAt: new Date(),
      } as StoredMessage,
    ]);
```

## Building Content Parts

The API expects content as an array of typed parts. Text is always included, and
images are added as `image_url` parts when an attachment is present.

```tsx
    const userContent: Array<{ type: "text"; text: string } | { type: "image_url"; image_url: { url: string } }> = [
      { type: "text", text: prompt },
    ];
    if (attachedImage) {
      userContent.push({ type: "image_url", image_url: { url: attachedImage } });
    }
```

## Calling sendMessage

The content parts are passed to `sendMessage` along with the selected model.
`includeHistory: true` tells the SDK to prepend conversation history
automatically.

```tsx
    const result = await sendMessage({
      messages: [{ role: "user", content: userContent }],
      model: selectedModel,
      includeHistory: true,
      serverTools: [],
    });
```

## Title Generation

After the first message in a new conversation, the title is set to a truncated
version of the user's input using `updateConversationTitle` from the SDK.

```tsx
        // Set conversation title to first message (truncated)
        const isNewConversation = !conversationId;
        if (isNewConversation) {
          const title = prompt.length > 50 ? prompt.slice(0, 50) + "..." : prompt;
          await updateConversationTitle(convId, title);
        }
```

## Post-Stream Merge

After streaming completes, messages are reloaded from the database. Because
WatermelonDB strips data URIs from file attachments, the merge step preserves
the original image URLs from the optimistic update so attached images continue
to render.

```tsx
        // Instead of reloading from DB (which strips data URIs),
        // merge stored messages with preserved file URLs from optimistic update
        const storedMessages = await getMessages(convId);

        // Merge: preserve file URLs for user messages that had attachments
        const mergedMessages = storedMessages.map((msg: StoredMessage) => {
          // If this is the user message we just sent and it had files
          if (msg.role === "user" && msg.content === prompt && optimisticFiles) {
            // Check if stored message has files without URLs (stripped data URIs)
            if (!msg.files || msg.files.every((f) => !f.url)) {
              return { ...msg, files: optimisticFiles };
            }
          }
          return msg;
        });

        onMessagesChange(mergedMessages);
```

## Message Format Conversion

`StoredMessage` from the SDK is converted to a UI-friendly format. Messages
with image files are transformed into multi-part content arrays so the chat
view can render both text and images.

```tsx
// Convert StoredMessage to UI Message format
const toUIMessage = (msg: StoredMessage): Message => {
  // Check if message has files with URLs
  const imageFiles = msg.files?.filter((f) => f.url) || [];

  if (imageFiles.length === 0) {
    return { role: msg.role, content: msg.content };
  }

  // Build content array with text and images
  const contentArray: MessageContent = [
    { type: "text", text: msg.content },
    ...imageFiles.map((f) => ({
      type: "image_url" as const,
      image_url: { url: f.url! },
    })),
  ];

  return { role: msg.role, content: contentArray };
};
```

---
Source: https://docs.anuma.ai/tutorials/expo/models

# Fetching Models

The `useModels` hook from `@anuma/sdk/expo` fetches available LLM models from the
API. The starter app wires it into a modal picker so users can select which model
to use for each message.

## Hook Initialization

```ts
  const { models, isLoading: isLoadingModels } = useModels({
    getToken: getIdentityToken,
    baseUrl: API_BASE_URL,
  });
```

The hook takes `getToken` (a function returning a Privy identity token) and an
optional `baseUrl`. It returns the `models` array and an `isLoading` flag.

## Model Picker

The `ModelPickerSheet` component renders a searchable modal list of available
models. Each model shows its name and provider, with a checkmark on the selected
one. The selected model ID is passed to `sendMessage` on each request.

## Model Shape

Each model object contains:

- `id` — the model identifier passed to the API (e.g. `openai/gpt-4o`)
- `name` — display name
- `provider` — the model provider name

---
Source: https://docs.anuma.ai/tutorials/expo/setup

# Setup

The starter requires a few pieces of infrastructure before the SDK hooks can run:
polyfills for React Native's missing Web APIs, a WatermelonDB database, and a
Privy authentication provider.

## Polyfills

React Native doesn't ship Web Streams or `TextDecoderStream`, both of which the
SDK needs for SSE streaming. The app's entrypoint installs these before anything
else loads.

```js
// Import required polyfills first
// IMPORTANT: These polyfills must be installed in this order
import "react-native-get-random-values";
import "@ethersproject/shims";
import { Buffer } from "buffer";
import { LogBox } from "react-native";
global.Buffer = Buffer;

// Suppress Privy embedded wallet timeout error (non-blocking SDK issue)
LogBox.ignoreLogs(["Ping reached timeout"]);

// Web Streams polyfill for SSE streaming (TextDecoderStream, TransformStream, etc.)
import { ReadableStream, TransformStream } from "web-streams-polyfill";
if (typeof globalThis.ReadableStream === "undefined") {
  globalThis.ReadableStream = ReadableStream;
}
if (typeof globalThis.TransformStream === "undefined") {
  globalThis.TransformStream = TransformStream;
}

// SDK polyfills (TextDecoderStream, etc.)
import "@anuma/sdk/polyfills";
```

Order matters — `react-native-get-random-values` and `@ethersproject/shims` must
come first, then the Web Streams polyfill, then `@anuma/sdk/polyfills` which
provides `TextDecoderStream`.

## Database

The SDK persists conversations and messages in WatermelonDB. Create a single
database instance using the schema, migrations, and model classes exported from
`@anuma/sdk/expo`.

```ts
const adapter = new SQLiteAdapter({
  schema: sdkSchema,
  migrations: sdkMigrations,
  dbName: "anuma_chat",
  jsi: true,
  onSetUpError: (error) => {
    console.error("Database setup error:", error);
  },
});

export const database = new Database({
  adapter,
  modelClasses: sdkModelClasses,
});
```

The `jsi: true` flag enables the JSI SQLite adapter for native performance. The
database is named `anuma_chat` and is shared across the app via a direct import.

## Authentication

Privy handles authentication and provides an identity token that the SDK uses for
API requests. Wrap your app in `PrivyProvider` with your app and client IDs from
the Expo config.

```tsx
export default function RootLayout() {
  return (
    <GestureHandlerRootView style={{ flex: 1 }}>
      <PrivyProvider
        appId={Constants.expoConfig?.extra?.privyAppId}
        clientId={Constants.expoConfig?.extra?.privyClientId}
        config={{
          embedded: {
            ethereum: {
              createOnLogin: "users-without-wallets",
            },
            solana: {
              createOnLogin: "off",
            },
          },
        }}
      >
        <ErrorBoundary>
          <AppContent />
        </ErrorBoundary>
      </PrivyProvider>
    </GestureHandlerRootView>
  );
}
```

The `useIdentityToken` hook from Privy returns a `getIdentityToken` function that
the SDK's `useChatStorage` and `useModels` hooks accept as `getToken`.

---
Source: https://docs.anuma.ai/tutorials/expo/streaming

# Streaming

The SDK streams AI responses token-by-token via Server-Sent Events. The starter
app accumulates these chunks and appends a temporary assistant message to the
chat view so the response appears in real time.

## Callback Setup

The `useChatStorageSetup` hook passes three callbacks to the SDK's
`useChatStorage`:

- `onData` — called on each streamed chunk. Appends the chunk to a ref and
  forwards the full accumulated text to the parent via `onStreamingContent`.
- `onFinish` — resets the accumulator when streaming completes.
- `onError` — resets the accumulator and forwards the error.

```ts
  const chatStorage = useChatStorage({
    database,
    conversationId,
    getToken: getIdentityToken,
    baseUrl: API_BASE_URL,
    onData: (chunk: string) => {
      accumulatedContentRef.current += chunk;
      onStreamingContentRef.current?.(accumulatedContentRef.current);
    },
    onFinish: async () => {
      accumulatedContentRef.current = "";
      onStreamingContentRef.current?.("");
    },
    onError: (error: Error) => {
      console.error("Chat error:", error);
      accumulatedContentRef.current = "";
      onStreamingContentRef.current?.("");
      onErrorRef.current?.(error);
    },
  });
```

Callbacks are stored in refs to avoid re-creating the SDK hook when the parent
re-renders with new function references.

## Displaying Streaming Content

While streaming is active, the parent component appends a temporary assistant
message containing the accumulated text. Once streaming finishes, the
`onFinish` callback clears the streaming content and the message appears from
the database instead.

```tsx
  const displayMessages = streamingContent
    ? [...messages, { role: "assistant", content: streamingContent }]
    : messages;
```

## React Native Considerations

Unlike web apps that can update the DOM directly for low-latency rendering,
React Native goes through the bridge for every state update. The starter keeps
it simple by updating React state on each token. For very high-frequency
streaming, you could debounce the `onStreamingContent` callback or batch
updates using `requestAnimationFrame`.

---
Source: https://docs.anuma.ai/tutorials/nextjs

# Anuma Starter

A feature-rich AI chat application built with the
[Anuma SDK](https://github.com/anuma-ai/sdk), [Next.js](https://nextjs.org),
and [Privy](https://privy.io) for authentication. Includes conversation
management, project organization, file handling, memory-augmented responses,
and support for multiple AI models.

<video src="https://github.com/anuma-ai/starter-next/raw/refs/heads/main/public/demo.webm" autoplay loop playsinline style="border-radius: 8px;"></video>

## Getting Started

### Create an Anuma app

Sign in at [dashboard.anuma.ai](https://dashboard.anuma.ai/) and create an app.
This provisions the API account that powers AI responses.

### Clone and install

```bash
git clone https://github.com/anuma-ai/starter-next.git
cd starter-next
pnpm install
```

### Configure environment variables

Create a `.env.local` file in the root directory:

```bash
NEXT_PUBLIC_API_URL=https://portal.anuma.ai
NEXT_PUBLIC_PRIVY_APP_ID=<your-privy-app-id>
```

### Run the development server

```bash
pnpm dev
```

Open http://localhost:3000 in your browser. After signing in through Privy
you'll get a chat interface with AI streaming, conversation history, projects,
file management, and more.

## Features

- AI chat with real-time streaming and multiple models
- Memory system with semantic retrieval from past conversations
- Conversation management with persistent local storage
- Projects to organize conversations with custom icons and themes
- File management with encrypted storage
- Thinking mode with extended reasoning
- Voice input with on-device transcription
- Server-side and client-side tool integration
- Cloud backups to Google Drive and Dropbox
- Light/dark themes with customizable accent colors

## Tech Stack

Next.js 16, React 19, TypeScript, Anuma SDK, shadcn/ui, Tailwind CSS 4, Privy,
and WatermelonDB. All data is stored locally in the browser — nothing is sent to
external servers except AI chat requests.

## License

MIT

---
Source: https://docs.anuma.ai/tutorials/nextjs/backup

# Cloud Backup

The `useAppBackup` hook provides encrypted backup and restore of conversations
to cloud storage providers (Google Drive, Dropbox). Conversations are exported
as encrypted JSON blobs, uploaded via the SDK's `useBackup` hook, and can be
imported back with automatic decryption and deduplication.

## Prerequisites

- A WatermelonDB `Database` instance configured in your app
- Privy authentication with an embedded wallet (for encryption key derivation)

## Hook Initialization

The hook connects to Privy for wallet access, initializes encryption, and
wires up the SDK's `useBackup` with custom export/import implementations:

```ts
export function useAppBackup() {
  const database = useDatabase();
  const { user, signMessage: privySignMessage } = usePrivy();
  const { wallets } = useWallets();
  const walletAddress = user?.wallet?.address ?? null;

  // Find the embedded wallet for signing
  const embeddedWallet = wallets.find((w) => w.walletClientType === "privy");

  // Track encryption key status
  const [isEncryptionReady, setIsEncryptionReady] = useState(false);
  const [isInitializingEncryption, setIsInitializingEncryption] = useState(false);

  // Check encryption key status on mount and when wallet changes
  useEffect(() => {
    if (walletAddress) {
      setIsEncryptionReady(hasEncryptionKey(walletAddress));
    } else {
      setIsEncryptionReady(false);
    }
  }, [walletAddress]);

  const { getMessages, getConversation, createConversation } = useChatStorage({
    database,
    getToken: async () => null,
    baseUrl: process.env.NEXT_PUBLIC_API_URL,
  });
```

[hooks/useAppBackup.ts](https://github.com/anuma-ai/starter-next/blob/main/hooks/useAppBackup.ts#L44-L70)

## Exporting Conversations

Export serializes a conversation and all its messages into a JSON structure,
encrypts it using the user's wallet-derived key, and returns a `Blob` ready
for upload:

```ts
  // Export a conversation to an encrypted blob
  const exportConversation = useCallback(
    async (
      conversationId: string,
      userAddress: string
    ): Promise<{ success: boolean; blob?: Blob }> => {
      try {
        // Get conversation metadata
        const conversation = await getConversation(conversationId);
        if (!conversation) {
          return { success: false };
        }

        // Get all messages for this conversation
        const messages = await getMessages(conversationId);

        // Create export data structure
        const exportData: ConversationExport = {
          version: 1,
          conversationId: conversation.conversationId,
          title: conversation.title,
          createdAt: conversation.createdAt.toISOString(),
          updatedAt: conversation.updatedAt.toISOString(),
          messages: messages.map((msg: StoredMessage) => ({
            uniqueId: msg.uniqueId,
            role: msg.role,
            content: msg.content,
            model: msg.model,
            files: msg.files,
            createdAt: msg.createdAt.toISOString(),
            updatedAt: msg.updatedAt.toISOString(),
          })),
        };

        // Encrypt the data
        const jsonString = JSON.stringify(exportData);
        const encrypted = await encryptData(jsonString, userAddress);

        // Create blob
        const blob = new Blob([encrypted], { type: "application/json" });

        return { success: true, blob };
      } catch (error) {
        console.error("Failed to export conversation:", error);
        return { success: false };
      }
    },
    [getConversation, getMessages]
  );
```

[hooks/useAppBackup.ts](https://github.com/anuma-ai/starter-next/blob/main/hooks/useAppBackup.ts#L119-L167)

The encryption uses `encryptData` from the SDK, which derives a symmetric key
from the user's wallet address.

## Importing Conversations

Import decrypts a blob, validates the data version, and restores the
conversation and messages to the local database. It handles several edge
cases: skipping conversations that already exist, restoring soft-deleted
conversations, and avoiding duplicate message insertion.

```ts
  // Import a conversation from an encrypted blob
  const importConversation = useCallback(
    async (
      blob: Blob,
      userAddress: string
    ): Promise<{ success: boolean }> => {
      try {
        // Read blob as text
        const encrypted = await blob.text();

        // Decrypt the data
        const jsonString = await decryptData(encrypted, userAddress);
        const importData: ConversationExport = JSON.parse(jsonString);

        // Validate version
        if (importData.version !== 1) {
          console.error("Unsupported backup version:", importData.version);
          return { success: false };
        }

        // Check if conversation exists (including soft-deleted)
        const conversationsCollection = database.get("conversations");
        const existingRecords = await conversationsCollection
          .query(Q.where("conversation_id", importData.conversationId))
          .fetch();

        if (existingRecords.length > 0) {
          // eslint-disable-next-line @typescript-eslint/no-explicit-any
          const existingConv = existingRecords[0] as any;
          const isDeleted = existingConv._getRaw("is_deleted");

          if (isDeleted) {
            // Undelete the soft-deleted conversation
            console.log("Restoring soft-deleted conversation:", importData.conversationId);
            await database.write(async () => {
              await existingConv.update(() => {
                existingConv._setRaw("is_deleted", false);
                existingConv._setRaw("title", importData.title);
              });
            });
          } else {
            // Active conversation exists, skip
            console.log("Conversation already exists, skipping:", importData.conversationId);
            return { success: true };
          }
        } else {
          // Create the conversation
          await createConversation({
            conversationId: importData.conversationId,
            title: importData.title,
          });
        }

        // Check if messages already exist for this conversation
        const messagesCollection = database.get("history");
        const existingMessages = await messagesCollection
          .query(Q.where("conversation_id", importData.conversationId))
          .fetch();

        // Restore messages using direct database access (only if none exist)
        if (importData.messages && importData.messages.length > 0 && existingMessages.length === 0) {
          await database.write(async () => {
            for (let i = 0; i < importData.messages.length; i++) {
              const msg = importData.messages[i];
              // eslint-disable-next-line @typescript-eslint/no-explicit-any
              await messagesCollection.create((record: any) => {
                record._setRaw("message_id", i + 1);
                record._setRaw("conversation_id", importData.conversationId);
                record._setRaw("role", msg.role);
                record._setRaw("content", msg.content);
                if (msg.model) record._setRaw("model", msg.model);
                if (msg.files) record._setRaw("files", JSON.stringify(msg.files));
              });
            }
          });

          console.log(`Restored ${importData.messages.length} messages for conversation:`, importData.conversationId);
        } else if (existingMessages.length > 0) {
          console.log(`Messages already exist for conversation, skipping message restore:`, importData.conversationId);
        }

        return { success: true };
      } catch (error) {
        console.error("Failed to import conversation:", error);
        return { success: false };
      }
    },
    [database, createConversation]
  );
```

[hooks/useAppBackup.ts](https://github.com/anuma-ai/starter-next/blob/main/hooks/useAppBackup.ts#L171-L259)

## Connecting to Cloud Providers

The SDK's `useBackup` hook handles the actual cloud provider integration. Pass
it the export/import functions along with the user's wallet address and an
encryption key request handler:

```ts
  // Use the SDK's useBackup hook with our implementations
  const backup = useBackup({
    database,
    userAddress: walletAddress,
    requestEncryptionKey: handleRequestEncryptionKey,
    exportConversation,
    importConversation,
  });

```

[hooks/useAppBackup.ts](https://github.com/anuma-ai/starter-next/blob/main/hooks/useAppBackup.ts#L263-L271)

The returned `backup` object from the SDK exposes methods for connecting to
Google Drive or Dropbox, listing remote backups, uploading, and downloading.

## Return Value

The hook spreads the SDK's backup methods and adds encryption and wallet
state:

```ts
  return {
    ...backup,
    walletAddress,
    isReady: !!walletAddress && !!embeddedWallet,
    isEncryptionReady,
    isInitializingEncryption,
    initializeEncryption,
  };
```

[hooks/useAppBackup.ts](https://github.com/anuma-ai/starter-next/blob/main/hooks/useAppBackup.ts#L275-L282)

Call `initializeEncryption()` before connecting to a backup provider — it
derives the encryption key from the user's wallet, which may prompt a
signature.

---
Source: https://docs.anuma.ai/tutorials/nextjs/chat

# Chat

`useAppChat` is the main hook for adding chat to your app. It wraps the SDK's
storage layer and wires in memory, vault, streaming, and tools so you get a
single hook that handles the full lifecycle of a conversation.

## Props

Pass in the values from the [Setup](setup) page along with any tools and model
configuration.

```ts
type UseAppChatProps = {
  database: Database;
  getToken: () => Promise<string | null>;
  model?: string;
  temperature?: number;
  maxOutputTokens?: number;
  store?: boolean;
  // Wallet address for encrypted file storage
  walletAddress?: string;
  // Sign a message with the user's wallet
  signMessage?: (message: string) => Promise<string>;
  // Sign a message silently using the embedded wallet
  embeddedWalletSigner?: (message: string) => Promise<string>;
  // Whether encryption is ready (for reloading files after encryption initializes)
  encryptionReady?: boolean;
  // Server-side tools (tool names or dynamic filter function)
  serverTools?: ServerToolsFilter;
  // Client-side tools (with local executors)
  clientTools?: any[];
  // Dynamic filter for client tools based on prompt embeddings
  clientToolsFilter?: ClientToolsFilterFn;
  toolChoice?: string;
  // System prompt for the AI
  systemPrompt?: string;
  // Callback when the vault tool wants to save a memory (for confirmation UI)
  onVaultSave?: (operation: VaultSaveOperation) => Promise<boolean>;
};
```

[hooks/useAppChat.ts](https://github.com/anuma-ai/starter-next/blob/main/hooks/useAppChat.ts#L24-L50)

## Sending a Message

Call `sendMessage` with the user's input. The hook creates a conversation if
one doesn't exist yet, injects any configured memory and vault tools alongside
your own, and streams the response back. Per-message overrides for model,
temperature, tools, reasoning, and file attachments can be passed as a second
argument. See [Sending Messages](messages) for the full implementation.

## Return Value

The hook returns chat state, streaming subscriptions, and vault operations.

```ts
  return {
    // Chat state
    messages,
    setMessages,
    conversations,
    conversationId,
    isLoading,
    error,
    input,
    setInput,
    status,

    // Chat actions
    sendMessage,
    sendRawMessage,
    handleSubmit,
    addMessageOptimistically,
    createConversation,
    switchConversation,
    setConversationId,
    deleteConversation,
    refreshConversations,
    subscribeToStreaming,
    subscribeToThinking,
    getMessages,
    getConversation,
    stop,

    // Memory vault
    getVaultMemories,
    createVaultMemory,
    updateVaultMemory,
    deleteVaultMemory,
  };
```

[hooks/useAppChat.ts](https://github.com/anuma-ai/starter-next/blob/main/hooks/useAppChat.ts#L516-L551)

## What's Next

Each feature the hook composes has its own page with implementation details:

- [Sending Messages](messages) — optimistic UI, content parts, tool calling,
  and the lower-level `useAppChatStorage` hook
- [Streaming](streaming) — `subscribeToStreaming` and `subscribeToThinking`
  for real-time DOM updates
- [Memory Engine](memory/retrieval) and [Vault](memory/vault) — how
  long-term memory and encrypted storage are injected as client tools
- [Tools](tools) — server tools, client tools, and how tool sets are managed

---
Source: https://docs.anuma.ai/tutorials/nextjs/conversations

# Conversation management

The `useChatStorage` hook exposes methods for creating, switching between, and
deleting conversations. These are typically wired up to a sidebar or
conversation list component.

## Creating a Conversation

There are two modes: auto-create on first message (the default when
`autoCreateConversation: true` is set), or create immediately for cases like
navigating to a project page where you need a conversation ID upfront.

```ts
  const handleNewConversation = useCallback(async (opts?: { projectId?: string; createImmediately?: boolean }) => {
    // Reset UI state
    setMessages([]);
    loadedConversationIdRef.current = null;

    // If createImmediately is true (e.g., from project page), create conversation now
    // Otherwise, just reset state - conversation will be created on first message via autoCreateConversation
    if (opts?.createImmediately || opts?.projectId) {
      const conv = await createConversation(opts);

      // Mark this conversation as already "loaded" to prevent useEffect from loading empty DB results
      // The caller will add optimistic messages after we return
      if (conv?.conversationId) {
        loadedConversationIdRef.current = conv.conversationId;
      }

      return conv;
    }

    // Clear conversation ID so SDK will auto-create on first message
    setConversationId(null as any);
    return null;
  }, [createConversation, setConversationId]);
```

[hooks/useAppChatStorage.ts](https://github.com/anuma-ai/starter-next/blob/main/hooks/useAppChatStorage.ts#L898-L920)

## Switching Conversations

Switching handles several edge cases: skipping redundant loads, caching
messages for conversations that are still streaming, and restoring cached
messages when switching back to a streaming conversation. Messages are preloaded
before the state update to prevent flicker.

```ts
  const handleSwitchConversation = useCallback(
    async (id: string) => {
      // Skip if this conversation is already loaded (prevents overwriting optimistic messages)
      // This handles the case where page.tsx syncs from URL after chatbot.tsx created a new conversation
      if (loadedConversationIdRef.current === id) {
        currentConversationIdRef.current = id;
        setConversationId(id);
        return;
      }

      // If switching away from a streaming conversation, cache its messages
      const currentLoadedId = loadedConversationIdRef.current;
      if (currentLoadedId && streamingConversationIdRef.current === currentLoadedId) {
        streamingMessagesCacheRef.current.set(currentLoadedId, messagesRef.current);
      }

      // Update currentConversationIdRef immediately so title generation has the correct ID
      // This avoids waiting for the SDK state update cycle
      currentConversationIdRef.current = id;

      // If switching TO a streaming conversation, restore from cache
      if (streamingConversationIdRef.current === id) {
        const cachedMessages = streamingMessagesCacheRef.current.get(id);
        if (cachedMessages) {
          loadedConversationIdRef.current = id;
          // Update the assistant message with current streaming text before restoring
          // The streaming text accumulates in streamingTextRef while user is on another conversation
          const currentStreamingText = streamingTextRef.current;
          const assistantMsgId = currentAssistantMessageIdRef.current;
          const updatedMessages = cachedMessages.map((msg) => {
            if (msg.id === assistantMsgId && currentStreamingText) {
              return {
                ...msg,
                parts: [{ type: "text" as const, text: currentStreamingText }],
              };
            }
            return msg;
          });
          setMessages(updatedMessages);
          setConversationId(id);
          return;
        }
      }

      // Preload messages before switching to prevent flicker
      const msgs = await getMessages(id);
      const uiMessages: Message[] = await Promise.all(
        msgs.map(async (msg: any) => {
          const parts: MessagePart[] = [];
          if (msg.thinking) {
            parts.push({ type: "reasoning" as const, text: msg.thinking });
          }
          if (msg.error && msg.role === "assistant") {
            parts.push({ type: "error" as const, error: msg.error });
          }
          if (msg.content) {
            parts.push({ type: "text" as const, text: msg.content });
          }
          // Resolve file references from msg.files or msg.fileIds,
          // decrypting from OPFS when wallet is connected
          const fileParts = await resolveMessageFiles(msg, walletAddress);
          parts.push(...fileParts);
          return {
            id: msg.uniqueId ?? `msg-${Date.now()}-${Math.random()}`,
            role: msg.role,
            parts,
          };
        })
      );

      loadedConversationIdRef.current = id;
      setMessages(uiMessages);
      setConversationId(id);
    },
    [setConversationId, getMessages]
  );
```

[hooks/useAppChatStorage.ts](https://github.com/anuma-ai/starter-next/blob/main/hooks/useAppChatStorage.ts#L924-L999)

## Deleting a Conversation

```ts
  const handleDeleteConversation = useCallback(
    async (id: string) => {
      await deleteConversation(id);
      if (conversationId === id) {
        setMessages([]);
      }
    },
    [deleteConversation, conversationId]
  );
```

[hooks/useAppChatStorage.ts](https://github.com/anuma-ai/starter-next/blob/main/hooks/useAppChatStorage.ts#L1003-L1011)

---
Source: https://docs.anuma.ai/tutorials/nextjs/features

# Features

### Authenticating with Privy

<video src="https://github.com/anuma-ai/starter-next/raw/refs/heads/demo/auth.setup.ts-Authenticating-with-Privy-setup--video.webm" controls style="border-radius: 8px;"></video>

### Attaching a document and asking about it

<video src="https://github.com/anuma-ai/starter-next/raw/refs/heads/demo/chat-chat-Attaching-a-document-and-asking-about-it-full-chromium--video.webm" controls style="border-radius: 8px;"></video>

### Attaching a spreadsheet and asking about it

<video src="https://github.com/anuma-ai/starter-next/raw/refs/heads/demo/chat-chat-Attaching-a-spreadsheet-and-asking-about-it-full-chromium--video.webm" controls style="border-radius: 8px;"></video>

### Attaching a zip ing about its contents

<video src="https://github.com/anuma-ai/starter-next/raw/refs/heads/demo/chat-chat-Attaching-a-zip--fc44f-ing-about-its-contents-full-chromium--video.webm" controls style="border-radius: 8px;"></video>

### Attaching an image and asking about it

<video src="https://github.com/anuma-ai/starter-next/raw/refs/heads/demo/chat-chat-Attaching-an-image-and-asking-about-it-full-chromium--video.webm" controls style="border-radius: 8px;"></video>

### Clearing input after sending a message

<video src="https://github.com/anuma-ai/starter-next/raw/refs/heads/demo/chat-chat-Clearing-input-after-sending-a-message-light-chromium--video.webm" controls style="border-radius: 8px;"></video>

### Generating an image from a prompt

<video src="https://github.com/anuma-ai/starter-next/raw/refs/heads/demo/chat-chat-Generating-an-image-from-a-prompt-full-chromium--video.webm" controls style="border-radius: 8px;"></video>

### Sending a prompt and receiving a response

<video src="https://github.com/anuma-ai/starter-next/raw/refs/heads/demo/chat-chat-Sending-a-prompt-and-receiving-a-response-full-chromium--video.webm" controls style="border-radius: 8px;"></video>

### Viewing the chat interface

<video src="https://github.com/anuma-ai/starter-next/raw/refs/heads/demo/chat-chat-Viewing-the-chat-interface-light-chromium--video.webm" controls style="border-radius: 8px;"></video>

Updated: 2026-05-13T07:55:38Z

---
Source: https://docs.anuma.ai/tutorials/nextjs/memory/retrieval

# Memory Engine

The `useAppChat` hook adds memory-augmented responses on top of
`useAppChatStorage`. Memory lets the AI recall information from past
conversations — things like the user's name, preferences, or previously
discussed topics — so it can give contextual answers without the user repeating
themselves.

## How It Works

Memory operates in two phases: storage and retrieval.

**Storage.** The SDK automatically embeds every message when it's stored. Long
messages are split into chunks, and each chunk gets a vector embedding (a
numerical representation of its meaning). These vectors live in WatermelonDB
alongside the message content.

**Retrieval.** When a new message is sent, a memory engine tool is injected
as a client tool. The AI reads the system prompt, which tells it about the tool,
and decides whether the user's question might benefit from past context. If so,
it calls the tool. The tool converts the query into a vector, runs a similarity
search against all stored embeddings (excluding the current conversation), and
returns the closest matching chunks.

The AI then uses those chunks as context to formulate its response. If the
question doesn't need memory (e.g., "what's 2+2"), the AI simply doesn't call
the tool.

## Prerequisites

- A WatermelonDB `Database` instance configured in your app
- An authentication function that returns a valid token

## Memory Settings

Three settings control memory behavior. They're persisted in `localStorage` and
synced across tabs via `StorageEvent`, so changes from the settings page take
effect immediately without a reload.

```ts
  const [memoryEnabled, setMemoryEnabled] = useState(true);
  const [memoryLimit, setMemoryLimit] = useState(5);
  const [memoryThreshold, setMemoryThreshold] = useState(0.2);
```

[hooks/useAppChat.ts](https://github.com/anuma-ai/starter-next/blob/main/hooks/useAppChat.ts#L91-L93)

- `memoryEnabled` — toggle memory on or off. Default: `true`.
- `memoryLimit` — max chunks returned per search (1–20). Default: `5`. Higher
  values provide more context but use more tokens.
- `memoryThreshold` — minimum similarity score (0.0–0.8). Default: `0.2` (20%).
  Lower values return more matches; higher values are stricter.

Settings are loaded from `localStorage` on mount and updated in real time when
changed from another tab or the settings page:

```ts
  // Load memory settings from localStorage
  useEffect(() => {
    const savedEnabled = localStorage.getItem("chat_memoryEnabled");
    if (savedEnabled !== null) {
      setMemoryEnabled(savedEnabled === "true");
    }

    const savedLimit = localStorage.getItem("chat_memoryLimit");
    if (savedLimit) {
      const limit = parseInt(savedLimit, 10);
      if (!isNaN(limit) && limit > 0) {
        setMemoryLimit(limit);
      }
    }

    const savedThreshold = localStorage.getItem("chat_memoryThreshold");
    if (savedThreshold) {
      const threshold = parseFloat(savedThreshold);
      if (!isNaN(threshold) && threshold >= 0 && threshold <= 1) {
        setMemoryThreshold(threshold);
      }
    }

    const savedVaultEnabled = localStorage.getItem("chat_vaultEnabled");
    if (savedVaultEnabled !== null) {
      setVaultEnabled(savedVaultEnabled === "true");
    }

    const savedVaultSearchLimit = localStorage.getItem("chat_vaultSearchLimit");
    if (savedVaultSearchLimit) {
      const limit = parseInt(savedVaultSearchLimit, 10);
      if (!isNaN(limit) && limit > 0) {
        setVaultSearchLimit(limit);
      }
    }

    const savedVaultSearchThreshold = localStorage.getItem("chat_vaultSearchThreshold");
    if (savedVaultSearchThreshold) {
      const threshold = parseFloat(savedVaultSearchThreshold);
      if (!isNaN(threshold) && threshold >= 0 && threshold <= 1) {
        setVaultSearchThreshold(threshold);
      }
    }

    const savedSystemPrompt = localStorage.getItem("chat_systemPrompt");
    if (savedSystemPrompt !== null) {
      setCustomSystemPrompt(savedSystemPrompt);
    }

    const savedVaultPrompt = localStorage.getItem("chat_vaultPrompt");
    if (savedVaultPrompt !== null) {
      setCustomVaultPrompt(savedVaultPrompt);
    }

    // Listen for changes from settings page
    const handleStorageChange = (e: StorageEvent) => {
      if (e.key === "chat_memoryEnabled" && e.newValue !== null) {
        setMemoryEnabled(e.newValue === "true");
      }
      if (e.key === "chat_memoryLimit" && e.newValue) {
        const limit = parseInt(e.newValue, 10);
        if (!isNaN(limit) && limit > 0) {
          setMemoryLimit(limit);
        }
      }
      if (e.key === "chat_memoryThreshold" && e.newValue) {
        const threshold = parseFloat(e.newValue);
        if (!isNaN(threshold) && threshold >= 0 && threshold <= 1) {
          setMemoryThreshold(threshold);
        }
      }
      if (e.key === "chat_vaultEnabled" && e.newValue !== null) {
        setVaultEnabled(e.newValue === "true");
      }
      if (e.key === "chat_vaultSearchLimit" && e.newValue) {
        const limit = parseInt(e.newValue, 10);
        if (!isNaN(limit) && limit > 0) {
          setVaultSearchLimit(limit);
        }
      }
      if (e.key === "chat_vaultSearchThreshold" && e.newValue) {
        const threshold = parseFloat(e.newValue);
        if (!isNaN(threshold) && threshold >= 0 && threshold <= 1) {
          setVaultSearchThreshold(threshold);
        }
      }
      if (e.key === "chat_systemPrompt") {
        setCustomSystemPrompt(e.newValue);
      }
      if (e.key === "chat_vaultPrompt") {
        setCustomVaultPrompt(e.newValue);
      }
    };
    window.addEventListener("storage", handleStorageChange);
    return () => window.removeEventListener("storage", handleStorageChange);
  }, []);
```

[hooks/useAppChat.ts](https://github.com/anuma-ai/starter-next/blob/main/hooks/useAppChat.ts#L107-L202)

## Creating the Memory Tool

On each `sendMessage` call, a memory engine tool is created with the current
settings and added to the client tools array. The current conversation is
excluded so the AI only recalls information from other conversations.

If the conversation is brand new (no ID yet), one is created first so the
exclusion works correctly.

When memory is disabled, the tool is simply omitted.

```ts
        // Ensure we have a conversation ID BEFORE creating the memory tool
        // This is critical for excludeConversationId to work on new conversations
        let effectiveConversationId = options?.conversationId || conversationId;
        if (!effectiveConversationId) {
          // Create a new conversation first so we have an ID to exclude
          // Pass createImmediately to actually create the conversation now (not on first message)
          const newConv = await createConversation({ createImmediately: true });
          if (newConv) {
            effectiveConversationId = newConv.conversationId;
          }
        }

        // Build client tools: memory engine + memory vault + base tools
        const builtInTools: any[] = [];

        if (memoryEnabled) {
          builtInTools.push(
            createMemoryEngineTool({
              limit: memoryLimit,
              minSimilarity: memoryThreshold,
              excludeConversationId: effectiveConversationId ?? undefined,
            })
          );
        }

        if (vaultEnabled) {
          // Wrap onVaultSave to eagerly embed content at save time
          const wrappedOnVaultSave = async (operation: VaultSaveOperation) => {
            try {
              await eagerEmbedContent(
                operation.content,
                { getToken, baseUrl: process.env.NEXT_PUBLIC_API_URL },
                vaultEmbeddingCache
              );
            } catch {
              // Non-critical: embedding will be generated on next search
            }
            return onVaultSave ? onVaultSave(operation) : true;
          };

          builtInTools.push(
            createMemoryVaultTool({
              onSave: wrappedOnVaultSave,
            })
          );
          builtInTools.push(createMemoryVaultSearchTool({
            limit: vaultSearchLimit,
            minSimilarity: vaultSearchThreshold,
          }));
        }

        const effectiveClientTools = [...builtInTools, ...baseClientTools];
```

[hooks/useAppChat.ts](https://github.com/anuma-ai/starter-next/blob/main/hooks/useAppChat.ts#L318-L371)

## System Prompt

The default system prompt tells the AI when to use the memory tool:

```
You have access to a memory engine tool that can recall information from
previous conversations with this user. When the user asks questions that might
relate to past conversations (like their name, preferences, personal
information, or previously discussed topics), use the memory engine tool to
recall relevant context before responding.
```

This can be overridden by passing a custom `systemPrompt` to the hook.

---
Source: https://docs.anuma.ai/tutorials/nextjs/memory/vault

# Memory Vault

The memory vault is a persistent knowledge store that complements the
conversation-based memory engine system. While the memory engine searches
across past conversation chunks, the vault stores curated facts and
preferences explicitly — things like "I'm vegetarian" or "my timezone is
PST". Vault entries persist independently of conversations and can be managed
directly by the user.

## How It Works

The vault operates through two client-side tools injected alongside the memory
engine tool:

- `memory_vault_search` — semantic similarity search across stored vault
  entries. The AI calls this to check if a related memory already exists
  before saving.
- `memory_vault_save` — creates or updates a vault entry. When an `id` is
  provided, the existing entry is updated instead of creating a duplicate.

The system prompt instructs the AI to always search before saving, and to
merge new information into existing entries to keep the vault compact.

## Prerequisites

- A WatermelonDB `Database` instance configured in your app
- An authentication function that returns a valid token (for embedding
  generation)

## Vault Settings

Three settings control vault behavior, persisted in `localStorage` alongside
the memory settings:

```ts
  const [vaultEnabled, setVaultEnabled] = useState(true);
  const [vaultSearchLimit, setVaultSearchLimit] = useState(5);
  const [vaultSearchThreshold, setVaultSearchThreshold] = useState(0.1);
  const [customSystemPrompt, setCustomSystemPrompt] = useState<string | null>(null);
  const [customVaultPrompt, setCustomVaultPrompt] = useState<string | null>(null);
```

[hooks/useAppChat.ts](https://github.com/anuma-ai/starter-next/blob/main/hooks/useAppChat.ts#L96-L100)

Default values and ranges are visible in the code above. `vaultSearchThreshold`
is lower than the memory engine's threshold because vault entries are typically
short and precise.

## System Prompt

When the vault is enabled, additional instructions are appended to the system
prompt telling the AI how to use the vault tools:

```ts
// Default vault instructions appended when the vault is enabled
const DEFAULT_VAULT_PROMPT = `You also have access to a memory vault for storing important facts and preferences the user shares. The vault has two tools:
- memory_vault_search: Search existing vault memories by semantic similarity. Returns matching entries with their IDs.
- memory_vault_save: Save or update a vault memory. Pass an "id" to update an existing entry.

IMPORTANT — vault workflow:
- When the user tells you something worth remembering, ALWAYS call memory_vault_search first to check if a related memory already exists.
- If memory_vault_search returns a related entry, use its id with memory_vault_save to UPDATE it rather than creating a duplicate. Merge the new information into the existing text.
- Only omit the "id" parameter when memory_vault_search confirms no existing entry is related.
- The vault should stay compact: one entry per topic, updated over time.
- When answering questions that might involve stored preferences or facts, call memory_vault_search to check.`;
```

[hooks/useAppChat.ts](https://github.com/anuma-ai/starter-next/blob/main/hooks/useAppChat.ts#L57-L67)

This prompt can be overridden by setting `customVaultPrompt` in
`localStorage`.

## Creating Vault Tools

On each `sendMessage` call, vault tools are created with the current settings
and added to the client tools array alongside the memory engine tool. If
the vault is disabled, the tools are simply omitted.

The save tool wraps the caller's `onVaultSave` callback with eager embedding
— when a memory is saved, its content is immediately embedded via
`eagerEmbedContent` so subsequent searches can find it without waiting for
background processing.

```ts
        if (vaultEnabled) {
          // Wrap onVaultSave to eagerly embed content at save time
          const wrappedOnVaultSave = async (operation: VaultSaveOperation) => {
            try {
              await eagerEmbedContent(
                operation.content,
                { getToken, baseUrl: process.env.NEXT_PUBLIC_API_URL },
                vaultEmbeddingCache
              );
            } catch {
              // Non-critical: embedding will be generated on next search
            }
            return onVaultSave ? onVaultSave(operation) : true;
          };

          builtInTools.push(
            createMemoryVaultTool({
              onSave: wrappedOnVaultSave,
            })
          );
          builtInTools.push(createMemoryVaultSearchTool({
            limit: vaultSearchLimit,
            minSimilarity: vaultSearchThreshold,
          }));
        }
```

[hooks/useAppChat.ts](https://github.com/anuma-ai/starter-next/blob/main/hooks/useAppChat.ts#L344-L368)

## CRUD Operations

The hook exposes methods for direct vault management, typically wired to a
settings page where users can view, edit, and delete their stored memories:

```ts
    // Memory vault
    getVaultMemories,
    createVaultMemory,
    updateVaultMemory,
    deleteVaultMemory,
```

[hooks/useAppChat.ts](https://github.com/anuma-ai/starter-next/blob/main/hooks/useAppChat.ts#L545-L549)

---
Source: https://docs.anuma.ai/tutorials/nextjs/messages

# Sending messages

The `useChatStorage` hook from `@anuma/sdk/react` provides persistent chat
storage with WatermelonDB. It manages conversations, message history, and
streams responses from the API.

## Hook Initialization

Pass the values from the Setup page into `useChatStorage`. The hook returns
methods for sending messages, managing conversations, and working with files.
See Setup for how to obtain `database`, `getToken`, and the wallet fields.

```ts
  const {
    sendMessage,
    isLoading,
    stop,
    conversationId,
    getMessages,
    getConversation,
    getConversations,
    createConversation,
    setConversationId,
    deleteConversation,
    getAllFiles,
    createMemoryEngineTool,
    createMemoryVaultTool,
    createMemoryVaultSearchTool,
    vaultEmbeddingCache,
    getVaultMemories,
    createVaultMemory,
    updateVaultMemory,
    deleteVaultMemory,
  } = useChatStorage({
    // WatermelonDB instance — set up once at app root with your schema
    database,
    // Privy identity token — wraps useIdentityToken() with caching and expiry refresh
    getToken,
    // Create a conversation automatically on the first message instead of upfront
    autoCreateConversation: true,
    baseUrl: process.env.NEXT_PUBLIC_API_URL,
    // Wallet-based encryption: when set, files are encrypted in OPFS using a key
    // derived from a wallet signature. signMessage prompts the user to sign,
    // embeddedWalletSigner signs silently via an embedded wallet.
    walletAddress,
    signMessage: signMessageProp,
    embeddedWalletSigner,
  });
```

[hooks/useAppChatStorage.ts](https://github.com/anuma-ai/starter-next/blob/main/hooks/useAppChatStorage.ts#L244-L278)

## Optimistic UI Updates

Add messages to the UI immediately before the API responds. This creates a
snappy user experience by showing the user's message right away along with an
empty assistant placeholder that will be filled as the response streams in.

```ts
  const addMessageOptimistically = useCallback(
    (text: string, files?: FileUIPart[], displayText?: string) => {
      isSendingMessageRef.current = true;

      // Build parts: text first, then images as image_url, other files as file
      const parts: MessagePart[] = [];
      const textForUI = displayText || text;
      if (textForUI) {
        parts.push({ type: "text", text: textForUI });
      }
      files?.forEach((file) => {
        parts.push(
          file.mediaType?.startsWith("image/")
            ? { type: "image_url", image_url: { url: file.url } }
            : { type: "file", url: file.url, mediaType: file.mediaType || "", filename: file.filename || "" }
        );
      });

      const userMessage: Message = { id: `user-${Date.now()}`, role: "user", parts };

      // Empty assistant placeholder — filled as the response streams in
      const assistantMessageId = `assistant-${Date.now()}`;
      currentAssistantMessageIdRef.current = assistantMessageId;
      const assistantMessage: Message = {
        id: assistantMessageId,
        role: "assistant",
        parts: [{ type: "text", text: "" }],
      };

      setMessages((prev) => [...prev, userMessage, assistantMessage]);
      return assistantMessageId;
    },
    []
  );
```

[hooks/useAppChatStorage.ts](https://github.com/anuma-ai/starter-next/blob/main/hooks/useAppChatStorage.ts#L566-L599)

## Building Content Parts

While the optimistic update builds parts for the UI, the API payload needs a
different format. Text is the same, but files are included as content parts
in the messages array as `image_url` content parts. Fireworks models
(Anuma) require the Chat Completions API for vision, so the hook
switches to `completions` when images are attached. Each file gets a
stable ID so the SDK can match it back to
extracted text after file preprocessing (see `preprocessFiles` in the SDK
docs). A separate `sdkFiles` array provides metadata so the SDK can encrypt
and store non-image files in OPFS.

```ts
      const contentParts: any[] = [];
      if (textForStorage) {
        contentParts.push({ type: "text", text: textForStorage });
      }

      // Stable IDs let the SDK match files back to their extracted text after preprocessing
      const enrichedFiles = (files || []).map((file) => ({
        ...file,
        stableId: (file as any).id || `file_${Date.now()}_${Math.random().toString(36).substring(2, 9)}`,
      }));

      // Fireworks models require Chat Completions API for vision/images;
      // their Responses API doesn't support multimodal content.
      const hasImages = enrichedFiles.some((f) => f.mediaType?.startsWith("image/"));
      const effectiveApiType =
        model?.startsWith("fireworks/") && hasImages ? "completions" as const : apiType;

      // Images are sent as image_url content parts (Chat Completions format).
      // Non-image files (PDF, DOCX, XLSX, ZIP) are handled by the SDK's client-side
      // preprocessing via the files parameter below.
      enrichedFiles.forEach((file) => {
        if (file.mediaType?.startsWith("image/")) {
          contentParts.push({ type: "image_url", image_url: { url: file.url, detail: "high" } });
        }
      });

      // SDK file metadata — the SDK preprocesses non-image files (PDF, Word, Excel) automatically.
      // Images are already included as content parts above, so exclude them here.
      const sdkFiles = enrichedFiles
        .filter((file) => !file.mediaType?.startsWith("image/"))
        .map((file) => ({
          id: file.stableId,
          name: file.filename || file.stableId,
          type: file.mediaType || "application/octet-stream",
          size: 0,
          url: file.url,
        }));
```

[hooks/useAppChatStorage.ts](https://github.com/anuma-ai/starter-next/blob/main/hooks/useAppChatStorage.ts#L669-L705)

## Calling sendMessage

The content parts and an optional system prompt are assembled into a messages
array, then passed to `sendMessage`. Each option is conditionally spread so
only provided values are sent. The `onData` callback streams text chunks to
the UI as they arrive. See `SendMessageWithStorageArgs` in the SDK docs for
the full list of options.

```ts
      const messagesArray: any[] = [];
      if (systemPrompt) {
        messagesArray.push({ role: "system", content: [{ type: "text", text: systemPrompt }] });
      }
      messagesArray.push({ role: "user", content: contentParts });

      // When files are attached, exclude UI interaction and display tools so
      // the model analyzes file contents directly instead of presenting
      // interactive menus or rendering charts/cards.
      const hasAttachments = sdkFiles.length > 0 || hasImages;
      const UI_INTERACTION_TOOLS = ["prompt_user_choice", "prompt_user_form", "display_chart", "display_weather"];
      const effectiveClientTools = hasAttachments && clientTools
        ? clientTools.filter((t: any) => {
            const toolName = t.function?.name || t.name;
            return !UI_INTERACTION_TOOLS.includes(toolName);
          })
        : clientTools;

      // See SendMessageWithStorageArgs in the SDK docs for the full list of options
      const sendArgs = {
        messages: messagesArray,
        model,
        includeHistory: true,
        ...(temperature !== undefined && { temperature }),
        ...(maxOutputTokens !== undefined && { maxOutputTokens }),
        ...(reasoning && { reasoning }),
        ...(sdkFiles && sdkFiles.length > 0 && { files: sdkFiles }),
        ...(serverTools && (typeof serverTools === "function" || serverTools.length > 0) && { serverTools }),
        ...(effectiveClientTools && effectiveClientTools.length > 0 && { clientTools: effectiveClientTools }),
        ...(clientToolsFilter && { clientToolsFilter }),
        ...(store !== undefined && { store }),
        ...(thinking && { thinking }),
        ...(onThinking && { onThinking }),
        ...(memoryContext && { memoryContext }),
        ...(toolChoice && { toolChoice }),
        ...(effectiveApiType && { apiType: effectiveApiType }),
        ...(explicitConversationId && { conversationId: explicitConversationId }),
        onData: (chunk: string) => {
          streamingTextRef.current += chunk;
          if (onStreamingData && loadedConversationIdRef.current === streamingConversationIdRef.current) {
            onStreamingData(chunk, streamingTextRef.current);
          }
        },
      };

      let response = await sendMessage(sendArgs);

      // Retry on transient failures:
      // 1. Empty responses — some models (e.g. Fireworks) intermittently return
      //    a successful SSE stream with no output text.
      // 2. Network errors — "Failed to fetch" can occur transiently in CI or
      //    under load. These are worth retrying.
      const isTransientError = (r: typeof response) => {
        if (!r?.error) return false;
        const e = r.error.toLowerCase();
        return e.includes("failed to fetch") || e.includes("fetch failed") ||
               e.includes("econnreset") || e.includes("econnrefused") ||
               e.includes("network");
      };
      // Retries should not re-preprocess files — the SDK extracts text and stores
      // files on the first call.  Re-sending with files causes duplicate storage
      // entries and wastes 10-30 s per file on redundant preprocessing.
      const retryArgs = sdkFiles.length > 0
        ? { ...sendArgs, files: undefined }
        : sendArgs;
      const MAX_RETRIES = 2;
      for (let retry = 0; retry < MAX_RETRIES; retry++) {
        if (stoppedRef.current) break;
        const hasAutoExecutedTools = (response as any)?.autoExecutedToolResults?.length > 0;
        const emptyResponse = !response?.error && !hasAutoExecutedTools && !streamingTextRef.current.trim();
        const transientError = isTransientError(response);
        if (!emptyResponse && !transientError) break;
        console.warn(`[useAppChatStorage] ${transientError ? "Transient error" : "Empty response"}, retrying (${retry + 1}/${MAX_RETRIES})`);
        streamingTextRef.current = "";
        response = await sendMessage(retryArgs);
      }
```

[hooks/useAppChatStorage.ts](https://github.com/anuma-ai/starter-next/blob/main/hooks/useAppChatStorage.ts#L713-L788)

## Stopping a Response

The SDK's `useChatStorage` returns a `stop` function that aborts the active
stream via an `AbortController`. Calling it cancels the HTTP request and the
SDK stores the partial response with `wasStopped: true`.

Because the SDK treats aborted requests as successful (returning
`{ error: null }`), the retry loop would interpret an early stop as an empty
response and re-send. A `stoppedRef` flag prevents this and also
short-circuits the tool calling loop. In the UI, conditionally render a stop
button when `isLoading` is true using a plain `<button type="button">` to
avoid triggering form submission.

```ts
  // Wrap SDK stop to also clear streaming state
  const handleStop = useCallback(() => {
    stoppedRef.current = true;
    stop();

    // Clear streaming state so UI updates immediately
    streamingConversationIdRef.current = null;
    setStreamingConversationIdState(null);
    isSendingMessageRef.current = false;
  }, [stop]);
```

[hooks/useAppChatStorage.ts](https://github.com/anuma-ai/starter-next/blob/main/hooks/useAppChatStorage.ts#L553-L562)

## Tool Calling

Tool execution is handled entirely by the SDK's internal tool loop. Client
tools are passed to `sendMessage` with an `executor` function, and the SDK
automatically executes them, sends results back to the model, and continues
until the model stops calling tools or the iteration limit is reached.

## Title Generation

After the first message, an LLM-generated title is created asynchronously
using `sendMessage` with `skipStorage: true` so the title request isn't saved
as a conversation message. `extractTextFromResponse` and
`storeConversationTitle` are app-level helpers — the SDK provides
`updateConversationTitle` on the hook result for the same purpose.

```ts
      // Generate an LLM title after the first message in a conversation.
      // Uses skipStorage so the title request isn't saved as a conversation message.
      if (isFirstMessage && messageConversationId) {
        const context = [
          { role: "user", text: (textForStorage || text).slice(0, 200) },
          { role: "assistant", text: finalText.slice(0, 200) },
        ].filter((m) => m.text).map((m) => `${m.role}: ${m.text}`).join("\n");

        setTimeout(async () => {
          try {
            const titleResponse = await sendMessage({
              messages: [{ role: "user", content: [{ type: "text",
                text: `Generate a short, descriptive title (3-6 words) for this conversation. Return ONLY the title, nothing else.\n\nConversation:\n${context}` }] }],
              model: "openai/gpt-4o-mini",
              maxOutputTokens: 50,
              skipStorage: true,
              includeHistory: false,
            });
            if (titleResponse.error || !titleResponse.data) return;

            let newTitle = extractTextFromResponse(titleResponse.data);
            if (!newTitle) return;
            newTitle = newTitle.replace(/^["']|["']$/g, "").trim();
            if (newTitle.length > 50) newTitle = newTitle.slice(0, 47) + "...";
            storeConversationTitle(messageConversationId, newTitle);
            setConversations((prev) =>
              prev.map((c) =>
                c.id === messageConversationId || c.conversationId === messageConversationId
                  ? { ...c, title: newTitle } : c
              )
            );
          } catch {
            // Title generation is non-critical
          }
        }, 500);
      }
```

[hooks/useAppChatStorage.ts](https://github.com/anuma-ai/starter-next/blob/main/hooks/useAppChatStorage.ts#L834-L869)

## Post-Stream Cleanup

After streaming completes, the final accumulated text is synced to React state.
If the user switched to a different conversation mid-stream, the update is
skipped — the message is already saved to the database and will appear when
they switch back.

```ts
      const finalText = streamingTextRef.current;
      const messageConversationId = explicitConversationId;
      const viewingConversationId = loadedConversationIdRef.current;

      // Skip the state update if the user switched conversations mid-stream.
      // The message is already saved to DB and will appear when they switch back.
      if (messageConversationId && viewingConversationId && messageConversationId !== viewingConversationId) {
        // User switched away — no state update needed
      } else {
        setMessages((prev) =>
          prev.map((msg) =>
            msg.id === assistantMessageId
              ? { ...msg, parts: [{ type: "text", text: finalText }] }
              : msg
          )
        );
      }
```

[hooks/useAppChatStorage.ts](https://github.com/anuma-ai/starter-next/blob/main/hooks/useAppChatStorage.ts#L814-L830)

---
Source: https://docs.anuma.ai/tutorials/nextjs/models

# Fetching Models

The `useModels` hook from `@anuma/sdk/react` fetches and manages the list of
available LLM models from the API. It provides model metadata and supports
refreshing the list.

## Prerequisites

- An authentication function that returns a valid token
- Optional: A custom base URL for the API

## Hook Initialization

```ts
  const { models, refetch, isLoading, error } = useModels({
    getToken,
    baseUrl: baseUrl || process.env.NEXT_PUBLIC_API_URL,
  });
```

[hooks/useAppModels.ts](https://github.com/anuma-ai/starter-next/blob/main/hooks/useAppModels.ts#L20-L23)

---
Source: https://docs.anuma.ai/tutorials/nextjs/ocr

# Extracting Text from Images

The `useOCR` hook from `@anuma/sdk/react` provides Optical Character
Recognition (OCR) capabilities. It extracts text from images and scanned
documents, and can serve as a fallback when PDF text extraction is insufficient.

## Hook Initialization

```ts
  const { extractOCRContext, isProcessing, error } = useOCR();
```

[hooks/useAppOCR.ts](https://github.com/anuma-ai/starter-next/blob/main/hooks/useAppOCR.ts#L30-L30)

## Extracting Text from Images

```ts
  const extractFromImages = useCallback(
    async (files: FileAttachment[]) => {
      const imageFiles = files.filter((f) => f.mediaType.startsWith("image/"));

      if (imageFiles.length === 0) {
        console.log("No image files to process");
        return null;
      }

      const context = await extractOCRContext(imageFiles);

      if (context && context.length > 0) {
        imageFiles.forEach((file) => {
          setExtractedTexts((prev) => [
            {
              filename: file.filename,
              content: context,
              timestamp: Date.now(),
            },
            ...prev,
          ]);
        });

        return context;
      }

      return null;
    },
    [extractOCRContext]
  );
```

[hooks/useAppOCR.ts](https://github.com/anuma-ai/starter-next/blob/main/hooks/useAppOCR.ts#L34-L63)

---
Source: https://docs.anuma.ai/tutorials/nextjs/projects

# Projects

Projects let users organize conversations by topic, purpose, or any other
criteria. Each project has a name, an optional description, and can contain
multiple conversations. An "inbox" project is automatically created to hold
unassigned conversations.

## Prerequisites

- A WatermelonDB `Database` instance configured in your app

## Hook Initialization

The `useAppProjects` hook wraps the SDK's `useProjects` hook and
automatically provides the database from context:

```ts
export function useAppProjects() {
  const database = useDatabase();

  const {
    projects,
    currentProjectId,
    setCurrentProjectId,
    isLoading,
    isReady,
    createProject,
    getProject,
    getProjects,
    updateProjectName,
    updateProject,
    deleteProject,
    getProjectConversations,
    getProjectConversationCount,
    updateConversationProject,
    getConversationsByProject,
    refreshProjects,
    inboxProjectId,
  } = useProjects({ database });
```

[hooks/useAppProjects.ts](https://github.com/anuma-ai/starter-next/blob/main/hooks/useAppProjects.ts#L22-L43)

## Return Value

The return value is organized into state, project CRUD, conversation
management, and utilities:

```ts
  return {
    // State
    projects,
    currentProjectId,
    setCurrentProjectId,
    isLoading,
    isReady,
    inboxProjectId,

    // Project CRUD
    createProject,
    getProject,
    getProjects,
    updateProjectName,
    updateProject,
    deleteProject,

    // Conversation management
    getProjectConversations,
    getProjectConversationCount,
    updateConversationProject,
    getConversationsByProject,

    // Utilities
    refreshProjects,
  };
```

[hooks/useAppProjects.ts](https://github.com/anuma-ai/starter-next/blob/main/hooks/useAppProjects.ts#L47-L72)

## Inbox

The SDK automatically creates an inbox project. Its ID is available as
`inboxProjectId` from the hook. New conversations that aren't explicitly
assigned to a project are placed in the inbox automatically by the
`ChatProvider`.

## Reactive State

The `projects` array and `isReady` flag are reactive — they update
automatically when projects change in the database. Use `refreshProjects()` to
force a manual refresh when needed.

---
Source: https://docs.anuma.ai/tutorials/nextjs/setup

# Setup

Most hooks require a WatermelonDB database, an auth token, and optionally
wallet credentials for encrypted file storage. This page shows how to obtain
each value.

## Database

`database` is a WatermelonDB instance created with `useDatabaseManager` from
the SDK. It's scoped to the user's wallet address so each user gets their own
local store. Expose it via React context so hooks can access it with
`useDatabase()`.

```ts
// Create a WatermelonDB instance scoped to the user's wallet address.
// Expose via React context so hooks can access it with useDatabase().
export function setupDatabase() {
  const { user } = usePrivy();
  const database = useDatabaseManager(user?.wallet?.address, dbManager);
  return database;
}
```

[lib/chat-setup.ts](https://github.com/anuma-ai/starter-next/blob/main/lib/chat-setup.ts#L20-L26)

## Authentication

`getToken` returns a Privy identity token. It caches the token from
`useIdentityToken()` and refreshes it when the JWT expires, avoiding redundant
API calls to `/api/v1/users/me`.

```ts
// Cache the Privy identity token and refresh when the JWT expires.
// This avoids calling Privy's standalone getIdentityToken() on every
// request (which hits /api/v1/users/me each time).
export function setupGetToken() {
  const { identityToken } = useIdentityToken();
  const identityTokenRef = useRef(identityToken);
  const tokenWaitersRef = useRef<Array<(token: string | null) => void>>([]);

  useEffect(() => {
    identityTokenRef.current = identityToken;
    if (identityToken && tokenWaitersRef.current.length > 0) {
      for (const resolve of tokenWaitersRef.current) resolve(identityToken);
      tokenWaitersRef.current = [];
    }
  }, [identityToken]);

  const getToken = useCallback(async (): Promise<string | null> => {
    const cached = identityTokenRef.current;
    if (cached) {
      try {
        const payload = JSON.parse(atob(cached.split(".")[1]));
        if (payload.exp && payload.exp * 1000 > Date.now() + 30_000) {
          return cached;
        }
      } catch {
        // Fall through to refresh
      }
      try {
        const fresh = await fetchIdentityToken();
        if (fresh) {
          identityTokenRef.current = fresh;
          return fresh;
        }
      } catch {
        // Network error — fall through to waiter
      }
    }
    return new Promise((resolve) => {
      tokenWaitersRef.current.push(resolve);
      setTimeout(() => {
        tokenWaitersRef.current = tokenWaitersRef.current.filter(
          (r) => r !== resolve
        );
        resolve(identityTokenRef.current);
      }, 10_000);
    });
  }, []);

  return getToken;
}
```

[lib/chat-setup.ts](https://github.com/anuma-ai/starter-next/blob/main/lib/chat-setup.ts#L30-L79)

## Wallet and Signing

`walletAddress` and the signing functions come from Privy's auth hooks.
`signMessage` prompts the user to sign (used to derive an encryption key for
file storage in OPFS), while `embeddedWalletSigner` signs silently via Privy's
embedded wallet.

```ts
// Get wallet address and signing functions from Privy.
// signMessage prompts the user; embeddedWalletSigner signs silently.
export function setupWallet() {
  const { user, signMessage: privySignMessage } = usePrivy();
  const { wallets } = useWallets();

  const walletAddress = user?.wallet?.address;

  const signMessage = useCallback(
    async (message: string) => {
      const result = await privySignMessage(
        { message },
        { uiOptions: { showWalletUIs: false } }
      );
      return result.signature;
    },
    [privySignMessage]
  );

  const embeddedWallet = wallets.find((w) => w.walletClientType === "privy");
  const embeddedWalletSigner = useCallback(
    async (message: string) => {
      if (!embeddedWallet?.address) throw new Error("Embedded wallet not ready");
      const result = await privySignMessage(
        { message },
        { uiOptions: { showWalletUIs: false } }
      );
      return result.signature;
    },
    [embeddedWallet, privySignMessage]
  );

  return { walletAddress, signMessage, embeddedWalletSigner };
}
```

[lib/chat-setup.ts](https://github.com/anuma-ai/starter-next/blob/main/lib/chat-setup.ts#L83-L116)

---
Source: https://docs.anuma.ai/tutorials/nextjs/streaming

# Streaming Subscriptions

The `useAppChat` hook provides a pub/sub system for streaming text updates
that bypasses React's state batching. This is important for chat UIs where
you want to render tokens as they arrive without waiting for React to batch
and flush state updates.

## The Problem

During streaming, the SDK fires `onData` callbacks rapidly (often 10–50 times
per second). Updating React state on each callback triggers re-renders that
can't keep up, causing visible lag and dropped frames. The streaming text
appears to update in chunks rather than smoothly.

## The Solution

Instead of updating React state on each token, `useAppChat` accumulates the
streamed text in a ref and notifies subscribers through a callback set. Each
subscriber can update the DOM directly (e.g. setting `textContent` on a ref)
without going through React's reconciliation:

```ts
  const subscribeToStreaming = useCallback(
    (callback: (text: string) => void) => {
      streamingCallbacksRef.current.add(callback);
      return () => {
        streamingCallbacksRef.current.delete(callback);
      };
    },
    []
  );

  const subscribeToThinking = useCallback(
    (callback: (text: string) => void) => {
      thinkingCallbacksRef.current.add(callback);
      return () => {
        thinkingCallbacksRef.current.delete(callback);
      };
    },
    []
  );
```

[hooks/useAppChat.ts](https://github.com/anuma-ai/starter-next/blob/main/hooks/useAppChat.ts#L490-L508)

## Usage

Subscribe from your chat message component. The callback receives the full
accumulated text (not individual chunks), so you can replace the element's
content directly:

```tsx
const contentRef = useRef<HTMLDivElement>(null);

useEffect(() => {
  const unsubscribe = subscribeToStreaming((text) => {
    if (contentRef.current) {
      contentRef.current.textContent = text;
    }
  });
  return unsubscribe;
}, [subscribeToStreaming]);
```

For markdown rendering, you'd parse and render the accumulated text on each
callback. The key advantage is that the callback fires synchronously — there's
no React render cycle between the token arriving and the DOM updating.

## Thinking Subscriptions

The same pattern applies to thinking/reasoning tokens via
`subscribeToThinking`. See [Thinking Mode](thinking) for details.

## When to Use React State Instead

After streaming completes, the final text is synced to React state in the
post-stream cleanup phase (see [Sending Messages](messages)). The streaming
subscription is only needed during active streaming — once the response is
complete, the message is available through the normal `messages` array.

---
Source: https://docs.anuma.ai/tutorials/nextjs/thinking

# Thinking Mode

Thinking mode enables extended reasoning, where the model "thinks" before
responding. The thinking tokens stream separately from the response text,
allowing you to display a reasoning panel or indicator while the model works
through complex problems.

## Two Reasoning Formats

The `sendMessage` function supports two reasoning parameter formats depending
on the model provider — `reasoning` for OpenAI-compatible models and `thinking`
for Anthropic models:

```ts
        reasoning?: { effort?: string; summary?: string };
        thinking?: { type?: string; budget_tokens?: number };
```

[hooks/useAppChat.ts](https://github.com/anuma-ai/starter-next/blob/main/hooks/useAppChat.ts#L279-L280)

Pass one or the other in the options object. Both are forwarded to the SDK and
included in the API request; only the parameter matching the model provider has
any effect.

## Streaming Thinking Tokens

Thinking tokens stream through a separate callback. The `useAppChat` hook
accumulates them and notifies subscribers via a pub/sub pattern that bypasses
React's batching for low-latency DOM updates:

```ts
  const subscribeToStreaming = useCallback(
    (callback: (text: string) => void) => {
      streamingCallbacksRef.current.add(callback);
      return () => {
        streamingCallbacksRef.current.delete(callback);
      };
    },
    []
  );

  const subscribeToThinking = useCallback(
    (callback: (text: string) => void) => {
      thinkingCallbacksRef.current.add(callback);
      return () => {
        thinkingCallbacksRef.current.delete(callback);
      };
    },
    []
  );
```

[hooks/useAppChat.ts](https://github.com/anuma-ai/starter-next/blob/main/hooks/useAppChat.ts#L490-L508)

Subscribe from your component to receive the accumulated thinking text as it
streams:

```ts
useEffect(() => {
  const unsubscribe = subscribeToThinking((thinkingText) => {
    // Update a ref or DOM element directly for smooth rendering
    thinkingRef.current = thinkingText;
  });
  return unsubscribe;
}, [subscribeToThinking]);
```

The same pattern applies to `subscribeToStreaming` for the main response text.
Both bypass React state updates to avoid re-render overhead during rapid
streaming.

---
Source: https://docs.anuma.ai/tutorials/nextjs/tools/display-tools

# Display Tools

Display tools let the AI render rich visual components inline in the chat.
They run entirely on the client side — when the model calls a display tool, the
SDK executes it in the browser, stores the result as a tool execution message,
and the model continues its response without blocking. This guide walks through
building a weather card as an example and covers the built-in chart tool.

## Overview

A display tool has four parts:

1. A tool definition with an `execute` function that fetches or validates data
   when the model calls it
2. A React component that renders the data
3. `UIInteractionProvider` wrapping your app to manage the interaction lifecycle
4. Rendering logic that places the card at the right position in the chat

## Provider Setup

Wrap your app with `UIInteractionProvider` from the SDK. This manages the
lifecycle of all UI interactions — both display tools and interactive tools
(forms, choice menus). Place it above your chat provider.

```tsx
import { UIInteractionProvider } from "@anuma/sdk/react";

export default function AppGroupLayout({
  children,
}: {
  children: React.ReactNode;
}) {
  return (
    <UIInteractionProvider>
      <ChatProvider>
        <AppLayout>{children}</AppLayout>
      </ChatProvider>
    </UIInteractionProvider>
  );
}
```

## Defining a Display Tool

### Result Types

Define the shape of data your `execute` function returns. The rendering
component receives this type.

```ts
// Result types returned by the weather display tool's execute function.
// The component that renders this data will receive one of these shapes.
export type ForecastDay = {
  date: string;
  weatherCode: number;
  temperatureMax: number;
  temperatureMin: number;
};

export type DisplayWeatherResult = {
  location: string;
  country?: string;
  temperature: number;
  apparentTemperature: number;
  humidity: number;
  windSpeed: number;
  weatherCode: number;
  isDay: boolean;
  forecast?: ForecastDay[];
  _meta?: { location: string };
} | {
  error: string;
  _meta?: { location: string };
};
```

[lib/ui-interaction-tools.ts](https://github.com/anuma-ai/starter-next/blob/main/lib/ui-interaction-tools.ts#L20-L43)

### createDisplayTool

Use `createDisplayTool` from `@anuma/sdk/tools` to define the tool. It
takes a name (how the model calls it), a description (tells the model when to
use it), a JSON Schema for parameters, a `displayType` string for dispatching
to the right component, and an `execute` function.

The `execute` function receives the model's parsed arguments, fetches data from
an external API, and returns the result. The SDK stores the result as a
`[Tool Execution Results]` message and returns it to the model so it can
reference the data in its text response.

```ts
  const weatherToolBase = createDisplayTool(options, {
    name: "display_weather",
    description:
      "Fetches and displays current weather as a visual card in the chat. ALWAYS call this tool when the user asks about weather, even if you already have weather data from another tool. The card displays temperature, conditions, and a 7-day forecast visually — do NOT repeat this data in your text response. Just add a brief conversational comment if appropriate.",
    parameters: {
      type: "object",
      properties: {
        location: {
          type: "string",
          description:
            "City name or place to get weather for (e.g., 'London', 'New York', 'Tokyo')",
        },
      },
      required: ["location"],
    },
    displayType: "weather",
    execute: async (args: Record<string, unknown>): Promise<DisplayWeatherResult> => {
      const location = args.location as string;
      if (!location || typeof location !== "string") {
        return { error: "No location provided", _meta: { location: "" } };
      }

      try {
        const geoRes = await fetch(
          `https://geocoding-api.open-meteo.com/v1/search?name=${encodeURIComponent(location)}&count=1&language=en&format=json`
        );
        const geoData = await geoRes.json();

        if (!geoData.results || geoData.results.length === 0) {
          return {
            error: `Location not found: ${location}`,
            _meta: { location },
          };
        }

        const { latitude, longitude, name, country } = geoData.results[0];

        const weatherRes = await fetch(
          `https://api.open-meteo.com/v1/forecast?latitude=${latitude}&longitude=${longitude}&current=temperature_2m,apparent_temperature,relative_humidity_2m,wind_speed_10m,weather_code,is_day&daily=weather_code,temperature_2m_max,temperature_2m_min&forecast_days=7&timezone=auto`
        );
        const weatherData = await weatherRes.json();
        const current = weatherData.current;
        const daily = weatherData.daily;

        const forecast: ForecastDay[] = daily?.time?.map((date: string, i: number) => ({
          date,
          weatherCode: daily.weather_code[i],
          temperatureMax: daily.temperature_2m_max[i],
          temperatureMin: daily.temperature_2m_min[i],
        })) || [];

        return {
          location: name,
          country,
          temperature: current.temperature_2m,
          apparentTemperature: current.apparent_temperature,
          humidity: current.relative_humidity_2m,
          windSpeed: current.wind_speed_10m,
          weatherCode: current.weather_code,
          isDay: current.is_day === 1,
          forecast,
          _meta: { location },
        };
      } catch {
        return {
          error: "Failed to fetch weather data",
          _meta: { location },
        };
      }
    },
  });
```

[lib/ui-interaction-tools.ts](https://github.com/anuma-ai/starter-next/blob/main/lib/ui-interaction-tools.ts#L218-L288)

### Built-in Chart Tool

The SDK provides a ready-made `createChartTool` that renders bar, line, area,
and pie charts using recharts. It validates the model's arguments (chart type,
data array, data keys) and returns them as-is for the `ChartCard` component to
render. No external API call is needed — the model supplies the data directly.

```ts
  const chartTool = createChartTool(options);
```

[lib/ui-interaction-tools.ts](https://github.com/anuma-ai/starter-next/blob/main/lib/ui-interaction-tools.ts#L292-L292)

The chart tool accepts these parameters from the model:

- `chartType` — `"bar"`, `"line"`, `"area"`, or `"pie"`
- `title` — optional title displayed above the chart
- `data` — array of data point objects with a label key and numeric value keys
- `dataKeys` — which keys in each data object to chart as series/bars/slices
- `xAxisKey` — which key to use for x-axis labels (or slice names for pie)
- `colors` — optional map of data key to CSS color value

## Wiring into the Chat

Pass your tools to the chat hook along with two context getters. `getContext`
provides the `UIInteractionProvider` state so the SDK can store display results.
`getLastMessageId` anchors each card to the message that was last in the chat
when the tool was called — this determines where the card renders.

```ts
const uiInteractionTools = createUIInteractionTools({
  getContext: () => uiInteraction,
  getLastMessageId: () => messagesRef.current.at(-1)?.id,
});
```

## Building the Component

Create a React component that accepts the data returned by your `execute`
function. This is a regular component with no special SDK dependencies.

```tsx
import type { ForecastDay } from "@/lib/ui-interaction-tools";
import { getWeatherInfo } from "@/lib/weather-codes";

export type WeatherData = {
  location: string;
  country?: string;
  temperature: number;
  apparentTemperature: number;
  humidity: number;
  windSpeed: number;
  weatherCode: number;
  isDay: boolean;
  forecast?: ForecastDay[];
  error?: string;
  _meta?: { location: string };
};

export type WeatherCardProps = {
  data: WeatherData;
};

function formatDay(dateStr: string): string {
  const date = new Date(dateStr + "T00:00:00");
  const today = new Date();
  today.setHours(0, 0, 0, 0);
  const tomorrow = new Date(today);
  tomorrow.setDate(tomorrow.getDate() + 1);

  if (date.getTime() === today.getTime()) return "Today";
  if (date.getTime() === tomorrow.getTime()) return "Tmrw";
  return date.toLocaleDateString("en", { weekday: "short" });
}

export function WeatherCard({ data }: WeatherCardProps) {
  if (data.error) {
    return (
      <div className="my-4 max-w-lg">
        <div className="rounded-xl bg-sidebar dark:bg-card px-4 py-3">
          <p className="text-sm text-muted-foreground">{data.error}</p>
        </div>
      </div>
    );
  }

  const { label, emoji } = getWeatherInfo(data.weatherCode, data.isDay);
  const locationLabel = data.country
    ? `${data.location}, ${data.country}`
    : data.location;

  return (
    <div className="my-4 max-w-lg">
      <div className="rounded-xl bg-sidebar dark:bg-card px-5 py-4">
        <div className="flex items-start justify-between gap-3">
          <div>
            <p className="text-sm text-muted-foreground">{locationLabel}</p>
            <p className="text-4xl font-semibold tracking-tight mt-1">
              {Math.round(data.temperature)}°C
            </p>
            <p className="text-sm text-muted-foreground mt-1">{label}</p>
          </div>
          <span className="text-4xl mt-1">{emoji}</span>
        </div>
        <div className="flex gap-4 mt-3 text-sm text-muted-foreground">
          <span>Feels like {Math.round(data.apparentTemperature)}°</span>
          <span>Humidity {data.humidity}%</span>
          <span>Wind {Math.round(data.windSpeed)} km/h</span>
        </div>
        {data.forecast && data.forecast.length > 0 && (
          <div className="mt-4 pt-4 border-t border-border/50 grid grid-cols-7 gap-1 text-center">
            {data.forecast.map((day) => {
              const { emoji: dayEmoji } = getWeatherInfo(day.weatherCode, true);
              return (
                <div key={day.date} className="flex flex-col items-center gap-1">
                  <span className="text-xs text-muted-foreground">{formatDay(day.date)}</span>
                  <span className="text-base">{dayEmoji}</span>
                  <div className="text-xs">
                    <span className="font-medium">{Math.round(day.temperatureMax)}°</span>
                    <span className="text-muted-foreground ml-0.5">{Math.round(day.temperatureMin)}°</span>
                  </div>
                </div>
              );
            })}
          </div>
        )}
      </div>
    </div>
  );
}

```

[components/chat/weather-card.tsx](https://github.com/anuma-ai/starter-next/blob/main/components/chat/weather-card.tsx)

For charts, import the `ChartCard` component directly from the SDK:

```ts
import { ChartCard } from "@anuma/sdk/react";
```

## Rendering Display Results

### How Results Are Stored

When a display tool executes, the SDK stores its return value in a
`[Tool Execution Results]` message. This message is persisted alongside the
conversation, so display results survive page refreshes without additional
localStorage handling.

### Parsing Results

Use `collectDisplayInteractions` to scan messages and extract display results
with their anchor positions.

```ts
/**
 * Scan all messages and collect display interactions with their anchor
 * positions.  Returns a flat list of DisplayInteraction objects and a Set
 * you can use to track which ones have already been rendered inline.
 */
export function collectDisplayInteractions(
  messages: Array<{ id: string; role: string; parts?: Array<{ type: string; text?: string }> }>
): { displays: DisplayInteraction[]; renderedIds: Set<string> } {
  const displays: DisplayInteraction[] = [];

  for (const message of messages) {
    if (message.role !== "user") continue;
    const text = message.parts?.[0]?.text;
    if (!text?.includes("[Tool Execution Results]")) continue;

    const parsed = parseDisplayResults(text);
    for (const p of parsed) {
      displays.push({
        id: `${message.id}-${p.displayType}`,
        displayType: p.displayType,
        result: p.result,
        afterMessageId: message.id,
      });
    }
  }

  return { displays, renderedIds: new Set<string>() };
}
```

[lib/display-interaction.ts](https://github.com/anuma-ai/starter-next/blob/main/lib/display-interaction.ts#L53-L80)

### Inline Rendering

For each message, use `getDisplaysForMessage` to find display interactions
anchored to it. The helper marks returned interactions as rendered so they
are not duplicated.

```ts
/**
 * Get display interactions that should render before a given message.
 * Marks returned interactions as rendered so they are not duplicated.
 */
export function getDisplaysForMessage(
  messageId: string,
  displays: DisplayInteraction[],
  renderedIds: Set<string>
): DisplayInteraction[] {
  const matching = displays.filter(
    (d) => d.afterMessageId === messageId && !renderedIds.has(d.id)
  );
  for (const d of matching) {
    renderedIds.add(d.id);
  }
  return matching;
}
```

[lib/display-interaction.ts](https://github.com/anuma-ai/starter-next/blob/main/lib/display-interaction.ts#L84-L100)

Dispatch to the right component based on `displayType`:

```tsx
{displaysForMsg.map((d) =>
  d.displayType === "weather" ? (
    <WeatherCard key={d.id} data={d.result} />
  ) : d.displayType === "chart" ? (
    <ChartCard key={d.id} data={d.result} />
  ) : null
)}
```

### Fallback

When the anchor message isn't found (e.g. messages haven't finished loading),
render unanchored display interactions at the bottom of the chat.

```ts
/**
 * Get display interactions whose anchor message is not present in the
 * current message list.  These are rendered at the bottom of the chat as a
 * fallback (e.g. after a page refresh before messages finish loading).
 */
export function getUnanchoredDisplays(
  displays: DisplayInteraction[],
  messageIds: Set<string>,
  renderedIds: Set<string>
): DisplayInteraction[] {
  return displays.filter((d) => {
    if (renderedIds.has(d.id)) return false;
    if (!d.afterMessageId) return true;
    return !messageIds.has(d.afterMessageId);
  });
}
```

[lib/display-interaction.ts](https://github.com/anuma-ai/starter-next/blob/main/lib/display-interaction.ts#L104-L119)

### Optional: Index-based Persistence

If you need to persist display interactions separately from message storage
(for example, if your message store doesn't retain tool execution text), you
can use a localStorage-based hook. Message IDs are ephemeral, so this stores
the message index and re-maps on restore.

```ts
type StoredInteraction = {
  displayType: string;
  result: any;
  messageIndex: number;
};

/**
 * Persist display interactions to localStorage so they survive page
 * refreshes.  Message IDs are ephemeral, so the hook stores the message
 * index instead and re-maps to the current ID list on restore.
 */
export function useDisplayPersistence(
  conversationId: string | undefined,
  messages: Array<{ id: string }>,
  displays: DisplayInteraction[]
) {
  const prevCountRef = useRef(0);

  // Save when new display interactions appear
  useEffect(() => {
    if (!conversationId || displays.length === 0) return;
    if (displays.length === prevCountRef.current) return;
    prevCountRef.current = displays.length;

    const stored: StoredInteraction[] = displays.map((d) => {
      const idx = messages.findIndex((m) => m.id === d.afterMessageId);
      return {
        displayType: d.displayType,
        result: d.result,
        messageIndex: idx,
      };
    });

    localStorage.setItem(
      `display_interactions_${conversationId}`,
      JSON.stringify(stored)
    );
  }, [conversationId, displays, messages]);

  // Restore on conversation load
  useEffect(() => {
    if (!conversationId || messages.length === 0) return;

    const raw = localStorage.getItem(
      `display_interactions_${conversationId}`
    );
    if (!raw) return;

    try {
      const stored: StoredInteraction[] = JSON.parse(raw);
      const restored: DisplayInteraction[] = stored
        .filter((s) => s.messageIndex >= 0 && s.messageIndex < messages.length)
        .map((s, i) => ({
          id: `restored-${i}`,
          displayType: s.displayType,
          result: s.result,
          afterMessageId: messages[s.messageIndex]?.id,
        }));

      if (restored.length > 0) {
        prevCountRef.current = restored.length;
      }
    } catch {
      // Ignore corrupt data
    }
  }, [conversationId, messages]);
}
```

[lib/display-interaction.ts](https://github.com/anuma-ai/starter-next/blob/main/lib/display-interaction.ts#L123-L189)

## How It Works End-to-End

1. User sends a message ("What's the weather in London?")
2. The model decides to call `display_weather` with `{ location: "London" }`
3. The SDK auto-executes the tool's `execute` function (geocoding + weather API)
4. The result is stored as a `[Tool Execution Results]` message in the
   conversation
5. The message list parses the result and renders the `WeatherCard` component
6. The model receives the weather data and continues its text response
7. On page refresh, the conversation messages are loaded from the database and
   the tool result message is re-parsed, so the card reappears automatically

---
Source: https://docs.anuma.ai/tutorials/nextjs/tools/interactive-tools

# Interactive Tools

Interactive tools let the AI present UI elements that collect input from the
user mid-conversation. Unlike display tools (which render read-only cards),
interactive tools pause the model's response, wait for the user to interact,
and send the result back so the model can continue with that information.

The starter includes two interactive tools: a choice menu and a multi-field
form. Both use `createInteractiveTool` from the SDK.

## Overview

An interactive tool has four parts:

1. A tool definition with parameters, validation, and an `interactionType`
   string
2. A React component that renders the interaction and calls
   `resolveInteraction` when the user submits
3. `UIInteractionProvider` wrapping your app to manage the interaction
   lifecycle
4. Rendering logic that places the interaction at the right position in the
   chat

## Provider Setup

Interactive tools share the same `UIInteractionProvider` as display tools —
see [Display Tools](display-tools) for the provider setup.

## Choice Tool

The choice tool renders an inline menu of options. It supports single and
multi-select modes, includes an "other" free-text option, and validates that
at least two options are provided.

```ts
  const choiceTool = createInteractiveTool(options, {
    name: "prompt_user_choice",
    description:
      "Renders an interactive inline menu the user can click to pick from choices. Use when the user's request naturally involves selecting between specific, concrete options — for example picking a restaurant, choosing a travel destination, or selecting a category. Call this tool FIRST before generating any response text. After the user selects, you receive their choice and can respond based on it.",
    parameters: {
      type: "object",
      properties: {
        title: {
          type: "string",
          description: "Question or prompt to show the user",
        },
        description: {
          type: "string",
          description: "Optional additional context or explanation",
        },
        options: {
          type: "array",
          items: {
            type: "object",
            properties: {
              value: {
                type: "string",
                description: "Unique identifier for this option",
              },
              label: {
                type: "string",
                description: "Display text for this option",
              },
              description: {
                type: "string",
                description: "Optional description or additional info",
              },
            },
            required: ["value", "label"],
          },
          description:
            "Array of options to present (minimum 2, maximum 10 recommended)",
        },
        allowMultiple: {
          type: "boolean",
          description:
            "Allow user to select multiple options (default: false)",
          default: false,
        },
      },
      required: ["title", "options"],
    },
    interactionType: "choice",
    validate: (args: any) =>
      args.title &&
      typeof args.title === "string" &&
      Array.isArray(args.options) &&
      args.options.length >= 2 &&
      args.options.every((o: any) => o.value && o.label),
    mapResult: (result: any, args: any) => ({
      ...result,
      _meta: {
        title: args.title,
        description: args.description,
        options: args.options,
        allowMultiple: args.allowMultiple,
      },
    }),
  });
```

[lib/ui-interaction-tools.ts](https://github.com/anuma-ai/starter-next/blob/main/lib/ui-interaction-tools.ts#L52-L115)

When the user confirms, `resolveInteraction` is called with the selected
value(s). The model receives the result and can tailor its response
accordingly.

## Form Tool

The form tool renders a multi-field form with support for six field types:
`text`, `textarea`, `select`, `toggle`, `date`, and `slider`. Each field can
have a default value, placeholder, and description.

```ts
  const formTool = createInteractiveTool(options, {
    name: "prompt_user_form",
    description:
      "Renders an interactive inline form the user can fill out and submit. Use when you need to collect 2 or more specific pieces of structured information from the user — for example trip planning details (destination, dates, budget), booking info, or configuration settings. Supports text inputs, textareas, dropdowns (select), toggles, date pickers, and sliders. Call this tool FIRST before generating any response text. After the user submits, you receive all their answers at once.",
    parameters: {
      type: "object",
      properties: {
        title: {
          type: "string",
          description: "Title or heading for the form",
        },
        description: {
          type: "string",
          description: "Optional instructions or context shown below the title",
        },
        fields: {
          type: "array",
          items: {
            type: "object",
            properties: {
              name: {
                type: "string",
                description: "Unique field identifier (used as key in result)",
              },
              label: {
                type: "string",
                description: "Display label for the field",
              },
              type: {
                type: "string",
                enum: ["text", "textarea", "select", "toggle", "date", "slider"],
                description: "Field type: text (single line), textarea (multi-line), select (dropdown), toggle (on/off), date (calendar picker), slider (numeric range)",
              },
              description: {
                type: "string",
                description: "Optional help text shown below the label",
              },
              placeholder: {
                type: "string",
                description: "Placeholder text for text/textarea/select fields",
              },
              options: {
                type: "array",
                items: {
                  type: "object",
                  properties: {
                    value: { type: "string" },
                    label: { type: "string" },
                  },
                  required: ["value", "label"],
                },
                description: "Options for select fields",
              },
              defaultValue: {
                description: "Default value for the field (string for text/textarea/select, boolean for toggle, number for slider)",
              },
              min: {
                type: "number",
                description: "Minimum value for slider fields (default: 0)",
              },
              max: {
                type: "number",
                description: "Maximum value for slider fields (default: 100)",
              },
              step: {
                type: "number",
                description: "Step increment for slider fields (default: 1)",
              },
            },
            required: ["name", "label", "type"],
          },
          description: "Array of form fields to display",
        },
      },
      required: ["title", "fields"],
    },
    interactionType: "form",
    validate: (args: any) => {
      if (!args.title || typeof args.title !== "string") return false;
      if (!Array.isArray(args.fields) || args.fields.length === 0) return false;
      for (const field of args.fields) {
        if (!field.name || !field.label || !field.type) return false;
        if (!["text", "textarea", "select", "toggle", "date", "slider"].includes(field.type)) return false;
        if (field.type === "select" && (!Array.isArray(field.options) || field.options.length === 0)) return false;
      }
      return true;
    },
    mapResult: (result: any, args: any) => ({
      ...result,
      _meta: {
        title: args.title,
        description: args.description,
        fields: args.fields,
      },
    }),
  });
```

[lib/ui-interaction-tools.ts](https://github.com/anuma-ai/starter-next/blob/main/lib/ui-interaction-tools.ts#L119-L214)

When the user submits, all field values are collected into a single object and
returned to the model.

## Wiring into the Chat

Interactive tools are created alongside display tools using the same
`createUIInteractionTools` factory — see
[Display Tools — Wiring into the Chat](display-tools) for the setup.

## Rendering Interactive Results

Interactive tools use the same `UIInteractionProvider` context as display
tools. Use `useUIInteraction` from the SDK to access pending and resolved
interactions:

```tsx
import { useUIInteraction } from "@anuma/sdk/react";

const { interactions } = useUIInteraction();
```

Each interaction has an `interactionType` (`"choice"` or `"form"`) and
metadata stored in `_meta`. Dispatch to the right component based on the type:

```tsx
{interactions.map((interaction) =>
  interaction.interactionType === "choice" ? (
    <ChoiceInteraction
      key={interaction.id}
      id={interaction.id}
      title={interaction._meta.title}
      options={interaction._meta.options}
      allowMultiple={interaction._meta.allowMultiple}
      resolved={interaction.resolved}
      result={interaction.result}
    />
  ) : interaction.interactionType === "form" ? (
    <FormInteraction
      key={interaction.id}
      id={interaction.id}
      title={interaction._meta.title}
      description={interaction._meta.description}
      fields={interaction._meta.fields}
      resolved={interaction.resolved}
      result={interaction.result}
    />
  ) : null
)}
```

## How It Works End-to-End

1. User sends a message ("Help me plan a trip")
2. The model decides to call `prompt_user_form` with fields for destination,
   dates, and budget
3. The SDK validates the arguments and creates a pending interaction
4. The form renders inline in the chat; the model's response is paused
5. The user fills in the form and clicks Submit
6. `resolveInteraction` sends the form values back to the model
7. The model receives the values and continues its response using them
8. On page refresh, resolved interactions are restored from the persisted
   conversation messages

---
Source: https://docs.anuma.ai/tutorials/nextjs/tools/managing

# Managing Tools

The `useAppTools` hook wraps the SDK's `useTools` hook to fetch server-side
tools from the API and manage per-tool modes locally. Each tool can be set to
one of three modes, and semantic search can automatically select relevant tools
based on the user's message.

## Prerequisites

- An authentication function that returns a valid token
- Optional: A custom base URL for the API

## Hook Initialization

```ts
export function useAppTools({ getToken, baseUrl }: UseToolsProps) {
  const [toolModes, setToolModesState] = useState<ToolModes>({});
  const [semanticSearchEnabled, setSemanticSearchEnabledState] = useState(true);

  // Use SDK's useTools hook for fetching tools
  const {
    tools: sdkTools,
    checksum,
    isLoading,
    error,
    refresh,
    checkForUpdates,
  } = useTools({
    getToken,
    baseUrl,
  });

  // Load tool modes and semantic search setting from localStorage on mount
  useEffect(() => {
    setToolModesState(getToolModes());
    setSemanticSearchEnabledState(getSemanticSearchEnabled());
  }, []);

  // Map SDK tools to our Tool type
  const tools: Tool[] = sdkTools.map((tool: any) => ({
    name: tool.name,
    description: tool.description || "",
    parameters: tool.parameters || { type: "object", properties: {}, required: [] },
  }));
```

[hooks/useAppTools.ts](https://github.com/anuma-ai/starter-next/blob/main/hooks/useAppTools.ts#L173-L201)

## Tool Modes

Every tool has a mode that controls whether it gets included in API requests:

- **auto** (default) — semantic search decides whether the tool is relevant to the current message. If semantic search is off, the tool is always included.
- **enable** — always include the tool, regardless of semantic search.
- **disable** — never include the tool.

Modes are persisted in `localStorage` and default to `auto` when unset.

```ts
  // Set mode for a specific tool
  const setToolMode = useCallback((toolName: string, mode: ToolMode) => {
    setToolModesState((prev) => {
      const newModes = { ...prev };
      if (mode === 'auto') {
        // Remove from storage when set to auto (default)
        delete newModes[toolName];
      } else {
        newModes[toolName] = mode;
      }
      setToolModes(newModes);
      return newModes;
    });
  }, []);

  // Get mode for a specific tool
  const getMode = useCallback(
    (toolName: string): ToolMode => toolModes[toolName] || 'auto',
    [toolModes]
  );

  // Legacy: get enabled tools (for backwards compatibility)
  const enabledTools = Object.entries(toolModes)
    .filter(([_, mode]) => mode === 'enable')
    .map(([name]) => name);
```

[hooks/useAppTools.ts](https://github.com/anuma-ai/starter-next/blob/main/hooks/useAppTools.ts#L205-L229)

## Semantic Search

When enabled, semantic search analyzes the user's message and automatically
selects which tools in `auto` mode are relevant. This reduces token usage by
only sending tools that match the conversation context.

```ts
  // Toggle semantic search
  const toggleSemanticSearch = useCallback((enabled: boolean) => {
    setSemanticSearchEnabledState(enabled);
    setSemanticSearchEnabled(enabled);
  }, []);
```

[hooks/useAppTools.ts](https://github.com/anuma-ai/starter-next/blob/main/hooks/useAppTools.ts#L233-L237)

## Checksum-Based Refresh

The API returns a `tools_checksum` with each response. The hook exposes
`checkForUpdates(checksum)` which compares against the last known checksum and
triggers a refresh when the server-side tool set changes. This is called
automatically after each message in `useAppChat`.

---
Source: https://docs.anuma.ai/tutorials/nextjs/tools/notion

# Notion Integration

The `useNotionTools` hook connects to Notion via OAuth and provides Notion
tools that the AI can call to search, read, and create content in the user's
Notion workspace.

## Prerequisites

- A wallet address (used as the key for storing OAuth tokens)
- The user must have connected their Notion account through the app's settings

## Hook Initialization

The hook loads the Notion access token on mount, running any necessary
migrations for older token formats. It then creates the tools using
`createNotionTools` from the SDK:

```ts
export function useNotionTools({
  walletAddress,
}: {
  walletAddress: string | undefined;
}) {
  const [accessToken, setAccessToken] = useState<string | null>(null);

  useEffect(() => {
    if (!walletAddress) return;

    async function load() {
      await migrateNotionClientRegistration(walletAddress!);
      await migrateNotionToken(walletAddress!);

      const token = await getNotionAccessToken(walletAddress);
      setAccessToken(token);
    }

    load();
  }, [walletAddress]);

  const tools = useMemo(() => {
    if (!accessToken) return [];
    return createNotionTools(
      () => accessToken,
      async () => {
        const token = await getNotionAccessToken(walletAddress);
        if (!token) throw new Error("Notion not connected");
        return token;
      }
    );
  }, [accessToken, walletAddress]);

```

[hooks/useNotionTools.ts](https://github.com/anuma-ai/starter-next/blob/main/hooks/useNotionTools.ts#L11-L43)

The `createNotionTools` function takes two arguments: a synchronous getter for
the current token and an async refresh function that fetches a fresh token
when the current one expires.

## Wiring into the Chat

Include the Notion tools in the client tools array only when the user has
connected their account:

```ts
const { tools: notionTools } = useNotionTools({ walletAddress });

const clientTools = useMemo(() => {
  const allTools = [];

  if (notionTools.length > 0) {
    allTools.push(...notionTools);
  }

  // ... other tools

  return allTools;
}, [notionTools]);
```

## Return Value

```ts
  return {
    tools,
    isConnected: hasNotionCredentials(walletAddress),
    accessToken,
  };
```

[hooks/useNotionTools.ts](https://github.com/anuma-ai/starter-next/blob/main/hooks/useNotionTools.ts#L47-L51)

---
Source: https://docs.anuma.ai/tutorials/quickstart

# Anuma Starter Mini

A minimal AI chat application built with the
[Anuma SDK](https://github.com/anuma-ai/sdk), [Privy](https://privy.io) for
authentication, and [Next.js](https://nextjs.org). The entire app fits in a
single file — `app/page.tsx` — making it a good starting point for understanding
how the pieces connect.

<video src="https://github.com/anuma-ai/starter-mini/raw/refs/heads/main/public/demo.webm" autoplay loop playsinline style="border-radius: 8px;"></video>

## Getting Started

### Create an Anuma app

Sign in at [dashboard.anuma.ai](https://dashboard.anuma.ai/) and create an app.
This provisions the API account that powers AI responses.

### Clone and install

```bash
git clone https://github.com/anuma-ai/starter-mini.git
cd starter-mini
pnpm install
```

### Configure environment variables

Create a `.env.local` file in the project root:

```
NEXT_PUBLIC_API_URL=https://portal.anuma.ai
NEXT_PUBLIC_PRIVY_APP_ID=<your-privy-app-id>
```

### Run the development server

```bash
pnpm dev
```

Open [http://localhost:3000](http://localhost:3000) to see the app. After signing
in through Privy you'll get a chat interface where you can talk to an AI model.

## What's in the Tutorial

**Setup** covers the Next.js configuration — wrapping your config with
`withAnuma` to set up the API proxy the SDK needs.

**Authentication** explains the Privy integration: the provider, the auth gate
that switches between login and chat, and how identity tokens are passed to the
SDK.

**Chat** introduces the `useChat` hook from `@anuma/sdk/react`, which manages
the connection to the Anuma backend, and the message state model.

**Streaming** describes how response text arrives in chunks through the `onData`
callback and gets rendered as markdown in real time.

**Sending Messages** walks through the submit handler that formats messages for
the API and sends the full conversation history with each request.

---
Source: https://docs.anuma.ai/tutorials/quickstart/auth

# Authentication

The app uses [Privy](https://privy.io) for authentication. The entire auth flow
lives in `app/page.tsx`.

```tsx
import { PrivyProvider, usePrivy, useIdentityToken } from "@privy-io/react-auth";
```

[app/page.tsx](https://github.com/anuma-ai/starter-mini/blob/main/app/page.tsx#L12-L12)

## Privy Provider

The root component wraps the app in a `PrivyProvider` with the app ID from
environment variables. A mount guard prevents SSR hydration mismatches.

```tsx
const privyAppId = process.env.NEXT_PUBLIC_PRIVY_APP_ID!;
const privyClientId = process.env.NEXT_PUBLIC_PRIVY_CLIENT_ID;

export default function Home() {
  const [mounted, setMounted] = useState(false);
  // eslint-disable-next-line react-hooks/set-state-in-effect -- hydration guard, runs once on mount
  useEffect(() => setMounted(true), []);

  if (!mounted) return null;

  return (
    <PrivyProvider
      appId={privyAppId}
      clientId={privyClientId}
      config={{
        embeddedWallets: {
          ethereum: { createOnLogin: "users-without-wallets" },
        },
      }}
    >
      <AuthGate />
    </PrivyProvider>
  );
}
```

[app/page.tsx](https://github.com/anuma-ai/starter-mini/blob/main/app/page.tsx#L47-L70)

## Auth Gate

`AuthGate` reads Privy's `ready` and `authenticated` state to decide what to
render: a loading indicator, the login screen, or the chat interface.

```tsx
function AuthGate() {
  const { ready, authenticated } = usePrivy();

  if (!ready) {
    return (
      <div className="flex h-screen items-center justify-center">
        <span className="animate-pulse-dot inline-block size-2 rounded-full bg-foreground" />
      </div>
    );
  }

  if (!authenticated) {
    return <LoginScreen />;
  }

  return <Chat />;
}
```

[app/page.tsx](https://github.com/anuma-ai/starter-mini/blob/main/app/page.tsx#L78-L94)

## Getting an Identity Token

Inside the chat component, `useIdentityToken` provides a JWT that the SDK sends
to the Anuma backend. The token is kept in a ref so the `getToken` callback
always returns the latest value without causing re-renders.

```tsx
  // Keep token in a ref so getToken always returns the latest value
  const tokenRef = useRef(identityToken);
  useEffect(() => {
    tokenRef.current = identityToken;
  }, [identityToken]);
  const getToken = useCallback(async () => tokenRef.current, []);
```

[app/page.tsx](https://github.com/anuma-ai/starter-mini/blob/main/app/page.tsx#L161-L166)

---
Source: https://docs.anuma.ai/tutorials/quickstart/chat

# Chat

```tsx
import { useChat } from "@anuma/sdk/react";
import type { LlmapiResponseResponse, LlmapiResponseOutputItem } from "@anuma/sdk";
```

[app/page.tsx](https://github.com/anuma-ai/starter-mini/blob/main/app/page.tsx#L15-L16)

## useChat Hook

The `useChat` hook from `@anuma/sdk/react` handles the connection to the Anuma
backend. Pass it a `getToken` function and streaming callbacks.

`onData` fires for each text chunk during streaming. `onFinish` fires when the
response is complete and receives the full API response object, which is used to
extract the final assistant message. `onError` handles any errors.

```tsx
  // SDK chat hook
  const { isLoading, sendMessage, stop } = useChat({
    getToken,
    baseUrl: process.env.NEXT_PUBLIC_API_URL,
    onData: (chunk) => {
      streamingRef.current += chunk;
      setStreamingText(streamingRef.current);
    },
    onFinish: (response) => {
      const text = extractResponseText(response);
      if (text) {
        setMessages((prev) => [
          ...prev,
          {
            id: crypto.randomUUID(),
            role: "assistant",
            content: text,
          },
        ]);
      }
      setStreamingText("");
      streamingRef.current = "";
    },
    onError: (error) => {
      console.error("Chat error:", error);
    },
  });
```

[app/page.tsx](https://github.com/anuma-ai/starter-mini/blob/main/app/page.tsx#L193-L219)

## Message Type

Messages are stored in local state as a simple array. Each message has an `id`,
a `role` (user or assistant), and a `content` string.

```tsx
type Message = {
  id: string;
  role: "user" | "assistant";
  content: string;
};

```

[app/page.tsx](https://github.com/anuma-ai/starter-mini/blob/main/app/page.tsx#L34-L39)

---
Source: https://docs.anuma.ai/tutorials/quickstart/sending

# Sending Messages

The submit handler validates input, adds the user message to local state, builds
the message array in the format the API expects, and calls `sendMessage`.

Each message is converted to `LlmapiMessage` format with a `role` and `content`
array containing a text part. The full conversation history is sent with every
request so the model has context.

```tsx
  // Submit handler
  const handleSubmit = useCallback(
    async (e: FormEvent) => {
      e.preventDefault();
      const text = input.trim();
      if (!text || isLoading) return;

      setInput("");
      streamingRef.current = "";
      setStreamingText("");

      const userMessage: Message = {
        id: crypto.randomUUID(),
        role: "user",
        content: text,
      };
      const updated = [...messages, userMessage];
      setMessages(updated);

      const llmapiMessages = updated.map((m) => ({
        role: m.role,
        content: [{ type: "text", text: m.content }],
      }));

      await sendMessage({
        messages: llmapiMessages,
        model: "openai/gpt-4.1-mini",
      });
    },
    [input, isLoading, messages, sendMessage]
  );
```

[app/page.tsx](https://github.com/anuma-ai/starter-mini/blob/main/app/page.tsx#L228-L258)

---
Source: https://docs.anuma.ai/tutorials/quickstart/setup

# Setup

## Next.js Config

Wrap your Next.js config with `withAnuma` from `@anuma/sdk/next`. This sets up
the API proxy that the SDK's `useChat` hook needs to communicate with the Anuma
backend.

```ts
import { withAnuma } from "@anuma/sdk/next";

export default withAnuma({
  reactStrictMode: false,
  turbopack: {},
});
```

[next.config.ts](https://github.com/anuma-ai/starter-mini/blob/main/next.config.ts#L2-L7)

## Environment Variables

Create a `.env.local` file with your Privy app ID:

```
NEXT_PUBLIC_PRIVY_APP_ID=<your-privy-app-id>
```

---
Source: https://docs.anuma.ai/tutorials/quickstart/streaming

# Streaming

```tsx
import { Streamdown } from "streamdown";
```

[app/page.tsx](https://github.com/anuma-ai/starter-mini/blob/main/app/page.tsx#L19-L19)

The SDK streams response text through the `onData` callback. Each chunk is
appended to a ref (for the latest value) and mirrored to React state (to trigger
re-renders). The `Streamdown` component renders the streaming markdown with
syntax-highlighted code blocks.

When the response finishes, `onFinish` receives the full API response. The
assistant text is extracted from `response.output` and added to the messages
array. The streaming buffer is then cleared.

```tsx
  // SDK chat hook
  const { isLoading, sendMessage, stop } = useChat({
    getToken,
    baseUrl: process.env.NEXT_PUBLIC_API_URL,
    onData: (chunk) => {
      streamingRef.current += chunk;
      setStreamingText(streamingRef.current);
    },
    onFinish: (response) => {
      const text = extractResponseText(response);
      if (text) {
        setMessages((prev) => [
          ...prev,
          {
            id: crypto.randomUUID(),
            role: "assistant",
            content: text,
          },
        ]);
      }
      setStreamingText("");
      streamingRef.current = "";
    },
    onError: (error) => {
      console.error("Chat error:", error);
    },
  });
```

[app/page.tsx](https://github.com/anuma-ai/starter-mini/blob/main/app/page.tsx#L193-L219)

---
Source: https://docs.anuma.ai/tutorials/telegram

# Anuma Starter Telegram

A starter template for building Telegram bots powered by
[Anuma](https://anuma.ai). Handles authentication via
[Privy](https://privy.io) and supports text and image messages out of the box.

Try the live bot: [@anuma_ai_bot](https://t.me/anuma_ai_bot)

## Getting Started

### Create an Anuma app

Sign in at [dashboard.anuma.ai](https://dashboard.anuma.ai/) and create an app.
This provisions the API account that powers AI responses.

### Clone and install

```bash
git clone https://github.com/anuma-ai/starter-telegram.git
cd starter-telegram
pnpm install
cp .env.example .env
```

### Create a Telegram bot

Open [@BotFather](https://t.me/BotFather), run `/newbot`, and copy the token
into `TELEGRAM_BOT_TOKEN` in `.env`. Use a separate bot for development —
running locally switches the bot to polling mode, which deactivates any existing
webhook.

### Expose the auth server

Telegram OAuth requires a public domain, so you need to expose the local auth
server (port 9876) over HTTPS. For example, with ngrok:

```bash
ngrok http 9876
```

Copy the HTTPS URL into `AUTH_BASE_URL` in `.env`.

### Configure the bot domain

In [@BotFather](https://t.me/BotFather), go to `/mybots` → your bot → Bot
Settings → Domain, and set it to your ngrok domain (without the `https://`
prefix). This allows Telegram OAuth to work from your auth page.

### Set up Privy

Create an app at [Privy Dashboard](https://dashboard.privy.io), then:

- Go to Login Methods and enable Telegram
- In the Telegram settings, add your bot token so Privy can verify Telegram auth
- Under Authentication > Advanced, enable "Return user data in an identity
  token"
- Copy the App ID into `PRIVY_APP_ID` in `.env`

### Run the bot

```bash
pnpm dev
```

This starts the bot in polling mode and a local auth server on port 9876. Send `/login` to your bot in Telegram — it will show a login button that opens the Privy auth flow. After logging in, you can start chatting.

## Environment Variables

See `.env.example` for the full list. Only `TELEGRAM_BOT_TOKEN` and `PRIVY_APP_ID` are required — everything else has sensible defaults. For Cloudflare Worker local dev, see `.dev.vars.example`.

## Cloudflare Worker Deployment

The bot can also run as a Cloudflare Worker using webhooks instead of polling. See `wrangler.jsonc` for the configuration. Secrets (`TELEGRAM_BOT_TOKEN`, `PRIVY_APP_ID`, `BOT_INFO`, `AUTH_BASE_URL`) are set via `wrangler secret put`.

After deploying, point Telegram to your worker's webhook:

```bash
# Set webhook
curl "https://api.telegram.org/bot<TOKEN>/setWebhook?url=<WORKER_URL>/webhook"

# Verify
curl "https://api.telegram.org/bot<TOKEN>/getWebhookInfo"
```

## License

MIT