Create a preview
curl --request POST \
--url https://api-staging.pixwel.com/api/previews \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"_id": "507f1f77bcf86cd799439011",
"asset": "507f1f77bcf86cd799439011",
"project": "507f1f77bcf86cd799439011",
"studio": "507f1f77bcf86cd799439011",
"revision": "<string>",
"label": "<string>",
"created": 123,
"$links": {
"self": "//example.com/path/to/object",
"asset": "//example.com/path/to/object",
"project": "//example.com/path/to/object",
"studio": "//example.com/path/to/object"
},
"path": "https://example.com/path/to/object",
"language": "<string>",
"type": "<string>",
"embargo": {
"start": "<unknown>",
"end": 123
}
}
'import requests
url = "https://api-staging.pixwel.com/api/previews"
payload = {
"_id": "507f1f77bcf86cd799439011",
"asset": "507f1f77bcf86cd799439011",
"project": "507f1f77bcf86cd799439011",
"studio": "507f1f77bcf86cd799439011",
"revision": "<string>",
"label": "<string>",
"created": 123,
"$links": {
"self": "//example.com/path/to/object",
"asset": "//example.com/path/to/object",
"project": "//example.com/path/to/object",
"studio": "//example.com/path/to/object"
},
"path": "https://example.com/path/to/object",
"language": "<string>",
"type": "<string>",
"embargo": {
"start": "<unknown>",
"end": 123
}
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
_id: '507f1f77bcf86cd799439011',
asset: '507f1f77bcf86cd799439011',
project: '507f1f77bcf86cd799439011',
studio: '507f1f77bcf86cd799439011',
revision: '<string>',
label: '<string>',
created: 123,
$links: {
self: '//example.com/path/to/object',
asset: '//example.com/path/to/object',
project: '//example.com/path/to/object',
studio: '//example.com/path/to/object'
},
path: 'https://example.com/path/to/object',
language: '<string>',
type: '<string>',
embargo: {start: '<unknown>', end: 123}
})
};
fetch('https://api-staging.pixwel.com/api/previews', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-staging.pixwel.com/api/previews",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'_id' => '507f1f77bcf86cd799439011',
'asset' => '507f1f77bcf86cd799439011',
'project' => '507f1f77bcf86cd799439011',
'studio' => '507f1f77bcf86cd799439011',
'revision' => '<string>',
'label' => '<string>',
'created' => 123,
'$links' => [
'self' => '//example.com/path/to/object',
'asset' => '//example.com/path/to/object',
'project' => '//example.com/path/to/object',
'studio' => '//example.com/path/to/object'
],
'path' => 'https://example.com/path/to/object',
'language' => '<string>',
'type' => '<string>',
'embargo' => [
'start' => '<unknown>',
'end' => 123
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-staging.pixwel.com/api/previews"
payload := strings.NewReader("{\n \"_id\": \"507f1f77bcf86cd799439011\",\n \"asset\": \"507f1f77bcf86cd799439011\",\n \"project\": \"507f1f77bcf86cd799439011\",\n \"studio\": \"507f1f77bcf86cd799439011\",\n \"revision\": \"<string>\",\n \"label\": \"<string>\",\n \"created\": 123,\n \"$links\": {\n \"self\": \"//example.com/path/to/object\",\n \"asset\": \"//example.com/path/to/object\",\n \"project\": \"//example.com/path/to/object\",\n \"studio\": \"//example.com/path/to/object\"\n },\n \"path\": \"https://example.com/path/to/object\",\n \"language\": \"<string>\",\n \"type\": \"<string>\",\n \"embargo\": {\n \"start\": \"<unknown>\",\n \"end\": 123\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-staging.pixwel.com/api/previews")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"_id\": \"507f1f77bcf86cd799439011\",\n \"asset\": \"507f1f77bcf86cd799439011\",\n \"project\": \"507f1f77bcf86cd799439011\",\n \"studio\": \"507f1f77bcf86cd799439011\",\n \"revision\": \"<string>\",\n \"label\": \"<string>\",\n \"created\": 123,\n \"$links\": {\n \"self\": \"//example.com/path/to/object\",\n \"asset\": \"//example.com/path/to/object\",\n \"project\": \"//example.com/path/to/object\",\n \"studio\": \"//example.com/path/to/object\"\n },\n \"path\": \"https://example.com/path/to/object\",\n \"language\": \"<string>\",\n \"type\": \"<string>\",\n \"embargo\": {\n \"start\": \"<unknown>\",\n \"end\": 123\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-staging.pixwel.com/api/previews")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"_id\": \"507f1f77bcf86cd799439011\",\n \"asset\": \"507f1f77bcf86cd799439011\",\n \"project\": \"507f1f77bcf86cd799439011\",\n \"studio\": \"507f1f77bcf86cd799439011\",\n \"revision\": \"<string>\",\n \"label\": \"<string>\",\n \"created\": 123,\n \"$links\": {\n \"self\": \"//example.com/path/to/object\",\n \"asset\": \"//example.com/path/to/object\",\n \"project\": \"//example.com/path/to/object\",\n \"studio\": \"//example.com/path/to/object\"\n },\n \"path\": \"https://example.com/path/to/object\",\n \"language\": \"<string>\",\n \"type\": \"<string>\",\n \"embargo\": {\n \"start\": \"<unknown>\",\n \"end\": 123\n }\n}"
response = http.request(request)
puts response.read_body{
"_id": "507f1f77bcf86cd799439011",
"asset": "507f1f77bcf86cd799439011",
"project": "507f1f77bcf86cd799439011",
"studio": "507f1f77bcf86cd799439011",
"revision": "<string>",
"label": "<string>",
"created": 123,
"$links": {
"self": "//example.com/path/to/object",
"asset": "//example.com/path/to/object",
"project": "//example.com/path/to/object",
"studio": "//example.com/path/to/object"
},
"path": "https://example.com/path/to/object",
"language": "<string>",
"type": "<string>",
"embargo": {
"start": "<unknown>",
"end": 123
}
}Previews
Create a preview
POST
/
previews
Create a preview
curl --request POST \
--url https://api-staging.pixwel.com/api/previews \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"_id": "507f1f77bcf86cd799439011",
"asset": "507f1f77bcf86cd799439011",
"project": "507f1f77bcf86cd799439011",
"studio": "507f1f77bcf86cd799439011",
"revision": "<string>",
"label": "<string>",
"created": 123,
"$links": {
"self": "//example.com/path/to/object",
"asset": "//example.com/path/to/object",
"project": "//example.com/path/to/object",
"studio": "//example.com/path/to/object"
},
"path": "https://example.com/path/to/object",
"language": "<string>",
"type": "<string>",
"embargo": {
"start": "<unknown>",
"end": 123
}
}
'import requests
url = "https://api-staging.pixwel.com/api/previews"
payload = {
"_id": "507f1f77bcf86cd799439011",
"asset": "507f1f77bcf86cd799439011",
"project": "507f1f77bcf86cd799439011",
"studio": "507f1f77bcf86cd799439011",
"revision": "<string>",
"label": "<string>",
"created": 123,
"$links": {
"self": "//example.com/path/to/object",
"asset": "//example.com/path/to/object",
"project": "//example.com/path/to/object",
"studio": "//example.com/path/to/object"
},
"path": "https://example.com/path/to/object",
"language": "<string>",
"type": "<string>",
"embargo": {
"start": "<unknown>",
"end": 123
}
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
_id: '507f1f77bcf86cd799439011',
asset: '507f1f77bcf86cd799439011',
project: '507f1f77bcf86cd799439011',
studio: '507f1f77bcf86cd799439011',
revision: '<string>',
label: '<string>',
created: 123,
$links: {
self: '//example.com/path/to/object',
asset: '//example.com/path/to/object',
project: '//example.com/path/to/object',
studio: '//example.com/path/to/object'
},
path: 'https://example.com/path/to/object',
language: '<string>',
type: '<string>',
embargo: {start: '<unknown>', end: 123}
})
};
fetch('https://api-staging.pixwel.com/api/previews', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-staging.pixwel.com/api/previews",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'_id' => '507f1f77bcf86cd799439011',
'asset' => '507f1f77bcf86cd799439011',
'project' => '507f1f77bcf86cd799439011',
'studio' => '507f1f77bcf86cd799439011',
'revision' => '<string>',
'label' => '<string>',
'created' => 123,
'$links' => [
'self' => '//example.com/path/to/object',
'asset' => '//example.com/path/to/object',
'project' => '//example.com/path/to/object',
'studio' => '//example.com/path/to/object'
],
'path' => 'https://example.com/path/to/object',
'language' => '<string>',
'type' => '<string>',
'embargo' => [
'start' => '<unknown>',
'end' => 123
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-staging.pixwel.com/api/previews"
payload := strings.NewReader("{\n \"_id\": \"507f1f77bcf86cd799439011\",\n \"asset\": \"507f1f77bcf86cd799439011\",\n \"project\": \"507f1f77bcf86cd799439011\",\n \"studio\": \"507f1f77bcf86cd799439011\",\n \"revision\": \"<string>\",\n \"label\": \"<string>\",\n \"created\": 123,\n \"$links\": {\n \"self\": \"//example.com/path/to/object\",\n \"asset\": \"//example.com/path/to/object\",\n \"project\": \"//example.com/path/to/object\",\n \"studio\": \"//example.com/path/to/object\"\n },\n \"path\": \"https://example.com/path/to/object\",\n \"language\": \"<string>\",\n \"type\": \"<string>\",\n \"embargo\": {\n \"start\": \"<unknown>\",\n \"end\": 123\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-staging.pixwel.com/api/previews")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"_id\": \"507f1f77bcf86cd799439011\",\n \"asset\": \"507f1f77bcf86cd799439011\",\n \"project\": \"507f1f77bcf86cd799439011\",\n \"studio\": \"507f1f77bcf86cd799439011\",\n \"revision\": \"<string>\",\n \"label\": \"<string>\",\n \"created\": 123,\n \"$links\": {\n \"self\": \"//example.com/path/to/object\",\n \"asset\": \"//example.com/path/to/object\",\n \"project\": \"//example.com/path/to/object\",\n \"studio\": \"//example.com/path/to/object\"\n },\n \"path\": \"https://example.com/path/to/object\",\n \"language\": \"<string>\",\n \"type\": \"<string>\",\n \"embargo\": {\n \"start\": \"<unknown>\",\n \"end\": 123\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-staging.pixwel.com/api/previews")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"_id\": \"507f1f77bcf86cd799439011\",\n \"asset\": \"507f1f77bcf86cd799439011\",\n \"project\": \"507f1f77bcf86cd799439011\",\n \"studio\": \"507f1f77bcf86cd799439011\",\n \"revision\": \"<string>\",\n \"label\": \"<string>\",\n \"created\": 123,\n \"$links\": {\n \"self\": \"//example.com/path/to/object\",\n \"asset\": \"//example.com/path/to/object\",\n \"project\": \"//example.com/path/to/object\",\n \"studio\": \"//example.com/path/to/object\"\n },\n \"path\": \"https://example.com/path/to/object\",\n \"language\": \"<string>\",\n \"type\": \"<string>\",\n \"embargo\": {\n \"start\": \"<unknown>\",\n \"end\": 123\n }\n}"
response = http.request(request)
puts response.read_body{
"_id": "507f1f77bcf86cd799439011",
"asset": "507f1f77bcf86cd799439011",
"project": "507f1f77bcf86cd799439011",
"studio": "507f1f77bcf86cd799439011",
"revision": "<string>",
"label": "<string>",
"created": 123,
"$links": {
"self": "//example.com/path/to/object",
"asset": "//example.com/path/to/object",
"project": "//example.com/path/to/object",
"studio": "//example.com/path/to/object"
},
"path": "https://example.com/path/to/object",
"language": "<string>",
"type": "<string>",
"embargo": {
"start": "<unknown>",
"end": 123
}
}Authorizations
BasicAuthBearerAuth
Email address and password. A personal access token (pat_…) or session token (token-…) may also be sent in the password field, with any non-empty value as the username — a blank username short-circuits to a 401 before the token is read.
Body
application/json
Example:
"507f1f77bcf86cd799439011"
Example:
"507f1f77bcf86cd799439011"
Example:
"507f1f77bcf86cd799439011"
Example:
"507f1f77bcf86cd799439011"
Show child attributes
Show child attributes
Example:
"https://example.com/path/to/object"
Show child attributes
Show child attributes
Response
OK
Example:
"507f1f77bcf86cd799439011"
Example:
"507f1f77bcf86cd799439011"
Example:
"507f1f77bcf86cd799439011"
Example:
"507f1f77bcf86cd799439011"
Show child attributes
Show child attributes
Example:
"https://example.com/path/to/object"
Show child attributes
Show child attributes
⌘I