# @semble.so/api

A fully-typed client for the [Semble](https://semble.so) API.

## Install

```bash
npm install @semble.so/api
```

The client uses [`ts-rest`](https://ts-rest.com) and [`zod`](https://zod.dev) under the hood. They are declared as peer dependencies and will be installed automatically by modern package managers; if you need to install them explicitly:

```bash
npm install @ts-rest/core zod
```

## Usage

```ts
import { createSembleClient } from '@semble.so/api';

const semble = createSembleClient({
  apiKey: process.env.SEMBLE_API_KEY!,
});

const result = await semble.cards.addUrlToLibrary({
  body: { url: 'https://semble.so' },
});
```

### Options

All options are optional:

- `apiKey` — your Semble API key. Without it, only public endpoints are accessible; authenticated endpoints will return `401`.
- `client` — a short identifier for your integration (e.g. `'my-plugin'`), sent as the `X-Semble-Client` header. Setting it helps Semble understand which tools people use — please set it if you're building an integration. The value is lowercased before being recorded, and after lowercasing must match `^[a-z0-9][a-z0-9_-]{0,31}$` (letters, digits, `-` and `_`; max 32 chars). Values that don't match are silently ignored — the request still succeeds, but your client won't be attributed.
- `baseUrl` — the API base URL (default: `https://api.semble.so/xrpc`).

```ts
const semble = createSembleClient({
  apiKey: '...',
  client: 'my-plugin',
  baseUrl: 'https://anotherappview.com/xrpc',
});
```

## API reference

See the full API reference at [https://docs.cosmik.network](https://docs.cosmik.network).

## License

ISC