API reference / Projects

List projects

GET/v1/projects

The workspace's projects, newest first, each with the head version of its main variation: 100 a page unless limit asks for another number, up to 1,000. q searches project names. copiedFromVersionId lists the copies made of that version, and copiedFromProjectId the copies made of any version of that project while it exists. When next is not null, pass it as before for older projects. headVersionId is null and renderable null while a project is empty. copiedFromVersionId is the version a copy was made from, kept after that version's project is deleted, or null. thumbnailUrl is the poster of the latest succeeded video render, or null.

Request

curl -s $BLITFRAME/projects -H "Authorization: Bearer $BLITFRAME_API_KEY"
import os, requests

response = requests.get(
    f"{os.environ['BLITFRAME']}/projects",
    headers={"Authorization": f"Bearer {os.environ['BLITFRAME_API_KEY']}"},
)
print(response.json())
const response = await fetch(`${process.env.BLITFRAME}/projects`, {
  headers: { Authorization: `Bearer ${process.env.BLITFRAME_API_KEY}` },
});
console.log(await response.json());
<?php
$request = curl_init(getenv("BLITFRAME") . "/projects");
curl_setopt_array($request, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer " . getenv("BLITFRAME_API_KEY"),
    ],
]);
$response = curl_exec($request);
echo $response;
require "net/http"

uri = URI(ENV["BLITFRAME"] + '/projects')
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer " + ENV["BLITFRAME_API_KEY"]
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| http.request(request) }
puts response.body
package main

import (
	"fmt"
	"io"
	"net/http"
	"os"
)

func main() {
	request, err := http.NewRequest("GET", os.Getenv("BLITFRAME")+"/projects", nil)
	if err != nil {
		panic(err)
	}
	request.Header.Set("Authorization", "Bearer "+os.Getenv("BLITFRAME_API_KEY"))
	response, err := http.DefaultClient.Do(request)
	if err != nil {
		panic(err)
	}
	defer response.Body.Close()
	text, _ := io.ReadAll(response.Body)
	fmt.Println(string(text))
}
using System.Net.Http.Headers;

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get,
    Environment.GetEnvironmentVariable("BLITFRAME") + "/projects");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", Environment.GetEnvironmentVariable("BLITFRAME_API_KEY"));
using var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        var request = HttpRequest.newBuilder(URI.create(System.getenv("BLITFRAME") + "/projects"))
            .header("Authorization", "Bearer " + System.getenv("BLITFRAME_API_KEY"))
            .method("GET", HttpRequest.BodyPublishers.noBody())
            .build();
        var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

Query parameters

  • qstring
  • copiedFromVersionIdstring (uuid)
  • copiedFromProjectIdstring (uuid)
  • limitinteger

    Default 100

  • beforestring (uuid)

Headers

  • AuthorizationBearer Blitframe API keyrequired

    API key from the developer console.

Try it

GET/v1/projects

Used for the requests you send from this page only. It is not saved.

This sends a real request to your workspace: a render spends render seconds, and a delete is final.

Response

Send the request to see the answer here.

Responses

  • 200 OK

application/json · PageOfProjectDto

  • itemsarray of ProjectDto
    ProjectDto fields
    • idstring (uuid)
    • namestring
    • createdAtstring (date-time)
    • headVersionIdstring (uuid) or null
    • renderableboolean or null
    • copiedFromVersionIdstring (uuid) or null
    • thumbnailUrlstring or null
  • nextstring or null

Errors

  • 400 Bad Request
  • 401 Unauthorized
  • 404 Not Found
  • 429 Too Many Requests

application/json · ErrorResponse

  • ApiError fields
    • codestring
    • messagestring

Errors lists the error codes and says when to retry.