Skip to main content
GET
Get a scene task
GET /v1/scenes/{task_id} returns the current state of a task started by Create Scene, Create Scene from Custom Panorama, Generate Scene Views, or Reconstruct Scene — the same Scene Task object the submission answered with. Poll every 5 seconds until status is ready, failed, or cancelled, then download the files under result. Tasks belong to your account — your organization, or your user when the key has no organization — so any API key of the same account can read them. An unknown ID, or one from another account, answers 404 INVALID_REQUEST.

Request parameters

Response parameters

Returns 200 OK with a Scene Task object. Field names are camelCase.

Result

Every url Viggle signs is valid for 3 hours. Fetch the task again for fresh ones.

Output batch

A batch is a set of posed images in one session. Its batchId is what you pass in referenceBatchIds to generate more views or reconstruct the scene. kind and views can be missing on tasks that finished before they were introduced; manifest is always there.

Ready example

A pano task. Signature query parameters shortened:

Failed example

Status and errors

error.code on a failed task: HTTP errors from this endpoint: These use the same error object as a failed task’s error, wrapped as {"error": {...}}. See Errors and recovery.

Retention

  • A task can be read for about 72 hours after it finishes; after that this endpoint answers 404. Download what you need, or have Viggle upload it straight to your storage with outputUris.
  • Signed URLs last 3 hours each; fetch the task again for fresh ones while it is still readable.

Examples

Quick Start: Scene Model

Build a scene, generate new views, and reconstruct it, end to end.

Authorizations

Authorization
string
header
required

Server-side SDK clients use a project API key. Remote MCP clients use an OAuth access token. Never expose a project API key in browser code.

Headers

X-Request-Id
string

Optional caller-supplied correlation ID, up to 128 characters. The service returns the effective value in the response header for tracing and support.

Required string length: 1 - 128
X-Viggle-Source
string

Optional source-channel label, up to 128 characters, used to attribute traffic to an SDK, integration, product surface, or internal workflow.

Required string length: 1 - 128

Path Parameters

task_id
string
required

Scene task ID (scn_ prefix, scn_{runId}.{sessionId}) returned by a /v1/scenes submission. It must belong to the caller's account.

Minimum string length: 1

Response

Current scene task state.

A scene task (scn_ prefix), returned by every /v1/scenes submission and by GET /v1/scenes/{task_id}. ready, failed, and cancelled are terminal. A task stays readable for about 72 hours after it finishes.

id
string
required

Task ID, scn_{runId}.{sessionId}.

sessionId
string
required
operation
enum<string>
required

A custom-pano task reports pano.

Available options:
pano,
generate,
reconstruct
status
enum<string>
required
Available options:
processing,
ready,
failed,
cancelled
createdAt
integer<int64> | null
required

Start time, Unix milliseconds.

completedAt
integer<int64> | null
required

End time, Unix milliseconds; null while processing.

result
object | null
required

Set only when ready.

error
object | null
required

Set only when failed. code is INVALID_REQUEST (not retryable — the model rejected the input, such as a batch from another session) or PROCESSING_FAILED (retryable).