---
title: "Poll a job"
method: GET
path: "/api/v1/jobs/{id}"
tags: ["Jobs"]
---

# Poll a job

`GET /api/v1/jobs/{id}`

## Request

- Base URL: `https://www.vidguy.ai`
- URL: `https://www.vidguy.ai/api/v1/jobs/{id}`
- Auth: HTTP bearer

## Path parameters

- `id` string, required

## Response `200`

Job state and result payload.

- GetApiJobResponse
  - `jobId` string, required
  - `offeringId` 'video_production' | 'clip_analysis_upload' | 'clip_render' | 'snack_generation' | 'ai_story_generation' | 'carousel_generation' | 'slides_generation' | 'carousel_v2_batch', required
  - `name` string, nullable
  - `status` 'queued' | 'processing' | 'awaiting_selection' | 'completed' | 'failed' | 'cancelled', required
  - `progress` integer, required
  - `projectId` string, nullable
  - `clipJobId` string, nullable
  - `parentJobId` string, nullable
  - `instanceId` string, nullable
  - `creditsReserved` integer, nullable
  - `creditsFinal` integer, nullable
  - `error` string, nullable
  - `result` object, required
  - `createdAt` string, nullable
  - `updatedAt` string, nullable

## Other responses

- `401`: Missing or invalid API key.
- `404`: Job not found.

---

[API](https://skmtc.dev/vidguy/apis/vidguy-snacks-api.md) · [All operations](https://skmtc.dev/vidguy/apis/vidguy-snacks-api/llms.txt) · [OpenAPI document](https://skmtc.dev/vidguy/apis/vidguy-snacks-api/revisions/ad6855539a1a?raw)