{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"fde91e9f-a6c9-4143-9c69-fea3db5191be","name":"TakeOne Public API","description":"## **Overview**\n\nThe TakeOne API provides an end-to-end solution for professional profile videos. We support the entire video creation life cycle, from guiding the user in creating the video to hosting and streaming the video on the user profile page.\n\nOur solution includes REST API, HTML video player, a recording app, and a web management tool to give our customers everything they need to integrate high-quality, better converting profile videos into their platform.\n\nThis documentation covers all the endpoints required to implement the API integration.\n\nBase url: [https://api.takeone.video](https://api.takeone.video/)\n\n## Definitions:\n\n- **App User** - The App User represents your user in the TakeOne system. This user is required to perform various actions regarding creating and managing a video for a provider.\n    \n- **Project** - the object representing all the state and data required for a video recording. Once the project is completed, that project will have a streamable link associated with the video.\n    \n- **Container** - In this context, a \"container\" is an object that serves as the central entity responsible for managing various videos and projects for a specific use case. It can be likened to a \"billboard\" where content is displayed. The container is in charge of handling all aspects of the project life cycle, including video states, determining which video is ready for publication, and managing the creation of new videos tailored to particular locations, users, and types.\n    \n- **Container template (type)** - each container has a set of characteristics that define its properties, which will eventually determine the type of videos created for that container such that all videos are from the same type. For example, a company can create a profile template with horizontal videos, and the user can record as many videos for that container. At this point, the template creation is being done on our side and is part of the pre-configuration of the integration.\n    \n\n## Webhooks:\n\nIf configured, notifications will be send to the webhook URL in the following circumstances:\n\n- A project status changes (`project_status_change`).\n    \n- Project publishing has completed (`project_published`). Project publishing is initiated either via the app user electing to publish the video, or via the Publish Project API endpoint.\n    \n- Project unpublishing has completed (`project_unpublished`). Project unpublishing is initiated via the Unpublish Project endoint.\n    \n\nEach webhook notification will include a notification type, a timestamp, a summary of the project, and a summary its video container.\n\n```\n{\n    \"type\": \"project_published\", // one of ('project_status_change', 'project_published', 'project_unpublished')\n    \"timestamp\": 1714493662,\n    \"project\": {\n        \"id\": \"694be4b1-ef0b-4a73-8b39-bba8915fa13f\",\n        \"video_container\": \"7fd3964f-9f4b-49f4-a2d7-74c2927498b7\",\n        \"user\": \"2a55b35f-612c-4bed-9409-1f0350e1a9d0\",\n        \"state\": \"completed\",\n        \"publishing_status\": \"published\",\n        \"language\": \"en\",\n        \"created_date_time\": \"2024-04-26T22:16:41.432197Z\",\n        \"modified_date_time\": \"2024-04-30T16:10:59.412675Z\",\n        \"published_video_stream\": { // deprecated\n            \"src\": \"https://customer-xxxxxx.cloudflarestream.com/xxxxxx/manifest/video.m3u8\",\n            \"type\": \"application/x-mpegURL\",\n            \"video_format\": \"landscape\",\n            \"preview_images\": {\n                \"original\": \"https://imagedelivery.net/xxxxxx/xxxxxx/original\",\n                \"high_res\": \"https://imagedelivery.net/xxxxxx/xxxxxx/3840\",\n                \"medium_res\": \"https://imagedelivery.net/xxxxxx/xxxxxx/1920\"\n            }\n        },\n        \"publishing_info\": { // either null or a map containing the published video information keyed by processed video format\n            \"portrait\": {\n                \"video\": {\n                    \"src\": \"https://customer-xxxxxx.cloudflarestream.com/xxxxxx/manifest/video.m3u8\",\n                    \"type\": \"application/x-mpegURL\"\n                },\n                \"images\": {\n                    \"original\": \"https://imagedelivery.net/xxxxxx/xxxxxx/original\",\n                    \"high_res\": \"https://imagedelivery.net/xxxxxx/xxxxxx/3840\",\n                    \"medium_res\": \"https://imagedelivery.net/xxxxxx/xxxxxx/1920\"\n                }\n            },\n            \"landscape\": {\n                \"video\": {\n                    \"src\": \"https://customer-xxxxxx.cloudflarestream.com/xxxxxx/manifest/video.m3u8\",\n                    \"type\": \"application/x-mpegURL\"\n                },\n                \"images\": {\n                    \"original\": \"https://imagedelivery.net/xxxxxx/xxxxxx/original\",\n                    \"high_res\": \"https://imagedelivery.net/xxxxxx/xxxxxx/3840\",\n                    \"medium_res\": \"https://imagedelivery.net/xxxxxx/xxxxxx/1920\"\n                }\n            }\n        }\n    },\n    \"video_container\": {\n        \"id\": \"7fd3964f-9f4b-49f4-a2d7-74c2927498b7\",\n        \"template\": \"3c0a6647-d7a8-4859-88aa-85d36f21da23\",\n        \"hotlinking_protection_enabled\": false,\n        \"allowed_origins\": [],\n        \"language\": \"en\",\n        \"created_date_time\": \"2024-04-26T22:16:41.127624Z\",\n        \"modified_date_time\": \"2024-04-26T22:16:41.127644Z\",\n        \"video_stream\": { // deprecated\n            \"src\": \"https://customer-xxxxxx.cloudflarestream.com/xxxxxx/manifest/video.m3u8\",\n            \"type\": \"application/x-mpegURL\",\n            \"video_format\": \"landscape\",\n            \"preview_images\": {\n                \"original\": \"https://imagedelivery.net/xxxxxx/xxxxxx/original\",\n                \"high_res\": \"https://imagedelivery.net/xxxxxx/xxxxxx/3840\",\n                \"medium_res\": \"https://imagedelivery.net/xxxxxx/xxxxxx/1920\"\n            }\n        },\n        \"publishing_info\": { // either null or a map containing the published video information keyed by processed video format\n            \"portrait\": {\n                \"video\": {\n                    \"src\": \"https://customer-xxxxxx.cloudflarestream.com/xxxxxx/manifest/video.m3u8\",\n                    \"type\": \"application/x-mpegURL\"\n                },\n                \"images\": {\n                    \"original\": \"https://imagedelivery.net/xxxxxx/xxxxxx/original\",\n                    \"high_res\": \"https://imagedelivery.net/xxxxxx/xxxxxx/3840\",\n                    \"medium_res\": \"https://imagedelivery.net/xxxxxx/xxxxxx/1920\"\n                }\n            },\n            \"landscape\": {\n                \"video\": {\n                    \"src\": \"https://customer-xxxxxx.cloudflarestream.com/xxxxxx/manifest/video.m3u8\",\n                    \"type\": \"application/x-mpegURL\"\n                },\n                \"images\": {\n                    \"original\": \"https://imagedelivery.net/xxxxxx/xxxxxx/original\",\n                    \"high_res\": \"https://imagedelivery.net/xxxxxx/xxxxxx/3840\",\n                    \"medium_res\": \"https://imagedelivery.net/xxxxxx/xxxxxx/1920\"\n                }\n            }\n        }\n    }\n}\n\n ```\n\nNote - Currently, the webhooks are only configurable via direct communication with our engineering support team. If you have any questions, please write to us at [info@takeone.video](https://mailto:info@takeone.video).","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"27705263","team":3011122,"collectionId":"fde91e9f-a6c9-4143-9c69-fea3db5191be","publishedId":"2s93sW9vkp","public":true,"publicUrl":"https://documenter-api.postman.tech/view/27705263/2s93sW9vkp","privateUrl":"https://go.postman.co/documentation/27705263-fde91e9f-a6c9-4143-9c69-fea3db5191be","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/53dce8bc-de1f-481e-bb88-ec470a9dc65a/RnJhbWUgNzU4NTMxMDM3LnBuZw==","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":"https://content.pstmn.io/6eaf4cba-87d9-4b01-b0d3-ab461a368e6f/dGFrZS1vbmUtaWNvbi10ZXh0LWxpZ2h0LnBuZw==","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2023-06-04T18:23:06.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/6eaf4cba-87d9-4b01-b0d3-ab461a368e6f/dGFrZS1vbmUtaWNvbi10ZXh0LWxpZ2h0LnBuZw==","logoDark":"https://content.pstmn.io/53dce8bc-de1f-481e-bb88-ec470a9dc65a/RnJhbWUgNzU4NTMxMDM3LnBuZw=="}},"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/3a6345bc585a42f7aee6f9dca730ba43ed2dc32dd1047848f0309bb3bfa07d91","favicon":""},"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://documenter.gw.postman.com/view/metadata/2s93sW9vkp"}