Status

Check the status of generate.

Request

GEThttps://api.fliki.ai/v1/generate/status

Headers

{
  "Content-type": "application/json",
  "Authorization": "Bearer API_KEY"
}

Key	Value	Description
Content-Type	application/json	Specifies that the request body format is JSON, allowing the server to parse the data correctly.
Authorization	Bearer YOUR_API_KEY	Generate your API Key in the account/api. section and replace YOUR_API_KEY with your actual key.

Query params

{
  "fileId": String
}

Obtain fileId from the response of the audio, video, or template generate endpoints.

Response

{
  "fileId": String,
  "status": "queued" | "processing" | "success" | "error" | "canceled",
  "progress": Number | undefined,
  "download": String | undefined // CDN URL, only present when status is "success"
}

Key	Type	Description
fileId	string	The unique identifier for the file.
status	string	The current generation status: queued, processing, success, error, or canceled.
progress	number | undefined	The progress percentage of the file generation (if available).
download	string | undefined	The CDN URL to download the finished file. Only present once status is success.

note

status and download track the final exported file. This is a separate asset from the per-scene voiceover you can hear when opening the file in the Fliki editor. A file can be playable in the editor while its export is still queued or processing; the download URL only becomes available after the export completes (status: "success"). Poll every few seconds, or use the webhook (see audio) to be notified on completion.

Example

Bash

cURL Request

curl  
  -H "Authorization: Bearer <API KEY>"  
  -H "Content-Type: application/json"  
  -G -d "fileId=..."  
  -X GET https://api.fliki.ai/v1/generate/status

TypeScript

TypeScript Request

const apiKey = '<API KEY>'; // Replace with your actual API key
const fileId = '...'; // Replace with your actual file ID

async function getGenerateStatus(apiKey: string, fileId: string) {
const url = `https://api.fliki.ai/v1/generate/status?fileId=${encodeURIComponent(fileId)}`;

  try {
    const response = await fetch(url, {
      method: 'GET',
      headers: {
        'Authorization': `Bearer ${apiKey}`,
        'Content-Type': 'application/json',
      },
    });

    if (!response.ok) {
        throw new Error(`Error: ${response.status} - ${response.statusText}`);
    }

    const data = await response.json();
    return data;
  } catch (error) {
    console.error('Error fetching Fliki status:', error);
    throw error; // Re-throw the error for further handling if needed
  }

}

getGenerateStatus(apiKey, fileId)
.then(data => console.log(data))
.catch(error => console.error(error));

Python

Python Request

import requests

api_key = "<API KEY>" # Replace with your actual API key
file_id = "..." # Replace with your actual file ID

url = "https://api.fliki.ai/v1/generate/status"
headers = {
"Authorization": f"Bearer {api_key}",
"Content-Type": "application/json"
}
params = {
"fileId": file_id
}

response = requests.get(url, headers=headers, params=params)
print(response.json())

Go

Go Request

package main

import (
"bytes"
"encoding/json"
"fmt"
"net/http"
)

func main() {
apiKey := "<API KEY>" // Replace with your actual API key
fileID := "..." // Replace with your actual file ID

  url := "https://api.fliki.ai/v1/generate/status"
  req, err := http.NewRequest("GET", url, bytes.NewBuffer(nil))
  if err != nil {
    panic(err)
  }

  req.Header.Set("Authorization", "Bearer "+apiKey)
  req.Header.Set("Content-Type", "application/json")
  q := req.URL.Query()
  q.Add("fileId", fileID)
  req.URL.RawQuery = q.Encode()

  client := &http.Client{}
  resp, err := client.Do(req)
  if err != nil {
    panic(err)
  }
  defer resp.Body.Close()

  var result map[string]interface{}
  json.NewDecoder(resp.Body).Decode(&result)
  fmt.Println(result)

}