PARAMETERS

Our API allows you to retrieve informations from our website via GET request and supports the following query parameters:

Name	Meaning	Description
t (required)	Query type.	This parameter specify the type of the query, `u` is for profile informations, `t` is for job informations, `a` is for all jobs informations, `n` is for all nodes informations.
q (required)	Requested username.	The `t` parameter supports two values: u = username [returns basic profile informations containing the following] `id` = returns the unique user id `first_name` = returns the first name `last_name` = returns the last bame `website` = returns the website `description` = returns the description `image` = returns the profile avatar image `facebook` = returns the facebook `x.com` = returns the x.com `instagram` = returns the instagram `youtube` = returns the youtube `vimeo` = returns the vimeo `linkedin` = returns the linkedin t = job [returns informations about the job id] `id` = returns the unique job id `title` = returns the job title `description` = returns the description of the job `engine` = returns the curren engine `extension` = returns the extension allowed output `tag` = returns the tag list `start_frame` = returns the start of frame `end_frame` = returns the end of frame `total_frames` = returns the total of frame `width` = returns the width frame `height` = returns the height frame `license` = returns the license type `time` = returns the date time when was published `status` = returns the status type `priority` = returns the priority type `views` = returns the number of views `downloads` = returns the number of downloads a = jobs [returns informations about all the jobs of an user] `id` = returns the unique job id `title` = returns the job title `description` = returns the description of the job `engine` = returns the curren engine `extension` = returns the extension allowed output `tag` = returns the tag list `start_frame` = returns the start of frame `end_frame` = returns the end of frame `total_frames` = returns the total of frame `width` = returns the width frame `height` = returns the height frame `license` = returns the license type `time` = returns the date time when was published `status` = returns the status type `priority` = returns the priority type `views` = returns the number of views `downloads` = returns the number of downloads n = nodes [returns informations about all the nodes of an user] `id` = Unique identifier of the node `hostname` = rNode's hostname (machine name) `ip` = Current IP address of the node `status` = Current status of the node (e.g., active, offline, pending) `registered_at` = Date and time when the node was registered `last_seen_at` = Last time the node was connected and online

EXAMPLE GET USER INFO

For profile information of a user:
https://www.pixomea.com/api.php?t=u&q=USERNAME

Sample code PHP:

// --- API credentials ---
$app_key = 'YOUR API KEY';      // Public key of your application
$app_secret = 'YOUR API SECRET'; // Private key of your application

// --- Safe cURL helper function ---
function api_get($url) {
    $ch = curl_init($url);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 5); // 5 sec connection timeout
    curl_setopt($ch, CURLOPT_TIMEOUT, 8);        // 8 sec total timeout

    $result = curl_exec($ch);

    if (curl_errno($ch)) {
        $err = curl_error($ch);
        curl_close($ch);
        die("cURL error: $err\nURL: $url");
    }

    curl_close($ch);
    return $result;
}

// --- Step 1: Get authentication token ---
$url_token = "http://localhost/render/api/api.php?t=token&app_key=$app_key&app_secret=$app_secret";
$json = api_get($url_token);

// Clean the response (in case of PHP warnings before JSON)
if (($pos = strpos($json, '{')) !== false) {
    $json = substr($json, $pos);
}

$data = json_decode($json, true);

// Verify if token exists
if (empty($data['token'])) {
    die("Error retrieving token: " . ($data['error'] ?? 'Token missing'));
}

$token = $data['token']; // Use this token for all further requests

print_r($data);

// Get user info
$username = 'pppppp'; // Replace with the username to test
$url_user = "http://localhost/render/api/api.php?t=u&q=" . urlencode($username) . "&token=$token";
$file = api_get($url_user);

// Clean JSON response
if (($pos = strpos($file, '{')) !== false) {
    $file = substr($file, $pos);
}

$user_data = json_decode($file, true);

print_r($user_data);

EXAMPLE GET JOB INFO

For information of a job:
https://www.pixomea.com/api.php?t=t&q=IDJOB

Sample code PHP:

