What an asset is and may be used for
curl --request GET \
--url http://localhost:3000/api/v1/assets/{id}/description \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:3000/api/v1/assets/{id}/description"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:3000/api/v1/assets/{id}/description', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/v1/assets/{id}/description",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://localhost:3000/api/v1/assets/{id}/description"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:3000/api/v1/assets/{id}/description")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/v1/assets/{id}/description")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"filename": "<string>",
"mime": "<string>",
"size": 0,
"width": 0,
"height": 0,
"sha256": "<string>",
"status": "draft",
"state": "draft",
"version": 0,
"current": true,
"proposedBy": "<string>",
"reviewNote": "<string>",
"title": "<string>",
"description": "<string>",
"creator": "<string>",
"copyright": "<string>",
"tags": [
"<string>"
],
"fields": {},
"collections": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"rights": {
"license": "<string>",
"territories": [
"<string>"
],
"channels": [
"<string>"
],
"embargo": "2023-12-25",
"expires": "2023-12-25",
"modelRelease": "released"
},
"provenance": {
"origin": "shot",
"parentAssetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"generator": "<string>",
"prompt": "<string>",
"c2pa": {
"manifests": 0,
"generator": "<string>",
"title": "<string>",
"signedBy": "<string>",
"actions": [
"<string>"
],
"digitalSourceType": "<string>",
"softwareAgent": "<string>",
"ingredients": 0
}
},
"supersededBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"urls": {
"original": "<string>",
"download": "<string>",
"rendition": "<string>"
},
"constraints": {
"w": [
123,
123
],
"h": [
123,
123
],
"q": [
123,
123
],
"fit": [
"cover"
],
"f": [
"jpeg"
],
"enlarges": false
},
"alternatives": [
{
"name": "<string>",
"url": "<string>"
}
]
}{
"error": {
"code": "<string>",
"message": "<string>",
"detail": "<unknown>"
}
}API Reference
What an asset is and may be used for
Title, credit, tags, effective field values, rights, provenance, what supersedes it, its URLs, the transforms it allows and ready-made rendition URLs. Whether a particular use is allowed: POST /api/v1/check.
Scope: read.
GET
/
api
/
v1
/
assets
/
{id}
/
description
What an asset is and may be used for
curl --request GET \
--url http://localhost:3000/api/v1/assets/{id}/description \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:3000/api/v1/assets/{id}/description"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:3000/api/v1/assets/{id}/description', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/v1/assets/{id}/description",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://localhost:3000/api/v1/assets/{id}/description"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:3000/api/v1/assets/{id}/description")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/v1/assets/{id}/description")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"filename": "<string>",
"mime": "<string>",
"size": 0,
"width": 0,
"height": 0,
"sha256": "<string>",
"status": "draft",
"state": "draft",
"version": 0,
"current": true,
"proposedBy": "<string>",
"reviewNote": "<string>",
"title": "<string>",
"description": "<string>",
"creator": "<string>",
"copyright": "<string>",
"tags": [
"<string>"
],
"fields": {},
"collections": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"rights": {
"license": "<string>",
"territories": [
"<string>"
],
"channels": [
"<string>"
],
"embargo": "2023-12-25",
"expires": "2023-12-25",
"modelRelease": "released"
},
"provenance": {
"origin": "shot",
"parentAssetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"generator": "<string>",
"prompt": "<string>",
"c2pa": {
"manifests": 0,
"generator": "<string>",
"title": "<string>",
"signedBy": "<string>",
"actions": [
"<string>"
],
"digitalSourceType": "<string>",
"softwareAgent": "<string>",
"ingredients": 0
}
},
"supersededBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"urls": {
"original": "<string>",
"download": "<string>",
"rendition": "<string>"
},
"constraints": {
"w": [
123,
123
],
"h": [
123,
123
],
"q": [
123,
123
],
"fit": [
"cover"
],
"f": [
"jpeg"
],
"enlarges": false
},
"alternatives": [
{
"name": "<string>",
"url": "<string>"
}
]
}{
"error": {
"code": "<string>",
"message": "<string>",
"detail": "<unknown>"
}
}Authorizations
bearersession
An API key: ab_...
Path Parameters
Asset id
Response
The description
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Required range:
-9007199254740991 <= x <= 9007199254740991Required range:
-9007199254740991 <= x <= 9007199254740991Required range:
-9007199254740991 <= x <= 9007199254740991Available options:
draft, proposed, active, archived, rejected Only active is served at /a/{id} to anyone; expired and archived answer 410
Available options:
draft, proposed, active, expired, archived, rejected, deleted Its number in its stack of versions; null when it has one
Required range:
-9007199254740991 <= x <= 9007199254740991The version to use: its stack's current one, or the only one
Effective values: own over inherited
Show child attributes
Show child attributes
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Show child attributes
Show child attributes
Show child attributes
Show child attributes
Replaced: use this one instead
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Show child attributes
Show child attributes
What a rendition of this asset may ask for; null when it can't be transformed
Show child attributes
Show child attributes
Ready-made renditions
Show child attributes
Show child attributes