SPB Git

Repository Public

xai-lifecycles.json 5.6 KB 241 lines json

1[2 {3  "provider": "xai",4  "object": "video_generation_job",5  "api_family": "videos",6  "status_field": "status",7  "states": {8   "pending": "Job running. GET returns HTTP 202 with progress 0–99 (observed 1 → 87).",9   "done": "Terminal. HTTP 200; `video.url` (temporary), `video.duration`, `video.respect_moderation`, `model`, `usage.cost_in_usd_ticks`, progress 100. If respect_moderation=false the url is empty.",10   "failed": "Terminal. `error.code` ∈ invalid_argument | permission_denied | failed_precondition | service_unavailable | internal_error, `error.message`; progress/model/video omitted.",11   "expired": "Terminal. Result no longer retrievable (retention window elapsed; the docs do not state the window — the Batch API notes media URLs expire after 1 hour)."12  },13  "initial": "pending",14  "terminal": [15   "done",16   "failed",17   "expired"18  ],19  "transitions": [20   [21    "pending",22    "done"23   ],24   [25    "pending",26    "failed"27   ],28   [29    "pending",30    "expired"31   ],32   [33    "done",34    "expired"35   ]36  ],37  "http_status_by_state": {38   "pending": 202,39   "done": 200,40   "failed": "200 (documented as body-level failure; HTTP not observed)",41   "expired": "unobserved"42  },43  "timestamps": [],44  "polling": {45   "documented_interval": "SDK default 100 ms, examples use 5 s",46   "sdk_timeout_default": "10 min",47   "observed_completion": "1 s / 480p / grok-imagine-video → done in 11.4 s"48  },49  "status": [50   "DOCUMENTED",51   "LIVE_VERIFIED"52  ],53  "sources": [54   {55    "url": "https://docs.x.ai/developers/rest-api-reference/inference/videos",56    "retrieved_at": "2026-09-18"57   },58   {59    "url": "https://docs.x.ai/developers/model-capabilities/video/generation",60    "retrieved_at": "2026-09-18"61   }62  ],63  "last_verified": "2026-09-18"64 },65 {66  "provider": "xai",67  "object": "realtime.response",68  "api_family": "voice",69  "status_field": "response.status",70  "states": {71   "in_progress": "Emitted on response.created; deltas follow.",72   "completed": "Terminal (response.done).",73   "cancelled": "Terminal: interrupted by VAD barge-in or response.cancel.",74   "incomplete": "Terminal: cut short (max tokens / duration)."75  },76  "initial": "in_progress",77  "terminal": [78   "completed",79   "cancelled",80   "incomplete"81  ],82  "transitions": [83   [84    "in_progress",85    "completed"86   ],87   [88    "in_progress",89    "cancelled"90   ],91   [92    "in_progress",93    "incomplete"94   ]95  ],96  "status": [97   "DOCUMENTED",98   "LIVE_VERIFIED"99  ],100  "sources": [101   {102    "url": "https://docs.x.ai/voice-realtime.ws.json",103    "retrieved_at": "2026-09-18"104   }105  ],106  "last_verified": "2026-09-18"107 },108 {109  "provider": "xai",110  "object": "realtime.item",111  "api_family": "voice",112  "status_field": "item.status",113  "states": {114   "in_progress": "Assistant item being generated (response.output_item.added / conversation.item.added).",115   "completed": "Item finished (user items are created completed; assistant items on response.output_item.done)."116  },117  "initial": "in_progress (assistant) | completed (user)",118  "terminal": [119   "completed"120  ],121  "transitions": [122   [123    "in_progress",124    "completed"125   ]126  ],127  "status": [128   "LIVE_VERIFIED"129  ],130  "sources": [131   {132    "url": "https://docs.x.ai/voice-realtime.ws.json",133    "retrieved_at": "2026-09-18"134   },135   {136    "url": "tmp-live/xai-media/voice-ws-session.json",137    "retrieved_at": "2026-09-18"138   }139  ],140  "last_verified": "2026-09-18"141 },142 {143  "provider": "xai",144  "object": "stt_streaming_transcript",145  "api_family": "voice",146  "status_field": "transcript.partial flags (is_final, speech_final)",147  "states": {148   "interim": "is_final=false — text may change (only with interim_results=true).",149   "chunk_final": "is_final=true, speech_final=false — chunk locked (also the demoted state when smart_turn confidence is below threshold).",150   "utterance_final": "is_final=true, speech_final=true — speaker stopped (endpointing / smart_turn / finalize).",151   "done": "transcript.done after audio.done; connection closes."152  },153  "initial": "transcript.created (ready)",154  "terminal": [155   "done"156  ],157  "transitions": [158   [159    "interim",160    "chunk_final"161   ],162   [163    "chunk_final",164    "utterance_final"165   ],166   [167    "interim",168    "utterance_final"169   ],170   [171    "utterance_final",172    "done"173   ]174  ],175  "status": [176   "DOCUMENTED"177  ],178  "sources": [179   {180    "url": "https://docs.x.ai/stt-streaming.ws.json",181    "retrieved_at": "2026-09-18"182   },183   {184    "url": "https://docs.x.ai/developers/model-capabilities/audio/speech-to-text",185    "retrieved_at": "2026-09-18"186   }187  ],188  "last_verified": "2026-09-18"189 },190 {191  "provider": "xai",192  "object": "image_generation_call (Responses tool output)",193  "api_family": "responses",194  "status_field": "status",195  "states": {196   "in_progress": "Tool call accepted.",197   "generating": "Image being rendered.",198   "completed": "`result` holds bare base64 (JPEG/PNG by magic bytes).",199   "failed": "`result` null."200  },201  "initial": "in_progress",202  "terminal": [203   "completed",204   "failed"205  ],206  "transitions": [207   [208    "in_progress",209    "generating"210   ],211   [212    "generating",213    "completed"214   ],215   [216    "generating",217    "failed"218   ],219   [220    "in_progress",221    "failed"222   ]223  ],224  "status": [225   "DOCUMENTED"226  ],227  "sources": [228   {229    "url": "https://docs.x.ai/openapi.json (local copy sources/xai/openapi/openapi.json)",230    "retrieved_at": "2026-09-18"231   },232   {233    "url": "https://docs.x.ai/developers/tools/image-generation",234    "retrieved_at": "2026-09-18"235   }236  ],237  "notes": "Documented by the tools agent (docs/tools); listed here for the status machine only.",238  "last_verified": "2026-09-18"239 }240]241
Files main
Menu

Theme