ContentResource

Post contentsresourcesderive

Derive an image with a named recipe and answer with the asset it is stored under, so a caller that cannot run the recipe itself (a pod without the matte model) can have the deployment holding it do the work and then draw the result from the shared store.

Internal only: it derives an arbitrary url on demand, and the identity it derives into is the x-rlvt-company-id of the internal request, so it is refused without the internal secret rather than left to a user token.

POST

contents

resources

derive

cURL

curl --request POST \
  --url https://api.reelevant.com/v2/contents/resources/derive \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "recipe": "<string>",
  "url": "<string>",
  "refresh": true,
  "prompt": "<string>",
  "frame": "<string>",
  "variant": "<string>",
  "size": 123
}
'

import requests

url = "https://api.reelevant.com/v2/contents/resources/derive"

payload = {
    "recipe": "<string>",
    "url": "<string>",
    "refresh": True,
    "prompt": "<string>",
    "frame": "<string>",
    "variant": "<string>",
    "size": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    recipe: '<string>',
    url: '<string>',
    refresh: true,
    prompt: '<string>',
    frame: '<string>',
    variant: '<string>',
    size: 123
  })
};

fetch('https://api.reelevant.com/v2/contents/resources/derive', 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.reelevant.com/v2/contents/resources/derive",
  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([
    'recipe' => '<string>',
    'url' => '<string>',
    'refresh' => true,
    'prompt' => '<string>',
    'frame' => '<string>',
    'variant' => '<string>',
    'size' => 123
  ]),
  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 := "https://api.reelevant.com/v2/contents/resources/derive"

	payload := strings.NewReader("{\n  \"recipe\": \"<string>\",\n  \"url\": \"<string>\",\n  \"refresh\": true,\n  \"prompt\": \"<string>\",\n  \"frame\": \"<string>\",\n  \"variant\": \"<string>\",\n  \"size\": 123\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.reelevant.com/v2/contents/resources/derive")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"recipe\": \"<string>\",\n  \"url\": \"<string>\",\n  \"refresh\": true,\n  \"prompt\": \"<string>\",\n  \"frame\": \"<string>\",\n  \"variant\": \"<string>\",\n  \"size\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.reelevant.com/v2/contents/resources/derive")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"recipe\": \"<string>\",\n  \"url\": \"<string>\",\n  \"refresh\": true,\n  \"prompt\": \"<string>\",\n  \"frame\": \"<string>\",\n  \"variant\": \"<string>\",\n  \"size\": 123\n}"

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "program": "<string>",
  "version": "<string>",
  "datetime": "<string>",
  "message": "<string>",
  "data": {
    "identifier": "<string>",
    "version": "<string>",
    "contentType": "<string>",
    "generated": true
  },
  "code": 123
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

recipe

string

required

Name of the recipe to apply

url

string

Source image url. Required for every recipe but the generate ones (background), which read only the prompt.

refresh

boolean

Derive from what the origin serves now rather than answering with the asset already in the shared store

prompt

string

Generation prompt, for recipes that generate their asset (background). It alone is the derived identifier.

frame

string

Identifier of the stored frame a useSources generation is conditioned on. The caller stored it; this peer only reads it, so asking to render one it cannot find fails the derivation rather than producing an unconditioned background.

variant

string

A regenerate nonce, part of the generation fingerprint on the caller's side too: the peer derives under the same identifier the caller would.

size

number

Edge of the square an unconditioned generation runs at. Part of the identifier on the caller's side too, so the peer derives the same asset the caller already named.

Response

200 - application/json

status

enum<string>

required

Available options:

success

program

string

required

version

string

required

datetime

string

required

message

string

required

data

object

required

Show child attributes

code

number

⌘I

cURL

curl --request POST \
  --url https://api.reelevant.com/v2/contents/resources/derive \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "recipe": "<string>",
  "url": "<string>",
  "refresh": true,
  "prompt": "<string>",
  "frame": "<string>",
  "variant": "<string>",
  "size": 123
}
'

import requests

url = "https://api.reelevant.com/v2/contents/resources/derive"

payload = {
    "recipe": "<string>",
    "url": "<string>",
    "refresh": True,
    "prompt": "<string>",
    "frame": "<string>",
    "variant": "<string>",
    "size": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    recipe: '<string>',
    url: '<string>',
    refresh: true,
    prompt: '<string>',
    frame: '<string>',
    variant: '<string>',
    size: 123
  })
};

fetch('https://api.reelevant.com/v2/contents/resources/derive', 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.reelevant.com/v2/contents/resources/derive",
  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([
    'recipe' => '<string>',
    'url' => '<string>',
    'refresh' => true,
    'prompt' => '<string>',
    'frame' => '<string>',
    'variant' => '<string>',
    'size' => 123
  ]),
  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 := "https://api.reelevant.com/v2/contents/resources/derive"

	payload := strings.NewReader("{\n  \"recipe\": \"<string>\",\n  \"url\": \"<string>\",\n  \"refresh\": true,\n  \"prompt\": \"<string>\",\n  \"frame\": \"<string>\",\n  \"variant\": \"<string>\",\n  \"size\": 123\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.reelevant.com/v2/contents/resources/derive")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"recipe\": \"<string>\",\n  \"url\": \"<string>\",\n  \"refresh\": true,\n  \"prompt\": \"<string>\",\n  \"frame\": \"<string>\",\n  \"variant\": \"<string>\",\n  \"size\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.reelevant.com/v2/contents/resources/derive")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"recipe\": \"<string>\",\n  \"url\": \"<string>\",\n  \"refresh\": true,\n  \"prompt\": \"<string>\",\n  \"frame\": \"<string>\",\n  \"variant\": \"<string>\",\n  \"size\": 123\n}"

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "program": "<string>",
  "version": "<string>",
  "datetime": "<string>",
  "message": "<string>",
  "data": {
    "identifier": "<string>",
    "version": "<string>",
    "contentType": "<string>",
    "generated": true
  },
  "code": 123
}

Getting Started

SDKs

Data Collection

Web Integration

Mobile Integration

Guides

Datasources API

Contents API

Workflow API

Datasources Collector

Entity Manager API

Statistics API

Post contentsresourcesderive

Authorizations

Body

Response