Start here
Get a project
GET
/v1/studio/projects/{project}on https://api.auray.ai/v1A project, its cover signed afresh.
A project, its cover signed afresh. One you are not a member of is not_found, exactly as one that does not exist. 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 |
#Example request
curl https://api.auray.ai/v1/studio/projects/3f0c8a52-6a1d-4e8b-9c2d-7e5f4a3b2c1d \
-H "Authorization: Bearer $AURAY_API_KEY"const res = await fetch("https://api.auray.ai/v1/studio/projects/3f0c8a52-6a1d-4e8b-9c2d-7e5f4a3b2c1d", {
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",
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", 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");
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")
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"))
.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");
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 "project". |
id | string | yes | — | |
name | string | yes | — | 0 to 80 characters. |
slug | string | yes | — | The address segment its links carry; unique among the owner's projects. 3 to 60 characters. |
description | string | yes | — | 0 to 140 characters. May be null. |
cover | object or null | yes | — | |
cover_item_id | string | yes | — | May be null. |
access | string | yes | — | private is the only access in this release. One of "private", "team". |
role | string | yes | — | Your own role in the project. One of "owner", "admin", "collaborator", "viewer". |
can | string[] | yes | — | What your role lets you do here; anything else is refused role_forbidden. |
counts | object | yes | — | |
counts.items | integer | yes | — | Every item not in the Trash. |
counts.generations | integer | yes | — | |
counts.uploads | integer | yes | — | |
counts.elements | integer | yes | — | |
counts.folders | integer | yes | — | |
counts.trashed | integer | yes | — | |
limits | object | yes | — | What it may hold: the figures in force of its OWNER's plan (studio.max_items, studio.max_canvases, studio.max_members), whoever reads it — each told only to a role that can add against it, null to every other reader. A figure moved lower refuses the next one past it (studio_limit_reached, whose max is the same number) and takes nothing away, so a count above it is a project that held more before. |
limits.items | integer | yes | — | Items it may hold, the Trash counted. Null unless your role may generate, upload or edit items. 1 to …. May be null. |
limits.canvases | integer | yes | — | Canvases it may hold. Null unless your role may edit canvases. 1 to …. May be null. |
limits.members | integer | yes | — | People it may seat, its owner counted. Null unless your role manages members. 1 to …. May be null. |
plan | object | yes | — | What its OWNER's plan lets happen in it, whoever reads it — each bit told only to a reader it binds, null to every other, as limits is. open false is a read-only project: its owner's plan does not include Cinema Studio, so nothing can be added or changed in it, and every such write answers studio_not_in_plan; opening and downloading everything, removing things and handing the project over still work, and can stays your role's list. |
plan.open | boolean | yes | — | Whether anything can be added or changed here: false in a read-only project. Null only to a reader who is no member. May be null. |
plan.calls | boolean | yes | — | Whether a call can be held here: its owner's plan includes Cinema Studio and calls, and seats a team. False, a join answers studio_not_in_plan. Null unless your role may join calls. May be null. |
plan.publish | boolean | yes | — | Whether the project may be published, or its publication updated: its owner's plan includes Cinema Studio and publishing. Withdrawing a publication never asks. Null unless you own it. May be null. |
bytes | integer | yes | — | What its kept files take, the Trash included — what deleting it frees. |
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.