Skip to main content

Official Python SDK for building and deploying agents on the Circuit platform

Project description

Circuit Agent SDK - Python

Official Python SDK for building and deploying agents on the Circuit platform.

See the full documentation at docs.circuit.org.

Internal Environment Variables

These variables are supported for internal development and deployed runtime wiring. They are intentionally not documented on the public docs site.

Variable Purpose Default
CIRCUIT_AGENT_API_URL Override the Agent API URL for non-deployed SDK requests. Required alongside CIRCUIT_API_URL when targeting staging with circuit run (e.g. https://agents.staging.circuit.org). https://agents.circuit.org
CIRCUIT_AUTH_FILE Override the auth filename used for local filesystem auth lookup unset
CIRCUIT_DEV_API_KEY Add an X-API-Key header for local development unset
CIRCUIT_DEPLOYED Auto-set for deployed agents to force internal VPC routing unset
CIRCUIT_AGENT_SLUG Auto-set for deployed agents and sent as X-Agent-Slug unset

Base URL resolution order:

  1. config.base_url
  2. CIRCUIT_DEPLOYED=true or Lambda runtime detection, which routes to http://transaction-service.agent.internal
  3. CIRCUIT_AGENT_API_URL
  4. https://agents.circuit.org

Filesystem auth filename resolution order:

  1. CIRCUIT_AUTH_FILE
  2. auth-local.json when CIRCUIT_AGENT_API_URL or CIRCUIT_API_URL contains localhost or 127.0.0.1
  3. auth-production.json

The SDK checks ~/.config/circuit/<filename> first, then ~/.circuit/<filename>.

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

circuit_agent_sdk-2.4.0.tar.gz (198.9 kB view details)

Uploaded Source

Built Distribution

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

circuit_agent_sdk-2.4.0-py3-none-any.whl (69.3 kB view details)

Uploaded Python 3

File details

Details for the file circuit_agent_sdk-2.4.0.tar.gz.

File metadata

  • Download URL: circuit_agent_sdk-2.4.0.tar.gz
  • Upload date:
  • Size: 198.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.6 {"installer":{"name":"uv","version":"0.11.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for circuit_agent_sdk-2.4.0.tar.gz
Algorithm Hash digest
SHA256 7c2e12420a17515a07466611ca5c2e4ecc96d2f360f4654a2fa79a813123b242
MD5 aa944afdda4de37bb91b2a7f23c0d536
BLAKE2b-256 b27305add4c2fcce098696995567afe2f8e1e292a4a8bebc099b757f7268990d

See more details on using hashes here.

File details

Details for the file circuit_agent_sdk-2.4.0-py3-none-any.whl.

File metadata

  • Download URL: circuit_agent_sdk-2.4.0-py3-none-any.whl
  • Upload date:
  • Size: 69.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.6 {"installer":{"name":"uv","version":"0.11.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for circuit_agent_sdk-2.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5818fb129972e8fe933d16b07210031a0357faa0c259650df719f3f0e6c9a347
MD5 2a3c986cbdcecc24442381b78ca15a56
BLAKE2b-256 2197d67ad001567ecb52961f5540afe425028e018e26d7ed91ddc302a2c3ee4b

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