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.0.1.tar.gz (314.4 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.0.1-py3-none-any.whl (69.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: circuit_agent_sdk-2.0.1.tar.gz
  • Upload date:
  • Size: 314.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.3 {"installer":{"name":"uv","version":"0.11.3","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.0.1.tar.gz
Algorithm Hash digest
SHA256 847938f2d89d0887c792e831450756489034778269aec40d2aadd933679946ce
MD5 2c480afac11385e54c83a8e374914c36
BLAKE2b-256 01daaa07644ed325b25a77be1e2e964bc44263b2eb699b17665fc4f0d6f64b9f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: circuit_agent_sdk-2.0.1-py3-none-any.whl
  • Upload date:
  • Size: 69.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.3 {"installer":{"name":"uv","version":"0.11.3","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.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 eae0130041bafc323886dc899dfa66bb72b568e2357482205e5945adf9626caf
MD5 ea42ae3072c8ab529a11365402d2f54c
BLAKE2b-256 435e407577c9f2680ec26ff02a80d7bb1982070762c94f5a5b77bd626cdd88cf

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