profound
This library provides convenient access to the profound REST API from Python.
The full API of this library can be found in api.md.
Contents
- Installation
- Usage
- API Reference
- Async
- Streaming
- Authentication
- Errors
- Client Options
- Retries and Timeouts
- Helpers
- Logging
- Requirements
Installation
pip install profound
Usage
import os
from profound import Profound
client = Profound(
api_key=os.environ.get("PROFOUND_API_KEY"),
)
category = client.organizations.categories.list()
print(category)
The examples in the following sections assume a client configured as shown above.
See the API reference for every available operation.
Async
Every client has an Async counterpart (AsyncProfound) exposing the same resource tree with await.
import asyncio
from profound import AsyncProfound
async def main() -> None:
client = AsyncProfound()
category = await client.organizations.categories.list()
asyncio.run(main())
Streaming
Streaming endpoints return an async iterator that yields results as the server emits them.
stream = client.prompts.stream_answers_v2(
category_id="7c9e6679-7425-40de-944b-e07fc1f90ae7",
start_date="",
end_date="",
)
for event in stream:
print(event)
Authentication
Pass credentials to the generated client constructor. Environment variables are read automatically when supported by the target runtime.
| Option | Type | Default | Description |
|---|---|---|---|
api_key |
string | provider |
- | Credential for the APIKeyHeader scheme. Defaults to PROFOUND_API_KEY. |
access_token |
string | provider |
- | Credential for the BearerAuth scheme. Defaults to PROFOUND_ACCESS_TOKEN. |
Declared schemes:
APIKeyHeaderAPI key in headerX-API-KeyBearerAuthbearer token
Errors
Non-success responses throw generated API errors. Error objects expose status, headers, response body, and request metadata where the target runtime supports it.
from profound import APIStatusError
try:
category = client.organizations.categories.list()
except APIStatusError as err:
print(err.status_code, err.message)
raise
Documented error statuses: 422.
Client Options
Configure the generated client by setting any of these options when you create it.
from profound import Profound
client = Profound(
timeout=60.0,
max_retries=2,
)
| Option | Type | Default | Description |
|---|---|---|---|
api_key |
str | None |
os.environ.get("PROFOUND_API_KEY") |
Credential for the APIKeyHeader scheme. |
access_token |
str | None |
os.environ.get("PROFOUND_ACCESS_TOKEN") |
Credential for the BearerAuth scheme. |
base_url |
str | httpx.URL | None |
- | Override the default API base URL. |
timeout |
float | Timeout | None |
60.0 |
Maximum time in seconds to wait for a response before aborting a request. |
max_retries |
int |
2 |
Number of retries for temporary failures. |
default_headers |
Mapping[str, str] | None |
- | Headers sent with every request. |
default_query |
Mapping[str, object] | None |
- | Query parameters sent with every request. |
Retries and Timeouts
Generated clients support request timeouts and retry temporary failures such as network errors, 408, 409, 429, and 5xx responses. Retry delays honor Retry-After headers when present. Tune the retry and timeout client options shown above, or override them per request.
Helpers
- Use
client.with_raw_response.<resource>.<method>(...)to access the rawhttpx.Responseand parse it yourself. - Use
client.with_streaming_response.<resource>.<method>(...)to stream a response body without buffering it.
Logging
- Set the
PROFOUND_LOGenvironment variable toinfoordebugto enable HTTP logging. - Logs are emitted through the standard
loggingmodule under theprofoundlogger.
Requirements
- Python 3.8 or newer
Powered by Scalar.
Release files for profound 0.58.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| profound-0.58.1.tar.gz | 260.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| profound-0.58.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 627.8 kB
Release files / profound-0.58.1.tar.gz
| Download URL | profound-0.58.1.tar.gz |
|---|---|
| Size | 260.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
bce282c490d7e5305f5fcd0ad81606eb377d707de4f84a77de1b43581fc99181
|
|
BLAKE2b-256 checksum How to use checksums |
a55f94ecef17478756c736574dcaf50e670510583e7269d44156f6436bef108a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 28, 2026.
Transparency logRelease files / profound-0.58.1-py3-none-any.whl
| Download URL | profound-0.58.1-py3-none-any.whl |
|---|---|
| Size | 367.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d28969f676bb584e5cc3ad9c0dd8d63e3e00f13fd1a85aae29015b47d0071715
|
|
BLAKE2b-256 checksum How to use checksums |
14c5780192b90298e25d2c46fcc91f7a2f0015d95a1f3bb73bca4680d8fba6d2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 28, 2026.
Transparency log
