Start here
Export a film
/v1/studio/projects/{project}/films/{film}/exportson https://api.auray.ai/v1Export a film, as it stands at base_rev, into one video of the project — free, as joining a storyboard's scenes is.
Export a film, as it stands at base_rev, into one video of the project — free, as joining a storyboard's scenes is. Its clips are trimmed and joined in order into one MP4 (H.264 and AAC, 1920×1080 across or 1080×1920 up, 24 frames a second), each fitted into the frame and never stretched, with silence where a clip has none and the music laid under the clips' own sound; a poster is drawn from it. Answered 201 at once with the export, queued or running: read it until it is done — item_id is then the video, filed in the project's Film folder and labelled made with AI when any clip was — or failed, with a word saying why. Refused while another export of the film is being made (film_export_running names it), while a clip is withheld or held after a report (content_held), when the film holds no clip or a clip cannot be exported as it is (film_invalid), when the project holds as many items as its limits.items says — its owner's plan's figure (studio_limit_reached), and while video is paused (video_paused). A film made of a clip that is later withheld is withheld with it, and so is its publication. Needs the edit_items capability. Takes a key holding studio:write — Account offers it unticked — or the desktop's own session key. Spends nothing.
#Authentication
Authorization: Bearer auray_sk_… — studio:write — Account offers it unticked; the desktop's session key holds it.
#Request
#Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
project | string | yes | |
film | string | yes |
#Body
application/json, required.
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
base_rev | integer | yes | — | The rev the film was read at: the revision exported. 1 to …. |
#Example request
curl -X POST https://api.auray.ai/v1/studio/projects/3f0c8a52-6a1d-4e8b-9c2d-7e5f4a3b2c1d/films/6d7e8f90-1a2b-4c3d-8e4f-5a6b7c8d9e0f/exports \
-H "Authorization: Bearer $AURAY_API_KEY" \
-H "content-type: application/json" \
-d '{
"base_rev": 3
}'const res = await fetch("https://api.auray.ai/v1/studio/projects/3f0c8a52-6a1d-4e8b-9c2d-7e5f4a3b2c1d/films/6d7e8f90-1a2b-4c3d-8e4f-5a6b7c8d9e0f/exports", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.AURAY_API_KEY}`,
"content-type": "application/json",
},
body: JSON.stringify({
"base_rev": 3
}),
});
console.log(await res.json());import os, requests
r = requests.post(
"https://api.auray.ai/v1/studio/projects/3f0c8a52-6a1d-4e8b-9c2d-7e5f4a3b2c1d/films/6d7e8f90-1a2b-4c3d-8e4f-5a6b7c8d9e0f/exports",
headers={"Authorization": f"Bearer {os.environ['AURAY_API_KEY']}"},
json={
"base_rev": 3
},
)
r.raise_for_status()
print(r.json())package main
import (
"bytes"
"fmt"
"io"
"net/http"
"os"
)
func main() {
body := []byte(`{
"base_rev": 3
}`)
req, err := http.NewRequest("POST", "https://api.auray.ai/v1/studio/projects/3f0c8a52-6a1d-4e8b-9c2d-7e5f4a3b2c1d/films/6d7e8f90-1a2b-4c3d-8e4f-5a6b7c8d9e0f/exports", bytes.NewReader(body))
if err != nil {
panic(err)
}
req.Header.Set("Authorization", "Bearer "+os.Getenv("AURAY_API_KEY"))
req.Header.Set("Content-Type", "application/json")
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");
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("AURAY_API_KEY"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => json_encode([
"base_rev" => 3,
], JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE),
]);
$response = curl_exec($ch);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE), " ", $response, PHP_EOL;require "net/http"
require "json"
uri = URI("https://api.auray.ai/v1/studio/projects/3f0c8a52-6a1d-4e8b-9c2d-7e5f4a3b2c1d/films/6d7e8f90-1a2b-4c3d-8e4f-5a6b7c8d9e0f/exports")
req = Net::HTTP::Post.new(uri)
req["Authorization"] = "Bearer #{ENV.fetch("AURAY_API_KEY")}"
req["Content-Type"] = "application/json"
req.body = {
"base_rev" => 3
}.to_json
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 {
String body = """
{
"base_rev": 3
}""";
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"))
.header("Authorization", "Bearer " + System.getenv("AURAY_API_KEY"))
.header("Content-Type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString(body))
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode() + " " + response.body());
}
}using System.Net.Http.Headers;
using System.Text;
using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization =
new AuthenticationHeaderValue("Bearer", Environment.GetEnvironmentVariable("AURAY_API_KEY"));
using var request = new HttpRequestMessage(HttpMethod.Post, "https://api.auray.ai/v1/studio/projects/3f0c8a52-6a1d-4e8b-9c2d-7e5f4a3b2c1d/films/6d7e8f90-1a2b-4c3d-8e4f-5a6b7c8d9e0f/exports");
var body = """
{
"base_rev": 3
}
""";
request.Content = new StringContent(body, Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");#Responses
#201 Created
Created.
| 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 |
#400 Bad Request
#401 Unauthorized
#403 Forbidden
#404 Not Found
#409 Conflict
#413 Payload Too Large
#429 Too Many Requests
#500 Internal Server Error
#503 Service Unavailable
#Status codes
| Status | Meaning |
|---|---|
201 | Created. |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
413 | Payload Too Large |
429 | Too Many Requests |
500 | Internal Server Error |
503 | Service Unavailable |
Every refusal names its code, and every code is explained at Errors.