Skip to main content

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.

Metadata

Release files for asteroid-odyssey 1.9.99

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for asteroid-odyssey 1.9.99
File Size Uploaded Provenance
asteroid_odyssey-1.9.99.tar.gz 178.3 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for asteroid-odyssey 1.9.99
File Interpreter ABI Platform
asteroid_odyssey-1.9.99-py3-none-any.whl Python 3 none any Details

Total release size: 725.6 kB

Release files / asteroid_odyssey-1.9.99.tar.gz

Download URL asteroid_odyssey-1.9.99.tar.gz
Size 178.3 kB
Tags Source
SHA-256 checksum
How to use checksums
68e8a1e4193a854e4202dde951ffd5092ac8884dab5661c9fcef26a41e7de3a8
BLAKE2b-256 checksum
How to use checksums
43a3c034aa4929300d417d7521c10e68c3e32bbf56bab0fada781c66d1ad79a2
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.99-py3-none-any.whl

Download URL asteroid_odyssey-1.9.99-py3-none-any.whl
Size 547.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
cba9c7ba83a6c2dbf8fa822b30f4a3e9199878929049397d4fdb0e22a74bbcbb
BLAKE2b-256 checksum
How to use checksums
6dd312c9f51d70be17318ff9310225d97d83f63a305f6ec1c7ef9e891793477a
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.99

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.

Release history Release notifications | RSS feed

This release

1.9.99 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page