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

idstring required
Example:85d535ac-219e-4fde-b527-488ed1157bb2

The public API job ID.

Response

Job state and result payload.

jobIdstring required
offeringId'video_production' | 'clip_analysis_upload' | 'clip_render' | 'snack_generation' | 'ai_story_generation' | 'carousel_generation' | 'slides_generation' | 'carousel_v2_batch' required
namestring nullable
status'queued' | 'processing' | 'awaiting_selection' | 'completed' | 'failed' | 'cancelled' required
progressinteger required
projectIdstring nullable
clipJobIdstring nullable
parentJobIdstring nullable
instanceIdstring nullable
creditsReservedinteger nullable
creditsFinalinteger nullable
errorstring nullable
resultobject required
createdAtstring nullable
updatedAtstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.