README

Introduction

Picsart Image Tools API is a simple HTTP interface. The results are usually the URL of the output image. To get started, first you need to get your API Key. Below you can find the sample codes to get started easily. Reference docs are given with more information about available parameters that can be adjusted. ## Sample Run curl -X POST \\ 'https://api.picsart.io/tools/1.0/removebg' \\ -H 'x-picsart-api-key: APIKEYHERE' \\ -F 'output_type=cutout' \\ -F 'image_url=https://cdn140.picsart.com/13902645939997000779.jpg' ## Server The demo environment has been removed (https://api.picsart.io/tools/demo/). We recommend that you use the new production environment (https://api.picsart.io/tools/1.0/) instead. Please contact us if you find any issues. ## API Key To try out our services you will need to * create an account, * create an app under My Apps * and get the API key required for authorization. You can find more details about this process in the Quickstart. ## Input File Input images of type JPG, PNG and WEBP are supported. Input image file size is 100 MB max. References to uploaded image files will be valid and can be used within 24 hours. ## Output Formats You can request one of three formats, JPG, PNG, WEBP, via the format parameter. The result files will be available for use for 24 hours. ## Rate Limit Users can process up to 100 requests per month during the demo run. When the rate limit is hit, the API will return 429 code with the info: { \"fault\": { \"faultstring\": \"Rate limit quota violation. Quota limit exceeded. Identifier : _default\", \"detail\": { \"errorcode\": \"policies.ratelimit.QuotaViolation\" } } } ## Authentication Authentication should be done via the provided API Key. API Key can be sent as a header: curl 'https://api.picsart.io/tools/1.0/effects' -H 'x-picsart-api-key: APIKEY' Developer Guidelines

This PHP package is automatically generated by the Swagger Codegen project:

API version: 2.0
Build package: io.swagger.codegen.v3.generators.php.PhpClientCodegen

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/git_user_id/git_repo_id.git"
    }
  ],
  "require": {
    "git_user_id/git_repo_id": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/SwaggerClient-php/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apiKey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Picsart-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Picsart-API-Key', 'Bearer');

$apiInstance = new Swagger\Client\Api\AdjustApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->adjustPost();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdjustApi->adjustPost: ', $e->getMessage(), PHP_EOL;
}

// Configure API key authorization: apiKey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Picsart-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Picsart-API-Key', 'Bearer');

$apiInstance = new Swagger\Client\Api\AdjustApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->editPost();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdjustApi->editPost: ', $e->getMessage(), PHP_EOL;
}
?>

Documentation for API Endpoints

All URIs are relative to https://api.picsart.io/tools/1.0

Class	Method	HTTP request	Description
AdjustApi	adjustPost	POST /adjust	Adjust
AdjustApi	editPost	POST /edit	Basic Editing
ContentGenerationApi	backgroundTexturePost	POST /background/texture	Texture Generator
ConversionApi	vectorizerPost	POST /vectorizer	Image Vectorizer
EffectsApi	effectsGet	GET /effects	Effects
EffectsApi	effectsPost	POST /effects
EffectsApi	effectsPreviewsPost	POST /effects/previews	Effect Previews
EffectsApi	masksPost	POST /masks
EffectsApi	masksPreviewsPost	POST /masks/previews
PhotoEnhancementApi	enhanceFacePost	POST /enhance/face	Face Enhancement
PhotoEnhancementApi	upscaleEnhancePost	POST /upscale/enhance	Ultra Enhance
PhotoEnhancementApi	upscalePost	POST /upscale	Upscale
PhotoEnhancementApi	upscaleUltraPost	POST /upscale/ultra	Upscale Ultra
PhotoEnhancementApi	upscaleUltraTransactionIdGet	GET /upscale/ultra/{transaction_id}
RemoveBackgroundApi	removebgPost	POST /removebg	Remove & Change Background
StyleTransferApi	styletransferPost	POST /styletransfer	Style Transfer
UploadApi	uploadPost	POST /upload

fourkitchens / picsart-api-client

Maintainers

Details

README

Introduction

Requirements

Installation & Usage

Composer

Manual Installation

Tests

Getting Started

Documentation for API Endpoints

Documentation For Models

Documentation For Authorization

apiKey

Author