Skip to main content

Getting started

Add AI-powered natural-language control to your app in a few lines of code.

1. Get a partner key​

Talk2View is in private beta. Request a partner key and we'll get you set up. You receive one key:

  • pk_live_… — your partner key: a public identifier, safe in client-side code.

That one key is all you need — Talk2View does not issue a partner secret key.

Before you build, read Intended use: Talk2View isn't a medical device, and your app shouldn't send it patient data.

2. Install the SDK​

npm install @talk2view/sdk

3. Drop in the chat​

The fastest path is the packaged chat — one component and one stylesheet. Give it a tool and the assistant can act in your app, not just answer:

import { Talk2ViewChat } from '@talk2view/sdk/chat';
import type { ClientTool } from '@talk2view/sdk';
import '@talk2view/sdk/chat.css';

const tools: ClientTool[] = [{
  name: 'send_email',
  description: 'Send an email.',
  parameters: {
    type: 'object',
    properties: { to: { type: 'string', description: 'Recipient address.' } },
    required: ['to'],
  },
  execute: async (args) => {
    // your app's code runs here
    return 'Sent to ' + String(args.to) + '.';
  },
}];

export function Assistant() {
  return <Talk2ViewChat partnerKey="pk_live_..." tools={tools} />;
}

<Talk2ViewChat> handles sign-in, tool registration, streaming, and the interrupt/resume cycle. See Concepts for how that loop works.

4. Who can chat​

End-users sign in with a Talk2View account. If you'd rather let anyone chat without signing in, turn on Anonymous access under Settings in the dashboard and ask us to set a daily limit on new guests for your key. For Google and Apple sign-in, add your site to Allowed websites in the dashboard so your users skip an extra confirmation screen. See Authentication.

Going further​

Building headless or outside React? The lower-level Talk2View client, tool registration, and the streamed chat events are covered in the TypeScript SDK repository. The API reference lists the HTTP endpoints but doesn't describe the events in the stream.

  • TypeScript SDK — source, runnable examples, full API
  • Python SDK — coming soon
  • API reference — the HTTP endpoints; for the streamed chat events, see the SDK