# Developer quickstart

URL: /docs/developers

The Orvelt Business API lets your server read opinions and answers, manage questions, send verified opinion invitations, and count or invite subscribers. Use the `@orvelt/business` TypeScript SDK, the `orvelt-business` Python SDK, or HTTP requests directly. Both SDKs are generated from the same contract as the [HTTP API](/docs/api-reference) and ship together under the [SDK release notes](/changelog?product=sdk).

This section is for developers. Everything here can also be done without code in Orvelt Business: if you're not writing code, start with the [Quick start guide](/docs/quickstart). To connect an AI assistant instead, use [Business MCP](/docs/ai), which needs no API key.

To put an opinion form on your website, you need no key or backend: see [Website embed](/docs/developers/collect/website-embed).

## Create an API key [#create-an-api-key]

You need an Orvelt Business organization with at least one project.

### Copy the key once [#copy-the-key-once]

1. In Orvelt Business, open **Manage Settings → API Keys** and select **Create key**.
2. Name the key after the service that uses it and choose when it expires.
3. Copy the key into your server's secret manager as `ORVELT_BUSINESS_API_KEY`. Orvelt shows it only once.
4. Copy a project ID into `ORVELT_PROJECT_ID`.

![The API key created dialog says the key cannot be viewed again and provides Copy and Done buttons; the key is redacted.](/hc/screenshots/business-key-created.png)

A key works for every project in its organization. Keep it on your server: see [API keys](/docs/developers/api-keys) and [Authentication](/docs/developers/authentication).

## Install the SDK [#install-the-sdk]

Choose the client for your server. TypeScript runs on Bun, Node.js 18 or later, and any runtime with Fetch. Python requires Python 3.10 or later.

### Choose your package manager [#choose-your-package-manager]

**bun**

```bash
bun add @orvelt/business
```

**npm**

```bash
npm install @orvelt/business
```

**pnpm**

```bash
pnpm add @orvelt/business
```

### Configure the client on the server [#configure-the-client-on-the-server]

**TypeScript SDK**

For TypeScript, call `orvelt` once, from a module that only runs on your server:

```ts title="src/orvelt.ts"
import { orvelt } from '@orvelt/business';

orvelt({
  apiKey: process.env.ORVELT_BUSINESS_API_KEY!,
});
```

If your framework bundles modules for the browser, put this file behind its server-only boundary.

**Python SDK**

Create a client with your server's API key. The context manager closes its connections:

```python
import os
from orvelt_business import Orvelt

with Orvelt(business_api_key=os.environ["ORVELT_BUSINESS_API_KEY"]) as client:
    page = client.opinions.list(project_id=os.environ["ORVELT_PROJECT_ID"])
```

To change the base URL or use several TypeScript clients, see the [TypeScript SDK](/docs/developers/typescript-sdk). For async requests and Python-specific options, see the [Python SDK](/docs/developers/python-sdk).

## Send your first request [#send-your-first-request]

List the newest opinions for your project. Choose TypeScript, Python, or the equivalent cURL request; replace placeholders such as `PROJECT_ID` with your own values.

### List opinions [#list-opinions]

**TypeScript SDK**

```ts
import { opinions } from '@orvelt/business';

const result = await opinions.list({
  projectId: process.env.ORVELT_PROJECT_ID!,
  page: 1,
  limit: 20,
});

if (result.error) {
  throw new Error(result.error.message);
}

console.log({ count: result.data.opinions.length, page: result.data.pagination.page });
```

**Python SDK**

```python
import os
from orvelt_business import Orvelt

with Orvelt(business_api_key=os.environ["ORVELT_BUSINESS_API_KEY"]) as client:
    page = client.opinions.list(
        project_id=os.environ["ORVELT_PROJECT_ID"],
        page=1,
        limit=20,
    )
    print({"count": len(page.result.opinions), "page": page.result.pagination.page})
```

**cURL**

```bash
curl --request GET \
  --url "https://api.orvelt.com/v1/project/$ORVELT_PROJECT_ID/opinions?page=1&limit=20" \
  --header "x-api-key: $ORVELT_BUSINESS_API_KEY"
```

### Check the result [#check-the-result]

A `200` returns `{ opinions, pagination }`; a new project returns an empty `opinions` array. Any other status means the key, permission, or project ID needs fixing: [Errors](/docs/developers/errors) explains each one.

## What to build next [#what-to-build-next]

### Pick a goal [#pick-a-goal]

- **Questions:** [create questions](/docs/developers/questions/create), then read their [results](/docs/developers/questions/results).
- **Collection:** [website embed](/docs/developers/collect/website-embed), [delivery links](/docs/developers/collect/delivery-links), or [QR codes](/docs/developers/collect/qr-codes).
- **Feedback:** [sync opinions and answers](/docs/developers/feedback/sync), [replies](/docs/developers/feedback/reply), or [webhooks](/docs/developers/feedback/webhooks).

New to Orvelt? Read [How questions are picked](/docs/research/how-questions-are-picked) first: it explains why each customer sees different questions.