Skip to main content
GET
Query 3D Task Status

Get Task Status

Query the execution status of 3D generation tasks and retrieve generated model files when complete.

Endpoint

Authentication

All requests require Bearer token authentication:

Parameters

Path Parameters

Response

Success Response (200)

Response Fields

Status Values

Code Example

Important Notes

Content Validity: Generated 3D files are accessible for 3 days after creation. Download and save your content promptly.
Webhooks: Instead of polling, you can provide a callback_url when submitting tasks to receive automatic notifications. See 3D Webhook Callbacks.

Authorizations

Authorization
string
header
required

All API endpoints require Bearer Token authentication.

Create an API key: sign in to PoYo, open Dashboard → API Key at poyo.ai/dashboard/api-key, and click to create a key.

Add it to the request header:

Path Parameters

task_id
string
required

Unique task identifier returned from the submit endpoint

Response

200 - application/json

Task status

code
enum<integer>
required

Business status code. 200 means success; any other value means the request failed. Always check this field: some validation errors return HTTP 200 with code: 400 in the body.

  • 200: Success
  • 400: Invalid request parameters
  • 401: Missing or invalid API key
  • 402: Insufficient credits
  • 403: Permission denied
  • 404: Resource not found
  • 408: Request timeout
  • 429: Rate limit exceeded
  • 500: Internal server error
  • 502: Upstream service error
  • 503: Service unavailable

See Error Codes for details.

Available options:
200,
400,
401,
402,
403,
404,
408,
429,
500,
502,
503
Example:

200

data
object
required
Example: