VEED Fabric 1.0 API Documentation

VEED Fabric 1.0 API check status - Request Code

POST https://gateway.pixazo.ai/veed-fabric-1-0-api-130/v1/veed-fabric-1-0-api-request-result HTTP/1.1 Content-Type: application/json Cache-Control: no-cache Ocp-Apim-Subscription-Key: YOUR_SUBSCRIPTION_KEY { "request_id": "a1b2c3d4-e5f6-7890-g1h2-i3j4k5l6m7n8" }
import requests url = "https://gateway.pixazo.ai/veed-fabric-1-0-api-130/v1/veed-fabric-1-0-api-request-result" headers = { "Content-Type": "application/json", "Cache-Control": "no-cache", "Ocp-Apim-Subscription-Key": "YOUR_SUBSCRIPTION_KEY" } data = { "request_id": "a1b2c3d4-e5f6-7890-g1h2-i3j4k5l6m7n8" } response = requests.post(url, json=data, headers=headers) print(response.json())
const url = 'https://gateway.pixazo.ai/veed-fabric-1-0-api-130/v1/veed-fabric-1-0-api-request-result'; const headers = { 'Content-Type': 'application/json', 'Cache-Control': 'no-cache', 'Ocp-Apim-Subscription-Key': 'YOUR_SUBSCRIPTION_KEY' }; const data = { request_id: 'a1b2c3d4-e5f6-7890-g1h2-i3j4k5l6m7n8' }; fetch(url, { method: 'POST', headers: headers, body: JSON.stringify(data) }) .then(response => response.json()) .then(data => console.log(data)) .catch(error => console.error('Error:', error));
curl -X POST "https://gateway.pixazo.ai/veed-fabric-1-0-api-130/v1/veed-fabric-1-0-api-request-result" \ -H "Content-Type: application/json" \ -H "Cache-Control: no-cache" \ -H "Ocp-Apim-Subscription-Key: YOUR_SUBSCRIPTION_KEY" \ --data-raw '{ "request_id": "a1b2c3d4-e5f6-7890-g1h2-i3j4k5l6m7n8" }'
import java.net.URI; import java.net.http.HttpClient; import java.net.http.HttpRequest; import java.net.http.HttpResponse; import java.time.Duration; public class ApiExample { public static void main(String[] args) throws Exception { HttpClient client = HttpClient.newBuilder() .connectTimeout(Duration.ofSeconds(10)) .build(); String json = "{\n" + " \"request_id\": \"a1b2c3d4-e5f6-7890-g1h2-i3j4k5l6m7n8\"\n" + "}"; HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("https://gateway.pixazo.ai/veed-fabric-1-0-api-130/v1/veed-fabric-1-0-api-request-result")) .header("Content-Type", "application/json") .header("Cache-Control", "no-cache") .header("Ocp-Apim-Subscription-Key", "YOUR_SUBSCRIPTION_KEY") .POST(HttpRequest.BodyPublishers.ofString(json)) .build(); HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.body()); } }
 'a1b2c3d4-e5f6-7890-g1h2-i3j4k5l6m7n8' ]); curl_setopt($ch, CURLOPT_URL, $url); curl_setopt($ch, CURLOPT_POST, 1); curl_setopt($ch, CURLOPT_POSTFIELDS, $data); curl_setopt($ch, CURLOPT_HTTPHEADER, [ 'Content-Type: application/json', 'Cache-Control: no-cache', 'Ocp-Apim-Subscription-Key: YOUR_SUBSCRIPTION_KEY' ]); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); $response = curl_exec($ch); curl_close($ch); echo $response; ?>

Output

Successful API response:

{ "status": "COMPLETED", "request_id": "a1b2c3d4-e5f6-7890-g1h2-i3j4k5l6m7n8", "video": { "url": "https://storage.fal.media/output/veed-fabric/a1b2c3d4-e5f6-7890-g1h2-i3j4k5l6m7n8.mp4", "resolution": "720p" } }

