> ## Documentation Index
> Fetch the complete documentation index at: https://docs.opennote.com/llms.txt
> Use this file to discover all available pages before exploring further.

# SDKs

> Learn how to work with the Python and TypeScript SDKs.

# Official SDKs

We provide two lightweight open-source SDKs to help you integrate our API quickly and efficiently.

<CardGroup cols={2}>
  <Card title="Python SDK" icon="python" href="https://github.com/opennote-dev/api-sdk-python">
    {}
  </Card>

  <Card title="TypeScript SDK" icon="code-simple" href="https://github.com/opennote-dev/api-sdk-typescript">
    {}
  </Card>
</CardGroup>

## Installation

<CodeGroup>
  ```bash Python theme={null}
  pip install opennote
  ```

  ```bash TypeScript/JavaScript   theme={null}
  # npm
  npm install @opennote-ed/sdk

  # yarn
  yarn add @opennote-ed/sdk

  # pnpm  
  pnpm add @opennote-ed/sdk

  # bun
  bun add @opennote-ed/sdk
  ```
</CodeGroup>

## Quick Start

<CodeGroup>
  ```python Python theme={null}
  from opennote import OpennoteClient
  import os

  # Initialize the client
  client = OpennoteClient(api_key=os.getenv("OPENNOTE_API_KEY"))

  # Make your first request
  journals = client.journals.list()
  print(f"Found {len(journals.journals)} journals")
  ```

  ```typescript TypeScript theme={null}
  import { OpennoteClient } from '@opennote-ed/sdk';

  // Initialize the client
  const client = new OpennoteClient({ api_key: process.env.OPENNOTE_API_KEY! });

  // Make your first request  
  const journals = await client.journals.list();
  console.log(`Found ${journals.journals?.length} journals`);
  ```
</CodeGroup>

## Resources

* **Python SDK**
  * [GitHub Repository](https://github.com/opennote-dev/api-sdk-python)
  * [PyPI Package](https://pypi.org/project/opennote/)
  * [Full Documentation](https://github.com/opennote-dev/api-sdk-python/blob/main/README.md)

* **TypeScript SDK**
  * [GitHub Repository](https://github.com/opennote-dev/api-sdk-typescript)
  * [npm Package](https://www.npmjs.com/package/@opennote-ed/sdk)
  * [Full Documentation](https://github.com/opennote-dev/api-sdk-typescript/blob/main/README.md)

Both SDKs are open-source and welcome contributions! Found a bug or want to add a feature? Please open an issue or submit a pull request.

For examples and tutorials, check out the `/examples` directories in each repository for your language of choice.

All schemas are available in the [API Reference](/api-reference).