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/agents/v2",
    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.8.149

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.8.149
File	Size	Uploaded
asteroid_odyssey-1.8.149.tar.gz	213.5 kB	Oct 5, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for asteroid-odyssey 1.8.149
File	Interpreter	ABI	Platform	Reset
asteroid_odyssey-1.8.149-py3-none-any.whl 675.8 kB Oct 5, 2026	Python 3	none	any	Details

Total release size: 889.3 kB

Release files / asteroid_odyssey-1.8.149.tar.gz

Download URL	asteroid_odyssey-1.8.149.tar.gz
Size	213.5 kB
Tags	Source
SHA-256 checksum How to use checksums	`0df1028ffe2adb10c361573c0552efe1cb89bf0d8976525f710d7d1397797a47`
BLAKE2b-256 checksum How to use checksums	`def58ba7065fd8c2b98d5f46f25f4e37461eeca07f4530dbf5652ae60a3faef9`
Upload date	Oct 5, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.11.16`

Release files / asteroid_odyssey-1.8.149-py3-none-any.whl

Download URL	asteroid_odyssey-1.8.149-py3-none-any.whl
Size	675.8 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`2df5caa999affffbbace5146911e540c48b9a32dd72d454316729121f9632427`
BLAKE2b-256 checksum How to use checksums	`eb1a4919fbbb6f1d184d3cf90b412ea68bbf5907952dba367e9b058605508512`
Upload date	Oct 5, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.11.16`