// --- API credentials --- $app_key = 'YOUR API KEY'; // Public key of your application $app_secret = 'YOUR API SECRET'; // Private key of your application // --- Safe cURL helper function --- function api_get($url) { $ch = curl_init($url); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 5); // 5 sec connection timeout curl_setopt($ch, CURLOPT_TIMEOUT, 8); // 8 sec total timeout $result = curl_exec($ch); if (curl_errno($ch)) { $err = curl_error($ch); curl_close($ch); die("cURL error: $err\nURL: $url"); } curl_close($ch); return $result; } // --- Step 1: Get authentication token --- $url_token = "http://localhost/render/api/api.php?t=token&app_key=$app_key&app_secret=$app_secret"; $json = api_get($url_token); // Clean the response (in case of PHP warnings before JSON) if (($pos = strpos($json, '{')) !== false) { $json = substr($json, $pos); } $data = json_decode($json, true); // Verify if token exists if (empty($data['token'])) { die("Error retrieving token: " . ($data['error'] ?? 'Token missing')); } $token = $data['token']; // Use this token for all further requests print_r($data); // Get info for a specific job $job_id = '00'; // Replace with the job ID to test $url_job = "http://localhost/render/api/api.php?t=t&id=" . urlencode($job_id) . "&token=$token"; $file = api_get($url_job); if (($pos = strpos($file, '{')) !== false) { $file = substr($file, $pos); } $job_data = json_decode($file, true); print_r($job_data);

EXAMPLE GET ALL JOBS OF AN USER

For information of all jobs of an user:
https://www.pixomea.com/api.php?t=a&q=USERNAME

Sample code PHP:

// --- API credentials ---
$app_key = 'YOUR API KEY';      // Public key of your application
$app_secret = 'YOUR API SECRET'; // Private key of your application

// --- Safe cURL helper function ---
function api_get($url) {
    $ch = curl_init($url);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 5); // 5 sec connection timeout
    curl_setopt($ch, CURLOPT_TIMEOUT, 8);        // 8 sec total timeout

    $result = curl_exec($ch);

    if (curl_errno($ch)) {
        $err = curl_error($ch);
        curl_close($ch);
        die("cURL error: $err\nURL: $url");
    }

    curl_close($ch);
    return $result;
}

// --- Step 1: Get authentication token ---
$url_token = "http://localhost/render/api/api.php?t=token&app_key=$app_key&app_secret=$app_secret";
$json = api_get($url_token);

// Clean the response (in case of PHP warnings before JSON)
if (($pos = strpos($json, '{')) !== false) {
    $json = substr($json, $pos);
}

$data = json_decode($json, true);

// Verify if token exists
if (empty($data['token'])) {
    die("Error retrieving token: " . ($data['error'] ?? 'Token missing'));
}

$token = $data['token']; // Use this token for all further requests

print_r($data);

// Get all jobs for a user
$user = 'pppppp'; // Replace with username
$url_jobs = "http://localhost/render/api/api.php?t=a&q=" . urlencode($user) . "&token=$token";
$file = api_get($url_jobs);

if (($pos = strpos($file, '{')) !== false) {
    $file = substr($file, $pos);
}

$jobs_data = json_decode($file, true);

print_r($jobs_data);

EXAMPLE GET ALL NODES OF AN USER

For information of all nodes of an user:
https://www.pixomea.com/api.php?t=n&q=USERNAME

Sample code PHP:

// --- API credentials ---
$app_key = 'YOUR API KEY';      // Public key of your application
$app_secret = 'YOUR API SECRET'; // Private key of your application

// --- Safe cURL helper function ---
function api_get($url) {
    $ch = curl_init($url);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 5); // 5 sec connection timeout
    curl_setopt($ch, CURLOPT_TIMEOUT, 8);        // 8 sec total timeout

    $result = curl_exec($ch);

    if (curl_errno($ch)) {
        $err = curl_error($ch);
        curl_close($ch);
        die("cURL error: $err\nURL: $url");
    }

    curl_close($ch);
    return $result;
}

// --- Step 1: Get authentication token ---
$url_token = "http://localhost/render/api/api.php?t=token&app_key=$app_key&app_secret=$app_secret";
$json = api_get($url_token);

// Clean the response (in case of PHP warnings before JSON)
if (($pos = strpos($json, '{')) !== false) {
    $json = substr($json, $pos);
}

$data = json_decode($json, true);

// Verify if token exists
if (empty($data['token'])) {
    die("Error retrieving token: " . ($data['error'] ?? 'Token missing'));
}

$token = $data['token']; // Use this token for all further requests

print_r($data);

// Get all nodes for a user
$user = 'pppppp'; // Replace with username
$url_nodes = "http://localhost/render/api/api.php?t=n&q=" . urlencode($user) . "&token=$token";
$file = api_get($url_nodes);

if (($pos = strpos($file, '{')) !== false) {
    $file = substr($file, $pos);
}

$nodes_data = json_decode($file, true);

print_r($nodes_data);

Paramètres utilisateur

Paramètres utilisateur

Travaillez en équipe

Installez le logiciel

Connectez vos nodes

Organisez vos projets

Lancez un rendu

Suivez vos rendus

Gérez vos jobs

Suivi des frames

Tout est prêt

Consentement relatif aux cookies