Start here
Get a film
/v1/studio/projects/{project}/films/{film}on https://api.auray.ai/v1A film: its document at its revision, its length, every clip — and the music — that cannot be exported as it is now and why (sources), whether it can be exported (exportable), and its last export.
A film: its document at its revision, its length, every clip — and the music — that cannot be exported as it is now and why (sources), whether it can be exported (exportable), and its last export. 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 |
#Example request
curl https://api.auray.ai/v1/studio/projects/3f0c8a52-6a1d-4e8b-9c2d-7e5f4a3b2c1d/films/6d7e8f90-1a2b-4c3d-8e4f-5a6b7c8d9e0f \
-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", {
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",
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", 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");
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")
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"))
.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");
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". |
id | string | yes | — | |
project_id | string | yes | — | |
name | string | yes | — | 0 to 80 characters. |
doc | object | yes | — | A film's document, exactly these keys: its shape, its clips in order, and its soundtrack. At most 60 clips and 10 minutes of film — every clip's kept length, less each fade — and 32 KB of JSON. |
doc.v | integer | yes | — | One of 1. |
doc.aspect | string | yes | — | Across or up. Every clip is fitted into the frame, never stretched or cut. One of "16:9", "9:16". |
doc.clips | object[] | yes | — | |
doc.clips[].item_id | string | yes | — | A video item of the project, in lower case. |
doc.clips[].in_ms | integer | yes | — | 0 to …. |
doc.clips[].out_ms | integer | yes | — | … to 86400000. |
doc.clips[].transition | string | yes | — | How it joins the clip before it: at once, or by a cross-fade of picture and sound. The first clip cuts in. One of "cut", "fade". |
doc.clips[].fade_ms | integer | yes | — | 0 for a cut; 200 to 3000 for a fade, and at most half the shorter of the two clips it joins. Two clips joined by a fade overlap by its length. 0 to 3000. |
doc.sound | object | yes | — | |
doc.sound.clips | string | yes | — | The clips' own sound, kept or every clip silent. One of "keep", "mute". |
doc.sound.music | null or object | yes | — | One music bed under the clips, from in_ms into the sound; one that runs on past the film's end fades out over its last moments, and one that ends sooner simply ends. Null for none. |
rev | integer | yes | — | A change names the rev it was read at. 1 to …. |
duration_ms | integer | yes | — | Every clip's kept length, less each fade. 0 to …. |
sources | object[] | yes | — | Every clip — and the music — that cannot be exported as it is now; empty when nothing stops it. |
sources[].at | string | yes | — | One of "clip", "music". |
sources[].index | integer | yes | — | The clip's place in doc.clips; null for the music. 0 to …. May be null. |
sources[].item_id | string | yes | — | |
sources[].problem | string | yes | — | Gone from the project, in the Trash, still being copied in, withheld after a report, held while a report is looked at, a clip that is no video, music that is no sound, no stored file, or a file larger than a film reads. One of "missing", "trashed", "pending", "withheld", "held", "not_video", "not_audio", "no_file", "too_large". |
exportable | boolean | yes | — | It holds a clip and nothing in sources stops it. |
latest_export | null or object | yes | — | Its newest export, whatever its state; null before the first. |
created_at | string | yes | — | |
updated_at | string | yes | — | |
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.