{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"1a0c8ed0-6203-4728-b898-917d4d6c264f","name":"API documentation","description":"## Overview\n\nThis 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](https://choppity.com/contact) to request a specific new endpoint to be added to the API.\n\n## **Getting started**\n\nTo start using the API:\n\n- You must use a valid API Key to send requests to the API endpoints. You can get your API key from [your account page](https://choppity.com/account). You must be a paying Choppity customer to use the API.\n    \n- The API has rate and usage limits.\n    \n- The API only responds to HTTPS-secured communications.\n    \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    \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    \n\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\".\n\n## Authentication\n\nThe 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'.\n\n### Authentication error response\n\nIf 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.\n\n## Status codes\n\n| Code | Status | Description |\n| --- | --- | --- |\n| 200 | OK | Request was successful. |\n| 400 | Bad request | The request failed due to an invalid request. |\n| 401 | Unauthorized | Missing or invalid API key. |\n| 404 | Not found | The requested resource doesn’t exist. |\n| 429 | Too many requests | Too many requests were sent to the API. |\n| 500 | Server error | Something went wrong on Choppity's end. |\n\n## Template IDs\n\nFor 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<img src=\"https://choppity-resources.s3.eu-west-2.amazonaws.com/docs/templateIds.png\">\n\n### **Need some help?**\n\nPlease contact Aaron, our CTO (email: [aaron@choppity.com](https://mailto:aaron@choppity.com)), he's always happy to help!","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"33432036","team":6287365,"collectionId":"1a0c8ed0-6203-4728-b898-917d4d6c264f","publishedId":"2sA3XPBhNX","public":true,"publicUrl":"https://docs.choppity.com","privateUrl":"https://go.postman.co/documentation/33432036-1a0c8ed0-6203-4728-b898-917d4d6c264f","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"6329BC"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":"Choppity API Documentation"}],"appearance":{"default":"dark","themes":[{"name":"dark","logo":"https://content.pstmn.io/f7e1a301-0028-418a-b0ba-9aa1de0d13e7/Y2hvcHBpdHktdy5wbmc=","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"B295DF"}},{"name":"light","logo":"https://content.pstmn.io/fef141ea-2ea7-499c-8db5-25ce87d1f586/Y2hvcHBpdHkucG5n","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"6329BC"}}]}},"version":"8.10.0","publishDate":"2024-06-12T15:53:18.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Choppity API Documentation","description":""},"logos":{"logoLight":"https://content.pstmn.io/fef141ea-2ea7-499c-8db5-25ce87d1f586/Y2hvcHBpdHkucG5n","logoDark":"https://content.pstmn.io/f7e1a301-0028-418a-b0ba-9aa1de0d13e7/Y2hvcHBpdHktdy5wbmc="}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/55e5b5507646533a07474b3e414edaf92cec56fe1eb4e69cd401a20101b6aa0c","favicon":"https://res.cloudinary.com/postman/image/upload/v1718365950/team/oatiwccsomtsrmrwazjr.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://docs.choppity.com/view/metadata/2sA3XPBhNX"}