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

# api

A library for working with HTTP Clients and APIs.

## What is requests?

<mark style="color:orange;">**Requests**</mark> is an elegant and simple HTTP library for Python, built for human beings.

{% embed url="<https://requests.readthedocs.io/en/latest/>" %}
requests official documentation
{% endembed %}

## Two Ways to Use it

* `api fixture` - A fixture of **requests** for any tests
* `import requests` - Simply use the import statement to bring it into any file!

## Syntax

```python
def test_(api)

---or--- # just import it

# recommended
import requests
```

## Usage

{% code title="api fixture" %}

```python
def test_api_fixture(api):
    response = api.get(f"{BASE_URL}/api/cards")
```

{% endcode %}

{% code title="Recommended" %}

```python
import requests

response = requests.get(f"{BASE_URL}/api/cards")
```

{% endcode %}

## CRUD

Requests provides everything you need out of the box, but these are probably the actions you want :)

### GET

```python
requests.get()
```

### POST

```python
requests.post()
```

### DELETE

```python
requests.delete()
```

### PATCH

```python
requests.patch()
```

### PUT

```python
requests.put()
```


---

# 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.pylenium.io/fixtures/requests.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.