# Quickstart

## Installation <a href="#installation" id="installation"></a>

```bash
uv pip install edison-client
```

## Authentication <a href="#authentication" id="authentication"></a>

In order to use the `EdisonClient`, you need to authenticate yourself. Authentication is done by providing an API key, which can be obtained directly from your [profile page in the Edison platform](https://platform.edisonscientific.com/profile).

To access your API key:

1. Create an account on the [Edison platform](https://platform.edisonscientific.com/).
2. Click on the "Account" button on the left sidebar. Then click on the "Profile" button.
3. Under "API Tokens", click "Create New Token."

## Basic task running <a href="#basic-task-running" id="basic-task-running"></a>

```python
from edison_client import EdisonClient, JobNames

client = EdisonClient(
    api_key="<your_api_key>",
)

task_data = {
    "name": JobNames.LITERATURE,
    "query": "Which neglected diseases had a treatment developed by artificial intelligence?",
}

task_response = client.run_tasks_until_done(task_data)
```


---

# Agent Instructions: Querying This Documentation

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

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.edisonscientific.com/edison-client/quickstart.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.