retrieve_workflow
Retrieve complete workflow data including status, results, and metadata in a single API call for molecular design and simulation workflows.
Instructions
Retrieve complete workflow data including status, results, and metadata.
This is THE primary function for getting workflow information in a single API call. Returns all available workflow data including:
Status information (status_code, is_finished, is_successful, is_failed, is_running)
Results data (in 'data' field when workflow is complete)
Metadata (name, timestamps, credits, notes, etc.)
Args: uuid: UUID of the workflow to retrieve
Returns: Dictionary with complete workflow data
Example: >>> # Check status and get results in one call >>> workflow = retrieve_workflow("workflow-uuid-here") >>> >>> if workflow["is_finished"]: ... if workflow["is_successful"]: ... results = workflow["data"] ... print(f"Success! Results: {results}") ... print(f"Credits used: {workflow['credits_charged']}") ... elif workflow["is_failed"]: ... print(f"Failed: {workflow['status_description']}") >>> else: ... print(f"Still running: {workflow['status_description']}") >>> >>> # Poll for completion >>> import time >>> while not workflow["is_finished"]: ... time.sleep(60) # Wait 1 minute ... workflow = retrieve_workflow(uuid)
Raises: ValueError: If workflow UUID is invalid or workflow not found RuntimeError: If API authentication fails or other API errors occur
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| uuid | Yes | UUID of the workflow to retrieve |