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.5.0.tar.gz (190.6 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.5.0-py3-none-any.whl (71.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: circuit_agent_sdk-2.5.0.tar.gz
  • Upload date:
  • Size: 190.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.7 {"installer":{"name":"uv","version":"0.11.7","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.5.0.tar.gz
Algorithm Hash digest
SHA256 51e76559bf2a2e7d7ea0a1ef57cb7fd3514befc3a6e5d80c68a65b0617045d99
MD5 ac8d5df51771c5816477b46ebdeeaad2
BLAKE2b-256 eb2cfef6e63c06670ca79093daac7e51eb001be9bfda4ad2caa16418f393ee26

See more details on using hashes here.

File details

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

File metadata

  • Download URL: circuit_agent_sdk-2.5.0-py3-none-any.whl
  • Upload date:
  • Size: 71.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.7 {"installer":{"name":"uv","version":"0.11.7","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.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 392d7f4ec520ea1ab0820130ba4b29041c38e0b4115d895e3c617af96c08bb9c
MD5 fd25810f35219df46f93a9ab40334c22
BLAKE2b-256 09e87a34dbd9817c45148c74ec3080ae067ddddc21274296f2c6447b8a6e0612

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