> For the complete documentation index, see [llms.txt](https://docs.interactive.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.interactive.ai/sdk/readme.md).

# Overview

### Python SDK

Client library for the [InteractiveAI](https://pypi.org/project/interactiveai/) observability platform.

#### Synopsis

Provides OpenTelemetry-based tracing, automatic LLM framework instrumentation, prompt management, dataset evaluation, and direct API access to InteractiveAI.

### Install

```bash
pip install interactiveai
```

With extras for LLM framework auto-instrumentation:

```bash
pip install "interactiveai[openai]"
pip install "interactiveai[langchain]"
```

#### Quick Start

```python
import interactiveai

client = interactiveai.Interactive(
    public_key="<INTERACTIVEAI_PUBLIC_KEY>",
    secret_key="<INTERACTIVEAI_SECRET_KEY>",
)

with client.start_as_current_span(name="my-operation") as span:
    result = do_work()
    span.update(output=result)

client.flush()
```

#### Options

| Variable                        | Default                      | Description             |
| ------------------------------- | ---------------------------- | ----------------------- |
| `INTERACTIVEAI_PUBLIC_KEY`      | —                            | API public key          |
| `INTERACTIVEAI_SECRET_KEY`      | —                            | API secret key          |
| `INTERACTIVEAI_HOST`            | `https://app.interactive.ai` | API endpoint            |
| `INTERACTIVEAI_DEBUG`           | `false`                      | Enable debug logging    |
| `INTERACTIVEAI_TRACING_ENABLED` | `true`                       | Enable/disable tracing  |
| `INTERACTIVEAI_SAMPLE_RATE`     | `1.0`                        | Sampling rate (0.0–1.0) |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.interactive.ai/sdk/readme.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
