The AgentOrbit Python SDK provides convenient access to the AgentOrbit REST API from any Python 3.8+ application. The SDK includes rich type definitions and enables receiving real-time executions via WebSockets.
Full documentation of the SDK is available at https://AgentOrbit.ai/docs/sdk/introduction. You may also want to check out the REST API Reference.
You can install the SDK via pip:
pip install AgentOrbitOnce installed, you can use it to make requests.
import AgentOrbit
AgentOrbit.api_key = "YOUR_API_KEY"
agent = AgentOrbit.Agent.create(
name="My Agent",
script="def main(request, store):\n return request.payload",
requirements="requests==2.31.0\npandas==2.1.4",
env_vars="FOO=bar\nBAZ=qux",
python_version="3.11",
store_id="b553e996-6556-42dd-8990-ddb7ef2142f6",
)import AgentOrbit
AgentOrbit.api_key = "YOUR_API_KEY"
agent = AgentOrbit.Agent.retrieve(id="15d19ca3-26f1-4adb-9cea-3955b73d9b4e")
execution = agent.execute(payload={"key": "value"})import AgentOrbit
AgentOrbit.api_key = "YOUR_API_KEY"
cron_job = AgentOrbit.AgentExecutorCronJob.create(
agent_id="15d19ca3-26f1-4adb-9cea-3955b73d9b4e",
name="My cron job",
expression="* * * * *",
)import AgentOrbit
AgentOrbit.api_key = "YOUR_API_KEY"
cron_job = AgentOrbit.AgentExecutorCronJob.retrieve(id="f3384d13-7a32-4abe-9c10-964ca17413b7")
for execution in cron_job.stream():
# Every time a new execution is created, it will be printed.
print(execution)These are only a few examples of what you can do with the SDK. Refer to the full documentation to learn more about the SDK.
