Documentation

Create and manage your meta profiles and their processes through simple API calls. You can do it through your Ziggeo account dashboard, however you can also do it through your own API calls.

It is simple, fast and bellow you can see exactly how to do it.

Fork me on GitHub
  • create
    Create a new meta profile.
    $ziggeo->metaProfiles()->create($arguments = array())
    
    1. key Meta Profile profile key.
    2. title Meta Profile profile title.
    This method returns JSON
    Example:
    <?php
    /*
    	This script will show you how to create a meta profile
    
    	Parameters you need to pass:
    	1. app_token
    	2. private_key
    	3. meta_title
    	4. meta_key
    */
    require_once(dirname(__FILE__) . "/../Ziggeo.php");
    
    $opts = getopt("", array("app_token:", "private_key:", "meta_title:", "meta_key:"));
    
    $ziggeo = new Ziggeo($opts["app_token"], $opts["private_key"]);
    
    $ziggeo->metaProfiles()->create(array(
    	"title" => $opts["meta_title"],
    	"key" => (!empty($opts["meta_key"])) ? $opts["meta_key"] : null
    ));
    
    ?>
    
  • index
    Get list of meta profiles.
    $ziggeo->metaProfiles()->index($arguments = array())
    
    1. limit Limit the number of returned meta profiles. Can be set up to 100.
    2. skip Skip the first [n] entries.
    3. reverse Reverse the order in which meta profiles are returned.
    This method returns JSON
  • get
    Get a single meta profile
    $ziggeo->metaProfiles()->get($token_or_key)
    
    This method returns JSON
  • delete
    Delete the meta profile
    $ziggeo->metaProfiles()->delete($token_or_key)
    
  • index
    Return all processes associated with a meta profile
    $ziggeo->metaProfileProcess()->index($meta_token_or_key)
    
    This method returns JSON
  • get
    Get a single process
    $ziggeo->metaProfileProcess()->get($meta_token_or_key, $token_or_key)
    
    This method returns JSON
  • delete
    Delete the process
    $ziggeo->metaProfileProcess()->delete($meta_token_or_key, $token_or_key)
    
  • create_video_analysis_process
    Create a new video analysis meta process
    $ziggeo->metaProfileProcess()->create_video_analysis_process($meta_token_or_key)
    
    This method returns JSON
    Example:
    <?php
    /*
    	This script will show you how to create a meta profile and attach video analysis process
    
    	Info: https://ziggeo.com/features/visual-analysis
    
    	Parameters you need to pass:
    	1. app_token
    	2. private_key
    	3. meta_title
    	4. meta_key
    */
    require_once(dirname(__FILE__) . "/../Ziggeo.php");
    
    $opts = getopt("", array("app_token:", "private_key:", "meta_title:", "meta_key:"));
    
    //We initiate our SDK
    $ziggeo = new Ziggeo($opts["app_token"], $opts["private_key"]);
    
    $metaprofiles = $ziggeo->metaProfiles()->create(array(
    	"title" => $opts["meta_title"],
    	"key" => (!empty($opts["meta_key"])) ? $opts["meta_key"] : null
    ));
    
    $ziggeo->metaProfileProcess()->create_video_analysis_process($metaprofiles->token));
    
    ?>
    
  • create_audio_transcription_process
    Create a new audio transcription meta process
    $ziggeo->metaProfileProcess()->create_audio_transcription_process($meta_token_or_key)
    
    This method returns JSON
    Example:
    <?php
    /*
    	This script will show you how to create a meta profile and attach audio transcription process
    
    	Info: https://ziggeo.com/features/audio-transcription
    
    	Parameters you need to pass:
    	1. app_token
    	2. private_key
    	3. meta_title
    	4. meta_key
    */
    require_once(dirname(__FILE__) . "/../Ziggeo.php");
    
    $opts = getopt("", array("app_token:", "private_key:", "meta_title:", "meta_key:"));
    
    //We initiate our SDK
    $ziggeo = new Ziggeo($opts["app_token"], $opts["private_key"]);
    
    $metaprofiles = $ziggeo->metaProfiles()->create(array(
    	"title" => $opts["meta_title"],
    	"key" => (!empty($opts["meta_key"])) ? $opts["meta_key"] : null
    ));
    
    $ziggeo->metaProfileProcess()->create_audio_transcription_process($metaprofiles->token);
    
    ?>
    
  • create_nsfw_process
    Create a new nsfw filter meta process
    $ziggeo->metaProfileProcess()->create_nsfw_process($meta_token_or_key, $arguments = array())
    
    1. nsfw_action One of the following three: approve, reject, nothing.
    This method returns JSON
    Example:
    <?php
    /*
    	This script will show you how to create a meta profile and attach NSFW process
    
    	Info: https://ziggeo.com/features/nsfw
    
    	Parameters you need to pass:
    	1. app_token
    	2. private_key
    	3. meta_title
    	4. meta_key
    */
    require_once(dirname(__FILE__) . "/../Ziggeo.php");
    
    $opts = getopt("", array("app_token:", "private_key:", "meta_title:", "meta_key:"));
    
    //We initiate our SDK
    $ziggeo = new Ziggeo($opts["app_token"], $opts["private_key"]);
    
    $metaprofiles = $ziggeo->metaProfiles()->create(array(
    	"title" => $opts["meta_title"],
    	"key" => (!empty($opts["meta_key"])) ? $opts["meta_key"] : null
    ));
    
    $ziggeo->metaProfileProcess()->create_nsfw_process($metaprofiles->token, array("nsfw_action"=>"reject"));
    
    ?>