Start here
Get a film's export
/v1/studio/projects/{project}/films/{film}/exports/{export}on https://api.auray.ai/v1Where an export of a film stands: queued, running, done with the video it filed (item_id, an item of the project — read it for its file), or failed with why (error).
Where an export of a film stands: queued, running, done with the video it filed (item_id, an item of the project — read it for its file), or failed with why (error). expected_seconds is what a progress bar may assume, never a promise. out_of_date once the film was changed since, or a clip it was made of — or the film itself — has since been withheld. Takes a key holding studio:read (or studio:write, which reads too) — Account offers both unticked — or the desktop's own session key. Spends nothing.
#Authentication
Authorization: Bearer auray_sk_… — studio:read, or studio:write, which reads too — Account offers both unticked; the desktop's session key holds both.
#Request
#Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
project | string | yes | |
film | string | yes | |
export | string | yes |
#Example request
curl https://api.auray.ai/v1/studio/projects/3f0c8a52-6a1d-4e8b-9c2d-7e5f4a3b2c1d/films/6d7e8f90-1a2b-4c3d-8e4f-5a6b7c8d9e0f/exports/7e8f9a0b-1c2d-4e3f-8a4b-5c6d7e8f9a0b \
-H "Authorization: Bearer $AURAY_API_KEY"const res = await fetch("https://api.auray.ai/v1/studio/projects/3f0c8a52-6a1d-4e8b-9c2d-7e5f4a3b2c1d/films/6d7e8f90-1a2b-4c3d-8e4f-5a6b7c8d9e0f/exports/7e8f9a0b-1c2d-4e3f-8a4b-5c6d7e8f9a0b", {
method: "GET",
headers: { Authorization: `Bearer ${process.env.AURAY_API_KEY}` },
});
console.log(await res.json());import os, requests
r = requests.get(
"https://api.auray.ai/v1/studio/projects/3f0c8a52-6a1d-4e8b-9c2d-7e5f4a3b2c1d/films/6d7e8f90-1a2b-4c3d-8e4f-5a6b7c8d9e0f/exports/7e8f9a0b-1c2d-4e3f-8a4b-5c6d7e8f9a0b",
headers={"Authorization": f"Bearer {os.environ['AURAY_API_KEY']}"},
)
r.raise_for_status()
print(r.json())package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, err := http.NewRequest("GET", "https://api.auray.ai/v1/studio/projects/3f0c8a52-6a1d-4e8b-9c2d-7e5f4a3b2c1d/films/6d7e8f90-1a2b-4c3d-8e4f-5a6b7c8d9e0f/exports/7e8f9a0b-1c2d-4e3f-8a4b-5c6d7e8f9a0b", nil)
if err != nil {
panic(err)
}
req.Header.Set("Authorization", "Bearer "+os.Getenv("AURAY_API_KEY"))
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(res.Status, string(out))
}<?php
$ch = curl_init("https://api.auray.ai/v1/studio/projects/3f0c8a52-6a1d-4e8b-9c2d-7e5f4a3b2c1d/films/6d7e8f90-1a2b-4c3d-8e4f-5a6b7c8d9e0f/exports/7e8f9a0b-1c2d-4e3f-8a4b-5c6d7e8f9a0b");
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("AURAY_API_KEY"),
],
]);
$response = curl_exec($ch);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE), " ", $response, PHP_EOL;require "net/http"
uri = URI("https://api.auray.ai/v1/studio/projects/3f0c8a52-6a1d-4e8b-9c2d-7e5f4a3b2c1d/films/6d7e8f90-1a2b-4c3d-8e4f-5a6b7c8d9e0f/exports/7e8f9a0b-1c2d-4e3f-8a4b-5c6d7e8f9a0b")
req = Net::HTTP::Get.new(uri)
req["Authorization"] = "Bearer #{ENV.fetch("AURAY_API_KEY")}"
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
puts res.code, res.bodyimport java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Main {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.auray.ai/v1/studio/projects/3f0c8a52-6a1d-4e8b-9c2d-7e5f4a3b2c1d/films/6d7e8f90-1a2b-4c3d-8e4f-5a6b7c8d9e0f/exports/7e8f9a0b-1c2d-4e3f-8a4b-5c6d7e8f9a0b"))
.header("Authorization", "Bearer " + System.getenv("AURAY_API_KEY"))
.GET()
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode() + " " + response.body());
}
}using System.Net.Http.Headers;
using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization =
new AuthenticationHeaderValue("Bearer", Environment.GetEnvironmentVariable("AURAY_API_KEY"));
using var request = new HttpRequestMessage(HttpMethod.Get, "https://api.auray.ai/v1/studio/projects/3f0c8a52-6a1d-4e8b-9c2d-7e5f4a3b2c1d/films/6d7e8f90-1a2b-4c3d-8e4f-5a6b7c8d9e0f/exports/7e8f9a0b-1c2d-4e3f-8a4b-5c6d7e8f9a0b");
using var response = await client.SendAsync(request);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");#Responses
#200 OK
OK.
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
object | string | yes | — | One of "film_export". |
id | string | yes | — | |
film_id | string | yes | — | The film it was made of; null once that film was deleted — the video stays. May be null. |
rev | integer | yes | — | The film's revision it was made of. 1 to …. |
state | string | yes | — | One of "queued", "running", "done", "failed". |
item_id | string | yes | — | The video it filed in the project's Film folder, once done; null before, and once that item was deleted. May be null. |
error | string | yes | — | Why it failed: a clip or the music could not be read, the clips could not be made into one film, the film was larger than a film is kept at, it could not be stored, no film arrived after every try, video was paused before it could start again, a clip was withheld or left the project before it started, its place in the project went, or its film was deleted. Null unless failed. One of "source_unreadable", "render_failed", "too_large", "upload_failed", "timed_out", "paused", "source_withheld", "source_missing", "lost", "cancelled", null. May be null. |
out_of_date | boolean | yes | — | Done, and no longer the film as it stands: the film was changed since, or a clip it was made of — or the film itself — has since been withheld. |
duration_ms | integer | yes | — | The film's length by its document. 0 to …. |
expected_seconds | integer | yes | — | What a progress bar may assume, from the film's length — never a promise. 0 to …. |
created_at | string | yes | — | |
started_at | string | yes | — | May be null. |
finished_at | string | yes | — | May be null. |
request_id | string | no | — | Mirrored in the X-Request-Id header. |
Headers:
| Header | Description |
|---|---|
RateLimit-Limit | Burst capacity. |
RateLimit-Remaining | |
RateLimit-Reset | Seconds until refill. |
X-RateLimit-Limit | |
X-RateLimit-Remaining | |
X-RateLimit-Reset | Unix seconds. The X- spelling is what client libraries read. |
X-Request-Id |
#401 Unauthorized
#403 Forbidden
#404 Not Found
#429 Too Many Requests
#500 Internal Server Error
#503 Service Unavailable
#Status codes
| Status | Meaning |
|---|---|
200 | OK. |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
429 | Too Many Requests |
500 | Internal Server Error |
503 | Service Unavailable |
Every refusal names its code, and every code is explained at Errors.