{"info":{"_postman_id":"30efdc49-cd07-457a-914a-a776eb8be4ee","name":"Magnifi x Partner Integration Documentation","description":"
Magnifi offers a comprehensive suite of API endpoints designed for seamless integration, enabling partners to access platform resources, content, and metadata efficiently. These endpoints support key functions such as stream ingestion, video downloads, metadata retrieval, and management of match schedules and team rosters. This document provides a complete guide to the available endpoints, essential resources, error codes, and the integration workflow.
\nThis documentation is intended for developers and technical teams responsible for integrating Magnifiβs API into their products. The endpoints are straightforward and designed for ease of use. Multiple request examples are provided to illustrate different use cases.
\nAccess Credentials: Ensure you have obtained your Access Key and Access Secret from Magnifi.
HTTP Client: Any standard HTTP client can be used, as all endpoints are accessible via HTTPS.
\nResource: A general term for entities such as streams, clips, or match schedules.
\nContent: Typically refers to video assets, such as clips, highlights, or highlight clips.
\nMetadata: JSON-formatted data associated with content like clips and highlights.
\nentityId: A unique identifier for your organization or workspace. All resources and content are associated with this ID.
\nOrganization/Workspace: Each partner is assigned a unique API key linked to their organization or workspace, collectively called entities. Different entities will have distinct access credentials.
\nCategory: Organizations may have access to specific content categories (e.g., Cricket, Football), which serve as the primary classification for most content.
\nTemplates: Pre-configured video templates required for stream ingestion.
\nStream: A live or recorded video feed ingested into the Magnifi platform. Content such as clips, highlights, and highlight clips are generated from streams, along with associated metadata. (See the Stream section for details.)
\nClip: A short video capturing a key moment in a game. Metadata can be delivered via webhooks during stream processing or accessed through API endpoints. (See the Clip section for more details.)
\nHighlight: A dynamic compilation of clips based on business rules set by the partner. (See the Highlight section for more information.)
\nHighlight Clip: The finalized version of a highlight, ready for partner use. Metadata is available via webhooks and endpoints. (Refer to the Highlight Clips section for details.)
\nTournament/Team/Player: These are roster details that should be associated with a stream to enable accurate player tagging. This information is reflected in the metadata of Clips and Highlight Clips. (See the Partner section for more details.)
\nMatch Schedule: This feature allows you to create and manage match schedules, which can be linked to specific streams. (Refer to the Match Schedule section for further information.)
\nTo interact with Magnifi's API, you must authenticate each request using your Access Key and Access Secret. These credentials ensure that only authorized users can access the resources within your organization or workspace.
\nInclude the following headers in every API request:
\nx-access-key: Your unique Access Key. Example:x-access-key: pak_1a1a1a1a-1a1a-1a1a-1aaa-1a1a1a1a1a1a\n\n\nx-access-secret: Your Access Secret, used to verify your identity. Example x-access-secret: 2b2b2b2b2b2b2b2b2b2b2b2b2b2b2b2b2b2b2b2b2b2b2b2b2b2b2b2b2b2b2b2b\n\n\nObtaining Your Credentials:
\nEnvironment Configuration:
\nTesting with Postman:
\nx-access-key and x-access-secret as environment variables. This will streamline testing and integration.401 Unauthorized response with the message:{\n \"message\": \"Invalid access key or access secret\",\n \"error\": \"Unauthorized\",\n \"statusCode\": 401\n}\n\n\n{\n \"statusCode\": 404,\n \"error\": {\n \"message\": \"Clip data not found\",\n \"code\": \"C001\",\n \"metadata\": {}\n }\n}\n\n\nRetrieve details of the partner based on their access key.
Retrieves a list of categories allotted to partners to create a stream.
\nQuery Params:
\npage (number, required): The page number to retrieve.
pageSize (number, required): The number of items per page.
Retrieve templates allotted to partners to create a stream efficiently.
\n","urlObject":{"path":["v1","partner","templates"],"host":["{{PARTNER_BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"26cb2522-480e-48fe-b913-65d06b282adc","name":"Get Partner Templates","originalRequest":{"method":"GET","header":[{"key":"x-access-key","value":"{{PARTNER-X-ACCESS-KEY}}","type":"text"},{"key":"x-access-secret","value":"{{PARTNER-X-ACCESS-SECRET}}","type":"text"}],"url":"{{PARTNER_BASE_URL}}/v1/partner/templates"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 27 Aug 2024 05:57:43 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"6170"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 200,\n \"message\": \"Partner templates retrieved successfully\",\n \"data\": {\n \"direct\": [\n {\n \"id\": \"66bc71fgh3052d000718xcaa\",\n \"templateName\": \"Example Direct Template\"\n }\n ],\n \"medialive\": [\n {\n \"id\": \"66bc71fgh3052d000718xcbb\",\n \"templateName\": \"Example Media Template\"\n }\n ],\n \"reserved_channel\": [\n {\n \"id\": \"66bc71fgh3052d000718xcacc\",\n \"templateName\": \"Example Reserved Channel\"\n }\n ]\n }\n}"}],"_postman_id":"c10a597a-f16c-421a-a109-0171c774bce7"},{"name":"Get Partner Workspaces","id":"95192a2a-d814-4b23-8a0a-de76fd2439fb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-access-key","value":"{{PARTNER-X-ACCESS-KEY}}","type":"text"},{"key":"x-access-secret","value":"{{PARTNER-X-ACCESS-SECRET}}","type":"text"}],"url":"{{PARTNER_BASE_URL}}/v1/partner/workspaces","description":"fetch a list of workspaces associated with the partner account.
\n","urlObject":{"path":["v1","partner","workspaces"],"host":["{{PARTNER_BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"40cf958b-2c14-4859-913c-52dfe045b810","name":"Get Partner Workspaces","originalRequest":{"method":"GET","header":[{"key":"x-access-key","value":"{{PARTNER-X-ACCESS-KEY}}","type":"text"},{"key":"x-access-secret","value":"{{PARTNER-X-ACCESS-SECRET}}","type":"text"}],"url":"{{PARTNER_BASE_URL}}/v1/partner/workspaces"},"code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"statusCode\": 200,\n \"message\": \"Partner workspaces retrieved successfully\",\n \"data\": {\n \"workspaces\": [\n {\n \"workspaceId\": \"ws_some_random_uuid1\",\n \"workspaceName\": \"ws1\"\n },\n {\n \"workspaceId\": \"ws_some_random_uuid2\",\n \"workspaceName\": \"ws2\"\n },\n ]\n }\n}"},{"id":"baea3fdc-6ce3-4afd-b8da-b54d3c0b9c2c","name":"Get Partner Workspaces - Error","originalRequest":{"method":"GET","header":[{"key":"x-access-key","value":"{{PARTNER-X-ACCESS-KEY}}","type":"text"},{"key":"x-access-secret","value":"{{PARTNER-X-ACCESS-SECRET}}","type":"text"}],"url":"{{PARTNER_BASE_URL}}/v1/partner/workspaces"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 404,\n \"error\": {\n \"message\": \"Workspace user can not fetch other workspace's data\",\n \"code\": \"WS001\",\n \"metadata\": {}\n }\n}"}],"_postman_id":"95192a2a-d814-4b23-8a0a-de76fd2439fb"},{"name":"Get Partner Stream Custom Fields","id":"3364f950-890d-487a-9fe2-ebb57b3d7eb9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-access-key","value":"{{PARTNER-X-ACCESS-KEY}}","type":"text"},{"key":"x-access-secret","value":"{{PARTNER-X-ACCESS-SECRET}}","type":"text"}],"url":"{{PARTNER_BASE_URL}}/v1/partner/stream-fields?category=cricket","description":"Retrieves a list of stream fields allotted to partners to create a stream/match schedule.
\nQuery Params:
\ncategory (string, required): The category for which to retrieve the allotted fields.Retrieves a list of clip naming templates
\n","urlObject":{"path":["v1","partner","clip-naming-templates"],"host":["{{PARTNER_BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"a1282366-abd3-4331-992c-8d31cf615b52","name":"Get Partner Clip Naming Templates","originalRequest":{"method":"GET","header":[{"key":"x-access-key","value":"{{PARTNER-X-ACCESS-KEY}}","type":"text"},{"key":"x-access-secret","value":"{{PARTNER-X-ACCESS-SECRET}}","type":"text"}],"url":"{{PARTNER_BASE_URL}}/v1/partner/clip-naming-templates"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"vary","value":"Origin"},{"key":"access-control-allow-credentials","value":"true"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"4413"},{"key":"Date","value":"Tue, 10 Feb 2026 11:07:47 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=72"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 200,\n \"message\": \"Partner clip naming templates retrieved successfully\",\n \"data\": {\n \"templates\": [\n {\n \"clipNamingTemplateId\": \"b170342f-957b-454d-b4bf-26774c0482a1\",\n \"format\": \"{{#if (ne outcome \\\"failed\\\")}}Still going strong!{{/if}}\",\n \"templateName\": \"example-not-equal-template\",\n \"category\": \"cricket\",\n \"isActive\": false,\n \"keys\": [\n \"outcome\"\n ]\n },\n {\n \"clipNamingTemplateId\": \"66df134f-84c4-4fcc-b285-9dc6f3d615fb\",\n \"format\": \"{{#if (lt clipRating 3)}}Low Rating{{/if}}\",\n \"templateName\": \"example-rating-template\",\n \"category\": \"cricket\",\n \"isActive\": false,\n \"keys\": [\n \"clipRating\"\n ]\n },\n {\n \"clipNamingTemplateId\": \"6dab8e59-b6a8-42ff-9261-7b55139fec18\",\n \"format\": \"{{aspectRatio}}_{{team1}}_{{team2}}_{{tournament}}\",\n \"templateName\": \"sample-generic-template\",\n \"category\": \"football\",\n \"isActive\": true,\n \"keys\": [\n \"aspectRatio\",\n \"team1\",\n \"team2\",\n \"tournament\"\n ]\n }\n ],\n \"currentPage\": 1,\n \"pageSize\": 10,\n \"totalItems\": 3,\n \"totalPages\": 1\n }\n}"}],"_postman_id":"db442842-156f-413b-961f-5a914de6c2a9"},{"name":"Get Partner Storage Buckets","id":"b6fc05b0-9b28-4080-9775-60c4ea041c0a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-access-key","value":"{{PARTNER-X-ACCESS-KEY}}","type":"text"},{"key":"x-access-secret","value":"{{PARTNER-X-ACCESS-SECRET}}","type":"text"}],"url":"{{PARTNER_BASE_URL}}/v1/partner/storage-buckets","description":"Retrieves a list of storage buckets of media processing
\n","urlObject":{"path":["v1","partner","storage-buckets"],"host":["{{PARTNER_BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"601df1b4-0fc6-4c02-8e4b-35c9accfa211","name":"Get Partner Storage Buckets","originalRequest":{"method":"GET","header":[{"key":"x-access-key","value":"{{PARTNER-X-ACCESS-KEY}}","type":"text"},{"key":"x-access-secret","value":"{{PARTNER-X-ACCESS-SECRET}}","type":"text"}],"url":"{{PARTNER_BASE_URL}}/v1/partner/storage-buckets"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"vary","value":"Origin"},{"key":"access-control-allow-credentials","value":"true"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"661"},{"key":"Date","value":"Tue, 10 Feb 2026 10:54:59 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=72"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 200,\n \"message\": \"Partner storage buckets retrieved successfully\",\n \"data\": {\n \"buckets\": [\n {\n \"storageId\": \"656822e5423177b1f71812abc\",\n \"storageName\": \"example_media_storage_1\",\n \"folderPath\": \"load/testing\",\n \"defaultStorage\": false\n },\n {\n \"storageId\": \"67c99ef8a6e56a0009fe02ab\",\n \"storageName\": \"test_media_storage_mumbai\",\n \"folderPath\": \"test/\",\n \"defaultStorage\": false\n },\n {\n \"storageId\": \"67f53101502b2800099098cd\",\n \"storageName\": \"sample_multistream_storage\",\n \"folderPath\": \"video_engineering/\",\n \"defaultStorage\": false\n },\n {\n \"storageId\": \"67ff4c6d30b0f60009d2c5ef\",\n \"storageName\": \"staging_feed_storage_example\",\n \"folderPath\": \"recordings/\",\n \"defaultStorage\": false\n }\n ]\n }\n}"}],"_postman_id":"b6fc05b0-9b28-4080-9775-60c4ea041c0a"},{"name":"Get Partner Languages","id":"2f671d0b-c467-45ca-9f34-e08aead36afe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-access-key","value":"{{PARTNER-X-ACCESS-KEY}}","type":"text"},{"key":"x-access-secret","value":"{{PARTNER-X-ACCESS-SECRET}}","type":"text"}],"url":"{{PARTNER_BASE_URL}}/v1/partner/languages","description":"Retrieves a list of languages
\n","urlObject":{"path":["v1","partner","languages"],"host":["{{PARTNER_BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"701c7be5-079c-4e06-910e-8a57a598ff40","name":"Get Partner Languages","originalRequest":{"method":"GET","header":[{"key":"x-access-key","value":"{{PARTNER-X-ACCESS-KEY}}","type":"text"},{"key":"x-access-secret","value":"{{PARTNER-X-ACCESS-SECRET}}","type":"text"}],"url":"{{PARTNER_BASE_URL}}/v1/partner/languages"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"vary","value":"Origin"},{"key":"access-control-allow-credentials","value":"true"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"18018"},{"key":"Date","value":"Fri, 23 Jan 2026 13:05:42 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=72"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 200,\n \"message\": \"Partner languages retrieved successfully\",\n \"data\": {\n \"languages\": [\n {\n \"name\": \"Afar\",\n \"code\": \"aar\"\n },\n {\n \"name\": \"Abkhazian\",\n \"code\": \"abk\"\n },\n {\n \"name\": \"Achinese\",\n \"code\": \"ace\"\n },\n {\n \"name\": \"Acoli\",\n \"code\": \"ach\"\n },\n {\n \"name\": \"Adangme\",\n \"code\": \"ada\"\n },\n {\n \"name\": \"Adyghe; Adygei\",\n \"code\": \"ady\"\n },\n {\n \"name\": \"Afro-Asiatic languages\",\n \"code\": \"afa\"\n },\n {\n \"name\": \"Afrihili\",\n \"code\": \"afh\"\n },\n {\n \"name\": \"Afrikaans\",\n \"code\": \"afr\"\n },\n {\n \"name\": \"Ainu\",\n \"code\": \"ain\"\n },\n {\n \"name\": \"Akan\",\n \"code\": \"aka\"\n },\n {\n \"name\": \"Akkadian\",\n \"code\": \"akk\"\n },\n {\n \"name\": \"Albanian\",\n \"code\": \"alb\"\n },\n {\n \"name\": \"Aleut\",\n \"code\": \"ale\"\n },\n {\n \"name\": \"Algonquian languages\",\n \"code\": \"alg\"\n },\n {\n \"name\": \"Southern Altai\",\n \"code\": \"alt\"\n },\n {\n \"name\": \"Amharic\",\n \"code\": \"amh\"\n },\n {\n \"name\": \"English, Old (ca.450-1100)\",\n \"code\": \"ang\"\n },\n {\n \"name\": \"Angika\",\n \"code\": \"anp\"\n },\n {\n \"name\": \"Apache languages\",\n \"code\": \"apa\"\n },\n {\n \"name\": \"Arabic\",\n \"code\": \"ara\"\n },\n {\n \"name\": \"Official Aramaic (700-300 BCE); Imperial Aramaic (700-300 BCE)\",\n \"code\": \"arc\"\n },\n {\n \"name\": \"Aragonese\",\n \"code\": \"arg\"\n },\n {\n \"name\": \"Armenian\",\n \"code\": \"arm\"\n },\n {\n \"name\": \"Mapudungun; Mapuche\",\n \"code\": \"arn\"\n },\n {\n \"name\": \"Arapaho\",\n \"code\": \"arp\"\n },\n {\n \"name\": \"Artificial languages\",\n \"code\": \"art\"\n },\n {\n \"name\": \"Arawak\",\n \"code\": \"arw\"\n },\n {\n \"name\": \"Assamese\",\n \"code\": \"asm\"\n },\n {\n \"name\": \"Asturian; Bable; Leonese; Asturleonese\",\n \"code\": \"ast\"\n },\n {\n \"name\": \"Athapascan languages\",\n \"code\": \"ath\"\n },\n {\n \"name\": \"Australian languages\",\n \"code\": \"aus\"\n },\n {\n \"name\": \"Avaric\",\n \"code\": \"ava\"\n },\n {\n \"name\": \"Avestan\",\n \"code\": \"ave\"\n },\n {\n \"name\": \"Awadhi\",\n \"code\": \"awa\"\n },\n {\n \"name\": \"Aymara\",\n \"code\": \"aym\"\n },\n {\n \"name\": \"Azerbaijani\",\n \"code\": \"aze\"\n },\n {\n \"name\": \"Banda languages\",\n \"code\": \"bad\"\n },\n {\n \"name\": \"Bamileke languages\",\n \"code\": \"bai\"\n },\n {\n \"name\": \"Bashkir\",\n \"code\": \"bak\"\n },\n {\n \"name\": \"Baluchi\",\n \"code\": \"bal\"\n },\n {\n \"name\": \"Bambara\",\n \"code\": \"bam\"\n },\n {\n \"name\": \"Balinese\",\n \"code\": \"ban\"\n },\n {\n \"name\": \"Basque\",\n \"code\": \"baq\"\n },\n {\n \"name\": \"Basa\",\n \"code\": \"bas\"\n },\n {\n \"name\": \"Baltic languages\",\n \"code\": \"bat\"\n },\n {\n \"name\": \"Beja; Bedawiyet\",\n \"code\": \"bej\"\n },\n {\n \"name\": \"Belarusian\",\n \"code\": \"bel\"\n },\n {\n \"name\": \"Bemba\",\n \"code\": \"bem\"\n },\n {\n \"name\": \"Bengali\",\n \"code\": \"ben\"\n },\n {\n \"name\": \"Berber languages\",\n \"code\": \"ber\"\n },\n {\n \"name\": \"Bhojpuri\",\n \"code\": \"bho\"\n },\n {\n \"name\": \"Bihari languages\",\n \"code\": \"bih\"\n },\n {\n \"name\": \"Bikol\",\n \"code\": \"bik\"\n },\n {\n \"name\": \"Bini; Edo\",\n \"code\": \"bin\"\n },\n {\n \"name\": \"Bislama\",\n \"code\": \"bis\"\n },\n {\n \"name\": \"Siksika\",\n \"code\": \"bla\"\n },\n {\n \"name\": \"Bantu languages\",\n \"code\": \"bnt\"\n },\n {\n \"name\": \"Bosnian\",\n \"code\": \"bos\"\n },\n {\n \"name\": \"Braj\",\n \"code\": \"bra\"\n },\n {\n \"name\": \"Breton\",\n \"code\": \"bre\"\n },\n {\n \"name\": \"Batak languages\",\n \"code\": \"btk\"\n },\n {\n \"name\": \"Buriat\",\n \"code\": \"bua\"\n },\n {\n \"name\": \"Buginese\",\n \"code\": \"bug\"\n },\n {\n \"name\": \"Bulgarian\",\n \"code\": \"bul\"\n },\n {\n \"name\": \"Burmese\",\n \"code\": \"bur\"\n },\n {\n \"name\": \"Blin; Bilin\",\n \"code\": \"byn\"\n },\n {\n \"name\": \"Caddo\",\n \"code\": \"cad\"\n },\n {\n \"name\": \"Central American Indian languages\",\n \"code\": \"cai\"\n },\n {\n \"name\": \"Galibi Carib\",\n \"code\": \"car\"\n },\n {\n \"name\": \"Catalan; Valencian\",\n \"code\": \"cat\"\n },\n {\n \"name\": \"Caucasian languages\",\n \"code\": \"cau\"\n },\n {\n \"name\": \"Cebuano\",\n \"code\": \"ceb\"\n },\n {\n \"name\": \"Celtic languages\",\n \"code\": \"cel\"\n },\n {\n \"name\": \"Chamorro\",\n \"code\": \"cha\"\n },\n {\n \"name\": \"Chibcha\",\n \"code\": \"chb\"\n },\n {\n \"name\": \"Chechen\",\n \"code\": \"che\"\n },\n {\n \"name\": \"Chagatai\",\n \"code\": \"chg\"\n },\n {\n \"name\": \"Chinese\",\n \"code\": \"chi\"\n },\n {\n \"name\": \"Chinese (Cantonese, Traditional)\",\n \"code\": \"yue\"\n },\n {\n \"name\": \"Chuukese\",\n \"code\": \"chk\"\n },\n {\n \"name\": \"Mari\",\n \"code\": \"chm\"\n },\n {\n \"name\": \"Chinook jargon\",\n \"code\": \"chn\"\n },\n {\n \"name\": \"Choctaw\",\n \"code\": \"cho\"\n },\n {\n \"name\": \"Chipewyan; Dene Suline\",\n \"code\": \"chp\"\n },\n {\n \"name\": \"Cherokee\",\n \"code\": \"chr\"\n },\n {\n \"name\": \"Church Slavic; Old Slavonic; Church Slavonic; Old Bulgarian; Old Church Slavonic\",\n \"code\": \"chu\"\n },\n {\n \"name\": \"Chuvash\",\n \"code\": \"chv\"\n },\n {\n \"name\": \"Cheyenne\",\n \"code\": \"chy\"\n },\n {\n \"name\": \"Chamic languages\",\n \"code\": \"cmc\"\n },\n {\n \"name\": \"Montenegrin\",\n \"code\": \"cnr\"\n },\n {\n \"name\": \"Coptic\",\n \"code\": \"cop\"\n },\n {\n \"name\": \"Cornish\",\n \"code\": \"cor\"\n },\n {\n \"name\": \"Corsican\",\n \"code\": \"cos\"\n },\n {\n \"name\": \"Creoles and pidgins, English based\",\n \"code\": \"cpe\"\n },\n {\n \"name\": \"Creoles and pidgins, French-based\",\n \"code\": \"cpf\"\n },\n {\n \"name\": \"Creoles and pidgins, Portuguese-based\",\n \"code\": \"cpp\"\n },\n {\n \"name\": \"Cree\",\n \"code\": \"cre\"\n },\n {\n \"name\": \"Crimean Tatar; Crimean Turkish\",\n \"code\": \"crh\"\n },\n {\n \"name\": \"Creoles and pidgins\",\n \"code\": \"crp\"\n },\n {\n \"name\": \"Kashubian\",\n \"code\": \"csb\"\n },\n {\n \"name\": \"Cushitic languages\",\n \"code\": \"cus\"\n },\n {\n \"name\": \"Czech\",\n \"code\": \"cze\"\n },\n {\n \"name\": \"Dakota\",\n \"code\": \"dak\"\n },\n {\n \"name\": \"Danish\",\n \"code\": \"dan\"\n },\n {\n \"name\": \"Dargwa\",\n \"code\": \"dar\"\n },\n {\n \"name\": \"Land Dayak languages\",\n \"code\": \"day\"\n },\n {\n \"name\": \"Delaware\",\n \"code\": \"del\"\n },\n {\n \"name\": \"Slave (Athapascan)\",\n \"code\": \"den\"\n },\n {\n \"name\": \"Dogrib\",\n \"code\": \"dgr\"\n },\n {\n \"name\": \"Dinka\",\n \"code\": \"din\"\n },\n {\n \"name\": \"Divehi; Dhivehi; Maldivian\",\n \"code\": \"div\"\n },\n {\n \"name\": \"Dogri\",\n \"code\": \"doi\"\n },\n {\n \"name\": \"Dravidian languages\",\n \"code\": \"dra\"\n },\n {\n \"name\": \"Lower Sorbian\",\n \"code\": \"dsb\"\n },\n {\n \"name\": \"Duala\",\n \"code\": \"dua\"\n },\n {\n \"name\": \"Dutch, Middle (ca.1050-1350)\",\n \"code\": \"dum\"\n },\n {\n \"name\": \"Dutch; Flemish\",\n \"code\": \"dut\"\n },\n {\n \"name\": \"Dyula\",\n \"code\": \"dyu\"\n },\n {\n \"name\": \"Dzongkha\",\n \"code\": \"dzo\"\n },\n {\n \"name\": \"Efik\",\n \"code\": \"efi\"\n },\n {\n \"name\": \"Egyptian (Ancient)\",\n \"code\": \"egy\"\n },\n {\n \"name\": \"Ekajuk\",\n \"code\": \"eka\"\n },\n {\n \"name\": \"Elamite\",\n \"code\": \"elx\"\n },\n {\n \"name\": \"English\",\n \"code\": \"eng\"\n },\n {\n \"name\": \"English, Middle (1100-1500)\",\n \"code\": \"enm\"\n },\n {\n \"name\": \"Esperanto\",\n \"code\": \"epo\"\n },\n {\n \"name\": \"Estonian\",\n \"code\": \"est\"\n },\n {\n \"name\": \"Ewe\",\n \"code\": \"ewe\"\n },\n {\n \"name\": \"Ewondo\",\n \"code\": \"ewo\"\n },\n {\n \"name\": \"Fang\",\n \"code\": \"fan\"\n },\n {\n \"name\": \"Faroese\",\n \"code\": \"fao\"\n },\n {\n \"name\": \"Fanti\",\n \"code\": \"fat\"\n },\n {\n \"name\": \"Fijian\",\n \"code\": \"fij\"\n },\n {\n \"name\": \"Filipino; Pilipino\",\n \"code\": \"fil\"\n },\n {\n \"name\": \"Finnish\",\n \"code\": \"fin\"\n },\n {\n \"name\": \"Finno-Ugrian languages\",\n \"code\": \"fiu\"\n },\n {\n \"name\": \"Fon\",\n \"code\": \"fon\"\n },\n {\n \"name\": \"French\",\n \"code\": \"fre\"\n },\n {\n \"name\": \"French, Middle (ca.1400-1600)\",\n \"code\": \"frm\"\n },\n {\n \"name\": \"French, Old (842-ca.1400)\",\n \"code\": \"fro\"\n },\n {\n \"name\": \"Northern Frisian\",\n \"code\": \"frr\"\n },\n {\n \"name\": \"Eastern Frisian\",\n \"code\": \"frs\"\n },\n {\n \"name\": \"Western Frisian\",\n \"code\": \"fry\"\n },\n {\n \"name\": \"Fulah\",\n \"code\": \"ful\"\n },\n {\n \"name\": \"Friulian\",\n \"code\": \"fur\"\n },\n {\n \"name\": \"Ga\",\n \"code\": \"gaa\"\n },\n {\n \"name\": \"Gayo\",\n \"code\": \"gay\"\n },\n {\n \"name\": \"Gbaya\",\n \"code\": \"gba\"\n },\n {\n \"name\": \"Germanic languages\",\n \"code\": \"gem\"\n },\n {\n \"name\": \"Georgian\",\n \"code\": \"geo\"\n },\n {\n \"name\": \"German\",\n \"code\": \"ger\"\n },\n {\n \"name\": \"Geez\",\n \"code\": \"gez\"\n },\n {\n \"name\": \"Gilbertese\",\n \"code\": \"gil\"\n },\n {\n \"name\": \"Gaelic; Scottish Gaelic\",\n \"code\": \"gla\"\n },\n {\n \"name\": \"Irish\",\n \"code\": \"gle\"\n },\n {\n \"name\": \"Galician\",\n \"code\": \"glg\"\n },\n {\n \"name\": \"Manx\",\n \"code\": \"glv\"\n },\n {\n \"name\": \"German, Middle High (ca.1050-1500)\",\n \"code\": \"gmh\"\n },\n {\n \"name\": \"German, Old High (ca.750-1050)\",\n \"code\": \"goh\"\n },\n {\n \"name\": \"Gondi\",\n \"code\": \"gon\"\n },\n {\n \"name\": \"Gorontalo\",\n \"code\": \"gor\"\n },\n {\n \"name\": \"Gothic\",\n \"code\": \"got\"\n },\n {\n \"name\": \"Grebo\",\n \"code\": \"grb\"\n },\n {\n \"name\": \"Greek, Ancient (to 1453)\",\n \"code\": \"grc\"\n },\n {\n \"name\": \"Greek, Modern (1453-)\",\n \"code\": \"gre\"\n },\n {\n \"name\": \"Guarani\",\n \"code\": \"grn\"\n },\n {\n \"name\": \"Swiss German; Alemannic; Alsatian\",\n \"code\": \"gsw\"\n },\n {\n \"name\": \"Gujarati\",\n \"code\": \"guj\"\n },\n {\n \"name\": \"Gwich'in\",\n \"code\": \"gwi\"\n },\n {\n \"name\": \"Haida\",\n \"code\": \"hai\"\n },\n {\n \"name\": \"Haitian; Haitian Creole\",\n \"code\": \"hat\"\n },\n {\n \"name\": \"Hausa\",\n \"code\": \"hau\"\n },\n {\n \"name\": \"Hawaiian\",\n \"code\": \"haw\"\n },\n {\n \"name\": \"Hebrew\",\n \"code\": \"heb\"\n },\n {\n \"name\": \"Herero\",\n \"code\": \"her\"\n },\n {\n \"name\": \"Hiligaynon\",\n \"code\": \"hil\"\n },\n {\n \"name\": \"Himachali languages; Western Pahari languages\",\n \"code\": \"him\"\n },\n {\n \"name\": \"Hindi\",\n \"code\": \"hin\"\n },\n {\n \"name\": \"Hittite\",\n \"code\": \"hit\"\n },\n {\n \"name\": \"Hmong; Mong\",\n \"code\": \"hmn\"\n },\n {\n \"name\": \"Hiri Motu\",\n \"code\": \"hmo\"\n },\n {\n \"name\": \"Croatian\",\n \"code\": \"hrv\"\n },\n {\n \"name\": \"Upper Sorbian\",\n \"code\": \"hsb\"\n },\n {\n \"name\": \"Hungarian\",\n \"code\": \"hun\"\n },\n {\n \"name\": \"Hupa\",\n \"code\": \"hup\"\n },\n {\n \"name\": \"Iban\",\n \"code\": \"iba\"\n },\n {\n \"name\": \"Igbo\",\n \"code\": \"ibo\"\n },\n {\n \"name\": \"Icelandic\",\n \"code\": \"ice\"\n },\n {\n \"name\": \"Ido\",\n \"code\": \"ido\"\n },\n {\n \"name\": \"Sichuan Yi; Nuosu\",\n \"code\": \"iii\"\n },\n {\n \"name\": \"Ijo languages\",\n \"code\": \"ijo\"\n },\n {\n \"name\": \"Inuktitut\",\n \"code\": \"iku\"\n },\n {\n \"name\": \"Interlingue; Occidental\",\n \"code\": \"ile\"\n },\n {\n \"name\": \"Iloko\",\n \"code\": \"ilo\"\n },\n {\n \"name\": \"Interlingua (International Auxiliary Language Association)\",\n \"code\": \"ina\"\n },\n {\n \"name\": \"Indic languages\",\n \"code\": \"inc\"\n },\n {\n \"name\": \"Indonesian\",\n \"code\": \"ind\"\n },\n {\n \"name\": \"Indo-European languages\",\n \"code\": \"ine\"\n },\n {\n \"name\": \"Ingush\",\n \"code\": \"inh\"\n },\n {\n \"name\": \"Inupiaq\",\n \"code\": \"ipk\"\n },\n {\n \"name\": \"Iranian languages\",\n \"code\": \"ira\"\n },\n {\n \"name\": \"Iroquoian languages\",\n \"code\": \"iro\"\n },\n {\n \"name\": \"Italian\",\n \"code\": \"ita\"\n },\n {\n \"name\": \"Javanese\",\n \"code\": \"jav\"\n },\n {\n \"name\": \"Lojban\",\n \"code\": \"jbo\"\n },\n {\n \"name\": \"Japanese\",\n \"code\": \"jpn\"\n },\n {\n \"name\": \"Judeo-Persian\",\n \"code\": \"jpr\"\n },\n {\n \"name\": \"Judeo-Arabic\",\n \"code\": \"jrb\"\n },\n {\n \"name\": \"Kara-Kalpak\",\n \"code\": \"kaa\"\n },\n {\n \"name\": \"Kabyle\",\n \"code\": \"kab\"\n },\n {\n \"name\": \"Kachin; Jingpho\",\n \"code\": \"kac\"\n },\n {\n \"name\": \"Kalaallisut; Greenlandic\",\n \"code\": \"kal\"\n },\n {\n \"name\": \"Kamba\",\n \"code\": \"kam\"\n },\n {\n \"name\": \"Kannada\",\n \"code\": \"kan\"\n },\n {\n \"name\": \"Karen languages\",\n \"code\": \"kar\"\n },\n {\n \"name\": \"Kashmiri\",\n \"code\": \"kas\"\n },\n {\n \"name\": \"Kanuri\",\n \"code\": \"kau\"\n },\n {\n \"name\": \"Kawi\",\n \"code\": \"kaw\"\n },\n {\n \"name\": \"Kazakh\",\n \"code\": \"kaz\"\n },\n {\n \"name\": \"Kabardian\",\n \"code\": \"kbd\"\n },\n {\n \"name\": \"Khasi\",\n \"code\": \"kha\"\n },\n {\n \"name\": \"Khoisan languages\",\n \"code\": \"khi\"\n },\n {\n \"name\": \"Central Khmer\",\n \"code\": \"khm\"\n },\n {\n \"name\": \"Khotanese; Sakan\",\n \"code\": \"kho\"\n },\n {\n \"name\": \"Kikuyu; Gikuyu\",\n \"code\": \"kik\"\n },\n {\n \"name\": \"Kinyarwanda\",\n \"code\": \"kin\"\n },\n {\n \"name\": \"Kirghiz; Kyrgyz\",\n \"code\": \"kir\"\n },\n {\n \"name\": \"Kimbundu\",\n \"code\": \"kmb\"\n },\n {\n \"name\": \"Konkani\",\n \"code\": \"kok\"\n },\n {\n \"name\": \"Komi\",\n \"code\": \"kom\"\n },\n {\n \"name\": \"Kongo\",\n \"code\": \"kon\"\n },\n {\n \"name\": \"Korean\",\n \"code\": \"kor\"\n },\n {\n \"name\": \"Kosraean\",\n \"code\": \"kos\"\n },\n {\n \"name\": \"Kpelle\",\n \"code\": \"kpe\"\n },\n {\n \"name\": \"Karachay-Balkar\",\n \"code\": \"krc\"\n },\n {\n \"name\": \"Karelian\",\n \"code\": \"krl\"\n },\n {\n \"name\": \"Kru languages\",\n \"code\": \"kro\"\n },\n {\n \"name\": \"Kurukh\",\n \"code\": \"kru\"\n },\n {\n \"name\": \"Kuanyama; Kwanyama\",\n \"code\": \"kua\"\n },\n {\n \"name\": \"Kumyk\",\n \"code\": \"kum\"\n },\n {\n \"name\": \"Kurdish\",\n \"code\": \"kur\"\n },\n {\n \"name\": \"Kutenai\",\n \"code\": \"kut\"\n },\n {\n \"name\": \"Ladino\",\n \"code\": \"lad\"\n },\n {\n \"name\": \"Lahnda\",\n \"code\": \"lah\"\n },\n {\n \"name\": \"Lamba\",\n \"code\": \"lam\"\n },\n {\n \"name\": \"Lao\",\n \"code\": \"lao\"\n },\n {\n \"name\": \"Latin\",\n \"code\": \"lat\"\n },\n {\n \"name\": \"Latvian\",\n \"code\": \"lav\"\n },\n {\n \"name\": \"Lezghian\",\n \"code\": \"lez\"\n },\n {\n \"name\": \"Limburgan; Limburger; Limburgish\",\n \"code\": \"lim\"\n },\n {\n \"name\": \"Lingala\",\n \"code\": \"lin\"\n },\n {\n \"name\": \"Lithuanian\",\n \"code\": \"lit\"\n },\n {\n \"name\": \"Mongo\",\n \"code\": \"lol\"\n },\n {\n \"name\": \"Lozi\",\n \"code\": \"loz\"\n },\n {\n \"name\": \"Luxembourgish; Letzeburgesch\",\n \"code\": \"ltz\"\n },\n {\n \"name\": \"Luba-Lulua\",\n \"code\": \"lua\"\n },\n {\n \"name\": \"Luba-Katanga\",\n \"code\": \"lub\"\n },\n {\n \"name\": \"Ganda\",\n \"code\": \"lug\"\n },\n {\n \"name\": \"Luiseno\",\n \"code\": \"lui\"\n },\n {\n \"name\": \"Lunda\",\n \"code\": \"lun\"\n },\n {\n \"name\": \"Luo (Kenya and Tanzania)\",\n \"code\": \"luo\"\n },\n {\n \"name\": \"Lushai\",\n \"code\": \"lus\"\n },\n {\n \"name\": \"Macedonian\",\n \"code\": \"mac\"\n },\n {\n \"name\": \"Madurese\",\n \"code\": \"mad\"\n },\n {\n \"name\": \"Magahi\",\n \"code\": \"mag\"\n },\n {\n \"name\": \"Marshallese\",\n \"code\": \"mah\"\n },\n {\n \"name\": \"Maithili\",\n \"code\": \"mai\"\n },\n {\n \"name\": \"Makasar\",\n \"code\": \"mak\"\n },\n {\n \"name\": \"Malayalam\",\n \"code\": \"mal\"\n },\n {\n \"name\": \"Mandingo\",\n \"code\": \"man\"\n },\n {\n \"name\": \"Maori\",\n \"code\": \"mao\"\n },\n {\n \"name\": \"Austronesian languages\",\n \"code\": \"map\"\n },\n {\n \"name\": \"Marathi\",\n \"code\": \"mar\"\n },\n {\n \"name\": \"Masai\",\n \"code\": \"mas\"\n },\n {\n \"name\": \"Malay\",\n \"code\": \"may\"\n },\n {\n \"name\": \"Moksha\",\n \"code\": \"mdf\"\n },\n {\n \"name\": \"Mandar\",\n \"code\": \"mdr\"\n },\n {\n \"name\": \"Mende\",\n \"code\": \"men\"\n },\n {\n \"name\": \"Irish, Middle (900-1200)\",\n \"code\": \"mga\"\n },\n {\n \"name\": \"Mi'kmaq; Micmac\",\n \"code\": \"mic\"\n },\n {\n \"name\": \"Minangkabau\",\n \"code\": \"min\"\n },\n {\n \"name\": \"Uncoded languages\",\n \"code\": \"mis\"\n },\n {\n \"name\": \"Mon-Khmer languages\",\n \"code\": \"mkh\"\n },\n {\n \"name\": \"Malagasy\",\n \"code\": \"mlg\"\n },\n {\n \"name\": \"Maltese\",\n \"code\": \"mlt\"\n },\n {\n \"name\": \"Manchu\",\n \"code\": \"mnc\"\n },\n {\n \"name\": \"Manipuri\",\n \"code\": \"mni\"\n },\n {\n \"name\": \"Manobo languages\",\n \"code\": \"mno\"\n },\n {\n \"name\": \"Mohawk\",\n \"code\": \"moh\"\n },\n {\n \"name\": \"Mongolian\",\n \"code\": \"mon\"\n },\n {\n \"name\": \"Mossi\",\n \"code\": \"mos\"\n },\n {\n \"name\": \"Multiple languages\",\n \"code\": \"mul\"\n },\n {\n \"name\": \"Munda languages\",\n \"code\": \"mun\"\n },\n {\n \"name\": \"Creek\",\n \"code\": \"mus\"\n },\n {\n \"name\": \"Mirandese\",\n \"code\": \"mwl\"\n },\n {\n \"name\": \"Marwari\",\n \"code\": \"mwr\"\n },\n {\n \"name\": \"Mayan languages\",\n \"code\": \"myn\"\n },\n {\n \"name\": \"Erzya\",\n \"code\": \"myv\"\n },\n {\n \"name\": \"Nahuatl languages\",\n \"code\": \"nah\"\n },\n {\n \"name\": \"North American Indian languages\",\n \"code\": \"nai\"\n },\n {\n \"name\": \"Neapolitan\",\n \"code\": \"nap\"\n },\n {\n \"name\": \"Nauru\",\n \"code\": \"nau\"\n },\n {\n \"name\": \"Navajo; Navaho\",\n \"code\": \"nav\"\n },\n {\n \"name\": \"Ndebele, South; South Ndebele\",\n \"code\": \"nbl\"\n },\n {\n \"name\": \"Ndebele, North; North Ndebele\",\n \"code\": \"nde\"\n },\n {\n \"name\": \"Ndonga\",\n \"code\": \"ndo\"\n },\n {\n \"name\": \"Low German; Low Saxon; German, Low; Saxon, Low\",\n \"code\": \"nds\"\n },\n {\n \"name\": \"Nepali\",\n \"code\": \"nep\"\n },\n {\n \"name\": \"Nepal Bhasa; Newari\",\n \"code\": \"new\"\n },\n {\n \"name\": \"Nias\",\n \"code\": \"nia\"\n },\n {\n \"name\": \"Niger-Kordofanian languages\",\n \"code\": \"nic\"\n },\n {\n \"name\": \"Niuean\",\n \"code\": \"niu\"\n },\n {\n \"name\": \"Norwegian Nynorsk; Nynorsk, Norwegian\",\n \"code\": \"nno\"\n },\n {\n \"name\": \"BokmΓ₯l, Norwegian; Norwegian BokmΓ₯l\",\n \"code\": \"nob\"\n },\n {\n \"name\": \"Nogai\",\n \"code\": \"nog\"\n },\n {\n \"name\": \"Norse, Old\",\n \"code\": \"non\"\n },\n {\n \"name\": \"Norwegian\",\n \"code\": \"nor\"\n },\n {\n \"name\": \"N'Ko\",\n \"code\": \"nqo\"\n },\n {\n \"name\": \"Pedi; Sepedi; Northern Sotho\",\n \"code\": \"nso\"\n },\n {\n \"name\": \"Nubian languages\",\n \"code\": \"nub\"\n },\n {\n \"name\": \"Classical Newari; Old Newari; Classical Nepal Bhasa\",\n \"code\": \"nwc\"\n },\n {\n \"name\": \"Chichewa; Chewa; Nyanja\",\n \"code\": \"nya\"\n },\n {\n \"name\": \"Nyamwezi\",\n \"code\": \"nym\"\n },\n {\n \"name\": \"Nyankole\",\n \"code\": \"nyn\"\n },\n {\n \"name\": \"Nyoro\",\n \"code\": \"nyo\"\n },\n {\n \"name\": \"Nzima\",\n \"code\": \"nzi\"\n },\n {\n \"name\": \"Occitan (post 1500)\",\n \"code\": \"oci\"\n },\n {\n \"name\": \"Ojibwa\",\n \"code\": \"oji\"\n },\n {\n \"name\": \"Oriya\",\n \"code\": \"ori\"\n },\n {\n \"name\": \"Oromo\",\n \"code\": \"orm\"\n },\n {\n \"name\": \"Osage\",\n \"code\": \"osa\"\n },\n {\n \"name\": \"Ossetian; Ossetic\",\n \"code\": \"oss\"\n },\n {\n \"name\": \"Turkish, Ottoman (1500-1928)\",\n \"code\": \"ota\"\n },\n {\n \"name\": \"Otomian languages\",\n \"code\": \"oto\"\n },\n {\n \"name\": \"Papuan languages\",\n \"code\": \"paa\"\n },\n {\n \"name\": \"Pangasinan\",\n \"code\": \"pag\"\n },\n {\n \"name\": \"Pahlavi\",\n \"code\": \"pal\"\n },\n {\n \"name\": \"Pampanga; Kapampangan\",\n \"code\": \"pam\"\n },\n {\n \"name\": \"Panjabi; Punjabi\",\n \"code\": \"pan\"\n },\n {\n \"name\": \"Papiamento\",\n \"code\": \"pap\"\n },\n {\n \"name\": \"Palauan\",\n \"code\": \"pau\"\n },\n {\n \"name\": \"Persian, Old (ca.600-400 B.C.)\",\n \"code\": \"peo\"\n },\n {\n \"name\": \"Persian\",\n \"code\": \"per\"\n },\n {\n \"name\": \"Philippine languages\",\n \"code\": \"phi\"\n },\n {\n \"name\": \"Phoenician\",\n \"code\": \"phn\"\n },\n {\n \"name\": \"Pali\",\n \"code\": \"pli\"\n },\n {\n \"name\": \"Polish\",\n \"code\": \"pol\"\n },\n {\n \"name\": \"Pohnpeian\",\n \"code\": \"pon\"\n },\n {\n \"name\": \"Portuguese\",\n \"code\": \"por\"\n },\n {\n \"name\": \"Prakrit languages\",\n \"code\": \"pra\"\n },\n {\n \"name\": \"ProvenΓ§al, Old (to 1500); Occitan, Old (to 1500)\",\n \"code\": \"pro\"\n },\n {\n \"name\": \"Pushto; Pashto\",\n \"code\": \"pus\"\n },\n {\n \"name\": \"Reserved for local use\",\n \"code\": \"qaa-qtz\"\n },\n {\n \"name\": \"Quechua\",\n \"code\": \"que\"\n },\n {\n \"name\": \"Rajasthani\",\n \"code\": \"raj\"\n },\n {\n \"name\": \"Rapanui\",\n \"code\": \"rap\"\n },\n {\n \"name\": \"Rarotongan; Cook Islands Maori\",\n \"code\": \"rar\"\n },\n {\n \"name\": \"Romance languages\",\n \"code\": \"roa\"\n },\n {\n \"name\": \"Romansh\",\n \"code\": \"roh\"\n },\n {\n \"name\": \"Romany\",\n \"code\": \"rom\"\n },\n {\n \"name\": \"Romanian; Moldavian; Moldovan\",\n \"code\": \"rum\"\n },\n {\n \"name\": \"Rundi\",\n \"code\": \"run\"\n },\n {\n \"name\": \"Aromanian; Arumanian; Macedo-Romanian\",\n \"code\": \"rup\"\n },\n {\n \"name\": \"Russian\",\n \"code\": \"rus\"\n },\n {\n \"name\": \"Sandawe\",\n \"code\": \"sad\"\n },\n {\n \"name\": \"Sango\",\n \"code\": \"sag\"\n },\n {\n \"name\": \"Yakut\",\n \"code\": \"sah\"\n },\n {\n \"name\": \"South American Indian languages\",\n \"code\": \"sai\"\n },\n {\n \"name\": \"Salishan languages\",\n \"code\": \"sal\"\n },\n {\n \"name\": \"Samaritan Aramaic\",\n \"code\": \"sam\"\n },\n {\n \"name\": \"Sanskrit\",\n \"code\": \"san\"\n },\n {\n \"name\": \"Sasak\",\n \"code\": \"sas\"\n },\n {\n \"name\": \"Santali\",\n \"code\": \"sat\"\n },\n {\n \"name\": \"Sicilian\",\n \"code\": \"scn\"\n },\n {\n \"name\": \"Scots\",\n \"code\": \"sco\"\n },\n {\n \"name\": \"Selkup\",\n \"code\": \"sel\"\n },\n {\n \"name\": \"Semitic languages\",\n \"code\": \"sem\"\n },\n {\n \"name\": \"Irish, Old (to 900)\",\n \"code\": \"sga\"\n },\n {\n \"name\": \"Sign Languages\",\n \"code\": \"sgn\"\n },\n {\n \"name\": \"Shan\",\n \"code\": \"shn\"\n },\n {\n \"name\": \"Sidamo\",\n \"code\": \"sid\"\n },\n {\n \"name\": \"Sinhala; Sinhalese\",\n \"code\": \"sin\"\n },\n {\n \"name\": \"Siouan languages\",\n \"code\": \"sio\"\n },\n {\n \"name\": \"Sino-Tibetan languages\",\n \"code\": \"sit\"\n },\n {\n \"name\": \"Slavic languages\",\n \"code\": \"sla\"\n },\n {\n \"name\": \"Slovak\",\n \"code\": \"slo\"\n },\n {\n \"name\": \"Slovenian\",\n \"code\": \"slv\"\n },\n {\n \"name\": \"Southern Sami\",\n \"code\": \"sma\"\n },\n {\n \"name\": \"Northern Sami\",\n \"code\": \"sme\"\n },\n {\n \"name\": \"Sami languages\",\n \"code\": \"smi\"\n },\n {\n \"name\": \"Lule Sami\",\n \"code\": \"smj\"\n },\n {\n \"name\": \"Inari Sami\",\n \"code\": \"smn\"\n },\n {\n \"name\": \"Samoan\",\n \"code\": \"smo\"\n },\n {\n \"name\": \"Skolt Sami\",\n \"code\": \"sms\"\n },\n {\n \"name\": \"Shona\",\n \"code\": \"sna\"\n },\n {\n \"name\": \"Sindhi\",\n \"code\": \"snd\"\n },\n {\n \"name\": \"Soninke\",\n \"code\": \"snk\"\n },\n {\n \"name\": \"Sogdian\",\n \"code\": \"sog\"\n },\n {\n \"name\": \"Somali\",\n \"code\": \"som\"\n },\n {\n \"name\": \"Songhai languages\",\n \"code\": \"son\"\n },\n {\n \"name\": \"Sotho, Southern\",\n \"code\": \"sot\"\n },\n {\n \"name\": \"Spanish; Castilian\",\n \"code\": \"spa\"\n },\n {\n \"name\": \"Sardinian\",\n \"code\": \"srd\"\n },\n {\n \"name\": \"Sranan Tongo\",\n \"code\": \"srn\"\n },\n {\n \"name\": \"Serbian\",\n \"code\": \"srp\"\n },\n {\n \"name\": \"Serer\",\n \"code\": \"srr\"\n },\n {\n \"name\": \"Nilo-Saharan languages\",\n \"code\": \"ssa\"\n },\n {\n \"name\": \"Swati\",\n \"code\": \"ssw\"\n },\n {\n \"name\": \"Sukuma\",\n \"code\": \"suk\"\n },\n {\n \"name\": \"Sundanese\",\n \"code\": \"sun\"\n },\n {\n \"name\": \"Susu\",\n \"code\": \"sus\"\n },\n {\n \"name\": \"Sumerian\",\n \"code\": \"sux\"\n },\n {\n \"name\": \"Swahili\",\n \"code\": \"swa\"\n },\n {\n \"name\": \"Swedish\",\n \"code\": \"swe\"\n },\n {\n \"name\": \"Classical Syriac\",\n \"code\": \"syc\"\n },\n {\n \"name\": \"Syriac\",\n \"code\": \"syr\"\n },\n {\n \"name\": \"Tahitian\",\n \"code\": \"tah\"\n },\n {\n \"name\": \"Tai languages\",\n \"code\": \"tai\"\n },\n {\n \"name\": \"Tamil\",\n \"code\": \"tam\"\n },\n {\n \"name\": \"Tatar\",\n \"code\": \"tat\"\n },\n {\n \"name\": \"Telugu\",\n \"code\": \"tel\"\n },\n {\n \"name\": \"Timne\",\n \"code\": \"tem\"\n },\n {\n \"name\": \"Tereno\",\n \"code\": \"ter\"\n },\n {\n \"name\": \"Tetum\",\n \"code\": \"tet\"\n },\n {\n \"name\": \"Tajik\",\n \"code\": \"tgk\"\n },\n {\n \"name\": \"Tagalog\",\n \"code\": \"tgl\"\n },\n {\n \"name\": \"Thai\",\n \"code\": \"tha\"\n },\n {\n \"name\": \"Tibetan\",\n \"code\": \"tib\"\n },\n {\n \"name\": \"Tigre\",\n \"code\": \"tig\"\n },\n {\n \"name\": \"Tigrinya\",\n \"code\": \"tir\"\n },\n {\n \"name\": \"Tiv\",\n \"code\": \"tiv\"\n },\n {\n \"name\": \"Tokelau\",\n \"code\": \"tkl\"\n },\n {\n \"name\": \"Klingon; tlhIngan-Hol\",\n \"code\": \"tlh\"\n },\n {\n \"name\": \"Tlingit\",\n \"code\": \"tli\"\n },\n {\n \"name\": \"Tamashek\",\n \"code\": \"tmh\"\n },\n {\n \"name\": \"Tonga (Nyasa)\",\n \"code\": \"tog\"\n },\n {\n \"name\": \"Tonga (Tonga Islands)\",\n \"code\": \"ton\"\n },\n {\n \"name\": \"Tok Pisin\",\n \"code\": \"tpi\"\n },\n {\n \"name\": \"Tsimshian\",\n \"code\": \"tsi\"\n },\n {\n \"name\": \"Tswana\",\n \"code\": \"tsn\"\n },\n {\n \"name\": \"Tsonga\",\n \"code\": \"tso\"\n },\n {\n \"name\": \"Turkmen\",\n \"code\": \"tuk\"\n },\n {\n \"name\": \"Tumbuka\",\n \"code\": \"tum\"\n },\n {\n \"name\": \"Tupi languages\",\n \"code\": \"tup\"\n },\n {\n \"name\": \"Turkish\",\n \"code\": \"tur\"\n },\n {\n \"name\": \"Altaic languages\",\n \"code\": \"tut\"\n },\n {\n \"name\": \"Tuvalu\",\n \"code\": \"tvl\"\n },\n {\n \"name\": \"Twi\",\n \"code\": \"twi\"\n },\n {\n \"name\": \"Tuvinian\",\n \"code\": \"tyv\"\n },\n {\n \"name\": \"Udmurt\",\n \"code\": \"udm\"\n },\n {\n \"name\": \"Ugaritic\",\n \"code\": \"uga\"\n },\n {\n \"name\": \"Uighur; Uyghur\",\n \"code\": \"uig\"\n },\n {\n \"name\": \"Ukrainian\",\n \"code\": \"ukr\"\n },\n {\n \"name\": \"Umbundu\",\n \"code\": \"umb\"\n },\n {\n \"name\": \"Undetermined\",\n \"code\": \"und\"\n },\n {\n \"name\": \"Urdu\",\n \"code\": \"urd\"\n },\n {\n \"name\": \"Uzbek\",\n \"code\": \"uzb\"\n },\n {\n \"name\": \"Vai\",\n \"code\": \"vai\"\n },\n {\n \"name\": \"Venda\",\n \"code\": \"ven\"\n },\n {\n \"name\": \"Vietnamese\",\n \"code\": \"vie\"\n },\n {\n \"name\": \"VolapΓΌk\",\n \"code\": \"vol\"\n },\n {\n \"name\": \"Votic\",\n \"code\": \"vot\"\n },\n {\n \"name\": \"Wakashan languages\",\n \"code\": \"wak\"\n },\n {\n \"name\": \"Wolaitta; Wolaytta\",\n \"code\": \"wal\"\n },\n {\n \"name\": \"Waray\",\n \"code\": \"war\"\n },\n {\n \"name\": \"Washo\",\n \"code\": \"was\"\n },\n {\n \"name\": \"Welsh\",\n \"code\": \"wel\"\n },\n {\n \"name\": \"Sorbian languages\",\n \"code\": \"wen\"\n },\n {\n \"name\": \"Walloon\",\n \"code\": \"wln\"\n },\n {\n \"name\": \"Wolof\",\n \"code\": \"wol\"\n },\n {\n \"name\": \"Kalmyk; Oirat\",\n \"code\": \"xal\"\n },\n {\n \"name\": \"Xhosa\",\n \"code\": \"xho\"\n },\n {\n \"name\": \"Yao\",\n \"code\": \"yao\"\n },\n {\n \"name\": \"Yapese\",\n \"code\": \"yap\"\n },\n {\n \"name\": \"Yiddish\",\n \"code\": \"yid\"\n },\n {\n \"name\": \"Yoruba\",\n \"code\": \"yor\"\n },\n {\n \"name\": \"Yupik languages\",\n \"code\": \"ypk\"\n },\n {\n \"name\": \"Zapotec\",\n \"code\": \"zap\"\n },\n {\n \"name\": \"Blissymbols; Blissymbolics; Bliss\",\n \"code\": \"zbl\"\n },\n {\n \"name\": \"Zenaga\",\n \"code\": \"zen\"\n },\n {\n \"name\": \"Standard Moroccan Tamazight\",\n \"code\": \"zgh\"\n },\n {\n \"name\": \"Zhuang; Chuang\",\n \"code\": \"zha\"\n },\n {\n \"name\": \"Zande languages\",\n \"code\": \"znd\"\n },\n {\n \"name\": \"Zulu\",\n \"code\": \"zul\"\n },\n {\n \"name\": \"Zuni\",\n \"code\": \"zun\"\n },\n {\n \"name\": \"No linguistic content; Not applicable\",\n \"code\": \"zxx\"\n },\n {\n \"name\": \"Zaza; Dimili; Dimli; Kirdki; Kirmanjki; Zazaki\",\n \"code\": \"zza\"\n }\n ]\n }\n}"}],"_postman_id":"2f671d0b-c467-45ca-9f34-e08aead36afe"},{"name":"Get Partner Template Audio Options","id":"f9f1d3b7-fe50-4545-bfd8-630e5f50598d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-access-key","value":"{{PARTNER-X-ACCESS-KEY}}","type":"text"},{"key":"x-access-secret","value":"{{PARTNER-X-ACCESS-SECRET}}","type":"text"}],"url":"{{PARTNER_BASE_URL}}/v1/partner/audio-options","description":"Retrieves multi audio options available for a template
\nQuery Params:
\ntemplateName (string, required): The templatae name for which to retrieve the multi audio optionsAllows partners to obtain a pre-signed URL for a specific clip or highlight.
\nRequest Body
\nid (string) - The unique identifier of the video.
videoType (string) - The type of video can be either \"CLIP\" or \"HIGHLIGHT\" or \"HLCLIP\".
Create a new stream with the specified details.
\nRequest Body:
\ntitle (string, required): The title of the stream.
url (string, required): The URL of the stream.
category (string, required): The category of the stream.
fireAt (string, required): The timestamp at which the stream should start.
streamStartTime (string, optional): The start time of the stream.
fields (object, required): Additional fields for the stream.
ext_stream_id (string, optional): The external stream ID.templateName (string, required): The name of the template.
publishingWebhookUrl (string, optional): Webhook URL where you want us to send metadata.
hls_live_start_index (number, optional): Default value 1
tournamentId (string, optional): ID for the tournament to which the stream belongs.
homeTeamId (string, optional): ID for the home team participating in the stream.
awayTeamId (string, optional): ID for the away team participating in the stream.
matchScheduleId (string, optional): ID for the scheduled match linked to the stream. ( e.g: msh_54e6c315-f73a-4a77-b7c6-9940ff547123 )
shareType (enum, optional): Use this field to specify how the stream should be shared with workspaces. Note that the sharedWith field must also be provided for this to take effect. Accepted enum values:
original β The stream scope is shared, allowing generated clips to be accessible in both the parent organization and the shared workspace.
\nclone β The shared workspace can view clips generated in the parent organization, but the parent organization will not see clips created in the shared workspace.
\nsharedWith (string[], optional): A list of workspace IDs where the stream should be shared.
streamLanguage (string, optional): Default language for the stream (e.g: \"en\").
storageId (string, optional): Storage target ID for outputs.
clipNamingTemplateId (string, optional): Template ID for naming generated clips.
audioType (string, optional): How audio is selected for multi-audio streams. Accepted values: iso, track, pid. When iso, scte35Source is required.
scte35Source (string, optional): Where SCTE-35 cues are read from. Required when audioType is \"iso\". Accepted values: SEGMENTS, MANIFESTS. Optional otherwise.
audioLanguages (string[], optional): Language codes for audio tracks (e.g: [\"en\", \"es\"]).
clipLanguages (string[], optional): Language codes for clip generation (e.g: [\"en\", \"es\"]).
audioTracks (string[], optional): HLS audio group or track IDs (e.g: [\"aud1\", \"aud2\"]). Use when audioType is \"track\".
pids (string[], optional): MPEG-TS audio PIDs (e.g: [\"257\", \"258\"]). Use when audioType is \"pid\".
autoAspectRatioConvert (object, optional): Auto aspect-ratio conversion. e.g: { \"autoConvertAspectRatios\": [\"16:9\"] }.
The fields object is flexible, allowing you to pass any custom information needed when retrieving metadata.
If datafeed access is required, please reach out to us to enable it. Once access is granted, include the following within the payload object:
\"datafeed\": {\n \"type\": \"genius\",\n \"competitionId\": \"some_id\",\n \"tournamentId\": \"some_id\",\n \"matchId\": \"some_id\"\n}\n\n","urlObject":{"path":["v1","stream"],"host":["{{PARTNER_BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"b00c239a-d7d7-44bd-8bc6-d09b9e66646d","name":"Create stream","originalRequest":{"method":"POST","header":[{"key":"x-access-key","value":"{{PARTNER-X-ACCESS-KEY}}"},{"key":"x-access-secret","value":"{{PARTNER-X-ACCESS-SECRET}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Football Match\",\n \"url\": \"example.url\",\n \"category\": \"football\",\n \"fireAt\": \"2024-09-09T13:05:00\",\n \"streamStartTime\": \"2024-09-09T13:05:00+00:00\",\n \"fields\": {\n \"ext_stream_id\": \"uniqueStreamId\"\n },\n \"templateName\": \"example template\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PARTNER_BASE_URL}}/v1/stream"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 202,\n \"message\": \"Stream created successfully\",\n \"stream\": {\n \"streamId\": \"-aiwC0aiF\",\n \"title\": \"Football Match\",\n \"url\": \"example.url\",\n \"category\": \"football\",\n \"userId\": \"example.user\",\n \"entityId\": \"example.entity\",\n \"fireAt\": \"2024-09-09T13:05:00\",\n \"aspectRatio\": \"16:9\",\n \"status\": \"Pending\",\n \"streamStartTime\": \"2024-09-09T13:05:00.000Z\",\n \"fields\": {\n \"ext_stream_id\": \"uniqueStreamId\",\n \"stream_start_time\": \"2024-09-09T13:05:00+00:00\"\n },\n \"match_start_time_on_server\": 0,\n \"templateId\": \"example.templateId\",\n \"hls_live_start_index\": 1,\n \"publishingWebhookUrl\": \"https://example.org/webhook\",\n \"createdAt\": \"2024-09-09T13:05:02.775Z\"\n }\n}"},{"id":"7c4ce5c4-d5f4-471e-91c0-f57b25775fe6","name":"Create stream from match schedule","originalRequest":{"method":"POST","header":[{"key":"x-access-key","value":"{{PARTNER-X-ACCESS-KEY}}"},{"key":"x-access-secret","value":"{{PARTNER-X-ACCESS-SECRET}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Football Match\",\n \"url\": \"example.url\",\n \"category\": \"football\",\n \"fireAt\": \"2024-09-09T13:05:00\",\n \"streamStartTime\": \"2024-09-09T13:05:00+00:00\",\n \"fields\": {\n \"ext_stream_id\": \"uniqueStreamId\"\n },\n \"templateName\": \"example template\",\n \"matchScheduleId\": \"msh_54e6c315-f73a-4a77-b7c6-9940ff547123\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PARTNER_BASE_URL}}/v1/stream"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 202,\n \"message\": \"Stream created successfully\",\n \"stream\": {\n \"streamId\": \"-aiwC0aiF\",\n \"title\": \"Football Match\",\n \"url\": \"example.url\",\n \"category\": \"football\",\n \"userId\": \"example.user\",\n \"entityId\": \"example.entity\",\n \"fireAt\": \"2024-09-09T13:05:00\",\n \"aspectRatio\": \"16:9\",\n \"status\": \"Pending\",\n \"streamStartTime\": \"2024-09-09T13:05:00.000Z\",\n \"fields\": {\n \"ext_stream_id\": \"uniqueStreamId\",\n \"stream_start_time\": \"2024-09-09T13:05:00+00:00\"\n },\n \"match_start_time_on_server\": 0,\n \"templateId\": \"example.templateId\",\n \"hls_live_start_index\": 1,\n \"publishingWebhookUrl\": \"https://example.org/webhook\",\n \"createdAt\": \"2024-09-09T13:05:02.775Z\"\n }\n}"},{"id":"9c583f4a-1e92-47b4-8900-20a0826fa15d","name":"Create stream Datafeed","originalRequest":{"method":"POST","header":[{"key":"x-access-key","value":"{{PARTNER-X-ACCESS-KEY}}"},{"key":"x-access-secret","value":"{{PARTNER-X-ACCESS-SECRET}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Football Match\",\n \"url\": \"example.url\",\n \"category\": \"football\",\n \"fireAt\": \"2024-09-09T13:05:00\",\n \"streamStartTime\": \"2024-09-09T13:05:00+00:00\",\n \"fields\": {\n \"ext_stream_id\": \"uniqueStreamId\"\n },\n \"datafeed\": {\n \"type\": \"genius\",\n \"competitionId\": \"27124233\",\n \"tournamentId\": \"4567566345\",\n \"matchId\": \"9968678\"\n },\n \"templateName\": \"example template\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PARTNER_BASE_URL}}/v1/stream"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 202,\n \"message\": \"Stream created successfully\",\n \"stream\": {\n \"streamId\": \"-aiwC0aiF\",\n \"title\": \"Football Match\",\n \"url\": \"example.url\",\n \"category\": \"football\",\n \"userId\": \"example.user\",\n \"entityId\": \"example.entity\",\n \"fireAt\": \"2024-09-09T13:05:00\",\n \"aspectRatio\": \"16:9\",\n \"status\": \"Pending\",\n \"streamStartTime\": \"2024-09-09T13:05:00.000Z\",\n \"fields\": {\n \"ext_stream_id\": \"uniqueStreamId\",\n \"stream_start_time\": \"2024-09-09T13:05:00+00:00\"\n },\n \"datafeed\": {\n \"type\": \"genius\",\n \"competitionId\": \"27\",\n \"tournamentId\": \"1471\",\n \"matchId\": \"109920\"\n },\n \"match_start_time_on_server\": 0,\n \"templateId\": \"example.templateId\",\n \"hls_live_start_index\": 1,\n \"publishingWebhookUrl\": \"https://example.org/webhook\",\n \"createdAt\": \"2024-09-09T13:05:02.775Z\"\n }\n}"},{"id":"186fdba6-4010-42cf-9e99-f1eeaf2fd9c3","name":"Create stream - Error","originalRequest":{"method":"POST","header":[{"key":"x-access-key","value":"{{PARTNER-X-ACCESS-KEY}}"},{"key":"x-access-secret","value":"{{PARTNER-X-ACCESS-SECRET}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Demo Match\",\n \"url\": \"example.url\",\n \"category\": \"cricket\",\n \"fireAt\": \"2024-09-09T08:32:00\",\n \"streamStartTime\": \"2024-09-09T08:32:00+00:00\",\n \"fields\": {\n \"ext_stream_id\": \"uniqueStreamId\"\n },\n \"templateName\": \"mp4 live\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PARTNER_BASE_URL}}/v1/stream"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 400,\n \"error\": {\n \"message\": \"Partner storage config not found\",\n \"code\": \"PA003\",\n \"metadata\": {\n \"receivedPayload\": {\n \"hls_live_start_index\": 1,\n \"title\": \"Demo Match\",\n \"url\": \"example.url\",\n \"category\": \"cricket\",\n \"fireAt\": \"2024-09-09T08:32:00\",\n \"streamStartTime\": \"2024-09-09T08:32:00+00:00\",\n \"fields\": {\n \"ext_stream_id\": \"uniqueStreamId\"\n },\n \"templateName\": \"mp4 live\"\n }\n }\n }\n}"},{"id":"cb1aeac6-97bb-46af-b537-7fe2fb579c0d","name":"Create Stream - Error","originalRequest":{"method":"POST","header":[{"key":"x-access-key","value":"{{PARTNER-X-ACCESS-KEY}}","type":"text"},{"key":"x-access-secret","value":"{{PARTNER-X-ACCESS-SECRET}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Example stream\",\n \"url\": \"https://d1rkuvpc7jn123.cloudfront.net/example/master_highest.m3u8\",\n \"category\": \"cricket\",\n \"userId\": \"D5bdc8123\",\n \"fireAt\": \"now\",\n \"streamStartTime\": \"2025-08-13T13:34:00+00:00\",\n \"fields\": {\n \"VideoId\": 2000342\n },\n \"templateName\": \"Test HLS Template\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PARTNER_BASE_URL}}/v1/stream"},"status":"Bad Request","code":400,"_postman_previewlanguage":null,"header":[{"key":"vary","value":"Origin"},{"key":"access-control-allow-credentials","value":"true"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"629"},{"key":"Date","value":"Tue, 18 Nov 2025 14:00:12 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=72"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 400,\n \"error\": {\n \"message\": \"Stream required fields missing\",\n \"code\": \"S015\",\n \"metadata\": {\n \"errorMetadata\": \"Required stream custom fields missing: abcd (abcd), test input masking (test_input_masking)\",\n \"receivedPayload\": {\n \"streamStartTime\": \"2025-08-13T13:34:00+00:00\",\n \"hls_live_start_index\": 1,\n \"shareType\": \"restrict\",\n \"sharedWith\": [],\n \"title\": \"Example stream\",\n \"url\": \"https://d1rkuvpc7jn123.cloudfront.net/example/master_highest.m3u8\",\n \"category\": \"cricket\",\n \"userId\": \"D5bdc8f12\",\n \"fireAt\": \"now\",\n \"fields\": {\n \"VideoId\": 2000342\n },\n \"templateName\": \"Test HLS Template\"\n }\n }\n }\n}"}],"_postman_id":"6f3cd259-2f6b-4cf3-a8e8-a93c2d866d80"},{"name":"Update stream by streamId","id":"eafb5373-0c23-406f-af7c-9335a3e1f9e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"x-access-key","value":"{{PARTNER-X-ACCESS-KEY}}","type":"text"},{"key":"x-access-secret","value":"{{PARTNER-X-ACCESS-SECRET}}","type":"text"}],"url":"{{PARTNER_BASE_URL}}/v1/stream/{{STREAM_ID}}","description":"Updates details of a specific stream
\nParams:
\nSTREAM_ID (URL param): Specifies the unique identifier of the stream.Request Body:
\ntitle (string, optional): The title of the stream.
status (string, optional): The status of the stream. Allowed values are \"Completed\", \"Processing\", or \"Cancelled\".
fireAt (string, optional): The timestamp at which the stream should start.
url (string, optional): The URL of the stream.
publishingWebhookUrl (string | null, optional): The webhook URL to trigger when the stream/clip/hlclip is published/updated. Pass null if you want to remove the existing publishing webhook URL
matchScheduleId (string | null, optional): Pass null if you need to de-link the stream from any particular Match Schedule. Else you can pass your desired Match Schedule ID (starts with msh ) to re-link.
tournamentId (string, optional): ID for the tournament.
homeTeamId (string, optional): ID for the home team.
awayTeamId (string, optional): ID for the away team.
streamLanguage (string, optional): Default language for the stream (e.g: \"en\").
datafeed (object, optional): Datafeed configuration.
storageId (string, optional): Storage target ID for outputs.
clipLanguages (string[], optional): Language codes for clip generation (e.g: [\"en\", \"es\"]).
clipNamingTemplateId (string, optional): Template ID for naming generated clips.
autoAspectRatioConvert (object, optional): Auto aspect-ratio conversion. e.g: { \"autoConvertAspectRatios\": [\"16:9\"] }.
fields (object, optional): object is flexible, allowing you to update stream custom fields.
Retrieves a list of all streams.
\nQuery Params:
\npage (number, required): The page number to retrieve.
pageSize (number, required): The number of items per page.
filters (object, optional): Inside this you can pass any key-pair you had added inside fields object while creating a stream. Example: \"ext-match-id\": \"uuid\"
category (string, optional): You can optionally filter with categories alloted to you..
startTime and endTime (utc timestamp, optional): You can filter by a time range. You have to send both the fields to mak it work.
Retrieves the details of a specific stream
\nParams:
\nSTREAM_ID (URL param): Specifies the unique identifier of the stream.Fetches all clips associated with a particular stream using the streamId.
Params:
\nSTREAM_ID (URL param): Specifies the unique identifier of the stream.Query Params:
\npage (number, required): The page number to retrieve.
pageSize (number, required): The number of items per page.
events (string, optional): Filters clips by associated events. For multiple events, separate them with commas (e.g., four,out).
players (string, optional): Filters clips by associated player name. For multiple players, separate them with commas (e.g., ronaldo,messi).
search (string, optional): Searches for clips by title.
filters (object, optional): Allows filtering based on clip-level custom fields.
Pass keyβvalue pairs where the key is the custom field name and the value is the filter value.
e.g. filters={\"cameraAngle\":\"side\"}
sort (object, optional): Allows you to sort clips by createdAt.
By default the sort order is -1 (newest) but you can pass 1 for (oldest).
e.g. sort={\"createdAt\" : 1}
Fetches all highlight clips associated with a particular stream using the streamId.
Params:
\nSTREAM_ID (URL param): Specifies the unique identifier of the stream.Query Params:
\npage (number, required): The page number to retrieve.
pageSize (number, required): The number of items per page.
filters (object, optional): Allows filtering based on hlclip-level custom fields.
Pass keyβvalue pairs where the key is the custom field name and the value is the filter value.
e.g. filters={\"hl_type\":\"1st Inning\"}
Fetches all highlights associated with a particular stream using the streamId.
Params:
\nSTREAM_ID (URL param): Specifies the unique identifier of the stream.Query Params:
\npage (number, required): The page number to retrieve.
pageSize (number, required): The number of items per page.
Retrieves the filters associated with a specific stream.
\nParams:
\nSTREAM_IDΒ (URL param): Specifies the unique identifier of the stream.Fetches all match videos associated with a particular stream using the streamId.
Params:
\nSTREAM_ID (URL param): Specifies the unique identifier of the stream.Query Params:
\ntype (enum, optional): partial-video | full-video.
status (enum, optional): INITIATED | PROCESSING | COMPLETED | FAILED.
search (string, optional): Searches for match video by title.
Retrieves clip metadata based on the clipId.
Params:
\nCLIP_ID (URL param): Specifies the unique identifier of the clip to fetch.Retrieves the metadata of a specific highlight.
\nParams:
\nHIGHLIGHT_ID (URL param): Specifies the unique identifier of the highlight.Retrieves highlight clip metadata based on the hlClipId.
Params:
\nHLCLIP_ID (URL param): Specifies the unique identifier of the clip to fetch.Retrieves match video information based on the matchVideoId.
Params:
\nMATCH_VIDEO_ID (URL param): Specifies the unique identifier of the match video to fetch.Retrieves a list of all match videos.
\nQuery Params:
\ntype (enum, optional): partial-video | full-video.
status (enum, optional): INITIATED | PROCESSING | COMPLETED | FAILED.
search (string, optional): Searches for match video by title.
sort (number, optional): -1 = Newest, 1 = Oldest. By default, items are sorted by newest.
page (number, required): The page number to retrieve.
pageSize (number, required): The number of items per page.
Fetch Video & Thumbnail presigned url for a content.
\nRequest Body:
\ncontentId (string, required): Can be any clipId, highlightId, hlClipId, matchVideoId
contentType (enum, required): \"clip\" | \"highlight\" | \"hlClip\" | \"matchVideo\"
aspectRatio (string, optional): Only for clips available in multiple aspect ratios, you can include this field to retrieve the correct aspect ratio video URL. The available values can be found in aspectRatiosAvailable field in clip metadata. If absent, we consider the default aspect ratio which in most case is 16:9.
Allows you to create a new player in Partner's organization.
\nRequest Body:
\ncategory (string, required): The category of the player.
playerName (string, required): The name of the player.
metaData (object, required): Additional metadata for the player.
jerseyNumber (number): The jersey number of the player.The metaData object is flexible, allowing you to pass any custom information needed when retrieving clip metadata.
Allows you to update a player in Partner's organization.
\nParams:
\nPLAYER_ID (URL param): Specifies the unique identifier of the player.Request Body:
\ncategory (string, required): The category of the player.
playerName (string, required): The name of the player.
metaData (object, required): Additional metadata for the player.
jerseyNumber (number): The jersey number of the player.The metaData object is flexible, allowing you to pass any custom information needed when retrieving clip metadata.
Retrieves the list of players associated with the partner.
\nQuery Params:
\npage (number, required): The page number to retrieve.
pageSize (number, required): The number of items per page.
category (string, optional): Filter players by specific category.
search (string, optional): Search players by name.
filters (object, optional): Additional filter on player metadata, e.g., { \"extPlayerId\" : \"12345\" }.
Retrieves the details of a specific player associated with the partner.
\nParams:
\nPLAYER_ID (URL param): Specifies the unique identifier of the player.Add a new team for a partner.
\nRequest Body:
\ncategory (string, required): The category of the team.
teamName (string, required): The name of the team.
players (array, required): An array of players id .
metaData (object, required): Additional metadata for the team.
shortName (string): The short name of the team.The metaData object is flexible, allowing you to pass any custom information needed when retrieving clip metadata.
Allows you to update a team in Partner's organization.
\nParams:
\nTEAM_ID (URL param): Specifies the unique identifier of the TEAM.(short, unique ID)
Example:
TEAM_ID: hCOte-L.1
Request Body:
\ncategory (string, required): The category of the team.
teamName (string, required): The name of the team.
players (array, required): An array of players id .
metaData (object, required): Additional metadata for the team.
shortName (string): The short name of the team.The metaData object is flexible, allowing you to pass any custom information needed when retrieving clip metadata.
Retrieves the list of teams associated with the partner.
\nQuery Params:
\npage (number, required): The page number to retrieve.
pageSize (number, required): The number of items per page.
category (string, optional): Filter teams by specific category.
search (string, optional): Search teams by name.
filters (object, optional): Additional filter on team metadata, e.g., { \"extId\" : \"12345\" }.
Retrieves the details of a specific team associated with a partner.
\nParams:
\nTEAM_ID (URL param): Specifies the unique identifier of the TEAM.(short, unique ID)
Example:
TEAM_ID: hCOte-L.1
Create a new tournament for a partner.
\nRequest Body:
\ncategory (string, required): The category of the tournament.
tournamentName (string, required): The name of the tournament.
teams (array of strings, required): An array of teams id participating in the tournament.
Note: This should be a short ID.
(e.g., [ \"bynSs130W\" ])
metaData (object, required): Additional metadata for the tournament.
The metaData object is flexible, allowing you to pass any custom information needed when retrieving clip metadata.
Allows you to update a tournament in Partner's organization.
\nParams:
\nTOURNAMEMT_ID (URL param): Specifies the unique identifier of the Tournament.Request Body:
\ncategory (string, required): The category of the tournament.
tournamentName (string, required): The name of the tournament.
teams (array of strings, required): An array of teams id participating in the tournament.
Note: This should be a short ID.
(e.g., [ \"bynSs130W\" ])
metaData (object, required): Additional metadata for the tournament.
The metaData object is flexible, allowing you to pass any custom information needed when retrieving clip metadata.
Retrieves a list of tournaments associated with the partner.
\nQuery Params:
\npage (number, required): The page number to retrieve.
pageSize (number, required): The number of items per page.
category (string, optional): Filter tournaments by specific category.
search (string, optional): Search tournament by name.
filters (object, optional): Additional filter on tournament metadata, e.g., { \"extId\" : \"12345\" }.
Retrieves details of a specific tournament associated with the partner.
\nParams:
\nTOURNAMEMT_ID (URL param): Specifies the unique identifier of the Tournament.Create a new match schedule with the specified details.
\nRequest Body:
\nname (string, required): The name of the match.
matchStartTime (string, required): The timestamp at which the match is scheduled to start, in ISO 8601 format.
timezone (string, required): The timezone for the match start time, e.g., 'Etc/UTC'.
teams (array, optional): An array of objects representing the teams in the match.
teamId (string, required): The unique identifier of the team.
type (string, required): The role of the team in the match, e.g., 'HOME' or 'AWAY'.
tournament (string, optional): The unique identifier of the tournament to which the match belongs.
category (string, required): The category of the match, e.g., 'cricket'.
extMatchId (string, optional): An optional external match ID.slug (string, optional):An optional slug for the match.
slug (string, optional): An optional slug for the match.
streamUrl (string, optional): The URL for the match stream.
venue (string, optional): The venue where the match is taking place.
streamCustomFields (object, optional): A set of custom key-value pairs defining additional stream-specific fields for the match.
Update the details of a specific match schedule
\nParams:
\nMATCH_SCHEDULE_ID (URL param): Specifies the unique identifier of the match schedule.Request Body:
\nname (string, optional): The name of the match.
matchStartTime (string, optional): The timestamp at which the match is scheduled to start, in ISO 8601 format.
timezone (string, optional): The timezone for the match start time, e.g., 'Etc/UTC'.
teams (array, optional): An array of objects representing the teams in the match.
teamId (string, required): The unique identifier of the team.
type (string, required): The role of the team in the match, e.g., 'HOME' or 'AWAY'.
tournament (string, optional): The unique identifier of the tournament to which the match belongs.
category (string, optional): The category of the match, e.g., 'cricket'.
slug (string, optional): An optional slug for the match.
streamUrl (string, optional): The URL for the match stream.
venue (string, optional): The venue where the match is taking place.
streamCustomFields (object, optional): A set of custom key-value pairs defining additional stream-specific fields for the match.
Retrieves the details of a specific match schedule
\nParams:
\nMATCH_SCHEDULE_ID (URL param): Specifies the unique identifier of the match schedule.Retrieves a list of all match schedules.
\nQuery Params:
\nstartTime (string, required): The start time for filtering match schedules, in ISO 8601 format. Must be less than the endTime.
endTime (string, required): The end time for filtering match schedules, in ISO 8601 format.
category (string, optional): The category of the match, e.g., 'cricket'.
tournament (string, optional): The unique identifier of the tournament to which the match belongs.
search (string, optional): A search term for filtering match schedules by name or other relevant fields.
streamCustomFields (object, optional): An object used to filter match schedules by specific custom stream field values.
Deletes the details of a specific match schedule
\nParams:
\nMATCH_SCHEDULE_ID (URL param): Specifies the unique identifier of the match schedule.De-link a specific match schedule from the Stream it is linked with.
\nParams:
\nMATCH_SCHEDULE_ID (URL param): Specifies the unique identifier of the match schedule.Create a new stream from the match schedule.
\nParams:
\nMATCH_SCHEDULE_ID (URL param): Specifies the unique identifier of the match schedule.Request Body:
\ntemplateName (string, required): The name of the template.
title (string, optional): The title of the stream.
url (string, optional): The URL of the stream.
category (string, optional): The category of the stream.
fireAt (string, optional): The timestamp at which the stream should start.
streamStartTime (string, optional): The start time of the stream.
fields (object, optional): Additional fields for the stream.
ext_stream_id (string, optional): The external stream ID.publishingWebhookUrl (string, optional): Webhook URL where you want us to send metadata.
hls_live_start_index (number, optional): Default value 1
tournamentId (string, optional): ID for the tournament to which the stream belongs.
homeTeamId (string, optional): ID for the home team participating in the stream.
awayTeamId (string, optional): ID for the away team participating in the stream.
shareType (enum, optional): Use this field to specify how the stream should be shared with workspaces. Note that the sharedWith field must also be provided for this to take effect. Accepted enum values:
original β The stream scope is shared, allowing generated clips to be accessible in both the parent organization and the shared workspace.
\nclone β The shared workspace can view clips generated in the parent organization, but the parent organization will not see clips created in the shared workspace.
\nsharedWith (string[], optional): A list of workspace IDs where the stream should be shared.
streamLanguage (string, optional): Default language for the stream (e.g: \"en\").
storageId (string, optional): Storage target ID for outputs.
clipNamingTemplateId (string, optional): Template ID for naming generated clips.
audioType (string, optional): How audio is selected for multi-audio streams. Accepted values: iso, track, pid. When iso, scte35Source is required.
scte35Source (string, optional): Where SCTE-35 cues are read from. Required when audioType is \"iso\". Accepted values: SEGMENTS, MANIFESTS. Optional otherwise.
audioLanguages (string[], optional): Language codes for audio tracks (e.g: [\"en\", \"es\"]).
clipLanguages (string[], optional): Language codes for clip generation (e.g: [\"en\", \"es\"]).
audioTracks (string[], optional): HLS audio group or track IDs (e.g: [\"aud1\", \"aud2\"]). Use when audioType is \"track\".
pids (string[], optional): MPEG-TS audio PIDs (e.g: [\"257\", \"258\"]). Use when audioType is \"pid\".
autoAspectRatioConvert (object, optional): Auto aspect-ratio conversion. e.g: { \"autoConvertAspectRatios\": [\"16:9\"] }.
Note:
All optional fields will automatically fall back to the corresponding values from the match schedule, if available. If any optional field is not provided explicitly in the request body, the system will use the default value from the associated match schedule.
The fields object is flexible, allowing you to pass any custom information needed when retrieving metadata.
If datafeed access is required, please reach out to us to enable it. Once access is granted, include the following within the payload object:
\"datafeed\": {\n \"type\": \"genius\",\n \"competitionId\": \"some_id\",\n \"tournamentId\": \"some_id\",\n \"matchId\": \"some_id\"\n}\n\n","urlObject":{"path":["v1","match-schedule","{{MATCH_SCHEDULE_ID}}","invoke-stream"],"host":["{{PARTNER_BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"4794b159-14c2-4ab7-977b-e22eaf3ecadd","name":"Invoke stream by matchScheduleId","originalRequest":{"method":"POST","header":[{"key":"x-access-key","value":"{{PARTNER-X-ACCESS-KEY}}","type":"text"},{"key":"x-access-secret","value":"{{PARTNER-X-ACCESS-SECRET}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"templateName\": \"Test mp4 template\",\n \"url\": \"https://d1rkuvpc8sfd7al.cloudfront.net/example/master_highest.m3u8\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PARTNER_BASE_URL}}/v1/match-schedule/{{MATCH_SCHEDULE_ID}}/invoke-stream"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"Origin"},{"key":"access-control-allow-credentials","value":"true"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"content-length","value":"783"},{"key":"Date","value":"Mon, 10 Nov 2025 08:27:40 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=72"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 202,\n \"message\": \"Stream created from Match Schedule successfully\",\n \"data\": {\n \"stream\": {\n \"streamId\": \"bIaas2bkn\",\n \"title\": \"PS Match\",\n \"url\": \"https://qwertyul.cloudfront.net/example/master_highest.m3u8\",\n \"category\": \"cricket\",\n \"userId\": \"454354\",\n \"entityId\": \"org_b7335033-4815-a5fb-b0f5-5ad87adde5ef\",\n \"fireAt\": \"2025-11-10T14:00\",\n \"aspectRatio\": \"16:9\",\n \"status\": \"Pending\",\n \"streamStartTime\": \"2025-11-10T13:57:36.000Z\",\n \"fields\": {\n \"tournamentId\": \"KQErBW123\",\n \"team1Id\": null,\n \"team2Id\": null,\n \"stream_start_time\": \"2025-11-10T13:57:36+00:00\"\n },\n \"match_start_time_on_server\": 0,\n \"templateId\": \"66dea8cd414ea00007d1f123\",\n \"hls_live_start_index\": 1,\n \"publishingWebhookUrl\": \"\",\n \"createdAt\": \"2025-11-10T08:27:39.716Z\",\n \"datafeed\": {}\n }\n }\n}"},{"id":"3b6213b3-6e4e-4021-89fd-70e11c29fbaa","name":"Error - Invoke stream by matchScheduleId","originalRequest":{"method":"POST","header":[{"key":"x-access-key","value":"{{PARTNER-X-ACCESS-KEY}}","type":"text"},{"key":"x-access-secret","value":"{{PARTNER-X-ACCESS-SECRET}}","type":"text"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"{{PARTNER_BASE_URL}}/v1/match-schedule/{{MATCH_SCHEDULE_ID}}/invoke-stream"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"Origin"},{"key":"access-control-allow-credentials","value":"true"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"content-length","value":"193"},{"key":"Date","value":"Mon, 10 Nov 2025 08:21:11 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=72"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 400,\n \"message\": \"Validation failed\",\n \"error\": [\n {\n \"property\": \"templateName\",\n \"constraints\": {\n \"isNotEmpty\": \"templateName should not be empty\",\n \"isString\": \"templateName must be a string\"\n }\n }\n ]\n}"},{"id":"4993016e-69f0-42c0-a47c-ea141a98123e","name":"Error - Invoke stream by matchScheduleId","originalRequest":{"method":"POST","header":[{"key":"x-access-key","value":"{{PARTNER-X-ACCESS-KEY}}","type":"text"},{"key":"x-access-secret","value":"{{PARTNER-X-ACCESS-SECRET}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"templateName\": \"Test mp4 template\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PARTNER_BASE_URL}}/v1/match-schedule/{{MATCH_SCHEDULE_ID}}/invoke-stream"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"Origin"},{"key":"access-control-allow-credentials","value":"true"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"content-length","value":"1069"},{"key":"Date","value":"Mon, 10 Nov 2025 08:26:09 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=72"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 400,\n \"error\": {\n \"message\": \"Stream URL validation failed\",\n \"code\": \"S002\",\n \"metadata\": {\n \"matchScheduleData\": {\n \"id\": \"msh_c8921714-e4e4-4209-8287-bc33ca122b54\",\n \"name\": \"A demo match\",\n \"extMatchId\": \"ext_match_646ef753-422d-ed14-bba3-b35461b39222\",\n \"organizationId\": \"org_b7335033-a5fb-b0f5-4815-5ad87adde5ef\",\n \"workspaceWithAccess\": null,\n \"category\": \"cricket\",\n \"matchStartTime\": \"2025-11-10T08:30:00.000Z\",\n \"tournament\": \"KQErBW123\",\n \"teams\": null,\n \"venue\": null,\n \"streamId\": null,\n \"streamUrl\": null,\n \"metaData\": {\n \"originalMatchStartTime\": {\n \"matchStartTime\": \"2025-11-10T14:00:00\",\n \"timezone\": \"Asia/Kolkata\"\n },\n \"originalMatchEndTime\": {\n \"matchEndTime\": null,\n \"timezone\": \"Asia/Kolkata\"\n }\n }\n },\n \"payload\": {\n \"title\": \"A demo match\",\n \"url\": null,\n \"category\": \"cricket\"\n }\n }\n }\n}"}],"_postman_id":"f93e6e58-e252-4479-a50d-6768f3354704"}],"id":"b1b74df6-380d-493b-9610-7066cf2523a4","_postman_id":"b1b74df6-380d-493b-9610-7066cf2523a4","description":""},{"name":"Catch me up","item":[{"name":"Get Catch me up Highlight","id":"020f2db2-ec39-4fa6-92bf-86b7fff10283","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-access-key","value":"{{PARTNER-X-ACCESS-KEY}}","type":"text"},{"key":"x-access-secret","value":"{{PARTNER-X-ACCESS-SECRET}}","type":"text"}],"url":"{{PARTNER_BASE_URL}}/v1/catch-me-up/highlight?configId={{CATCH_ME_UP_CONFIG}}&streamId={{STREAM_ID}}","urlObject":{"path":["v1","catch-me-up","highlight"],"host":["{{PARTNER_BASE_URL}}"],"query":[{"key":"configId","value":"{{CATCH_ME_UP_CONFIG}}"},{"key":"streamId","value":"{{STREAM_ID}}"}],"variable":[]}},"response":[{"id":"cbb6d45f-8c44-4f52-8580-01cd07c24afa","name":"Get Catch me up Highlight","originalRequest":{"method":"GET","header":[{"key":"x-access-key","value":"{{PARTNER-X-ACCESS-KEY}}","type":"text"},{"key":"x-access-secret","value":"{{PARTNER-X-ACCESS-SECRET}}","type":"text"}],"url":{"raw":"{{PARTNER_BASE_URL}}/v1/catch-me-up/highlight?configId={{CATCH_ME_UP_CONFIG}}&streamId={{STREAM_ID}}","host":["{{PARTNER_BASE_URL}}"],"path":["v1","catch-me-up","highlight"],"query":[{"key":"configId","value":"{{CATCH_ME_UP_CONFIG}}"},{"key":"streamId","value":"{{STREAM_ID}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 200,\n \"message\": \"Catch me up HL retrieved successfully\",\n \"data\": {\n \"catchMeUpHL\": {\n \"id\": \"cmu_hl_a6c33f5a-8067-4135-9e31-a6c33f5a3afc\",\n \"configId\": \"cmu_cfg_60566546-4444-46f1-1234-7baamadu8ba0\",\n \"entityId\": \"entityId\",\n \"clips\": [\n {\n \"clipId\": \"6798a5271a42800009488f9f\",\n \"duration\": 7.834,\n \"preSignedUrl\": \"\"\n },\n {\n \"clipId\": \"6798a4d9b52e4e000923b1db\",\n \"duration\": 6.134,\n \"preSignedUrl\": \"\"\n },\n {\n \"clipId\": \"6798a465b52e4e000923af4d\",\n \"duration\": 5.6,\n \"preSignedUrl\": \"\"\n }\n ]\n }\n }\n}"},{"id":"4fe0217c-ee28-4b99-8b09-708b59adffa5","name":"Get Catch me up Highlight - not available","originalRequest":{"method":"GET","header":[{"key":"x-access-key","value":"{{PARTNER-X-ACCESS-KEY}}","type":"text"},{"key":"x-access-secret","value":"{{PARTNER-X-ACCESS-SECRET}}","type":"text"}],"url":{"raw":"{{PARTNER_BASE_URL}}/v1/catch-me-up/highlight?configId={{CATCH_ME_UP_CONFIG}}&streamId={{STREAM_ID}}","host":["{{PARTNER_BASE_URL}}"],"path":["v1","catch-me-up","highlight"],"query":[{"key":"configId","value":"{{CATCH_ME_UP_CONFIG}}"},{"key":"streamId","value":"{{STREAM_ID}}"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 404,\n \"error\": {\n \"message\": \"Catch me up Highlight is not yet ready for this stream\",\n \"code\": \"CM001\",\n \"metadata\": {\n \"configId\": \"cmu_cfg_18a6e30b-6b96-4a86-bdcc-012345c8d4f4\",\n \"streamId\": \"eHqq4ZTuu\",\n \"entityId\": \"org_11111111-a5fb-4815-b0f5-2222adde5ef\",\n \"userId\": \"qdgvbzVAz\"\n }\n }\n}"}],"_postman_id":"020f2db2-ec39-4fa6-92bf-86b7fff10283"}],"id":"0db26a22-ad80-441a-95a9-1803be22b473","_postman_id":"0db26a22-ad80-441a-95a9-1803be22b473","description":""},{"name":"Webhook","item":[{"name":"Metadata Delivery","item":[],"id":"ddb57865-94ee-442c-bc9a-af237e905011","description":"When a stream is being processed, if it has a publishingWebhookUrl field, metadata is pushed in real-time as content (e.g., clips or highlight clips).
Refer to the Create Stream API in the Stream section for setup details.
\n{\n \"data\": {\n \"metadata\": { ... }, // Matches the structure returned by the direct API for the resource\n \"version\": 2\n },\n \"event\": \"CLIP_CREATED\" // or \"CLIP_UPDATED\", etc.\n}\n\n\nTo help you verify that webhook requests originate from Magnifi and that the payload has not been tampered with, we support the following authentication mechanisms:
\nYou can provide a secret key, which will be securely configured on our side.
\nMagnifi generates an HMAC-SHA256 signature using this secret and the raw request payload.
\nThe generated signature is sent with every webhook request in the following HTTP header:
\nx-magnifi-signature\n\n\nYou should recompute the HMAC on your side using the same secret and compare it with the received signature to verify:
\nAuthenticity (the request was sent by Magnifi)
\nIntegrity (the payload was not modified in transit)
\nAlternatively, you may provide:
\nA custom HTTP header name
\nAn expected secret value
\nWhen configured, Magnifi will include this header with the specified value in every webhook request.
\nYou can validate incoming requests by checking for the presence and correctness of this header.
\n{\n \"data\": {\n \"metadata\": {\n \"clip\": {\n \"partnerData\": {\n \"internal-v1\": {\n \"over\": \"\",\n \"internalStreamId\": \"hczWXN6hz\"\n }\n },\n \"streamId\": \"hczWXN6hz\",\n \"hls_live_start_index\": 0,\n \"matchDetails\": {\n \"outcome\": \"catch\"\n },\n \"aspectRatio\": \"16:9\",\n \"aspectRatiosAvailableIn\": [\"16:9\"],\n \"process_start_time\": \"\",\n \"duration\": 0,\n \"clipId\": \"684beb398b1c240010433974\",\n \"startTime\": 0.55,\n \"endTime\": 2.674,\n \"category\": \"cricket\",\n \"clipTitle\": \"\",\n \"streamBufferDifference\": 0\n }\n },\n \"version\": 2\n },\n \"event\": \"CLIP_CREATED\"\n}\n\n\nYou may receive one CLIP_CREATED followed by multiple CLIP_UPDATED events for the same content.
This behavior is due to our multi-stage stream processing pipeline.
\nEach event is retried up to three times in case of delivery failures.
\nRetrives all the available topics for the partner to create subscription.
\n","urlObject":{"path":["v1","webhook","notifier","topics"],"host":["{{PARTNER_BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"b63d2979-3acb-4fae-900d-4c5646bb8088","name":"Fetch Topics","originalRequest":{"method":"GET","header":[{"key":"x-access-key","value":"{{PARTNER-X-ACCESS-KEY}}","type":"text"},{"key":"x-access-secret","value":"{{PARTNER-X-ACCESS-SECRET}}","type":"text"}],"url":"{{PARTNER_BASE_URL}}/v1/webhook/notifier/topics"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 200,\n \"message\": \"Topics fetched successfully\",\n \"data\": [\n {\n \"resourceType\": \"stream\",\n \"operations\": [\n \"CREATE\",\n \"UPDATE\"\n ],\n \"standardFields\": [\n \"title\",\n \"status\"\n ],\n \"customFields\": []\n },\n {\n \"resourceType\": \"matchVideo\",\n \"operations\": [\n \"CREATE\",\n \"UPDATE\"\n ],\n \"standardFields\": [\n \"matchVideoTitle\",\n \"status\",\n \"progress\",\n \"videoUrl\"\n ],\n \"customFields\": []\n },\n {\n \"resourceType\": \"clip\",\n \"operations\": [\n \"CREATE\",\n \"UPDATE\"\n ],\n \"standardFields\": [\n \"clipTitle\",\n \"startTime\",\n \"endTime\",\n \"duration\",\n \"players\",\n \"outcome\",\n \"rating\",\n \"transcript\",\n \"videoUrl\",\n \"videoThumbnailUrl\",\n \"aspectRatiosAvailableIn\"\n ],\n \"customFields\": [\n {\n \"fieldName\": \"batsman\",\n \"category\": \"cricket\"\n },\n {\n \"fieldName\": \"bowler\",\n \"category\": \"cricket\"\n },\n {\n \"fieldName\": \"corner\",\n \"category\": \"football\"\n }\n ]\n },\n {\n \"resourceType\": \"hlClip\",\n \"operations\": [\n \"CREATE\",\n \"UPDATE\"\n ],\n \"standardFields\": [\n \"hlClipTitle\",\n \"duration\",\n \"players\",\n \"outcome\",\n \"rating\",\n \"videoUrl\",\n \"clips\"\n ],\n \"customFields\": [\n {\n \"fieldName\": \"batsman\",\n \"category\": \"cricket\"\n },\n {\n \"fieldName\": \"bowler\",\n \"category\": \"cricket\"\n },\n {\n \"fieldName\": \"corner\",\n \"category\": \"football\"\n }\n ]\n }\n ]\n}"}],"_postman_id":"859646c6-d4dd-470e-b9fe-092f3114eba4"},{"name":"Create Subscription","id":"6d53a144-b309-4377-a60e-1856d9a8f7c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-access-key","value":"{{PARTNER-X-ACCESS-KEY}}","type":"text"},{"key":"x-access-secret","value":"{{PARTNER-X-ACCESS-SECRET}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"resourceType\": \"clip\",\n \"operations\": [\n \"UPDATE\"\n ],\n \"standardFields\": [\n \"clipTitle\",\n \"rating\"\n ],\n \"customFields\": [\n {\n \"fieldName\": \"run\",\n \"category\": \"cricket\"\n },\n {\n \"fieldName\": \"goal\",\n \"category\": \"football\"\n }\n ],\n \"webhookUrl\": \"https://api.example.com/webhooks/notifications\",\n \"secretKey\": \"your-32-character-secret-key-here-123456789\",\n \"description\": \"Webhook subscription for clip events\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PARTNER_BASE_URL}}/v1/webhook/notifier/subscription","description":"Create a new webhook subscription with the specified details.
\nRequest Body:
\nresourceType (enum, required): The type of resource to monitor.
operations (array of enum, required): List of operations to monitor.
standardFields (array of strings, optional): List of standard fields to include in the webhook payload. [To be used with _UPDATE_ operation only.]
customFields (array of objects, optional): List of custom fields to include in the webhook payload. [To be used with _UPDATE_ operation only.]
fieldName (string, required): Name of the custom field
category (string, required): Category of the custom field
webhookUrl (string, required): The HTTPS URL where webhook notifications will be sent. Must be a valid HTTPS URL with protocol, host, and TLD (e.g., https://example.com).
secretKey (string, optional): Secret key for webhook signature verification. If not passed, we will fallback to a default key.
Must be between 32 and 128 characters long
\nCan only contain letters, numbers, hyphens, and underscores
\ndescription (string, optional): A description of the webhook subscription.
Note: The available fields and their validation may change over time. It's recommended to:
\nUse the /webhook/notifier/topics endpoint to get the current list of available fields for each resource type
Check the API response for any validation errors
\nMonitor the webhook delivery status through the provided endpoints
\nUpdate an existing webhook subscription with the specified details.
\nRequest Body:
\nresourceType (enum, required): The type of resource to monitor.
operations (array of enum, required): List of operations to monitor.
standardFields (array of strings, optional): List of standard fields to include in the webhook payload.
customFields (array of objects, optional): List of custom fields to include in the webhook payload.
fieldName (string, required): Name of the custom field
category (string, required): Category of the custom field
webhookUrl (string, required): The HTTPS URL where webhook notifications will be sent. Must be a valid HTTPS URL with protocol, host, and TLD (e.g., https://example.com).
secretKey (string, optional): Secret key for webhook signature verification. If not passed, we will fallback to a default key.
Must be between 32 and 128 characters long
\nCan only contain letters, numbers, hyphens, and underscores
\ndescription (string, optional): A description of the webhook subscription.
Note: The available fields and their validation may change over time. It's recommended to:
\nUse the /webhook/notifier/topics endpoint to get the current list of available fields for each resource type
Check the API response for any validation errors
\nMonitor the webhook delivery status through the provided endpoints
\nRetreive all the active subscriiption available
\n","urlObject":{"path":["v1","webhook","notifier","subscriptions"],"host":["{{PARTNER_BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"13808e3f-9f5a-44ee-b84e-b4205b0e47c9","name":"Get Subscriptions","originalRequest":{"method":"GET","header":[{"key":"x-access-key","value":"{{PARTNER-X-ACCESS-KEY}}","type":"text"},{"key":"x-access-secret","value":"{{PARTNER-X-ACCESS-SECRET}}","type":"text"}],"url":"{{PARTNER_BASE_URL}}/v1/webhook/notifier/subscriptions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 200,\n \"message\": \"Subscriptions fetched successfully\",\n \"data\": {\n \"subscriptions\": [\n {\n \"subscriptionId\": \"Retrieve the subscription by its unique identifier.
\n","urlObject":{"path":["v1","webhook","notifier","subscription","{{SUBSCRIPTION_ID}}"],"host":["{{PARTNER_BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"83bebd55-60d4-47c1-a959-12f6a5d235a6","name":"Get Subscription by subscriptionId","originalRequest":{"method":"GET","header":[{"key":"x-access-key","value":"{{PARTNER-X-ACCESS-KEY}}","type":"text"},{"key":"x-access-secret","value":"{{PARTNER-X-ACCESS-SECRET}}","type":"text"}],"url":"{{PARTNER_BASE_URL}}/v1/webhook/notifier/subscription/{{SUBSCRIPTION_ID}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n\t\"statusCode\": 200,\n\t\"message\": \"Subscription fetched successfully\",\n\t\"data\": {\n\t\t\"subscription\": {\n\t\t\t\"subscriptionId\": \"This method allows you to subscribe to specific event topics (e.g., Stream Created, Clip Rating Changed, Match Video Progress) across your organization or workspace.
These notifications inform you when a resource changes, but only include which fields changedβnot the full content.
\nEach event includes metadata such as:
\nresourceType - stream | clip | hlClip | matchVideo
operation - CREATE | UPDATE
timestamp
changedStandardFields / changedCustomFields
You can configure a secret key when creating the subscription using the Subscription API.
\nWe use this key to generate a HMAC-SHA256 signature.
\nThe signature is included in the x-magnifi-signature header of every webhook event.
This allows you to verify authenticity and integrity of the payload.
\n{\n \"eventId\": \"evt_ntf_0536056b-b508-456e-813a-f753a8902b1d\",\n \"changedStandardFields\": [\"clipTitle\"],\n \"resourceId\": \"684bea988b1c2400104332de\",\n \"subscriptionId\": \"sub_ntf_22356c54-607b-4e51-9db7-6c9b16a10571\",\n \"operation\": \"UPDATE\",\n \"version\": 2,\n \"resourceType\": \"clip\",\n \"timestamp\": \"2025-06-13T09:08:52.017Z\"\n}\n\n\nWe attempt delivery up to five times.
\nIf repeated failures occur, the subscription may be disabled automatically.
\nCreate a new entity member with the specified details.
\nRequest Body:
\nname (string, required): The name of the entity member.
email (string, required): The email of the entity member.
password (string, required): Password of the entity member
role (string, required): Role for the entity member, e.g., 'user' or 'reviewer'.
Assign a role to a assignable user.
\nRequest Body:
\nuserId (string, required): User ID of the user.
role (string, required): Role for the user.
Note: Allowed values for roles are \"user\" or \"reviewer\"
\nRetrieve assignable users for the entity.
\n","urlObject":{"path":["v1","user","assignable"],"host":["{{PARTNER_BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"8c71a411-3cd0-4547-a1d9-65496eafff3d","name":"Get Assignable Users","originalRequest":{"method":"GET","header":[{"key":"x-access-key","value":"{PARTNER-X-ACCESS-KEY}","type":"text"},{"key":"x-access-secret","value":"{PARTNER-X-ACCESS-SECRET}","type":"text"}],"url":{"raw":"{{PARTNER_BASE_URL}}/v1/entity-member/assignable?page=1&pageSize=10","host":["{{PARTNER_BASE_URL}}"],"path":["v1","entity-member","assignable"],"query":[{"key":"page","value":"1"},{"key":"pageSize","value":"10"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"vary","value":"Origin"},{"key":"access-control-allow-credentials","value":"true"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"888"},{"key":"Date","value":"Fri, 30 Jan 2026 11:30:34 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=72"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 200,\n \"message\": \"Assignable users retrieved successfully\",\n \"data\": {\n \"users\": [\n {\n \"userId\": \"0WXRsQbMQ\",\n \"name\": \"Test User 2\",\n \"email\": \"faerWellUser@gmail.com\"\n },\n {\n \"userId\": \"3nbdsANEm\",\n \"name\": \"Test User 3\",\n \"email\": \"faerWelladmin@gmail.com\"\n },\n {\n \"userId\": \"728WCsrKz\",\n \"name\": \"Test User 4\",\n \"email\": \"april29@gmail.com\"\n },\n {\n \"userId\": \"C9u-f4KqS\",\n \"name\": \"Test User 5\",\n \"email\": \"nik123@yopmail.com\"\n },\n {\n \"userId\": \"FkqNXsehK\",\n \"name\": \"Test User 6\",\n \"email\": \"asdfsdf@magnifi.ai\"\n }\n ],\n \"currentPage\": 1,\n \"pageSize\": 10,\n \"totalItems\": 5,\n \"totalPages\": 1\n }\n}"}],"_postman_id":"fd3b2634-f758-49e2-b497-bc3da7b42893"},{"name":"Get Entity Members","id":"83eec6af-3a47-4da3-88d5-ec03a095376d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-access-key","value":"{{PARTNER-X-ACCESS-KEY}}","type":"text"},{"key":"x-access-secret","value":"{{PARTNER-X-ACCESS-SECRET}}","type":"text"}],"url":"{{PARTNER_BASE_URL}}/v1/entity-member","description":"Retrieve existing entity members of the entity.
\n","urlObject":{"path":["v1","entity-member"],"host":["{{PARTNER_BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"3599e13d-0177-4471-a2a4-b639667c4663","name":"Get Entity Members","originalRequest":{"method":"GET","header":[{"key":"x-access-key","value":"{PARTNER-X-ACCESS-KEY}","type":"text"},{"key":"x-access-secret","value":"{PARTNER-X-ACCESS-SECRET}","type":"text"}],"url":{"raw":"{{PARTNER_BASE_URL}}/v1/entity-member?page=1&pageSize=10","host":["{{PARTNER_BASE_URL}}"],"path":["v1","entity-member"],"query":[{"key":"page","value":"1"},{"key":"pageSize","value":"10"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"vary","value":"Origin"},{"key":"access-control-allow-credentials","value":"true"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"767"},{"key":"Date","value":"Fri, 30 Jan 2026 11:29:29 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=72"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 200,\n \"message\": \"Entity members retrieved successfully\",\n \"data\": {\n \"entityMembers\": [\n {\n \"entityMemberId\": \"orgMem_b593b0f3-83b5-45ee-8bf9-c9a9f1ebc123\",\n \"role\": \"admin\",\n \"userId\": \"v988DduzK\",\n \"name\": \"Test User 11\",\n \"email\": \"testadmin@magnifi.ai\"\n },\n {\n \"entityMemberId\": \"orgMem_b12a71dd-c377-4c6b-abcd-4feeec972456\",\n \"role\": \"user\",\n \"userId\": \".KKFPAEdw\",\n \"name\": \"Test User 8\",\n \"email\": \"user8@mailinator.com\"\n },\n {\n \"entityMemberId\": \"orgMem_f9b0603d-2eb6-4ae3-8894-bff51d90f789\",\n \"role\": \"admin\",\n \"userId\": \"HtH74Kk-c\",\n \"name\": \"Test User 7\",\n \"email\": \"admin@mailinator.com\"\n },\n {\n \"entityMemberId\": \"orgMem_f6072a00-dd34-4cdb-99f9-cd86f79da011\",\n \"role\": \"user\",\n \"userId\": \"nLnZRyj7c\",\n \"name\": \"Test user\",\n \"email\": \"molola3631@1200b.com\"\n }\n ],\n \"currentPage\": 1,\n \"pageSize\": 10,\n \"totalItems\": 4,\n \"totalPages\": 1\n }\n}"}],"_postman_id":"83eec6af-3a47-4da3-88d5-ec03a095376d"},{"name":"Update Entity Member Role","id":"55dd8e94-1d82-4057-b229-c29562324979","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"x-access-key","value":"{{PARTNER-X-ACCESS-KEY}}","type":"text"},{"key":"x-access-secret","value":"{{PARTNER-X-ACCESS-SECRET}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"role\": \"reviewer\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PARTNER_BASE_URL}}/v1/entity-member/{{ENTITY_MEMBER_ID}}","description":"Update the role of a existing entity member
\nParams:
\nENTITY_MEMBER_ID (URL param): Specifies the unique identifier of the entity member. (e.g orgMem_xxx or wsMem_xxx)Request Body:
\nrole (string, optional): Role for the entity member. (e.g 'user' or 'reviewer')Remove access of a existing entity member.
\nParams:
\nENTITY_MEMBER_ID (URL param): Specifies the unique identifier of the entity member. (e.g orgMem_xxx or wsMem_xxx)