{"info":{"_postman_id":"1a0c8ed0-6203-4728-b898-917d4d6c264f","name":"API documentation","description":"

Overview

This API provides a set of HTTPS endpoints to interact with your account on Choppity.com. Currently only a few important endpoints exist. More endpoints will be added over time. Contact us to request a specific new endpoint to be added to the API.

Getting started

To start using the API:

You must use a valid API Key to send requests to the API endpoints. You can get your API key from your account page. You must be a paying Choppity customer to use the API.
\n
The API has rate and usage limits.
\n
The API only responds to HTTPS-secured communications.
\n
The API returns request responses in JSON format. When an API request returns an error, it is sent in the JSON response as an error key.
\n
Many of the requests are long running. Therefore, instead of sending a response straight away, the API will send a POST request to a webhook url provided by you once the request has been completed. You can also optionally supply a header which will be used in the POST request (this can be used for authentication for example).
\n

NOTE: The example code snippets provided in this documentation always show a request method of \"GET\". This should be replaced with the appropriate request method e.g. \"POST\".

Authentication

The Choppity API uses the 'Authorization' header for authentication. Every request must include a header with the name \"Authorization' and the value 'Key YOUR_API_KEY'.

Authentication error response

If an API key is missing, malformed, or invalid, or if you attempt to access a resource you don't own (e.g. a project or a template) you will receive a HTTP 401 Unauthorized response code.

Status codes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Status	Description
200	OK	Request was successful.
400	Bad request	The request failed due to an invalid request.
401	Unauthorized	Missing or invalid API key.
404	Not found	The requested resource doesn’t exist.
429	Too many requests	Too many requests were sent to the API.
500	Server error	Something went wrong on Choppity's end.

Template IDs

For certain API requests, it is possible to supply a templateId parameter. To find the IDs for your templates, open a project, click the templates button in the header, click the 3 vertical dots, and then click \"View API IDs\". Use the image below as reference.

\n\n

Need some help?

Please contact Aaron, our CTO (email: aaron@choppity.com), he's always happy to help!

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"33432036","collectionId":"1a0c8ed0-6203-4728-b898-917d4d6c264f","publishedId":"2sA3XPBhNX","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"6329BC"},"publishDate":"2024-06-12T15:53:18.000Z"},"item":[{"name":"Asset","item":[{"name":"Create an asset","event":[{"listen":"test","script":{"id":"538c0b6c-b66e-4f94-8068-f565303bfbbd","exec":[""],"type":"text/javascript","packages":{}}}],"id":"4c34b32a-dccc-49a6-bd85-5f7170ac13e6","request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"url\": \"https://choppity-resources.s3.eu-west-2.amazonaws.com/docs/example.mp4\",\r\n \"name\": \"Example video\",\r\n \"type\": \"video\",\r\n \"templateId\": \"abc-123\",\r\n \"languageCode\": \"en\",\r\n \"webhook\": {\r\n \"url\":\"https://example.com/choppity-webhook\",\r\n \"header\":{\r\n \"name\": \"webhook-secret\",\r\n \"value\": \"webhook-secret-value\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.choppity.com/v1/asset","description":"

Create an asset. Post a video url and Choppity will analyse the video and generate projects automatically. The response will be sent as a POST request to the provided webhook url.

\n","urlObject":{"path":["asset"],"host":["https://api.choppity.com/v1"],"query":[],"variable":[]}},"response":[{"id":"d5491a31-d9b4-4fef-82a2-dbda2e80cead","name":"Webhook Response","originalRequest":{"method":"GET","header":[],"url":""},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":{"content":"","type":"text/plain"}}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"statusCode\": 200,\n \"type\": \"asset\",\n \"id\": \"asset-id-123\",\n \"projects\":[\"project-id-123\", \"project-id-124\"]\n}"},{"id":"9bdf36e2-434b-49dc-93fa-3f8b62559491","name":"Success","originalRequest":{"method":"GET","header":[],"url":""},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"asset-id-123\"\n}"}],"_postman_id":"4c34b32a-dccc-49a6-bd85-5f7170ac13e6"}],"id":"438f2fef-821d-41c1-b6ae-19c43b2d2860","description":"

The /asset endpoints allows management of assets in Choppity.

\n","_postman_id":"438f2fef-821d-41c1-b6ae-19c43b2d2860"},{"name":"Render","item":[{"name":"Render a project","event":[{"listen":"test","script":{"id":"538c0b6c-b66e-4f94-8068-f565303bfbbd","exec":[""],"type":"text/javascript","packages":{}}}],"id":"1beb3555-1e52-4065-8d66-7653983042aa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"webhook\": {\r\n \"url\":\"https://example.com/choppity-webhook\",\r\n \"header\":{\r\n \"name\": \"webhook-secret\",\r\n \"value\": \"webhook-secret-value\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.choppity.com/v1/render/:pid","description":"

Renders a project with the given pid (project id) to an mp4 video file. The response contains a url to an mp4 file hosted by Choppity. The response will be sent as a POST request to the provided webhook url. The mp4 file expires after 24 hours.

\n","urlObject":{"path":["render",":pid"],"host":["https://api.choppity.com/v1"],"query":[],"variable":[{"type":"any","value":"","key":"pid"}]}},"response":[{"id":"d234f685-340c-48a8-8d61-32402639d654","name":"Webhook Response","originalRequest":{"method":"GET","header":[],"url":""},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":{"content":"","type":"text/plain"}}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"statusCode\": 200,\n \"type\": \"render\",\n \"id\": \"project-id-123\",\n \"url\": \"https://choppity.../render/example.mp4\"\n}"},{"id":"cdd1bcd1-4b57-4a9a-baa0-2475193acf36","name":"Success","originalRequest":{"method":"GET","header":[],"url":""},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"1beb3555-1e52-4065-8d66-7653983042aa"}],"id":"2f6b4bd9-1390-4e86-90d9-8df5509d3aa7","description":"

The /render endpoint enables rendering a project to an mp4 file.

\n","_postman_id":"2f6b4bd9-1390-4e86-90d9-8df5509d3aa7"}],"event":[{"listen":"prerequest","script":{"id":"b8bbfdb5-8043-41ee-a9f1-095319c78858","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"26b726b3-ff7a-42c6-91fd-941593b50b8d","type":"text/javascript","exec":[""]}}],"variable":[{"key":"url","value":"https://api.choppity.com/v1"}]}