{"templateId":"markdown","versions":[{"version":"1.0","label":"1.0","link":"/en/products/live/live_guide","default":true,"active":true,"folderId":"435399db"}],"sharedDataIds":{"sidebar":"sidebar-@l10n/en/products/live/@1.0/live.sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["img"]},"type":"markdown"},"seo":{"title":"Kollus Live API 1.0 Guide","description":"The official guide to RESTful APIs for integrating with Kollus Live services. Find detailed specifications for standardized data integration with external systems and development environment setup, from API authentication methods to example code."},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"live-api-guide","__idx":0},"children":["Live API Guide"]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["⚠️ This document is a machine-translated draft and is currently undergoing review. Some content may be inaccurate or differ from the original Korean version. For the most precise information, please refer to the Korean documentation."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Kollus Live provides a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["RESTful API"]}," for data integration with external systems."," ","This guide explains the request specifications and authentication methods. You can set up your development environment by referring to the examples."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"request-specifications","__idx":1},"children":["Request Specifications"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"rate-limit","__idx":2},"children":["Rate Limit"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A maximum of 60 calls per minute is allowed. When making consecutive calls, please maintain an interval of at least 1 second."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"request-headers","__idx":3},"children":["Request Headers"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Accept header and Content-Type must be specified according to the HTTP Method."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"HTTP Method"},"children":["HTTP Method"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Accept Header"},"children":["Accept Header"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Content-Type"},"children":["Content-Type"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}," / ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["application/json"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["-"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}," / ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["application/json"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["application/x-www-form-urlencoded"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"authentication-method","__idx":4},"children":["Authentication Method"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All API requests comply with the OAuth2 specification and must include a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Bearer Token"]}," in the request header."]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In the Kollus Live console, navigate to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["[Settings] > [Basic Information] > ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://live-kr.kollus.com/preferences/service_account","target":"_blank","rel":"noopener noreferrer"},"children":["[Service Account] tab"]}]},"."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["[Personal Access Tokens]"]}," section at the bottom, click ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["[Create New Token]"]},"."]},{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/assets/live_api_guide_1.a52631479ae01d520e2a0a547a0f95ed02117c1513fe49a21b75be5cc2c359e8.9c1bb791.png","alt":"Kollus Live console screen","framed":false,"withLightbox":false,"width":"100%","border":"1px solid gray"},"children":[]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Enter a token name, check the required ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Scopes"]},", and click ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["[Save]"]},"."]},{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/assets/live_api_guide_2.3af5662667cf3e98554853e3887809cd983b98d3f87898ddbf2b046825173ab2.9c1bb791.png","alt":"Token creation dialog","framed":false,"withLightbox":false,"width":"50%","border":"1px solid gray"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The required Scope for each API can be found in the Security section of the API reference."]},{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/assets/live_api_guide_4.88608721166bfdf19e21d87733d9d5ca19acb47accb3560169e7c591f867181c.9c1bb791.png","alt":"API reference","framed":false,"withLightbox":false,"width":"100%","border":"1px solid gray"},"children":[]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For security reasons, the generated token cannot be retrieved again later. ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Copy the token immediately and store it in a safe place"]},"."]},{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/assets/live_api_guide_3.1c6cbe29eeff29ce14f43fdb36db4407ee4b3c1da9cbeda27415cd6ff7b7e950.9c1bb791.png","alt":"Token notice dialog","framed":false,"withLightbox":false,"width":"50%","border":"1px solid gray"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"request-example","__idx":5},"children":["Request Example"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"retrieve-channel-information","__idx":6},"children":["Retrieve Channel Information"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"curl","header":{"controls":{"copy":{}}},"source":"curl -X GET \"https://api-live-kr.kollus.com/api/v1/live/service-accounts/{SERVICE_ACCOUNT_KEY}/channels/{CHANNEL_KEY}/broadcasts?order=id_desc&page=1&per_page=10\" -H \"accept: application/json\" -H \"Authorization: Bearer accesstoken....\"\n","lang":"curl"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"service-account-roles-and-permissions","__idx":7},"children":["Service Account Roles and Permissions"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The available features and access scope vary depending on the role assigned to the service account. For detailed permissions by role, refer to the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://docs.kollus.com/en/service-guide/live/account/service-account","target":"_blank"},"children":["Service Account Roles and Permissions"]}," documentation."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"key-information","__idx":8},"children":["Key Information"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For key information included in the request URL, refer to the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://docs.kollus.com/en/dev-guide/live/quickstart/key","target":"_blank"},"children":["Authentication and Key Information"]}," documentation."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"examples","__idx":9},"children":["Examples"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"create-channel-post","__idx":10},"children":["Create Channel (POST)"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"js","header":{"controls":{"copy":{}}},"source":"// Implementation using axios\n\nimport axios from \"axios\";\n\nconst url =\n  \"https://api-live-kr.kollus.com/api/v1/live/service-accounts/{SERVICE_ACCOUNT_KEY}/channels\";\n\nconst body = new URLSearchParams({\n  title: \"test-channel\",\n  customer_code: \"catenoidtest\",\n  concurrently_viewer_limit: 100,\n  is_shared: 1,\n  live_media_profile_group_key: \"{ENCODING_PROFILE_KEY}\"\n});\n\naxios.post(url, body.toString(), {\n  headers: {\n    Accept: \"application/json\",\n    \"Content-Type\": \"application/x-www-form-urlencoded\",\n    Authorization: \"Bearer {ACCESS_TOKEN}\"\n  }\n})\n.then(response => {\n  console.log(\"Channel created successfully:\", response.data);\n})\n.catch(error => {\n  console.error(\n    \"Failed to create channel:\",\n    error.response?.data || error.message\n  );\n});\n\n","lang":"js"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"retrieve-broadcasts-in-a-channel-get","__idx":11},"children":["Retrieve Broadcasts in a Channel (GET)"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"js","header":{"controls":{"copy":{}}},"source":"// Implementation using fetch API\n\nconst url = \"https://api-live-kr.kollus.com/api\"\n+ \"/v1/live/service-accounts/{SERVICE_ACCOUNT_KEY}/channels/{CHANNEL_KEY}/broadcasts?order=id_desc&page=1&per_page=10\";\n\nfetch(url, {\n  method: \"GET\",\n  headers: {\n    \"Accept\": \"application/json\",\n    \"Authorization\": \"Bearer {ACCESS_TOKEN}\"\n  }\n})\n  .then(response => {\n    if (!response.ok) {\n      throw new Error(`HTTP error! status: ${response.status}`);\n    }\n    return response.json();\n  })\n  .then(data => {\n    console.log(\"Response Data:\", data);\n  })\n  .catch(error => {\n    console.error(\"Request failed:\", error);\n  });\n","lang":"js"},"children":[]}]},"headings":[{"value":"Live API Guide","id":"live-api-guide","depth":1},{"value":"Request Specifications","id":"request-specifications","depth":2},{"value":"Rate Limit","id":"rate-limit","depth":3},{"value":"Request Headers","id":"request-headers","depth":3},{"value":"Authentication Method","id":"authentication-method","depth":3},{"value":"Request Example","id":"request-example","depth":3},{"value":"Retrieve Channel Information","id":"retrieve-channel-information","depth":4},{"value":"Service Account Roles and Permissions","id":"service-account-roles-and-permissions","depth":3},{"value":"Key Information","id":"key-information","depth":3},{"value":"Examples","id":"examples","depth":2},{"value":"Create Channel (POST)","id":"create-channel-post","depth":3},{"value":"Retrieve Broadcasts in a Channel (GET)","id":"retrieve-broadcasts-in-a-channel-get","depth":3}],"frontmatter":{"seo":{"title":"Kollus Live API 1.0 Guide","description":"The official guide to RESTful APIs for integrating with Kollus Live services. Find detailed specifications for standardized data integration with external systems and development environment setup, from API authentication methods to example code."}},"lastModified":"2026-05-07T07:00:16.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/en/products/live/live_guide","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}