Dynamically render videos using Cartender's custom video templates and validation schemas. Learn more by emailing sales@cartender.com.
\nAuthenticate with the API using your Car Render API email and password via POST /users/authenticate
Get a client token for bearer token authorization.
\n180 requests per 100 seconds.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Authentication","slug":"authentication"},{"content":"Default Rate limit","slug":"default-rate-limit"}],"owner":"32580146","collectionId":"3b3c7dd6-eb8e-401f-a5aa-4954431e1ac8","publishedId":"2sA2r81PB8","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-09-10T01:37:26.000Z"},"item":[{"name":"/users/authenticate","id":"aa994c1d-f426-40a2-9f8a-f252b33e6c43","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"email\":\"{{user_email}}\",\n \"password\":\"{{user_pass}}\"\n}"},"url":"https://renderapi.cartender.co/users/authenticate","description":"All requests require an authentication token presented in the header of each HTTP request.
\nExample Request Header Token:
\nAuthorization: Bearer token\n\nTokens can be refreshed, but currently have no explicit expiration or TTL. It is recommended to authenticate before each API request and not store or rely upon older tokens.
\n","urlObject":{"protocol":"https","path":["users","authenticate"],"host":["renderapi","cartender","co"],"query":[],"variable":[]}},"response":[{"id":"978442d6-501a-4745-9d60-f3a3fe00cf9c","name":"/users/authenticate","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\":\"{{user_email}}\",\n \"password\":\"{{user_pass}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://renderapi.cartender.co/users/authenticate"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Mon, 06 Jan 2020 19:45:30 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"2d7-32FSL0tnNyH8pAGhL9ucBaSBwF4\""},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"email_notification\": {\n \"enable\": false,\n \"email_address\": \"{{user_email}}\",\n \"source_web\": true,\n \"source_google\": true,\n \"url_s3\": true,\n \"url_yt\": true,\n \"s3_base_url\": \"\"\n },\n \"render_sqs\": {\n \"enable\": true,\n \"url\": \"https://sqs.us-west-2.amazonaws.com/000000\",\n \"queue_name\": \"render\",\n \"region\": \"us-west-2\"\n },\n \"template_sqs\": {\n \"enable\": true,\n \"url\": \"https://sqs.us-west-2.amazonaws.com/000000\",\n \"queue_name\": \"template\",\n \"region\": \"us-west-2\"\n },\n \"_id\": \"5d6a64accd110b53dd171b2f\",\n \"email\": \"{{user_email}}\",\n \"company\": \"Demo\",\n \"company_id\": \"demo\",\n \"__v\": 0,\n \"createDate\": \"2019-08-31T12:14:36.716Z\",\n \"token\": \"token\"\n}"}],"_postman_id":"aa994c1d-f426-40a2-9f8a-f252b33e6c43"},{"name":"/users/authenticate/register","id":"6fab4807-9c8c-4903-9dce-e2e8cbb0b286","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"email\":\"{{user_email}}\",\n \"password\":\"{{user_pass}}\"\n}"},"url":"https://renderapi.cartender.co/users/authenticate","description":"All requests require an authentication token presented in the header of each HTTP request.
\nExample Request Header Token:
\nAuthorization: Bearer token\n\nTokens can be refreshed, but currently have no explicit expiration or TTL. It is recommended to authenticate before each API request and not store or rely upon older tokens.
\n","urlObject":{"protocol":"https","path":["users","authenticate"],"host":["renderapi","cartender","co"],"query":[],"variable":[]}},"response":[{"id":"91383c07-d998-42c1-88c1-d58612a83716","name":"/users/authenticate","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\":\"{{user_email}}\",\n \"password\":\"{{user_pass}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://renderapi.cartender.co/users/authenticate"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Mon, 06 Jan 2020 19:45:30 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"2d7-32FSL0tnNyH8pAGhL9ucBaSBwF4\""},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"email_notification\": {\n \"enable\": false,\n \"email_address\": \"\",\n \"source_web\": true,\n \"source_google\": true,\n \"url_s3\": true,\n \"url_yt\": true,\n \"s3_base_url\": \"\"\n },\n \"render_sqs\": {\n \"enable\": true,\n \"url\": \"https://sqs.us-west-2.amazonaws.com/000000\",\n \"queue_name\": \"render\",\n \"region\": \"us-west-2\"\n },\n \"template_sqs\": {\n \"enable\": true,\n \"url\": \"https://sqs.us-west-2.amazonaws.com/000000\",\n \"queue_name\": \"template\",\n \"region\": \"us-west-2\"\n },\n \"_id\": \"5d6a64accd110b53dd171b2f\",\n \"email\": \"{{user_email}}\",\n \"company\": \"Demo\",\n \"company_id\": \"demo\",\n \"__v\": 0,\n \"createDate\": \"2019-08-31T12:14:36.716Z\",\n \"token\": \"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\"\n}"}],"_postman_id":"6fab4807-9c8c-4903-9dce-e2e8cbb0b286"},{"name":"/users/authenticate/register","id":"eb33c8d5-f331-4720-9997-709587174366","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"email\":\"{{user_email}}\",\n \"password\":\"{{user_pass}}\"\n}"},"url":"https://renderapi.cartender.co/users/register","description":"All requests require an authentication token presented in the header of each HTTP request.
\nExample Request Header Token:
\nAuthorization: Bearer token\n\nTokens can be refreshed, but currently have no explicit expiration or TTL. It is recommended to authenticate before each API request and not store or rely upon older tokens.
\n","urlObject":{"protocol":"https","path":["users","register"],"host":["renderapi","cartender","co"],"query":[],"variable":[]}},"response":[{"id":"e3a40edd-6c4b-4dbf-9dc1-fa34a171bf0d","name":"/users/authenticate","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\":\"{{user_email}}\",\n \"password\":\"{{user_pass}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://renderapi.cartender.co/users/authenticate"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Mon, 06 Jan 2020 19:45:30 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"2d7-32FSL0tnNyH8pAGhL9ucBaSBwF4\""},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"email_notification\": {\n \"enable\": false,\n \"email_address\": \"\",\n \"source_web\": true,\n \"source_google\": true,\n \"url_s3\": true,\n \"url_yt\": true,\n \"s3_base_url\": \"\"\n },\n \"render_sqs\": {\n \"enable\": true,\n \"url\": \"https://sqs.us-west-2.amazonaws.com/000000\",\n \"queue_name\": \"render\",\n \"region\": \"us-west-2\"\n },\n \"template_sqs\": {\n \"enable\": true,\n \"url\": \"https://sqs.us-west-2.amazonaws.com/000000\",\n \"queue_name\": \"template\",\n \"region\": \"us-west-2\"\n },\n \"_id\": \"5d6a64accd110b53dd171b2f\",\n \"email\": \"{{user_email}}\",\n \"company\": \"Demo\",\n \"company_id\": \"demo\",\n \"__v\": 0,\n \"createDate\": \"2019-08-31T12:14:36.716Z\",\n \"token\": \"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\"\n}"}],"_postman_id":"eb33c8d5-f331-4720-9997-709587174366"},{"name":"/projects","id":"46659dd9-8bf6-4ca5-a196-58ac6a9ac7ea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"request-type\": \"new\",\n \"template\": {\n \"template\": \"{{example_template}}\",\n \"target\": \"HD_15s\"\n },\n \"dealership-name\": \"Cartender Motors\",\n \"account-id\": \"sample\",\n \"billing-account-id\": \"sample\",\n \"ref-id\": \"sample\",\n \"dealership-logo-type\": \"{{LogoText}}\",\n \"dealership-logo\": \"{{off}}\",\n \"event-logo\": \"{{off}}\",\n \"vehicle-type\": \"New\",\n \"vehicle-year\": \"2020\",\n \"vehicle-make\": \"Toyota\",\n \"vehicle-model\": \"RAV4\",\n \"vehicle-style\": \"Limited\",\n \"vehicle-image\": \"https://ct-car-clips.s3.us-west-1.amazonaws.com/Toyota/RAV4/2020/2020_Toyota_RAV4_Limited.png\",\n \"offer-tagline1\": \"#1 Toyota Dealer in The State\",\n \"offer-tagline2\": \"Buy Faster with Us\",\n \"offer-tagline3\": \"5 Star Google rating\",\n \"offer-type\": \"Lease\",\n \"offer-value\": \"$299/mo\",\n \"offer-terms\": \"For 36 Months\",\n \"offer-down-payment\": \"$2,000\",\n \"offer-secondary\": \"\",\n \"offer-disclaimer\": \"Expires 1/2/2021. Tax, title and registration not included.\",\n \"output\": \"sample_Lease_2020_Toyota_RAV4_Limited_HD_15s\",\n \"data-source\": \"api\",\n \"data-source-id\": \"xxxxxxxxxxxx\"\n}"},"url":"https://renderapi.cartender.co/projects","urlObject":{"protocol":"https","path":["projects"],"host":["renderapi","cartender","co"],"query":[],"variable":[]}},"response":[{"id":"50dd92e9-7c12-478c-acaf-76cbc4b6cfc9","name":"/projects","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"request-type\": \"new\",\n \"template\": {\n \"template\": \"{{example_template}}\",\n \"target\": \"HD_15s\"\n },\n \"dealership-name\": \"Cartender Motors\",\n \"account-id\": \"sample\",\n \"billing-account-id\": \"sample\",\n \"ref-id\": \"sample\",\n \"dealership-logo-type\": \"{{LogoText}}\",\n \"dealership-logo\": \"{{off}}\",\n \"event-logo\": \"{{off}}\",\n \"vehicle-type\": \"New\",\n \"vehicle-year\": \"2020\",\n \"vehicle-make\": \"Toyota\",\n \"vehicle-model\": \"RAV4\",\n \"vehicle-style\": \"Limited\",\n \"vehicle-image\": \"https://ct-car-clips.s3.us-west-1.amazonaws.com/Toyota/RAV4/2020/2020_Toyota_RAV4_Limited.png\",\n \"offer-tagline1\": \"#1 Toyota Dealer in The State\",\n \"offer-tagline2\": \"Buy Faster with Us\",\n \"offer-tagline3\": \"5 Star Google rating\",\n \"offer-type\": \"Lease\",\n \"offer-value\": \"$299/mo\",\n \"offer-terms\": \"For 36 Months\",\n \"offer-down-payment\": \"$2,000\",\n \"offer-secondary\": \"\",\n \"offer-disclaimer\": \"Expires 1/2/2021. Tax, title, registration not included.\",\n \"output\": \"sample_Lease_2020_Toyota_RAV4_Limited_HD_15s\",\n \"data-source\": \"api\",\n \"data-source-id\": \"xxxxxxxxxxxx\"\n}","options":{"raw":{"language":"json"}}},"url":"https://renderapi.cartender.co/projects"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Thu, 26 Sep 2019 19:59:28 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"388-On7MjDXM51f2Fdo819wKnh+Z4+E\""},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"request-type\": \"new\",\n \"template\": {\n \"template\": \"{{example_template}}\",\n \"target\": \"HD_15s\"\n },\n \"dealership-name\": \"Cartender Motors\",\n \"account-id\": \"sample\",\n \"billing-account-id\": \"sample\",\n \"ref-id\": \"sample\",\n \"dealership-logo-type\": \"{{LogoText}}\",\n \"dealership-logo\": \"{{off}}\",\n \"event-logo\": \"{{off}}\",\n \"vehicle-type\": \"New\",\n \"vehicle-year\": \"2020\",\n \"vehicle-make\": \"Toyota\",\n \"vehicle-model\": \"RAV4\",\n \"vehicle-style\": \"Limited\",\n \"vehicle-image\": \"https://ct-car-clips.s3.us-west-1.amazonaws.com/Toyota/RAV4/2020/2020_Toyota_RAV4_Limited.png\",\n \"offer-tagline1\": \"#1 Toyota Dealer in The State\",\n \"offer-tagline2\": \"Buy Faster with Us\",\n \"offer-tagline3\": \"5 Star Google rating\",\n \"offer-type\": \"Lease\",\n \"offer-value\": \"$299/mo\",\n \"offer-terms\": \"For 36 Months\",\n \"offer-down-payment\": \"$2,000\",\n \"offer-secondary\": \"\",\n \"offer-disclaimer\": \"Expires 1/2/2021. Tax, title and registration not included.\",\n \"output\": \"sample_Lease_2020_Toyota_RAV4_Limited_HD_15s\",\n \"data-source\": \"api\",\n \"data-source-id\": \"1234\"\n}"}],"_postman_id":"46659dd9-8bf6-4ca5-a196-58ac6a9ac7ea"},{"name":"/client/templates","id":"85d6019b-9c98-4599-953c-95b640cedb3b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"https://renderapi.cartender.co/client/templates","description":"Returns an array of video render templates associated with the authenticated client account.
\ne.g.
\n[\n {\n \"id\": \"5d9ebb81f0e019065e22f780\",\n \"template\": \"Client_Make_Theme\",\n \"targets\": [\n \"VT_6s\",\n \"SQ_15s\",\n \"HD_30s\"\n ],\n \"brands\": [\n {\n \"id\": \"5d4d318e634ac66e9f9d3937\",\n \"name\": \"Nissan\"\n }\n ]\n },\n {...},\n {...}\n]\n\nid
\nThe unique id of the template.
\nType: String
Required: Yes
Max length: 24
template
\nThe name of the template. This value will conform to the following general format: [client]_[make]_[theme]. Request a list of available templates from your GET /client/templates endpoint for a list of template.template names that are available for use within your client account.
Type: String
Required: Yes
Max length: 50
targets
\nAn array of target formats and durations that the template supports.
\ne.g.
\n[\n \"HD_6s\",\n \"HD_15s\",\n \"HD_30s\"\n],\n\nType: String
Required: Yes
Max length: 50
brands
\nAn array of brnads that the template supports.
\ne.g.
\n{\n \"id\": \"5d4d318e634ac66e9f9d3937\",\n \"name\": \"Nissan\"\n}\n\nType: String
Required: Yes
Max length: 50
Returns the currently authenticated client profile details.
\nIncludes:
\nThe templates that are currently assigned to the current user.
\nAmazon S3 bucket for video file storage. (if applicable)
\nAmazon SQS for notifications. (if applicable)
\nEmail notification preferences.
\nUser details including email, company, company_id, etc.
Note: See example response for details.
\n","urlObject":{"protocol":"https","path":["client","profile"],"host":["renderapi","cartender","co"],"query":[],"variable":[]}},"response":[{"id":"80cd4170-3fc3-4fa4-84c7-c68d199fb294","name":"/client/profile","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded","disabled":true}],"url":"https://renderapi.cartender.co/client/profile"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Thu, 09 Jan 2020 02:36:20 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"6ea-Wq+2SC3kV006DqlBnROouaYtXFE\""},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"user\": {\n \"id\": \"************0b53dd171b2f\",\n \"yt\": {\n \"access_token\": \"token\",\n \"refresh_token\": \"token\",\n \"scope\": \"https://www.googleapis.com/auth/youtube.force-ssl\",\n \"token_type\": \"Bearer\",\n \"expiry_date\": \"2020-01-06T16:45:39.197Z\"\n },\n \"s3\": {\n \"region\": \"us-west-2\",\n \"bucket\": \"myfiles\",\n \"access_key\": \"key\",\n \"secret_key\": \"key\",\n \"key_path\": \"videos/\",\n \"acl\": \"\",\n \"storage_class\": \"ONEZONE_IA\"\n },\n \"email_notification\": {\n \"enable\": false,\n \"email_address\": \"\",\n \"source_web\": true,\n \"source_google\": true,\n \"url_s3\": true,\n \"url_yt\": true,\n \"s3_base_url\": \"\"\n },\n \"render_sqs\": {\n \"enable\": true,\n \"url\": \"https://sqs.us-west-2.amazonaws.com/XXXXXXXXXXXX\",\n \"queue_name\": \"test\",\n \"region\": \"us-west-2\"\n },\n \"template_sqs\": {\n \"enable\": true,\n \"url\": \"https://sqs.us-west-2.amazonaws.com/XXXXXXXXXXXX\",\n \"queue_name\": \"test\",\n \"region\": \"us-west-2\"\n },\n \"email\": \"{{user_email}}\",\n \"company\": \"Demo\",\n \"company_id\": \"demo\",\n \"createDate\": \"2019-08-31T12:14:36.716Z\"\n },\n \"youtube_auth_url\": \"https://accounts.google.com/o/oauth2/v2/auth?access_type=offline&scope=https%3A%2F%2Fwww.googleapis.com%2Fauth%2Fyoutube.force-ssl&prompt=consent&response_type=code&client_id=xxx.apps.googleusercontent.com&redirect_uri=http%3A%2F%2Frender.cartender.co%2Foauth2callback\",\n \"templates\": [\n {\n \"id\": \"************19065e22f780\",\n \"template\": \"{{example_template}}\",\n \"targets\": [\"HD_15s\"],\n \"brands\": [\n {\n \"id\": \"************c66e9f9d3937\",\n \"name\": \"Nissan\"\n }\n ]\n },\n {\n \t\"id\": \"************19065e22f7ae\",\n \"template\": \"{{example_template}}-2\",\n \"targets\": [\"HD_15s,HD_6s\"],\n \"brands\": [\n {\n \"id\": \"************c66e9f9d393f\",\n \"name\": \"Toyota\"\n }\n ]\n }\n ]\n}"}],"_postman_id":"04421f3d-e88a-44ff-be7e-51135d32acdf"},{"name":"/projects/count","id":"817426c0-a296-438a-8767-ff8011613be5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://renderapi.cartender.co/projects/count","description":"Get the current user's total count of active projects in the system. Any projets that have already completed will not be reflected in the count number returned.
\n","urlObject":{"protocol":"https","path":["projects","count"],"host":["renderapi","cartender","co"],"query":[],"variable":[]}},"response":[{"id":"295cea4d-5238-4fee-aaf4-dc0859880330","name":"/projects/count","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded","disabled":true}],"url":"https://renderapi.cartender.co/projects/count"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Thu, 09 Jan 2020 02:48:27 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"1-tlifxqsNyCzxIJnRwtQKuZToQQw\""}],"cookie":[],"responseTime":null,"body":"22"}],"_postman_id":"817426c0-a296-438a-8767-ff8011613be5"},{"name":"/projects","id":"73545467-2fd1-43fe-a1d6-203acfde3540","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://renderapi.cartender.co/projects?page=1&limit=2&sort=-createDate","description":"Get list of projects for current user. Use render-status value for filtering.
The unique id of the project. This can be used to request the current status of a specific project with the GET /project/{id} endpoint.
\nType: String
Required: Yes
Max length: 24
Example: 5e31f2d6d92d6b0f50231d0d
\nThe stage of the render cycle that the request is currently within.
\nType: String
Required: No
Max length: 25
Default: ready
ready - New render project successfully added to system. (default)
preprocessing - Project is preprocessing video or images (if applicable) before versioning.
queued - Project is queued for rendering.
preparing - Project is being prepared for rendering.
waiting - Project is prepared and waiting to be rendered.
rendering - Project is being rendered and uploaded.
encoding - Project mp4 file is being encoded.
uploading - Project mp4 video file is being uploaded to AWS S3 and/or YouTube.
finished - Project is complete (encoded and uploaded).
canceled - Project has been canceled.
archived - Project has been archived (either after the render has finished or been canceled).
error - Project encountered and error and did not complete.
Properties:
\nid
\nThe unique id of the template.
\nType: String
Required: Yes
Max length: 24
template-type
\nThe requested template type.
\nType: String
Required: Yes
Max length: 50
Options:
\nnew-vehicle-offer (default)
used-vehicle-offer
service-offer
dealer-branding
template
\nThe name of the template. This value will conform to the following general format: [client][make][theme]. Request a list of available templates from your GET /client/templates endpoint for a list of template.template names that are available for use within your client account.
Type: String
Required: Yes
Max length: 50
version
\nThe version of the template used in the render request.
\nType: Number
Required: Yes
schema_id
\nThe id number of the schema associated with the template. The schema is used for validation of template properties when each render request is submitted.
\nType: String
Required: Yes
Max length: 24
target
\nThe target format and duration of the video render.
\ne.g. HD_15s = format_duration = \"High Definition\"_\"15 Seconds\"
\nType: String
Required: Yes
Max length: 50
change-reason
\nThe reason for the version change if the version is greater than 1.
\ne.g. \"Change font per compliance requirements.\"
Type: String
Required: Yes
Max length: 100
change-type
\nThe type of template change that occured.
\ne.g. \"compliance-update\"
Type: String
Required: Yes
Max length: 100
\"template\": {\n \"id\": \"5d9ebb81f0e019065e22f780\",\n \"template-type\": \"new-vehicle-offer\",\n \"template\": \"{{example_template}}\",\n \"version\": 3,\n \"schema_id\": \"5dd5a2a9e3d3595d3e4228fe\",\n \"target\": \"HD_15s\",\n \"change-reason\": \"Change font per compliance requirements.\",\n \"change-type\": \"compliance-update\"\n}\nThe video metadata object contains video rendering details including: width, height, bitrate and duration of the video being rendered.
\nContext: This information is only included after the encoding stage.
Type: Object
\nnull if render failed
Example:
\n{\n \"width\": \"1280\", (pixels)\n \"height\": \"720\", (pixels)\n \"bitrate\": \"1218\", (kbps)\n \"duration\": \"42\" (seconds)\n}\nThe low-quality preview video URL if request-type = preview.
\nContext: This information is only included at the finished stage.
Type: String
\n\nThe URL of the rendered video file if stored via Amazon S3.
\nContext: This information is only included at the finished stage.
Type: String
\n\n##youtube_url
\nThe URL of the rendered video file if stored via YouTube.
\nContext: This information is only included at the finished stage.
Type: String
\n##fb_url
\nThe URL of the rendered video file if stored via Facebook.
\nContext: This information is only included at the finished stage.
Type: String
\nThis is the status of your video render request quota. For example, if your limit per 100 seconds is \"180\" then a current of \"71\" represents the number of requests that have already been made within 100 seconds.
{\n limit: \"180\",\n current: \"33\"\n}\nContext: This information is included within the immediate reponse to POST requests for new projects and all subsequent GET requests for projects.
\nType: String
\nnull if YouTube upload failed
Example:
https://www.youtube.com/watch?v=TQB9OcjV3Sk
The URL of the video uploaded to YouTube if applicable.
\nContext: This information is only included after uploading stage.
Type: String
\nnull if YouTube upload failed
Example:
https://www.youtube.com/watch?v=TQB9OcjV3Sk
The length of time (in seconds) that the project took to render the video file.
\nContext: This information is only included after encoding stage.
Type: Number
\nThe length of time (in seconds) that the project took to upload the video file.
\nContext: This information is only included after 'uploading' stage.
\nType: Number
\nThe total length of time (in seconds) that the project took to render and upload the video file.
\nContext: This information is only included at finished stage.
Type: Number
\nAll GET requests that return more than one object offer pagination params in the API request URL.
\nExample paginated request:
\nGET /projects/?page=2&limit=10&sort=-createDate\nThis request returns the second page of results with 10 results per page being returned in descending order by -createDate (newest first)
Return the indicated page of a result set.
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Limits the number of items returned per page.
\n","type":"text/plain"},"key":"limit","value":"2"},{"description":{"content":"Sorts the returned results by selected sort criteria.
\nPlacing a minus sign (-) before the property returns the sorted property in descending order. No minus sign returns ascending order. Sort by createDate, startDate, completeDate, uploadDate.
\n","type":"text/plain"},"key":"sort","value":"-createDate"}],"variable":[]}},"response":[{"id":"dbaf487a-e07c-47d9-b7f6-f3454cef1f16","name":"/projects","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://renderapi.cartender.co/projects?page=1&limit=2&sort=-createDate","protocol":"https","host":["renderapi","cartender","co"],"path":["projects"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"2"},{"key":"sort","value":"-createDate"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Thu, 21 Nov 2019 18:16:29 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"80892-GvtTEn7E7t4i6QKoyJvy2K9eBc0\""},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"projects\": [\n \t{\n\t \"render-status\": \"finished\",\n\t \"id\": \"**********8dce02d32601b2\",\n\t \"render-cycle-time\": 80,\n \"upload-cycle-time\": 2,\n \"total-cycle-time\": 82,\n\t \"template\": {\n\t \"template-type\": \"new-vehicle-offer\",\n\t \"id\": \"**********f4b403392e4c53\",\n\t \"template\": \"{{example_template}}\",\n\t \"target\": \"HD_15s\",\n\t \"schema_id\": \"**********d78a9359ffbf43d5\",\n\t \"version\": 2,\n\t \"_id\": \"**********f4b403392e4c53\"\n\t },\n\t \"client\": {\n\t \"id\": \"**********110b53dd171b2f\",\n\t \"company\": \"Cartender Demo\",\n\t \"company_id\": \"ctdemo\",\n\t \"_id\": \"**********110b53dd171b2f\"\n\t },\n\t \"request-type\": \"new\",\n\t \"dealership-logo-type\": \"{{LogoText}}\",\n\t \"dealership-name\": \"Cartender Motors\",\n\t \"account-id\": \"sample\",\n\t \"billing-account-id\": \"sample\",\n\t \"ref-id\": \"sample\",\n\t \"dealership-logo\": \"{{off}}\",\n\t \"event-logo\": \"{{off}}\",\n\t \"vehicle-type\": \"New\",\n\t \"vehicle-year\": \"2020\",\n\t \"vehicle-make\": \"Toyota\",\n\t \"vehicle-model\": \"RAV4\",\n\t \"vehicle-style\": \"Limited\",\n\t \"vehicle-image\": \"https://ct-car-clips.s3.us-west-1.amazonaws.com/Toyota/RAV4/2020/2020_Toyota_RAV4_Limited.png\",\n\t\t\t\"offer-tagline1\": \"#1 Toyota Dealer in The State\",\n\t\t\t\"offer-tagline2\": \"Buy Faster with Us\",\n\t \"offer-tagline3\": \"5 Star Google rating\",\n\t \"offer-type\": \"Lease\",\n\t \"offer-value\": \"$299/mo\",\n\t \"offer-terms\": \"For 36 Months\",\n\t \"offer-down-payment\": \"$2,000\",\n\t \"offer-secondary\": \"\",\n\t \"offer-disclaimer\": \"Expires 1/2/2021. Tax, title, registration not included.\",\n\t \"output\": \"sample_Lease_2020_Toyota_RAV4_Limited_HD_15s_1573795704238_1574359681443\",\n\t \"data-source\": \"api\",\n\t \"data-source-id\": \"1234\",\n \"request-quota-status\": {\n \"limit\": 180,\n \"current\": 2\n },\n \"render-cycle-time\": 160,\n \"upload-cycle-time\": 0,\n \"total-cycle-time\": 160,\n\t \"createDate\": \"2020-01-03T19:18:54.453Z\",\n\t \"startDate\": \"2020-01-03T19:19:02.314Z\",\n\t \"completeDate\": \"2020-01-03T19:20:27.968Z\",\n\t \"uploadDate\": \"2020-01-03T19:20:27.641Z\",\n \"video-metadata\": {\n \"width\": \"1280\",\n \"height\": \"720\",\n \"bitrate\": \"961\",\n \"duration\": \"15\"\n },\n \"s3_url\": \"https://myfiles.s3.us-west-2.amazonaws.com/demo/sample_Lease_2020_Toyota_RAV4_Limited_HD_15s_1573795704238_1578079134454.mp4\"\n\t }\n\t],\n \"total\": 56,\n \"limit\": 2,\n \"totalPages\": 28,\n \"page\": 1,\n \"pagingCounter\": 1,\n \"hasPrevPage\": false,\n \"hasNextPage\": true,\n \"prev\": null,\n \"next\": 2\n\t\n}"}],"_postman_id":"73545467-2fd1-43fe-a1d6-203acfde3540"},{"name":"/projects/{status}","id":"849f064d-29d4-4b38-a638-d83c8814623f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://renderapi.cartender.co/projects/finished?page=1&limit=2&sort=-createDate","description":"Get a list of projects by a specific status (e.g. ready).
Example:\nGET /projects/finished
ready - New render project successfully added to system. (default)
queued - Project is queued for rendering.
preparing - Project is being prepared for rendering.
waiting - Project is prepared and waiting to be rendered.
rendering - Project is being rendered and uploaded.
encoding - Project mp4 file is being encoded.
uploading - Project mp4 video file is being uploaded to AWS S3 and/or YouTube.
finished - Project is complete (encoded and uploaded).
canceled - Project has been canceled.
archived - Project has been archived. (either after the render has finished or been canceled).
error - Project encountered and error and did not complete.
Return the indicated page of a result set.
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Limits the number of items returned per page.
\n","type":"text/plain"},"key":"limit","value":"2"},{"description":{"content":"Sorts the returned results by selected sort criteria.
\nPlacing a minus sign (-) before the property returns the sorted property in descending order. No minus sign returns ascending order. Sort by createDate, startDate, completeDate, uploadDate.
\n","type":"text/plain"},"key":"sort","value":"-createDate"}],"variable":[]}},"response":[{"id":"bbaeaba4-eef5-415a-92c3-cb55200196b1","name":"/projects/finished","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://renderapi.cartender.co/projects/finished?page=1&limit=2&sort=-createDate","protocol":"https","host":["renderapi","cartender","co"],"path":["projects","finished"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"2"},{"key":"sort","value":"-createDate"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Fri, 10 Jan 2020 01:09:09 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"f60-Wiyh22yeWHwIyhQyKKNqxt/7cpQ\""},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"projects\": [\n \t{\n\t \"render-status\": \"finished\",\n\t \"id\": \"**********dce02d32601b2\",\n\t \"template\": {\n\t \"template-type\": \"new-vehicle-offer\",\n\t \"id\": \"**********f4b403392e4c53\",\n\t \"template\": \"{{example_template}}\",\n\t \"target\": \"HD_15s\",\n\t \"schema_id\": \"**********d78a9359ffbf43d5\",\n\t \"version\": 2\n\t },\n\t \"client\": {\n\t \"id\": \"**********b53dd171b2f\",\n\t \"company\": \"Demo\",\n\t \"company_id\": \"demo\"\n\t },\n\t \"request-type\": \"new\",\n\t \"dealership-logo-type\": \"{{LogoText}}\",\n\t \"dealership-name\": \"Demo\",\n\t \"account-id\": \"demo\",\n\t \"billing-account-id\": \"demo\",\n\t \"ref-id\": \"sample\",\n\t \"dealership-logo\": \"{{off}}\",\n\t \"event-logo\": \"{{off}}\",\n\t \"vehicle-type\": \"New\",\n\t \"vehicle-year\": \"2020\",\n\t \"vehicle-make\": \"Toyota\",\n\t \"vehicle-model\": \"RAV4\",\n\t \"vehicle-style\": \"Limited\",\n\t \"vehicle-image\": \"https://myfiles.s3.us-west-1.amazonaws.com/Toyota/RAV4/2020/2020_Toyota_RAV4_Limited.png\",\n\t\t\t\"offer-tagline1\": \"#1 Toyota Dealer in The State\",\n\t\t\t\"offer-tagline2\": \"Buy Faster with Us\",\n\t \"offer-tagline3\": \"5 Star Google rating\",\n\t \"offer-type\": \"Lease\",\n\t \"offer-value\": \"$299/mo\",\n\t \"offer-terms\": \"For 36 Months\",\n\t \"offer-down-payment\": \"$2,000\",\n\t \"offer-secondary\": \"\",\n\t \"offer-disclaimer\": \"Expires 1/2/2021. Tax, title, registration not included.\",\n\t \"output\": \"sample_Lease_2020_Toyota_RAV4_Limited_HD_15s_1573795704238_1574359681443\",\n\t \"data-source\": \"api\",\n\t \"data-source-id\": \"xxxxxx\",\n \"request-quota-status\": {\n \"limit\": 180,\n \"current\": 2\n },\n \"render-cycle-time\": 160,\n \"upload-cycle-time\": 0,\n \"total-cycle-time\": 160,\n\t \"createDate\": \"2020-01-03T19:18:54.453Z\",\n\t \"startDate\": \"2020-01-03T19:19:02.314Z\",\n\t \"completeDate\": \"2020-01-03T19:20:27.968Z\",\n\t \"uploadDate\": \"2020-01-03T19:20:27.641Z\",\n \"video-metadata\": {\n \"width\": \"1280\",\n \"height\": \"720\",\n \"bitrate\": \"961\",\n \"duration\": \"15\"\n },\n \"s3_url\": \"https://myfiles.s3.us-west-2.amazonaws.com/demo/sample_Lease_2020_Toyota_RAV4_Limited_HD_15s_1573795704238_1578079134454.mp4\"\n\t }\n\t],\n \"total\": 33,\n \"limit\": 2,\n \"totalPages\": 17,\n \"page\": 1,\n \"pagingCounter\": 1,\n \"hasPrevPage\": false,\n \"hasNextPage\": true,\n \"prev\": null,\n \"next\": 2\n\t\n}"}],"_postman_id":"849f064d-29d4-4b38-a638-d83c8814623f"},{"name":"/projects/{id}","id":"c0036a6f-7631-4a69-86ad-229e18cd8714","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://renderapi.cartender.co/projects/68128f77cdf305e878092361","description":"Get the details of a specific project by ID.
\nExample:\nGET /projects/5e0f93a0a58dce02d32601b2
Returns the project with a project id matching 5e0f93a0a58dce02d32601b2.
If the project does not exist a 404 - Not Found will be returned.