curl --request PATCH \
--url http://localhost:3000/api/v1/assets/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"tags": [
"<string>"
],
"fields": {},
"title": "<string>",
"description": "<string>",
"creator": "<string>",
"copyright": "<string>",
"reviewNote": "<string>",
"proposedTags": [
"<string>"
],
"rights": {
"license": "<string>",
"territories": [
"<string>"
],
"channels": [
"<string>"
],
"embargo": "2023-12-25",
"expires": "2023-12-25"
},
"parentAssetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"generator": "<string>",
"prompt": "<string>",
"supersededBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"private": true
}
'import requests
url = "http://localhost:3000/api/v1/assets/{id}"
payload = {
"tags": ["<string>"],
"fields": {},
"title": "<string>",
"description": "<string>",
"creator": "<string>",
"copyright": "<string>",
"reviewNote": "<string>",
"proposedTags": ["<string>"],
"rights": {
"license": "<string>",
"territories": ["<string>"],
"channels": ["<string>"],
"embargo": "2023-12-25",
"expires": "2023-12-25"
},
"parentAssetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"generator": "<string>",
"prompt": "<string>",
"supersededBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"private": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
tags: ['<string>'],
fields: {},
title: '<string>',
description: '<string>',
creator: '<string>',
copyright: '<string>',
reviewNote: '<string>',
proposedTags: ['<string>'],
rights: {
license: '<string>',
territories: ['<string>'],
channels: ['<string>'],
embargo: '2023-12-25',
expires: '2023-12-25'
},
parentAssetId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
generator: '<string>',
prompt: '<string>',
supersededBy: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
private: true
})
};
fetch('http://localhost:3000/api/v1/assets/{id}', 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}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'tags' => [
'<string>'
],
'fields' => [
],
'title' => '<string>',
'description' => '<string>',
'creator' => '<string>',
'copyright' => '<string>',
'reviewNote' => '<string>',
'proposedTags' => [
'<string>'
],
'rights' => [
'license' => '<string>',
'territories' => [
'<string>'
],
'channels' => [
'<string>'
],
'embargo' => '2023-12-25',
'expires' => '2023-12-25'
],
'parentAssetId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'generator' => '<string>',
'prompt' => '<string>',
'supersededBy' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'private' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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 := "http://localhost:3000/api/v1/assets/{id}"
payload := strings.NewReader("{\n \"tags\": [\n \"<string>\"\n ],\n \"fields\": {},\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"creator\": \"<string>\",\n \"copyright\": \"<string>\",\n \"reviewNote\": \"<string>\",\n \"proposedTags\": [\n \"<string>\"\n ],\n \"rights\": {\n \"license\": \"<string>\",\n \"territories\": [\n \"<string>\"\n ],\n \"channels\": [\n \"<string>\"\n ],\n \"embargo\": \"2023-12-25\",\n \"expires\": \"2023-12-25\"\n },\n \"parentAssetId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"generator\": \"<string>\",\n \"prompt\": \"<string>\",\n \"supersededBy\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"private\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.patch("http://localhost:3000/api/v1/assets/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"tags\": [\n \"<string>\"\n ],\n \"fields\": {},\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"creator\": \"<string>\",\n \"copyright\": \"<string>\",\n \"reviewNote\": \"<string>\",\n \"proposedTags\": [\n \"<string>\"\n ],\n \"rights\": {\n \"license\": \"<string>\",\n \"territories\": [\n \"<string>\"\n ],\n \"channels\": [\n \"<string>\"\n ],\n \"embargo\": \"2023-12-25\",\n \"expires\": \"2023-12-25\"\n },\n \"parentAssetId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"generator\": \"<string>\",\n \"prompt\": \"<string>\",\n \"supersededBy\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"private\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/v1/assets/{id}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"tags\": [\n \"<string>\"\n ],\n \"fields\": {},\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"creator\": \"<string>\",\n \"copyright\": \"<string>\",\n \"reviewNote\": \"<string>\",\n \"proposedTags\": [\n \"<string>\"\n ],\n \"rights\": {\n \"license\": \"<string>\",\n \"territories\": [\n \"<string>\"\n ],\n \"channels\": [\n \"<string>\"\n ],\n \"embargo\": \"2023-12-25\",\n \"expires\": \"2023-12-25\"\n },\n \"parentAssetId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"generator\": \"<string>\",\n \"prompt\": \"<string>\",\n \"supersededBy\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"private\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sha256": "<string>",
"filename": "<string>",
"mime": "<string>",
"size": 0,
"width": 0,
"height": 0,
"probe": {},
"metadata": {
"title": "<string>",
"description": "<string>",
"keywords": [
"<string>"
],
"creator": "<string>",
"copyright": "<string>",
"capturedAt": "<string>",
"camera": "<string>",
"lens": "<string>",
"gps": {
"lat": 123,
"lon": 123
}
},
"tags": [
"<string>"
],
"fields": {},
"inherited": {},
"status": "draft",
"state": "draft",
"deletedAt": "2023-11-07T05:31:56Z",
"stackId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version": 0,
"current": true,
"proposedBy": "<string>",
"reviewNote": "<string>",
"proposedTags": [
"<string>"
],
"rights": {
"license": "<string>",
"territories": [
"<string>"
],
"channels": [
"<string>"
],
"embargo": "2023-12-25",
"expires": "2023-12-25",
"modelRelease": "released"
},
"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",
"private": true,
"collections": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"detail": "<unknown>"
}
}Edit an asset, or review what was proposed
Also its rights (replaced whole), provenance (origin, parentAssetId, generator, prompt), and supersededBy: the asset that replaces it, which /api/v1/check then names. status moves it through its lifecycle: draft, proposed (in review), active (approved), archived, rejected. Submitting or reworking a draft takes write; any other move takes write with the approve ability.
Scope: write.
curl --request PATCH \
--url http://localhost:3000/api/v1/assets/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"tags": [
"<string>"
],
"fields": {},
"title": "<string>",
"description": "<string>",
"creator": "<string>",
"copyright": "<string>",
"reviewNote": "<string>",
"proposedTags": [
"<string>"
],
"rights": {
"license": "<string>",
"territories": [
"<string>"
],
"channels": [
"<string>"
],
"embargo": "2023-12-25",
"expires": "2023-12-25"
},
"parentAssetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"generator": "<string>",
"prompt": "<string>",
"supersededBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"private": true
}
'import requests
url = "http://localhost:3000/api/v1/assets/{id}"
payload = {
"tags": ["<string>"],
"fields": {},
"title": "<string>",
"description": "<string>",
"creator": "<string>",
"copyright": "<string>",
"reviewNote": "<string>",
"proposedTags": ["<string>"],
"rights": {
"license": "<string>",
"territories": ["<string>"],
"channels": ["<string>"],
"embargo": "2023-12-25",
"expires": "2023-12-25"
},
"parentAssetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"generator": "<string>",
"prompt": "<string>",
"supersededBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"private": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
tags: ['<string>'],
fields: {},
title: '<string>',
description: '<string>',
creator: '<string>',
copyright: '<string>',
reviewNote: '<string>',
proposedTags: ['<string>'],
rights: {
license: '<string>',
territories: ['<string>'],
channels: ['<string>'],
embargo: '2023-12-25',
expires: '2023-12-25'
},
parentAssetId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
generator: '<string>',
prompt: '<string>',
supersededBy: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
private: true
})
};
fetch('http://localhost:3000/api/v1/assets/{id}', 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}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'tags' => [
'<string>'
],
'fields' => [
],
'title' => '<string>',
'description' => '<string>',
'creator' => '<string>',
'copyright' => '<string>',
'reviewNote' => '<string>',
'proposedTags' => [
'<string>'
],
'rights' => [
'license' => '<string>',
'territories' => [
'<string>'
],
'channels' => [
'<string>'
],
'embargo' => '2023-12-25',
'expires' => '2023-12-25'
],
'parentAssetId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'generator' => '<string>',
'prompt' => '<string>',
'supersededBy' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'private' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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 := "http://localhost:3000/api/v1/assets/{id}"
payload := strings.NewReader("{\n \"tags\": [\n \"<string>\"\n ],\n \"fields\": {},\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"creator\": \"<string>\",\n \"copyright\": \"<string>\",\n \"reviewNote\": \"<string>\",\n \"proposedTags\": [\n \"<string>\"\n ],\n \"rights\": {\n \"license\": \"<string>\",\n \"territories\": [\n \"<string>\"\n ],\n \"channels\": [\n \"<string>\"\n ],\n \"embargo\": \"2023-12-25\",\n \"expires\": \"2023-12-25\"\n },\n \"parentAssetId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"generator\": \"<string>\",\n \"prompt\": \"<string>\",\n \"supersededBy\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"private\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.patch("http://localhost:3000/api/v1/assets/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"tags\": [\n \"<string>\"\n ],\n \"fields\": {},\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"creator\": \"<string>\",\n \"copyright\": \"<string>\",\n \"reviewNote\": \"<string>\",\n \"proposedTags\": [\n \"<string>\"\n ],\n \"rights\": {\n \"license\": \"<string>\",\n \"territories\": [\n \"<string>\"\n ],\n \"channels\": [\n \"<string>\"\n ],\n \"embargo\": \"2023-12-25\",\n \"expires\": \"2023-12-25\"\n },\n \"parentAssetId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"generator\": \"<string>\",\n \"prompt\": \"<string>\",\n \"supersededBy\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"private\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/v1/assets/{id}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"tags\": [\n \"<string>\"\n ],\n \"fields\": {},\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"creator\": \"<string>\",\n \"copyright\": \"<string>\",\n \"reviewNote\": \"<string>\",\n \"proposedTags\": [\n \"<string>\"\n ],\n \"rights\": {\n \"license\": \"<string>\",\n \"territories\": [\n \"<string>\"\n ],\n \"channels\": [\n \"<string>\"\n ],\n \"embargo\": \"2023-12-25\",\n \"expires\": \"2023-12-25\"\n },\n \"parentAssetId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"generator\": \"<string>\",\n \"prompt\": \"<string>\",\n \"supersededBy\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"private\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sha256": "<string>",
"filename": "<string>",
"mime": "<string>",
"size": 0,
"width": 0,
"height": 0,
"probe": {},
"metadata": {
"title": "<string>",
"description": "<string>",
"keywords": [
"<string>"
],
"creator": "<string>",
"copyright": "<string>",
"capturedAt": "<string>",
"camera": "<string>",
"lens": "<string>",
"gps": {
"lat": 123,
"lon": 123
}
},
"tags": [
"<string>"
],
"fields": {},
"inherited": {},
"status": "draft",
"state": "draft",
"deletedAt": "2023-11-07T05:31:56Z",
"stackId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version": 0,
"current": true,
"proposedBy": "<string>",
"reviewNote": "<string>",
"proposedTags": [
"<string>"
],
"rights": {
"license": "<string>",
"territories": [
"<string>"
],
"channels": [
"<string>"
],
"embargo": "2023-12-25",
"expires": "2023-12-25",
"modelRelease": "released"
},
"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",
"private": true,
"collections": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"detail": "<unknown>"
}
}Authorizations
An API key: ab_...
Path Parameters
Asset id
Body
Replaces the whole set
10064Merges; null clears one unless it is required
Show child attributes
Show child attributes
2000200020002000"proposed" submits a draft for review; "active" approves it; "rejected" turns it down and keeps it, with reviewNote; "archived" retires it, and /a/{id} answers 410. Anything but submitting or reworking a draft takes approve
draft, proposed, active, archived, rejected Why it was rejected, for whoever proposed it
2000Replaces the pending suggestions; [] dismisses them all
10064Replaces them whole; null clears
Show child attributes
Show child attributes
Defaults to what its Content Credentials say, if any
shot, licensed, generated The asset it was made from: the photo an edit started from, a model's input
^([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)$The tool or model that made it, e.g. "gpt-image 2.0"
200For a generated asset: what it was asked for
10000The asset that replaces this one; /api/v1/check then refuses it and names that
^([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)$Only people with a grant on it, or on a collection it is in, and admins see it
Response
The updated asset
Show child attributes
Show child attributes