Asteroid Odyssey Python SDK
Python SDK for the Asteroid API.
Installation
pip install asteroid-odyssey
Usage
from asteroid_odyssey import ApiClient, Configuration, ExecutionApi, WorkflowsApi
config = Configuration(
host="https://odyssey.asteroid.ai",
api_key={"ApiKeyAuth": "your-api-key"}
)
client = ApiClient(config)
workflows_api = WorkflowsApi(client)
execution_api = ExecutionApi(client)
response = workflows_api.workflow_execute_post(
workflow_id="your-workflow-id",
workflows_workflow_execute_request={"inputs": {"input": "value"}}
)
print(f"Execution ID: {response.execution_id}")
execution = execution_api.execution_get(execution_id=response.execution_id)
print(f"Status: {execution.status}")
Migrating from the agent functions
A workflow is what you build and run. It used to be called an agent. A version is one immutable snapshot of a workflow. It used to be called a workflow. An agent is now the AI node inside a workflow.
The old methods still work and call the old /agents routes. They are marked deprecated and will be removed in a future major release. Move to the new methods:
| Old | New |
|---|---|
AgentsApi.agent_list |
WorkflowsApi.workflow_list |
AgentsApi.agent_create |
WorkflowsApi.workflow_create |
AgentsApi.available_tools_list |
WorkflowsApi.workflow_available_tools_list |
AgentsApi.agent_by_id_update |
WorkflowsApi.workflow_by_id_update |
AgentsApi.agent_by_id_delete |
WorkflowsApi.workflow_by_id_delete |
AgentsApi.agent_execute_post |
WorkflowsApi.workflow_execute_post |
AgentsApi.agent_execute_sync_post |
WorkflowsApi.workflow_execute_sync_post |
FilesApi.agent_workflow_head_get_files |
FilesApi.workflow_head_get_files |
FilesApi.agent_workflow_head_patch_files |
FilesApi.workflow_head_patch_files |
FilesApi.agent_workflow_head_publish_head |
FilesApi.workflow_head_publish |
WorkflowsApi.agent_workflows_list |
WorkflowVersionsApi.workflow_versions_list |
WorkflowsApi.agent_workflows_create |
WorkflowVersionsApi.workflow_versions_create |
WorkflowsApi.agent_workflows_validate |
WorkflowVersionsApi.workflow_versions_validate |
WorkflowsApi.agent_workflows_get |
WorkflowVersionsApi.workflow_versions_get |
WorkflowsApi.agent_workflows_delete_workflow |
WorkflowVersionsApi.workflow_versions_delete |
WorkflowsApi.agent_workflows_execute |
WorkflowVersionsApi.workflow_versions_execute |
WorkflowsApi.agent_workflows_get_files_by_version |
WorkflowVersionsApi.workflow_versions_get_files |
WorkflowsApi.agent_workflows_get_inputs |
WorkflowVersionsApi.workflow_versions_get_inputs |
WorkflowsApi.agent_workflows_get_output_schemas |
WorkflowVersionsApi.workflow_versions_get_output_schemas |
WorkflowsApi.agent_workflows_publish |
WorkflowVersionsApi.workflow_versions_publish |
Field names follow the same rule:
| Where | Old | New |
|---|---|---|
New /workflows routes |
agent_id |
workflow_id |
New /workflows routes |
version workflow_id |
version_id |
| Workflow detail | agent, workflow, versions_metadata |
workflow, version, versions |
| File tree | workflow_id, agent_name |
version_id, workflow_name |
| Execution, scheduled execution and batch responses | agent_id, agent_name |
workflow_id, workflow_name |
| Execution, scheduled execution and batch responses | workflow_id (the version) |
workflow_version_id |
On execution, scheduled execution and batch responses, workflow_id now holds the workflow ID, not the version ID. Read workflow_version_id for the version.
Documentation
See docs.asteroid.ai for full documentation.
1 maintainer
Metadata
1 maintainer
Release files for asteroid-odyssey 1.9.146
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| asteroid_odyssey-1.9.146.tar.gz | 180.7 kB | Without provenance | Details for asteroid_odyssey-1.9.146.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| asteroid_odyssey-1.9.146-py3-none-any.whl | Python 3 | none | any | Details for asteroid_odyssey-1.9.146-py3-none-any.whl |
Total release size: 731.5 kB
Release files / asteroid_odyssey-1.9.146.tar.gz
| Download URL | asteroid_odyssey-1.9.146.tar.gz |
|---|---|
| Size | 180.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e09cc79fbb485cb1920c5949ddbdf9099d7e15a0243d61c55f17534b603394be
|
|
BLAKE2b-256 checksum How to use checksums |
4775ce99eb12924aec1593837e9113854c8d319acf04f072e73226ff1f0f3c32
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.11.17
|
Release files / asteroid_odyssey-1.9.146-py3-none-any.whl
| Download URL | asteroid_odyssey-1.9.146-py3-none-any.whl |
|---|---|
| Size | 550.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
047a993eb99967cf15d5104045170e7e0bcc858280c7145fdba399b7fd5362d1
|
|
BLAKE2b-256 checksum How to use checksums |
75efcbd9e0bba351c02da80bb10b56429130bfc3ff35e5b0e1aaaedc9defe992
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.11.17
|
Security for asteroid-odyssey 1.9.146
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
