API reference / Uploads

Complete an upload

POST/v1/uploads/{uploadId}/complete

Every upload is completed once its bytes are in place: a single PUT with no body, a multipart upload with every part's number and the ETag its PUT returned. The upload is then processing while Blitframe checks it, and ready for an edit, a new project, an import or a render's replacement when that is done; a ZIP is ready at once, since its import checks it. Send Prefer: wait=N (at most 50) to hold the answer until the upload is ready or failed, or N seconds pass. Completing again is harmless: it answers the upload as it is, and resumes one that failed with interrupted, up to three checks in all; after that it fails with check_limit and the file must be uploaded again.

Request

curl -s -X POST $BLITFRAME/uploads/f289c525-d331-400f-b599-c1f6da1cbf8e/complete \
  -H "Authorization: Bearer $BLITFRAME_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Prefer: wait=50" \
  -d '{
    "parts": [
      {"partNumber": 1, "etag": "\"5d41402abc4b2a76\""},
      {"partNumber": 2, "etag": "\"7c2b8e3f1a9d4c6b\""}
    ]
  }'
import os, requests

response = requests.post(
    f"{os.environ['BLITFRAME']}/uploads/f289c525-d331-400f-b599-c1f6da1cbf8e/complete",
    headers={"Authorization": f"Bearer {os.environ['BLITFRAME_API_KEY']}", "Prefer": "wait=50"},
    json={
        "parts": [
            {"partNumber": 1, "etag": "\"5d41402abc4b2a76\""},
            {"partNumber": 2, "etag": "\"7c2b8e3f1a9d4c6b\""},
        ],
    },
)
print(response.json())
const response = await fetch(`${process.env.BLITFRAME}/uploads/f289c525-d331-400f-b599-c1f6da1cbf8e/complete`, {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BLITFRAME_API_KEY}`,
    "Content-Type": "application/json",
    Prefer: "wait=50",
  },
  body: JSON.stringify({
    parts: [
      { partNumber: 1, etag: "\"5d41402abc4b2a76\"" },
      { partNumber: 2, etag: "\"7c2b8e3f1a9d4c6b\"" },
    ],
  }),
});
console.log(await response.json());
<?php
$request = curl_init(getenv("BLITFRAME") . "/uploads/f289c525-d331-400f-b599-c1f6da1cbf8e/complete");
curl_setopt_array($request, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer " . getenv("BLITFRAME_API_KEY"),
        "Content-Type: application/json",
        "Prefer: wait=50",
    ],
    CURLOPT_POSTFIELDS => '{
      "parts": [
        {"partNumber": 1, "etag": "\\"5d41402abc4b2a76\\""},
        {"partNumber": 2, "etag": "\\"7c2b8e3f1a9d4c6b\\""}
      ]
    }',
]);
$response = curl_exec($request);
echo $response;
require "net/http"

uri = URI(ENV["BLITFRAME"] + '/uploads/f289c525-d331-400f-b599-c1f6da1cbf8e/complete')
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer " + ENV["BLITFRAME_API_KEY"]
request["Content-Type"] = "application/json"
request['Prefer'] = 'wait=50'
request.body = '{
  "parts": [
    {"partNumber": 1, "etag": "\\"5d41402abc4b2a76\\""},
    {"partNumber": 2, "etag": "\\"7c2b8e3f1a9d4c6b\\""}
  ]
}'
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"
	"strings"
)

func main() {
	body := strings.NewReader(`{
	  "parts": [
	    {"partNumber": 1, "etag": "\"5d41402abc4b2a76\""},
	    {"partNumber": 2, "etag": "\"7c2b8e3f1a9d4c6b\""}
	  ]
	}`)
	request, err := http.NewRequest("POST", os.Getenv("BLITFRAME")+"/uploads/f289c525-d331-400f-b599-c1f6da1cbf8e/complete", body)
	if err != nil {
		panic(err)
	}
	request.Header.Set("Authorization", "Bearer "+os.Getenv("BLITFRAME_API_KEY"))
	request.Header.Set("Content-Type", "application/json")
	request.Header.Set("Prefer", "wait=50")
	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 System.Text;

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post,
    Environment.GetEnvironmentVariable("BLITFRAME") + "/uploads/f289c525-d331-400f-b599-c1f6da1cbf8e/complete");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", Environment.GetEnvironmentVariable("BLITFRAME_API_KEY"));
request.Headers.Add("Prefer", "wait=50");
request.Content = new StringContent(
    """
    {
      "parts": [
        {"partNumber": 1, "etag": "\"5d41402abc4b2a76\""},
        {"partNumber": 2, "etag": "\"7c2b8e3f1a9d4c6b\""}
      ]
    }
    """, Encoding.UTF8, "application/json");
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") + "/uploads/f289c525-d331-400f-b599-c1f6da1cbf8e/complete"))
            .header("Authorization", "Bearer " + System.getenv("BLITFRAME_API_KEY"))
            .header("Content-Type", "application/json")
            .header("Prefer", "wait=50")
            .method("POST", HttpRequest.BodyPublishers.ofString("""
                {
                  "parts": [
                    {"partNumber": 1, "etag": "\\"5d41402abc4b2a76\\""},
                    {"partNumber": 2, "etag": "\\"7c2b8e3f1a9d4c6b\\""}
                  ]
                }
                """))
            .build();
        var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

Path parameters

  • uploadIdstring (uuid)required

Headers

  • AuthorizationBearer Blitframe API keyrequired

    API key from the developer console.

  • Preferstring

Body

application/json · optional · CompleteUploadRequest or null

  • partsarray of CompletedPart or null
    CompletedPart fields
    • partNumberintegerrequired
    • etagstring or nullrequired

Try it

POST/v1/uploads/{uploadId}/complete

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 · UploadDto

  • idstring (uuid)
  • One of open processing ready failed

  • urlstring or null
  • methodstring or null
  • expiresAtstring (date-time)
  • multipartMultipartDto or null
    MultipartDto fields
    • partSizeinteger (int64)
    • partCountinteger
    • urlsExpireAtstring (date-time)
    • partsarray of UploadPartDto
      UploadPartDto fields
      • partNumberinteger
      • urlstring
  • errorApiError or null
    ApiError fields
    • codestring
    • messagestring

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.