Request Body - VEED Fabric 1.0 API check status

Parameters for /veed-fabric-1-0-api-request-result:

ParameterRequiredTypeDescription
request_idYesstringThe unique identifier returned from the initial request to check status.

Example Request - VEED Fabric 1.0 API check status

JSON
{ "request_id": "a1b2c3d4-e5f6-7890-g1h2-i3j4k5l6m7n8" }

Response - VEED Fabric 1.0 API check status

JSON
{ "status": "COMPLETED", "request_id": "a1b2c3d4-e5f6-7890-g1h2-i3j4k5l6m7n8", "video": { "url": "https://storage.fal.media/output/veed-fabric/a1b2c3d4-e5f6-7890-g1h2-i3j4k5l6m7n8.mp4", "resolution": "720p", "duration_seconds": 7.4, "content_type": "video/mp4" } }

Request Headers

HeaderDescription
Content-TypeMust be set to application/json
Cache-ControlMust be set to no-cache
Ocp-Apim-Subscription-KeyYour API subscription key for authentication

Response Handling

The VEED Fabric 1.0 API returns specific HTTP status codes and response bodies to indicate the success or failure of a request. Developers should implement error handling in their applications to manage these responses effectively.

Common Status Codes and Responses

Status CodeDescriptionResponse Body
200Success - The request was successfully processed.{ "success": true, ... }
Bad Request - The request contains invalid parameters or missing fields.{ "error": "Invalid request parameters" }
401Unauthorized - The provided subscription key is missing or invalid.{ "error": "Invalid or missing authentication" }
403Forbidden - The subscription does not have access to this API or action.{ "error": "Access denied for this operation" }
404Not Found - The requested resource or endpoint could not be found.{ "error": "Endpoint not found" }
Too Many Requests - The request rate limit has been exceeded.{ "error": "Rate limit exceeded, please retry later" }
500Internal Server Error - An unexpected error occurred on the server.{ "error": "An unexpected error occurred, please try again later" }

Example Error Response

{ "error": "Invalid parameters" }

Retrieving Results

After submitting your request, use this endpoint to check status and retrieve results.

Endpoint

POST https://gateway.pixazo.ai/veed-fabric-1-0-api-130/v1/veed-fabric-1-0-api-request-result

Request Body

{ "request_id": "a1b2c3d4-e5f6-7890-g1h2-i3j4k5l6m7n8" }

Example Polling Request

curl -X POST "https://gateway.pixazo.ai/veed-fabric-1-0-api-130/v1/veed-fabric-1-0-api-request-result" \ -H "Content-Type: application/json" \ -H "Cache-Control: no-cache" \ -H "Ocp-Apim-Subscription-Key: YOUR_SUBSCRIPTION_KEY" \ --data-raw '{ "request_id": "a1b2c3d4-e5f6-7890-g1h2-i3j4k5l6m7n8" }'

Response States

StatusDescription
IN_QUEUERequest is queued and waiting to be processed.
IN_PROGRESSVideo generation is actively in progress.
COMPLETEDVideo has been generated successfully. Result URL is available.
FAILEDVideo generation failed due to invalid input, timeout, or system error.

Example Success Response

{ "status": "COMPLETED", "request_id": "a1b2c3d4-e5f6-7890-g1h2-i3j4k5l6m7n8", "video": { "url": "https://storage.fal.media/output/veed-fabric/a1b2c3d4-e5f6-7890-g1h2-i3j4k5l6m7n8.mp4", "resolution": "720p", "duration_seconds": 7.4, "content_type": "video/mp4" } }

Example In-Progress Response

{ "status": "IN_PROGRESS", "request_id": "a1b2c3d4-e5f6-7890-g1h2-i3j4k5l6m7n8", "progress_percentage": 65, "estimated_remaining_seconds": 12 }