Skip to main content

Official Ucotron API client SDK for Python — auto-generated from OpenAPI.

Project description

ucotron-sdk

Official Python 3.9+ client for the Ucotron Core API.

Full quickstart, 5 use-case walkthroughs, and reference docs: https://docs.ucotron.com/sdks/python

Install

pip install ucotron-sdk
# or
uv add ucotron-sdk

Usage

import os
from ucotron_sdk import UcotronClient

ucotron = UcotronClient(api_key=os.environ["UCOTRON_API_KEY"])

# List plans
plans = ucotron.plans.list(limit=20)

# Generate a plan
plan = ucotron.plans.generate(interaction_id="int_123")

# Verify an incoming webhook signature
ok = UcotronClient.verify_webhook_signature(
    body=raw_body,                                     # bytes
    signature=request.headers["X-Ucotron-Signature"],  # str
    secret=os.environ["WEBHOOK_SECRET"],
)

Versioning

This package follows the API revision in openapi.yaml (info.version). A minor API bump triggers a minor SDK bump. PEP-440 pre-release tags (1.0.0a0) map to the semver alpha tags.

License

Apache-2.0.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ucotron_sdk-1.0.0.tar.gz (4.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ucotron_sdk-1.0.0-py3-none-any.whl (4.5 kB view details)

Uploaded Python 3

File details

Details for the file ucotron_sdk-1.0.0.tar.gz.

File metadata

  • Download URL: ucotron_sdk-1.0.0.tar.gz
  • Upload date:
  • Size: 4.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.9

File hashes

Hashes for ucotron_sdk-1.0.0.tar.gz
Algorithm Hash digest
SHA256 8cab2e7558ce488e51abb04298fd5706b33c61a099544524088919f0d9f9bb96
MD5 5ccbf32788140b00c0da96d0fa8a9f48
BLAKE2b-256 b0f321e6e234937b5448afcf43bcde42078600d49bf6ed432cdded52f1f841ed

See more details on using hashes here.

File details

Details for the file ucotron_sdk-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: ucotron_sdk-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 4.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.9

File hashes

Hashes for ucotron_sdk-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 18f1449990910d8202c28c564b161a59e7e5931a315fba30f10310f31483d1a0
MD5 a3cbf9ec5bb455165816e410e812e737
BLAKE2b-256 53e5e5b0283670af92c4c42a3a9bc959d38e2b48c9569738d3215ee235289824

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page