Skip to main content

Userintuition Python Library

fern shield pypi

The Userintuition Python library provides convenient access to the Userintuition APIs from Python.

Table of Contents

Installation

pip install userintuition

Reference

A full reference for this library is available here.

Usage

Instantiate and use the client with the following:

from userintuition import UserIntuitionClient

client = UserIntuitionClient(
    token="<token>",
)

client.public_studies.create_study(
    name="Recent appliance purchases",
    study_type="in-depth-interview",
    recruiting_method="byop",
)

Environments

This SDK allows you to configure different environments for API requests.

from userintuition import UserIntuitionClient
from userintuition.environment import UserIntuitionClientEnvironment

client = UserIntuitionClient(
    environment=UserIntuitionClientEnvironment.PRODUCTION,
)

Async Client

The SDK also exports an async client so that you can make non-blocking calls to our API. Note that if you are constructing an Async httpx client class to pass into this client, use httpx.AsyncClient() instead of httpx.Client() (e.g. for the httpx_client parameter of this client).

import asyncio

from userintuition import AsyncUserIntuitionClient

client = AsyncUserIntuitionClient(
    token="<token>",
)


async def main() -> None:
    await client.public_studies.create_study(
        name="Recent appliance purchases",
        study_type="in-depth-interview",
        recruiting_method="byop",
    )


asyncio.run(main())

Exception Handling

When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error will be thrown.

from userintuition.core.api_error import ApiError

try:
    client.public_studies.create_study(...)
except ApiError as e:
    print(e.status_code)
    print(e.body)

Advanced

Access Raw Response Data

The SDK provides access to raw response data, including headers, through the .with_raw_response property. The .with_raw_response property returns a "raw" client that can be used to access the .headers and .data attributes.

from userintuition import UserIntuitionClient

client = UserIntuitionClient(...)
response = client.public_studies.with_raw_response.create_study(...)
print(response.headers)  # access the response headers
print(response.status_code)  # access the response status code
print(response.data)  # access the underlying object

Retries

The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long as the request is deemed retryable and the number of retry attempts has not grown larger than the configured retry limit (default: 2).

Which status codes are retried depends on the retryStatusCodes generator configuration:

legacy (current default): retries on

  • 408 (Timeout)
  • 409 (Conflict)
  • 429 (Too Many Requests)
  • 5XX (All server errors, including 500)

recommended: retries on

  • 408 (Timeout)
  • 409 (Conflict)
  • 429 (Too Many Requests)
  • 502 (Bad Gateway)
  • 503 (Service Unavailable)
  • 504 (Gateway Timeout)

Use the max_retries request option to configure this behavior.

client.public_studies.create_study(..., request_options={
    "max_retries": 1
})

Timeouts

The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level.

from userintuition import UserIntuitionClient

client = UserIntuitionClient(..., timeout=20.0)

# Override timeout for a specific method
client.public_studies.create_study(..., request_options={
    "timeout": 1
})

Custom Client

You can override the httpx client to customize it for your use-case. Some common use-cases include support for proxies and transports.

import httpx
from userintuition import UserIntuitionClient

client = UserIntuitionClient(
    ...,
    httpx_client=httpx.Client(
        proxy="http://my.test.proxy.example.com",
        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
    ),
)

Contributing

While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!

On the other hand, contributions to the README are always very welcome!

Metadata

Release files for userintuition 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for userintuition 0.1.1
File Size Uploaded Provenance Actions
userintuition-0.1.1.tar.gz 115.8 kB With provenance Details for userintuition-0.1.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for userintuition 0.1.1
File Interpreter ABI Platform Actions
userintuition-0.1.1-py3-none-any.whl Python 3 none any Details for userintuition-0.1.1-py3-none-any.whl

Total release size: 358.3 kB

Release files / userintuition-0.1.1.tar.gz

Download URL userintuition-0.1.1.tar.gz
Size 115.8 kB
Tags Source
SHA-256 checksum
How to use checksums
fe3a7d5ee85c11ed7809e24f62e9d8061210d1237e7cf545283f0397c0c26d86
BLAKE2b-256 checksum
How to use checksums
dc5cba8cf58986180f59f427927753eb4fb5a467e636889a16f38e0913901b12
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 Oct 8, 2026.

Transparency log

Release files / userintuition-0.1.1-py3-none-any.whl

Download URL userintuition-0.1.1-py3-none-any.whl
Size 242.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a0f1e7c01163b05e7c9788b1178dc47c25299d2e7bb2086d4f29797b65f1430b
BLAKE2b-256 checksum
How to use checksums
4838c4de76a5906c745c37dd61d2567fdf3266d63826dcc3f37a7f1f38dfeab8
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 Oct 8, 2026.

Transparency log

Security for userintuition 0.1.1

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.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for userintuition-0.1.1.tar.gz

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 Oct 8, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page