poll_rodin_job_status
Check completion status of Hyper3D Rodin 3D model generation tasks in Blender, using subscription keys or request IDs to monitor progress until final determination.
Instructions
Check if the Hyper3D Rodin generation task is completed.
For Hyper3D Rodin mode MAIN_SITE:
Parameters:
- subscription_key: The subscription_key given in the generate model step.
Returns a list of status. The task is done if all status are "Done".
If "Failed" showed up, the generating process failed.
This is a polling API, so only proceed if the status are finally determined ("Done" or "Canceled").
For Hyper3D Rodin mode FAL_AI:
Parameters:
- request_id: The request_id given in the generate model step.
Returns the generation task status. The task is done if status is "COMPLETED".
The task is in progress if status is "IN_PROGRESS".
If status other than "COMPLETED", "IN_PROGRESS", "IN_QUEUE" showed up, the generating process might be failed.
This is a polling API, so only proceed if the status are finally determined ("COMPLETED" or some failed state).Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| subscription_key | No | ||
| request_id | No |
Implementation Reference
- src/blender_mcp/server.py:803-845 (handler)The main handler function for the 'poll_rodin_job_status' MCP tool. It forwards the polling request to the Blender addon via socket command, using either a subscription_key (MAIN_SITE mode) or request_id (FAL_AI mode). Includes input validation via parameters and comprehensive docstring describing usage for both modes. The @mcp.tool() decorator registers it with the FastMCP server.
@mcp.tool() def poll_rodin_job_status( ctx: Context, subscription_key: str=None, request_id: str=None, ): """ Check if the Hyper3D Rodin generation task is completed. For Hyper3D Rodin mode MAIN_SITE: Parameters: - subscription_key: The subscription_key given in the generate model step. Returns a list of status. The task is done if all status are "Done". If "Failed" showed up, the generating process failed. This is a polling API, so only proceed if the status are finally determined ("Done" or "Canceled"). For Hyper3D Rodin mode FAL_AI: Parameters: - request_id: The request_id given in the generate model step. Returns the generation task status. The task is done if status is "COMPLETED". The task is in progress if status is "IN_PROGRESS". If status other than "COMPLETED", "IN_PROGRESS", "IN_QUEUE" showed up, the generating process might be failed. This is a polling API, so only proceed if the status are finally determined ("COMPLETED" or some failed state). """ try: blender = get_blender_connection() kwargs = {} if subscription_key: kwargs = { "subscription_key": subscription_key, } elif request_id: kwargs = { "request_id": request_id, } result = blender.send_command("poll_rodin_job_status", kwargs) return result except Exception as e: logger.error(f"Error generating Hyper3D task: {str(e)}") return f"Error generating Hyper3D task: {str(e)}" - src/blender_mcp/server.py:804-808 (schema)Function signature providing type hints and default values for tool parameters: subscription_key (str, optional for MAIN_SITE mode) and request_id (str, optional for FAL_AI mode). The docstring provides detailed input/output schema description.
def poll_rodin_job_status( ctx: Context, subscription_key: str=None, request_id: str=None, ): - src/blender_mcp/server.py:917-920 (helper)Usage instruction in the asset_creation_strategy prompt, guiding when and how to use the poll_rodin_job_status tool as part of the Hyper3D generation workflow.
2. Poll the status - Use poll_rodin_job_status() to check if the generation task has completed or failed 3. Import the asset - Use import_generated_asset() to import the generated GLB model the asset - src/blender_mcp/server.py:803-803 (registration)The @mcp.tool() decorator registers the poll_rodin_job_status function as an MCP tool with the FastMCP server instance.
@mcp.tool()