# Quickstart

The unofficial async API wrapper for <http://www.boredapi.com/>

## Installing

`pip install --upgrade bored_api`

## Usage

Here is simple example of usage.

```py
import asyncio

import bored_api

async def main():
  client = bored_api.BoredClient()
  activity = await client.get_by_type(bored_api.ActivityType.BUSYWORK)
  print(activity.activity)

asyncio.run(main())
```

## Documentation and API Reference:

<https://damego.gitbook.io/async-bored-api/>


---

# 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://damego.gitbook.io/async-bored-api/readme.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.