get_task
Retrieve the status and result of an AI generation task. Get the image URL once processing is complete.
Instructions
Get the status and result of a generation task. Returns image URL when completed.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| task_id | Yes | Task UUID returned from generate_image |
Implementation Reference
- sdk/vape_client/models.py:198-223 (schema)TaskResult data model used by the SDK client's get_task method to parse API responses.
class TaskResult: """Result of task status query.""" task_id: str status: str task_type: Optional[str] = None result_url: Optional[str] = None cost: float = 0.0 created_at: Optional[str] = None completed_at: Optional[str] = None error: Optional[str] = None metadata: Optional[Dict[str, Any]] = None @classmethod def from_response(cls, data: dict) -> "TaskResult": """Create from API response.""" return cls( task_id=data.get("task_id", ""), status=data.get("status", "unknown"), task_type=data.get("task_type") or data.get("type"), result_url=data.get("result_url") or data.get("image_url") or data.get("video_url") or data.get("audio_url"), cost=data.get("cost", 0.0), created_at=data.get("created_at"), completed_at=data.get("completed_at"), error=data.get("error"), metadata=data.get("metadata"), ) - sdk/vape_client/client.py:371-397 (handler)SDK client's synchronous get_task method that makes a GET request to /v3/tasks/{task_id} and returns a TaskResult.
duration: Target duration in seconds (30-480, default 120) instrumental: Generate without vocals loudness_preset: Normalization (streaming, apple, broadcast) audio_format: Output format (mp3 or wav) Returns: MusicResult with task_id for async tracking. Cost: $0.68 """ payload = { "type": "music_generation", "params": { "description": prompt, "duration": duration, "instrumental": instrumental, "loudness_preset": loudness_preset, "audio_format": audio_format, } } data = self._request("POST", "/v3/tasks", json=payload) return MusicResult.from_response(data) # ============================================ # Task Management # ============================================ def get_task(self, task_id: str) -> TaskResult: