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

# Quickstart

> Install the SDK and create your first client

This quickstart walks through the essentials for calling the Atomscale API with the Python SDK.

## Prerequisites

* Python 3.10 through 3.12
* An active Atomscale account
* An API key from the [Atomscale Dashboard](https://app.atomscale.ai) (found in **User** >
  **Manage Account** > **Access**)

## Install the client

```bash theme={null}
pip install atomscale
```

## Create a client

The `Client` reads `AS_API_KEY` and `AS_API_ENDPOINT` from the environment. Export the variables or pass values explicitly.

```python theme={null}
import os
from atomscale import Client

os.environ["AS_API_KEY"] = "YOUR_API_KEY"

client = Client()
```

<Warning>
  Never commit your API key to version control. Use environment variables or a secrets manager.
</Warning>

Override the endpoint when pointing at staging or a private deployment:

```python theme={null}
client = Client(
    api_key="YOUR_API_KEY",
    endpoint="https://api.atomscale.ai/",
)
```

## Verify the connection

Run a simple search to confirm the client is working:

```python theme={null}
results = client.search()
print(f"Found {len(results)} items in the catalogue")
```

## Mute progress bars

For non-interactive environments like CI pipelines, pass `mute_bars=True`:

```python theme={null}
client = Client(api_key="YOUR_API_KEY", mute_bars=True)
```

## Next steps

<CardGroup cols={2}>
  <Card title="Upload Data" icon="upload" href="/sdk/upload-data">
    Send files to Atomscale for analysis.
  </Card>

  <Card title="Search Data" icon="magnifying-glass" href="/sdk/search-data">
    Find items in your data catalogue.
  </Card>

  <Card title="Inspect Results" icon="chart-line" href="/sdk/inspect-results">
    Explore analysis outputs and plots.
  </Card>

  <Card title="Stream RHEED" icon="video" href="/sdk/stream-rheed">
    Push frames from your instrument in real time.
  </Card>
</CardGroup>