Getting Started
This page will help you get started with pictory-api. You'll be up and running in a jiffy!
Pictory APIs are completely RESTful and all our responses are returned in JSON. This guide details API calls, return object properties and specific API flows.
All Pictory APIs are authorized using Access Token. The access token can be obtained by providing the Client ID and Client Secret in the Authentication API. Prior to working with the Pictory APIs, request client_id
, client_secret
and X-Pictory-User-Id
from the Pictory sales team.
Following are sample use-cases which can be used to Create and Edit Videos using Pictory APIs:
πTry Pictory's API
You can try our API using Pictory's Postman collection.
Github Examples
We recommend you visit our Github Page to learn how to use our APIs effectively.
Click here to view Pictory Nodejs Examples on Github
Authentication
Access Token can be obtained by providing cliient_id and client secret in authorization API. Check More about Authentication Here.
πAPI Request Headers
All API requests need to have Authorisation
and X-Pictory-User-Id
parameter in the header requests.
π API Responses
All API responses contain success and data properties in JSON format. Check the success property to verify the call's success.
Success Response
{
"success": true,
"data": {...}
}
The data property of errors will include error_message and error_code to help you determine what went wrong. Non-zero error codes should never change. You can rely on them to make programming flow choices if necessary.
Error Response
{
"success": false,
"error": {
"error_message": "Error Message",
"error_code": 890
}
}
Updated 5 months ago