capturedit

Official Python SDK for the CapturedIt Context Hub API.

Install

pip install capturedit

Quick start

from capturedit import CapturedIt

client = CapturedIt(api_key="your_api_key")

# Search your library
results = client.search("machine learning")
for item in results.items:
    print(item.title)

# Get context for an AI prompt
context = client.get_context(q="project roadmap", format="text")

# Save a new item
result = client.create_item(
    "link",
    title="Interesting article",
    source_url="https://example.com/article",
)
print(f"Created item: {result.id}")

# Ask about a specific item
response = client.ask_about_item(result.id, question="Summarize this")
print(response.message)

Async usage

from capturedit import AsyncCapturedIt

async with AsyncCapturedIt(api_key="your_api_key") as client:
    results = await client.search("machine learning")
    for item in results.items:
        print(item.title)

Configuration

client = CapturedIt(
    api_key="your_api_key",
    base_url="https://api.capturedit.app",  # optional
    timeout=30.0,                            # optional, seconds
)

Methods

Webhook verification

from capturedit import verify_webhook_signature

is_valid = verify_webhook_signature(
    payload=request.body,
    header=request.headers["X-CapturedIt-Signature"],
    secret="your_webhook_secret",
)

Error handling

from capturedit import RateLimitError, AuthenticationError

try:
    results = client.search("query")
except RateLimitError as e:
    print(f"Retry after {e.retry_after} seconds")
except AuthenticationError:
    print("Invalid API key")

Requirements

• Python 3.10+
• CapturedIt API key (create at Dashboard → Security)
• All plans can use the API from the app surfaces; a Vault plan unlocks full integrator access (api_write) and the context endpoint. ask is available on all plans within your monthly quota.

Publishing (maintainers)

PyPI project name: capturedit.

1. First release (registers the project): from packages/sdk-python after tests:

   pip install build twine
   python -m build
   twine upload dist/*
   

   Use a PyPI API token with scope for this project.

2. Ongoing CI: In PyPI → Publishing → Add a trusted publisher → GitHub, point to this repository and workflow .github/workflows/publish-sdk-pypi.yml. Then use Actions → Publish capturedit to PyPI or push tag sdk-python/v0.1.0 (match pyproject.toml version).

3. Version bumps: Edit version in pyproject.toml before each release.