API

to use the hotmic public api, you need to use a public api key provided by hotmic retrieve 1 or more streams { "tab" "examples", "url" "https //public api hotmic io/streams", "name" "retrieve stream(s) endpoint", "method" "get", "request" { "pathparameters" \[], "queryparameters" \[ { "kind" "optional", "name" "limit", "type" "integer", "children" \[], "description" "limits the number of results returned by the query defaults to 100 " }, { "kind" "optional", "name" "state", "type" "string", "children" \[], "description" "filter results to only include streams with a given state can be \\"scheduled\\", \\"live\\", \\"ended\\", or \\"vod\\"" }, { "kind" "optional", "name" "userid", "type" "string", "children" \[], "description" "filter results to only include streams with a certain userid " }, { "kind" "optional", "name" "ids", "type" "string", "children" \[], "description" "filter results to only include 1 or more streams by id if passing multiple ids, separate them by an underscore (example abc 123 def 456 would filter for 2 streams \\"abc 123\\" and \\"def 456\\") " }, { "kind" "optional", "name" "orderby", "type" "string", "children" \[], "description" "the field to order by, ascending by default" }, { "kind" "optional", "name" "desc", "type" "boolean", "children" \[], "description" "if true, order by descending instead of ascending " }, { "kind" "optional", "name" "cursor", "type" "string", "children" \[], "description" "this filters the results to only return the next results after this cursor, up to the limit typically used for pagination, this is the last result that will be ignored based on the orderby field so if you are sorting by ids, and you have 5 users with id 1,2,3,4,5 passing cursor=2 limit=2 would return 3,4 \ndo not use combined with \\"skip\\" " }, { "kind" "optional", "name" "skip", "type" "integer", "children" \[], "description" "when paginating, how many results to skip if using skip 30 limit 10, you would get results 31 to 40 do not use combined with \\"cursor\\" " }, { "kind" "optional", "name" "pagination", "type" "string", "children" \[], "description" "defaults to \\"skip\\" if this is set to \\"cursor\\", then the \\"next\\" result on the link will always return the correct next paginated result using a cursor " } ], "headerparameters" \[ { "kind" "required", "name" "x api key", "type" "string", "children" \[], "description" "the api key provided to you by hotmic " } ], "bodydataparameters" \[], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "pndcwvz5krixkij082pv1", "code" "{\n \\"links\\" {\n \\"next\\" \\"https //public api hotmic io/streams?skip=3\&limit=2\&orderby=title\\",\n \\"self\\" \\"https //public api hotmic io/streams?skip=1\&limit=2\&orderby=title\\"\n },\n \\"limit\\" 2,\n \\"count\\" 2,\n \\"results\\" \[\n {\n \\" id\\" \\"82052303 2a846 45b9 nuo5 3e3447208xece\\",\n \\"user id\\" \\"a4erf186 6824 4asf4d a33e agsab1b776\\",\n \\"title\\" \\"111 live\\",\n \\"thumbnail\\" \\"https //d1h34rji cloudfront net/thumbnails/default thumbnail turner png\\",\n \\"scheduled date\\" \\"2022 08 16t22 27 08z\\",\n \\"state\\" \\"vod\\",\n \\"type\\" \\"broadcast\\",\n \\"description\\" \\"\\",\n \\"event id\\" \\"bb1asdfd 8d20 4881 a675 0433e43340883\\",\n \\"live date\\" \\"2022 08 16t22 28 36z\\",\n \\"duration\\" 31 295,\n \n \\"user\\" {\n \\" id\\" \\"a5fd6 6824 44erafd a33e bbc1rjf89776\\",\n \\"followers\\" 0,\n \\"display name\\" \\"bleacherbob\\",\n \\"profile pic\\" \\"https //d1h34rji cloudfront net/apps/09c935f55d90da6f455c/images/a533e186 d38bf4 profile png\\"\n },\n \\"last updated\\" \\"2022 08 16t22 29 17z\\",\n \\"video url\\" \\"https //d1h34rji cloudfront net/recorded streams/chris 9073/82052303447a18ece/chris m3u8\\"\n },\n {\n \\" id\\" \\"85a2easd8 02cc 4824e a3ff7 0gt4373\\",\n \\"user id\\" \\"a52adsff4 4erg bbc15ab1b776\\",\n \\"title\\" \\"123\\",\n \\"thumbnail\\" \\"https //d1h34rji cloudfront net/thumbnails/default thumbnails png\\",\n \\"scheduled date\\" \\"2022 08 17t15 22 19z\\",\n \\"state\\" \\"vod\\",\n \\"type\\" \\"broadcast\\",\n \\"description\\" \\"\\",\n \\"event id\\" \\"742f12d7 b875 463c2 a034refeafe7c\\",\n \\"live date\\" \\"2022 08 17t15 24 25z\\",\n \\"duration\\" 71 351,\n \\"user\\" {\n \\" id\\" \\"a5awef4 6824 43ed a33e 43erff776\\",\n \\"followers\\" 0,\n \\"display name\\" \\"bleacherbob\\",\n \\"profile pic\\" \\"https //d1h34rji cloudfront net/apps/09f455c/images/a533e76 8acfd38bf4 profile png\\"\n },\n \\"last updated\\" \\"2022 08 17t16 02 24z\\",\n \\"video url\\" \\"https //d1h34rji cloudfront net/recorded streams/chr03/85a2e6873/video m3u8\\",\n \\"video mp4 url\\" \\"https //example com/file mp4\\",\n \\"video dash url\\" \\"https //example com/manifest mpd\\",\n \\"video orientation\\" \\"portrait\\",\n \\"tags\\" \[\n {\n \\"uuid\\" \\"48681e1e fda3 438e 990c 8f925964f410\\",\n \\"type\\" \\"general\\",\n \\"displayname\\" \\"11\\"\n },\n {\n \\"uuid\\" \\"864e2094 9865 4f5b 8891 391fe9cfa23f\\",\n \\"type\\" \\"general\\",\n \\"displayname\\" \\"3 rsadf adsf\\"\n }\n ],\n }\n ]\n}", "language" "200", "customlabel" "" }, { "id" "hm1euishl9qqbamuy6y h", "code" "{\n \\"message\\" \\"ain't no cake like that \\"\n }", "language" "404", "customlabel" "" } ], "selectedlanguageid" "pndcwvz5krixkij082pv1" }, "examples" { "languages" \[ { "id" "gdfwbv2tfjwrzp h5x5lv", "code" "curl location request get 'https //public api hotmic io/streams?limit=integer\&state=string\&userid=string\&ids=string\&orderby=string\&desc=boolean\&cursor=string\&skip=integer\&pagination=string' \\\\\n header 'accept application/json' \\\\\n header 'x api key string'", "language" "curl", "customlabel" "" }, { "id" "4vnmtdnhhxgfhqu3rfcqx", "code" "var request = require('request');\nvar options = {\n 'method' 'get',\n 'url' 'https //public api hotmic io/streams?limit=integer\&state=string\&userid=string\&ids=string\&orderby=string\&desc=boolean\&cursor=string\&skip=integer\&pagination=string',\n 'headers' {\n 'accept' 'application/json',\n 'x api key' 'string'\n }\n};\nrequest(options, function (error, response) {\n if (error) throw new error(error);\n console log(response body);\n});\n", "language" "nodejs", "customlabel" "" }, { "id" "jix9k 5qm kfmngfauzd", "code" "var myheaders = new headers();\nmyheaders append(\\"accept\\", \\"application/json\\");\nmyheaders append(\\"x api key\\", \\"string\\");\n\nvar requestoptions = {\n method 'get',\n headers myheaders,\n redirect 'follow'\n};\n\nfetch(\\"https //public api hotmic io/streams?limit=integer\&state=string\&userid=string\&ids=string\&orderby=string\&desc=boolean\&cursor=string\&skip=integer\&pagination=string\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "language" "javascript", "customlabel" "" }, { "id" " 9m8buhtjyjhfjj8xwbjv", "code" "import requests\n\nurl = \\"https //public api hotmic io/streams?limit=integer\&state=string\&userid=string\&ids=string\&orderby=string\&desc=boolean\&cursor=string\&skip=integer\&pagination=string\\"\n\npayload={}\nheaders = {\n 'accept' 'application/json',\n 'x api key' 'string'\n}\n\nresponse = requests request(\\"get\\", url, headers=headers, data=payload)\n\nprint(response text)\n", "language" "python", "customlabel" "" }, { "id" "q5jbwrsa1xfbmwfcsnzrv", "code" "require \\"uri\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //public api hotmic io/streams?limit=integer\&state=string\&userid=string\&ids=string\&orderby=string\&desc=boolean\&cursor=string\&skip=integer\&pagination=string\\")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http get new(url)\nrequest\[\\"accept\\"] = \\"application/json\\"\nrequest\[\\"x api key\\"] = \\"string\\"\n\nresponse = https request(request)\nputs response read body\n", "language" "ruby", "customlabel" "" } ], "selectedlanguageid" "gdfwbv2tfjwrzp h5x5lv" }, "description" "get one or more streams ", "currentnewparameter" { "label" "query parameter", "value" "queryparameters" } } example requests get all streams (default limit) https //public api hotmic io/streams get set of 100 streams https //public api hotmic io/streams?limit=1000 get next set of 1000 streams (provided by “$ links next” in response https //public api hotmic io/streams?cursor=a3113c5b 26f5 4704 aa43 288446d250b6\&limit=1000 get specific streams by stream id https //public api hotmic io/streams?ids=e35a851b e161 46b7 a921 f6899ccb9cc0 0e246a7b 1a14 4028 aac6 a2f0433bd8c7 get all streams for specific user id (default limit) https //public api hotmic io/streams?userid=e35a851b e161 46b7 a921 f6899ccb9cc0 get all streams updated since last check https //public api hotmic io/streams?orderby=last updated\&cursor=2022 10 13t17 00 08z response returns the stream object if the update succeeded returns an error if there the update fails id string the id of the streams user id string the user id of the host title string the title of the stream thumbnail string the url to the thumbnail image scheduled date string the datetime a stream is scheduled state string can be "scheduled" "live" "ended" or "vod" duration integer length of vod in seconds tags array an array of objects video url string url for the live hls stream when live and vod hls stream when the state is vod this url for the live stream is available when the stream is created, but will not be a valid working hls until the creator broadcasts hls the url will not change until it is vod, at which time the video url will return the vod url video mp4 url string the url of a mp4 download link, available after the stream has in the vod state video dash url string url for the live dash stream when live and vod dash stream when the state is vod this url for the live stream is available when the stream is created, but will not be a valid working dash until the creator broadcasts dash the url will not change until it is vod, at which time the video dash url will return the vod url video orientation string null or "landscape" for horizontal video "portrait" for vertical video description string a description of the stream event id the id of the event a stream is associated to only useful if you are creating mutiple streams per event type string the type of stream live date string the datetime the stream was set to "live" last updated string the datetime the stream was edited invite link string the link stored by hotmic to the stream user object with id string the id of the user followers string the number of followers of the user if using hotmic following tools display name string the name of the user to display to others profile pic string the url to the profile pic of the user tags array 1 ore more tags associated with the user update a stream { "tab" "examples", "url" "https //public api hotmic io/streams/\ id", "name" "update stream endpoint", "method" "put", "request" { "pathparameters" \[ { "kind" "required", "name" "id", "type" "string", "children" \[], "description" "id of the stream to modify" } ], "queryparameters" \[], "headerparameters" \[ { "kind" "required", "name" "x api key", "type" "string", "children" \[], "description" "the api key provided to you by hotmic " } ], "bodydataparameters" \[ { "kind" "optional", "name" "title", "type" "string", "description" "the title of the stream" }, { "kind" "optional", "name" "user id", "type" "string", "children" \[], "description" "update the user id of the owner of the stream in hotmic note, this must be a valid hotmic user id " }, { "kind" "optional", "name" "thumbnail", "type" "string", "children" \[], "description" "update the url to the stream thumbnail of used in hotmic note the url must be publically accessible if updating in this way " }, { "kind" "optional", "name" "scheduled date", "type" "string", "children" \[], "description" "update the scheduled date of the stream dates are in iso 8601 format, for example \\"2019 09 08t00 00 00 000+00 00\\" " }, { "kind" "optional", "name" "description", "type" "string", "children" \[], "description" "update the description of the event " }, { "kind" "optional", "name" "invite link", "type" "string", "children" \[], "description" "the invite link is the link to the stream if you generate a link for the event, use this to update the link for the hosts to see this doesn't change the link to the event itself, rather the link for the hosts to view " } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "wonwbfdtqfgy jyuv sq", "code" "{\n \\" id\\" \\"82057643 2a46 45b9 96f5 3e3447a18ece\\",\n \\"user id\\" \\"a533e987 6824 43ed a33e bbc15ab1b776\\",\n \\"title\\" \\"streams are great\\",\n \\"thumbnail\\" \\"https //d1h8hiv1w8cbe cloudfront net/thumbnails/thu png\\",\n \\"scheduled date\\" \\"2022 08 16t22 27 08z\\",\n \\"state\\" \\"vod\\",\n \\"type\\" \\"broadcast\\",\n \\"description\\" \\"\\",\n \\"hls url\\" \\"https //d1q6387gevjuox cloudfront net/chris 9073/a/chris 9073 m3u8\\",\n \\"event id\\" \\"bbubiy6f7d 8d20 4881 a675 0433e0ba5883\\",\n \\"live date\\" \\"2022 08 16t22 28 36z\\",\n \\"duration\\" 31 295,\n \\"vod url\\" \\"https //d9djhjg315vs cloudfront net/recorded streams/chris 9073/82052303 2a46 45b9 96f5 3e3447a18ece/chris 9073 m3u8\\",\n \\"last updated\\" \\"2022 08 16t22 29 17z\\",\n \\"invite link\\" \\"https //www mylink com\\"\n}", "language" "200", "customlabel" "" }, { "id" "tfc7d uujjb8vtkzce as", "code" "{\n \\"message\\" \\"ain't no cake like that \\"\n }", "language" "404", "customlabel" "" } ], "selectedlanguageid" "wonwbfdtqfgy jyuv sq" }, "examples" { "languages" \[ { "id" "7w03q2kdzn2phh5qecb69", "code" "curl location request put 'https //public api hotmic io/streams/\ id' \\\\\n header 'accept application/json' \\\\\n header 'x api key string' \\\\\n data raw '{\\"title\\" \\"string\\",\\"user id\\" \\"string\\",\\"thumbnail\\" \\"string\\",\\"scheduled date\\" \\"string\\",\\"description\\" \\"string\\",\\"invite link\\" \\"string\\"}'", "language" "curl", "customlabel" "" }, { "id" "rtf6s3bbkjehx1t 7lwsq", "code" "var request = require('request');\nvar options = {\n 'method' 'put',\n 'url' 'https //public api hotmic io/streams/\ id',\n 'headers' {\n 'accept' 'application/json',\n 'x api key' 'string'\n },\n body '{\\"title\\" \\"string\\",\\"user id\\" \\"string\\",\\"thumbnail\\" \\"string\\",\\"scheduled date\\" \\"string\\",\\"description\\" \\"string\\",\\"invite link\\" \\"string\\"}'\n\n};\nrequest(options, function (error, response) {\n if (error) throw new error(error);\n console log(response body);\n});\n", "language" "nodejs", "customlabel" "" }, { "id" "ahrvojxthzxgekvuc3gjq", "code" "var myheaders = new headers();\nmyheaders append(\\"accept\\", \\"application/json\\");\nmyheaders append(\\"x api key\\", \\"string\\");\n\nvar raw = \\"{\\\\\\"title\\\\\\" \\\\\\"string\\\\\\",\\\\\\"user id\\\\\\" \\\\\\"string\\\\\\",\\\\\\"thumbnail\\\\\\" \\\\\\"string\\\\\\",\\\\\\"scheduled date\\\\\\" \\\\\\"string\\\\\\",\\\\\\"description\\\\\\" \\\\\\"string\\\\\\",\\\\\\"invite link\\\\\\" \\\\\\"string\\\\\\"}\\";\n\nvar requestoptions = {\n method 'put',\n headers myheaders,\n body raw,\n redirect 'follow'\n};\n\nfetch(\\"https //public api hotmic io/streams/\ id\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "language" "javascript", "customlabel" "" }, { "id" "hhtewoq0ya7iryvovewrw", "code" "import requests\n\nurl = \\"https //public api hotmic io/streams/\ id\\"\n\npayload = \\"{\\\\\\"title\\\\\\" \\\\\\"string\\\\\\",\\\\\\"user id\\\\\\" \\\\\\"string\\\\\\",\\\\\\"thumbnail\\\\\\" \\\\\\"string\\\\\\",\\\\\\"scheduled date\\\\\\" \\\\\\"string\\\\\\",\\\\\\"description\\\\\\" \\\\\\"string\\\\\\",\\\\\\"invite link\\\\\\" \\\\\\"string\\\\\\"}\\"\nheaders = {\n 'accept' 'application/json',\n 'x api key' 'string'\n}\n\nresponse = requests request(\\"put\\", url, headers=headers, data=payload)\n\nprint(response text)\n", "language" "python", "customlabel" "" }, { "id" "o5uwpudi28ge7h1no825d", "code" "require \\"uri\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //public api hotmic io/streams/\ id\\")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http put new(url)\nrequest\[\\"accept\\"] = \\"application/json\\"\nrequest\[\\"x api key\\"] = \\"string\\"\nrequest body = \\"{\\\\\\"title\\\\\\" \\\\\\"string\\\\\\",\\\\\\"user id\\\\\\" \\\\\\"string\\\\\\",\\\\\\"thumbnail\\\\\\" \\\\\\"string\\\\\\",\\\\\\"scheduled date\\\\\\" \\\\\\"string\\\\\\",\\\\\\"description\\\\\\" \\\\\\"string\\\\\\",\\\\\\"invite link\\\\\\" \\\\\\"string\\\\\\"}\\"\n\nresponse = https request(request)\nputs response read body\n", "language" "ruby", "customlabel" "" } ], "selectedlanguageid" "7w03q2kdzn2phh5qecb69" }, "description" "update stream information, such as title or invite link ", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } returns the stream object if the update succeeded returns an error if there the update fails update a user { "tab" "examples", "url" "https //public api hotmic io/users/\ id", "name" "update user endpoint", "method" "put", "request" { "pathparameters" \[ { "kind" "required", "name" "id", "type" "string", "children" \[], "description" "the id of the user to modify " } ], "queryparameters" \[], "headerparameters" \[ { "kind" "required", "name" "x api key", "type" "string", "children" \[], "description" "the api key provided to you by hotmic " } ], "bodydataparameters" \[ { "kind" "optional", "name" "name", "type" "string", "description" "the name of the user to modify" }, { "kind" "optional", "name" "email", "type" "string", "children" \[], "description" "the email of the user to modify" }, { "kind" "optional", "name" "default invite link", "type" "string", "children" \[], "description" "the default invite link of the user to modify" }, { "name" "tags", "kind" "optional", "type" "array", "description" "general tags are added, edited, and returned with the user object when it is returned in the api this allows you to add information for future use ", "children" \[] }, { "name" "authorized stream tags", "kind" "optional", "type" "array", "description" "\\"authorized stream tags\\" define the tags a user can add to a stream when adding a stream, a user can add tags to the stream from this list, and their selected tags will appear as stream tags ", "children" \[] } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "wmswgjykeylbp3g5qpcdv", "code" "{\n \\" id\\" \\"079giuheac d39a 4cc9 8997 d2kugi3da9\\",\n \\"name\\" \\"friendly host\\",\n \\"email\\" \\"host1\@hotmic io\\",\n \\"default invite link\\" \\"https //www yourapplink com/host\\"\n}", "language" "200", "customlabel" "" }, { "id" "slzvvzcfv7q9cdhgwcqf6", "code" "{\n \\"message\\" \\"ain't no cake like that \\"\n }", "language" "404", "customlabel" "" } ], "selectedlanguageid" "wmswgjykeylbp3g5qpcdv" }, "examples" { "languages" \[ { "id" "4s1w01jm5rg9prsxjeucg", "code" "curl location request put 'https //public api hotmic io/users/\ id' \\\\\n header 'accept application/json' \\\\\n header 'x api key string' \\\\\n data raw '{\\"name\\" \\"string\\",\\"email\\" \\"string\\",\\"default invite link\\" \\"string\\"}'", "language" "curl", "customlabel" "" }, { "id" "syleutp46ui57m3bcrgaj", "code" "var request = require('request');\nvar options = {\n 'method' 'put',\n 'url' 'https //public api hotmic io/users/\ id',\n 'headers' {\n 'accept' 'application/json',\n 'x api key' 'string'\n },\n body '{\\"name\\" \\"string\\",\\"email\\" \\"string\\",\\"default invite link\\" \\"string\\"}'\n\n};\nrequest(options, function (error, response) {\n if (error) throw new error(error);\n console log(response body);\n});\n", "language" "nodejs", "customlabel" "" }, { "id" "k703afophann4cpptw0ds", "code" "var myheaders = new headers();\nmyheaders append(\\"accept\\", \\"application/json\\");\nmyheaders append(\\"x api key\\", \\"string\\");\n\nvar raw = \\"{\\\\\\"name\\\\\\" \\\\\\"string\\\\\\",\\\\\\"email\\\\\\" \\\\\\"string\\\\\\",\\\\\\"default invite link\\\\\\" \\\\\\"string\\\\\\"}\\";\n\nvar requestoptions = {\n method 'put',\n headers myheaders,\n body raw,\n redirect 'follow'\n};\n\nfetch(\\"https //public api hotmic io/users/\ id\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "language" "javascript", "customlabel" "" }, { "id" "26wpamp25tfwsxreddzxg", "code" "import requests\n\nurl = \\"https //public api hotmic io/users/\ id\\"\n\npayload = \\"{\\\\\\"name\\\\\\" \\\\\\"string\\\\\\",\\\\\\"email\\\\\\" \\\\\\"string\\\\\\",\\\\\\"default invite link\\\\\\" \\\\\\"string\\\\\\"}\\"\nheaders = {\n 'accept' 'application/json',\n 'x api key' 'string'\n}\n\nresponse = requests request(\\"put\\", url, headers=headers, data=payload)\n\nprint(response text)\n", "language" "python", "customlabel" "" }, { "id" "mmneozcd4mch9bmtlytvn", "code" "require \\"uri\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //public api hotmic io/users/\ id\\")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http put new(url)\nrequest\[\\"accept\\"] = \\"application/json\\"\nrequest\[\\"x api key\\"] = \\"string\\"\nrequest body = \\"{\\\\\\"name\\\\\\" \\\\\\"string\\\\\\",\\\\\\"email\\\\\\" \\\\\\"string\\\\\\",\\\\\\"default invite link\\\\\\" \\\\\\"string\\\\\\"}\\"\n\nresponse = https request(request)\nputs response read body\n", "language" "ruby", "customlabel" "" } ], "selectedlanguageid" "4s1w01jm5rg9prsxjeucg" }, "description" "update user information, such as their name or the default invite link for their profile ", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } create user { "name" "create user endpoint", "method" "post", "url" "https //public api hotmic io/users/", "description" "creates a new user", "tab" "examples", "examples" { "selectedlanguageid" "xufcmiuqkalxktnx2lfsg", "languages" \[ { "id" "xufcmiuqkalxktnx2lfsg", "language" "javascript", "code" "var myheaders = new headers();\nmyheaders append(\\"accept\\", \\"application/json\\");\nmyheaders append(\\"content type\\", \\"application/json\\");\n\nvar raw = json stringify({\n \\"id\\" \\"string\\"\n});\n\nvar requestoptions = {\n method 'get',\n headers myheaders,\n body raw,\n redirect 'follow'\n};\n\nfetch(\\"https //api cakes com\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "customlabel" "" } ] }, "results" { "selectedlanguageid" "x9n2i09ivfaxwj6czt9lu", "languages" \[ { "id" "x9n2i09ivfaxwj6czt9lu", "language" "200", "customlabel" "", "code" "{\n \\"name\\" \\"cake's name\\",\n }" }, { "id" "dpz7 vzbsoy4dhe6ufr3i", "language" "404", "customlabel" "", "code" "{\n \\"message\\" \\"ain't no cake like that \\"\n }" } ] }, "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[ { "name" "x api key", "kind" "required", "type" "string", "description" "the api key provided to you by hotmic ", "children" \[] } ], "bodydataparameters" \[ { "name" "name", "kind" "required", "type" "string", "description" "the name of the user to modify" }, { "name" "email", "kind" "optional", "type" "string", "description" "the email of the user to modify", "children" \[] }, { "name" "default invite link", "kind" "optional", "type" "string", "description" "the default invite link of the user to modify", "children" \[] }, { "name" "display name", "kind" "optional", "type" "string", "description" "the display name, such as \\"superfan\\" ", "children" \[] }, { "name" "profile pic", "kind" "optional", "type" "string", "description" "a url to show for the user as a profile picture in chats and other areas ", "children" \[] }, { "name" "tags", "kind" "optional", "type" "array", "description" "general tags are added, edited, and returned with the user object when it is returned in the api this allows you to add information for future use ", "children" \[] }, { "name" "authorized stream tags", "kind" "optional", "type" "array", "description" "\\"authorized stream tags\\" define the tags a user can add to a stream when adding a stream, a user can add tags to the stream from this list, and their selected tags will appear as stream tags ", "children" \[] } ], "formdataparameters" \[] }, "currentnewparameter" { "label" "header parameter", "value" "headerparameters" } } get all users { "name" "retrieve users", "method" "get", "url" "https //public api hotmic io/users/", "description" "get a user by its id", "tab" "examples", "examples" { "languages" \[ { "id" "hynhyzkxctdgi 45mrr", "language" "javascript", "code" "var myheaders = new headers();\nmyheaders append(\\"accept\\", \\"application/json\\");\nmyheaders append(\\"content type\\", \\"application/json\\");\n\nvar raw = json stringify({\n \\"id\\" \\"string\\"\n});\n\nvar requestoptions = {\n method 'get',\n headers myheaders,\n body raw,\n redirect 'follow'\n};\n\nfetch(\\"https //api cakes com\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "customlabel" "" } ], "selectedlanguageid" "hynhyzkxctdgi 45mrr" }, "results" { "languages" \[ { "id" "vlbdu0u6krj31etzj3ftr", "language" "200", "customlabel" "", "code" "{\n \\"name\\" \\"cake's name\\",\n }" }, { "id" "dlm f8w9zq6mi1buogtml", "language" "404", "customlabel" "", "code" "{\n \\"message\\" \\"ain't no cake like that \\"\n }" } ], "selectedlanguageid" "vlbdu0u6krj31etzj3ftr" }, "request" { "pathparameters" \[], "queryparameters" \[ { "name" "limit", "kind" "optional", "type" "string", "description" "limits the number of results returned by the query defaults to 100 ", "children" \[] }, { "name" "ids", "kind" "optional", "type" "string", "description" "filter results to only include 1 or more streams by id if passing multiple ids, separate them by an underscore (example abc 123 def 456 would filter for 2 streams \\"abc 123\\" and \\"def 456\\") ", "children" \[] } ], "headerparameters" \[ { "name" "x api key", "kind" "required", "type" "string", "description" "the api key provided to you by hotmic ", "children" \[] } ], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "header parameter", "value" "headerparameters" } }