spotted

library0.31.1pypypi✓ verified 89d ago

The official Python library for the Spotted API, providing a typed interface for programmatic access. Current version 0.31.1, with frequent releases reflecting active development.

http-networking

pip install spotted

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · SPOTTED

spotted

http-networkingpythonv0.31.1

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

Spotted

✓ from spotted import Spotted

✗ from spotted.client import Spotted

The client is exported directly from the root package.

spotted

✓ import spotted

✗ from spotted import spotted

The top-level module is `spotted`, not a named export.

Initialize the client with an API key from environment variable and list available models.

from spotted import Spotted client = Spotted(api_key=os.environ.get('SPOTTED_API_KEY', '')) models = client.models.list() print(models)

Debug

Known issues

breakingThe client class was renamed from `SpottedAPI` to `Spotted` in an early version. Using the old name will raise an ImportError.

fix

Use `from spotted import Spotted` instead of `from spotted import SpottedAPI`.

affects: <0.1.0?

gotchaFile uploads require multi-part form data; ensure file paths are sent as a single parameter, not spread across multiple values. Bug fixed in 0.30.2.

fix

Upgrade to >=0.30.2 or ensure file data is passed as a single tuple/list.

affects: <0.30.2

deprecatedSetting custom headers via constructor kwargs is deprecated in favor of environment variables. Support added in 0.31.0.

fix

Set headers via environment variables (e.g., `MY_HEADER=value`) or use the `default_headers` parameter in the client.

affects: >=0.31.0

Errors

Common errors & fixes

ImportError: cannot import name 'SpottedAPI' from 'spotted'

The client class was renamed from SpottedAPI to Spotted.

fix

Use `from spotted import Spotted`.

Error: file data must be sent as a single parameter

Multiple file arguments were incorrectly passed as separate parameters instead of a single list.

fix

Pass files as `files=[('file', open('photo.jpg', 'rb'))]` or upgrade to >=0.30.2.

TypeError: 'by_alias' is an invalid keyword argument

Pydantic version mismatch; a bug in 0.29.1 passed `by_alias` without checking if set.

fix

Upgrade to >=0.29.2 or ensure compatible pydantic version.

Upgrade

Version history

0.31.1latest on PyPI · released May 9, 2026

Audit

Dependencies

typing-extensionsrequiredRequired for type hints; minimum version enforced in 0.29.2

pydanticoptionalUsed for model serialization; known bug with by_alias in 0.29.1

Agent activity

14 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/cjavdev/spotted-py ↗

packagehttps://pypi.org/project/spotted/ ↗

homepagehttps://spotted.com ↗