{"id":4141,"date":"2022-10-20T13:34:16","date_gmt":"2022-10-20T21:34:16","guid":{"rendered":"https:\/\/live-cometml.pantheonsite.io\/?p=4141"},"modified":"2025-04-24T17:17:02","modified_gmt":"2025-04-24T17:17:02","slug":"getting-started-with-comet-rest-api","status":"publish","type":"post","link":"https:\/\/www.comet.com\/site\/blog\/getting-started-with-comet-rest-api\/","title":{"rendered":"Getting Started with Comet REST API"},"content":{"rendered":"\n<div class=\"ir is it iu iv\">\n<p id=\"c108\" class=\"pw-post-body-paragraph lm ln iy bm b lo lp ki lq lr ls kl lt lu lv lw lx ly lz ma mb mc md me mf mg ir ga\" data-selectable-paragraph=\"\"><a class=\"au ll\" href=\"https:\/\/www.comet.com\/\" target=\"_blank\" rel=\"noopener ugc nofollow\">Comet<\/a>&nbsp;is an experimentation platform that allows you to track, monitor, and compare your Machine Learning experiments. You can write your code in your preferred language, and then compare the results of your experiments in the Comet interface. Originally, I had tested Comet using Python, but in some of my recent articles, I have described how to easily work with Comet using&nbsp;<a class=\"au ll\" href=\"https:\/\/heartbeat.comet.ml\/how-to-write-your-comet-experiments-in-r-dd44f07041aa\" target=\"_blank\" rel=\"noopener ugc nofollow\">R<\/a>&nbsp;and&nbsp;<a class=\"au ll\" href=\"https:\/\/heartbeat.comet.ml\/writing-a-classification-task-using-comet-and-java-d929d1ef9f4e\" target=\"_blank\" rel=\"noopener ugc nofollow\">Java<\/a>&nbsp;as well.<\/p>\n<p id=\"4911\" class=\"pw-post-body-paragraph lm ln iy bm b lo lp ki lq lr ls kl lt lu lv lw lx ly lz ma mb mc md me mf mg ir ga\" data-selectable-paragraph=\"\">In this article, I focus on REST API. Yes, because Comet also provides a very useful REST API service to interact with!<\/p>\n<p id=\"1712\" class=\"pw-post-body-paragraph lm ln iy bm b lo lp ki lq lr ls kl lt lu lv lw lx ly lz ma mb mc md me mf mg ir ga\" data-selectable-paragraph=\"\">The article is organized as follows:<\/p>\n<ul class=\"\">\n<li id=\"7bfe\" class=\"mh mi iy bm b lo lp lr ls lu mj ly mk mc ml mg mm mn mo mp ga\" data-selectable-paragraph=\"\">Overview of the Comet REST API<\/li>\n<li id=\"47a1\" class=\"mh mi iy bm b lo mq lr mr lu ms ly mt mc mu mg mm mn mo mp ga\" data-selectable-paragraph=\"\">A practical example<\/li>\n<\/ul>\n<h2 id=\"dab5\" class=\"mv mw iy bm mx my mz na nb nc nd ne nf kn ng ko nh kq ni kr nj kt nk ku nl nm ga\">1. Overview of the Comet REST API<\/h2>\n<p id=\"8715\" class=\"pw-post-body-paragraph lm ln iy bm b lo nn ki lq lr no kl lt lu np lw lx ly nq ma mb mc nr me mf mg ir ga\" data-selectable-paragraph=\"\">The Comet REST API service allows you to access workspaces, projects, experiments, models, and so on. To set up a connection with the Comet REST API service, you must first configure the&nbsp;<strong class=\"bm ns\">HTTP Authorization Header<\/strong>&nbsp;with your Comet API key. In the next section, you will see how to build a REST API call using the&nbsp;<code class=\"fp nt nu nv nw b\">curl<\/code>&nbsp;command.<\/p>\n<p id=\"1db5\" class=\"pw-post-body-paragraph lm ln iy bm b lo lp ki lq lr ls kl lt lu lv lw lx ly lz ma mb mc md me mf mg ir ga\" data-selectable-paragraph=\"\">Comet provides the following basic URL to access the REST API service:<\/p>\n<p id=\"adda\" class=\"pw-post-body-paragraph lm ln iy bm b lo lp ki lq lr ls kl lt lu lv lw lx ly lz ma mb mc md me mf mg ir ga\" data-selectable-paragraph=\"\"><code class=\"fp nt nu nv nw b\"><strong class=\"bm ns\">https:\/\/www.comet.com\/api\/rest\/v2\/<\/strong><\/code><\/p>\n<p id=\"8fe2\" class=\"pw-post-body-paragraph lm ln iy bm b lo lp ki lq lr ls kl lt lu lv lw lx ly lz ma mb mc md me mf mg ir ga\" data-selectable-paragraph=\"\">Depending on what you pass as the next parameter to the basic URL, you will get different Comet objects.<\/p>\n<p id=\"53fb\" class=\"pw-post-body-paragraph lm ln iy bm b lo lp ki lq lr ls kl lt lu lv lw lx ly lz ma mb mc md me mf mg ir ga\" data-selectable-paragraph=\"\">For example, to access all the workspaces, you can use the&nbsp;<code class=\"fp nt nu nv nw b\">workspaces<\/code>&nbsp;parameter, as follows:<\/p>\n<pre class=\"kx ky kz la gx nx bs ny\"><span id=\"ef1e\" class=\"ga nz mw iy nw b dm oa ob l oc\" data-selectable-paragraph=\"\">https:\/\/www.comet.com\/api\/rest\/v2\/workspaces<\/span><\/pre>\n<p id=\"52bc\" class=\"pw-post-body-paragraph lm ln iy bm b lo lp ki lq lr ls kl lt lu lv lw lx ly lz ma mb mc md me mf mg ir ga\" data-selectable-paragraph=\"\">You can also access all the projects within a workspace, using the&nbsp;<code class=\"fp nt nu nv nw b\">projects<\/code>&nbsp;parameter and the workspace name:<\/p>\n<pre class=\"kx ky kz la gx nx bs ny\"><span id=\"70fa\" class=\"ga nz mw iy nw b dm oa ob l oc\" data-selectable-paragraph=\"\">https:\/\/www.comet.com\/api\/rest\/v2\/projects?workspaceName=aWorkspace<\/span><\/pre>\n<p id=\"72b0\" class=\"pw-post-body-paragraph lm ln iy bm b lo lp ki lq lr ls kl lt lu lv lw lx ly lz ma mb mc md me mf mg ir ga\" data-selectable-paragraph=\"\">To access the experiments within a project, you can use the&nbsp;<code class=\"fp nt nu nv nw b\">experiment<\/code>&nbsp;parameter, as well as the&nbsp;<code class=\"fp nt nu nv nw b\">projectId<\/code>. If you do not want to access the archived experiments, you need to set up the keyword archived to false:<\/p>\n<pre class=\"kx ky kz la gx nx bs ny\"><span id=\"13e2\" class=\"ga nz mw iy nw b dm oa ob l oc\" data-selectable-paragraph=\"\">https:\/\/www.comet.com\/api\/rest\/v2\/experiments?projectId=aProjectId&amp;archived=false<\/span><\/pre>\n<p id=\"979f\" class=\"pw-post-body-paragraph lm ln iy bm b lo lp ki lq lr ls kl lt lu lv lw lx ly lz ma mb mc md me mf mg ir ga\" data-selectable-paragraph=\"\">You can even access models contained in the registry, using the registry-model parameter, as well as the workspace name:<\/p>\n<pre class=\"kx ky kz la gx nx bs ny\"><span id=\"4a73\" class=\"ga nz mw iy nw b dm oa ob l oc\" data-selectable-paragraph=\"\">https:\/\/www.comet.com\/api\/rest\/v2\/registry-model?workspaceName=aWorkspace<\/span><\/pre>\n<p id=\"1e34\" class=\"pw-post-body-paragraph lm ln iy bm b lo lp ki lq lr ls kl lt lu lv lw lx ly lz ma mb mc md me mf mg ir ga\" data-selectable-paragraph=\"\">To download a model from the registry, you can use the registry-model parameter, as well as the workspace name, the model name, and its version:<\/p>\n<pre class=\"kx ky kz la gx nx bs ny\"><span id=\"24a5\" class=\"ga nz mw iy nw b dm oa ob l oc\" data-selectable-paragraph=\"\">https:\/\/www.comet.com\/api\/rest\/v2\/registry-model\/item\/download?workspaceName=AWorkspace&amp;modelName=AModel&amp;version=AVersion<\/span><\/pre>\n<p id=\"105b\" class=\"pw-post-body-paragraph lm ln iy bm b lo lp ki lq lr ls kl lt lu lv lw lx ly lz ma mb mc md me mf mg ir ga\" data-selectable-paragraph=\"\">The Comet REST API service also permits you to access other objects. The list of all the calls provided by the Comet API is available&nbsp;<a class=\"au ll\" href=\"https:\/\/www.comet.com\/docs\/rest-api\/read-endpoints\/\" target=\"_blank\" rel=\"noopener ugc nofollow\">here<\/a>.<\/p>\n<\/div>\n\n\n\n<div class=\"ir is it iu iv\">\n<p id=\"df5b\" class=\"ol om iy bm on oo op oq or os ot mg cn\" data-selectable-paragraph=\"\"><strong>Different teams have different needs. Comet\u2019s got you covered.&nbsp;<a class=\"au ll\" href=\"https:\/\/www.comet.com\/site\/how-uber-manages-machine-learning-experiments-with-comet\/\" target=\"_blank\" rel=\"noopener ugc nofollow\">Learn how the team at Uber uses Comet\u2019s experiment management<\/a> to perform real-time model tuning.<\/strong><\/p>\n<\/div>\n\n\n\n<div class=\"ir is it iu iv\">\n<h2 id=\"5d7b\" class=\"mv mw iy bm mx my ou na nb nc ov ne nf kn ow ko nh kq ox kr nj kt oy ku nl nm ga\">2. A practical example<\/h2>\n<p id=\"d0e9\" class=\"pw-post-body-paragraph lm ln iy bm b lo nn ki lq lr no kl lt lu np lw lx ly nq ma mb mc nr me mf mg ir ga\" data-selectable-paragraph=\"\">Let\u2019s suppose that you\u2019ve built an experiment and tested different models. You\u2019ve chosen the best of these models and registered it in the Comet Registry. You can find a detailed description of how to perform these operations in my previous article, entitled&nbsp;<a class=\"au ll\" href=\"https:\/\/heartbeat.comet.ml\/how-to-use-the-comet-registry-to-track-your-machine-learning-models-4b18e7f61500\" target=\"_blank\" rel=\"noopener ugc nofollow\">How to Use the Comet Registry to Track Your Machine Learning Models<\/a>.<\/p>\n<p id=\"29f2\" class=\"pw-post-body-paragraph lm ln iy bm b lo lp ki lq lr ls kl lt lu lv lw lx ly lz ma mb mc md me mf mg ir ga\" data-selectable-paragraph=\"\"><strong class=\"bm ns\">Now you want to use the Comet Registry as the official repository for your model.<\/strong>&nbsp;This could be very useful when you move your application to production because you could use Comet to always store the best and last model. Thanks to the use of the Comet Registry, you will no longer have to remember which model is the best, because you will keep everything under control in the Comet Registry. For example, if a new experiment proves that one model is better than the current one, it will be sufficient to register it in Comet Registry, and simply replace the previous model with the new one. Through the REST API, then you can always download the most updated model.<\/p>\n<p id=\"221f\" class=\"pw-post-body-paragraph lm ln iy bm b lo lp ki lq lr ls kl lt lu lv lw lx ly lz ma mb mc md me mf mg ir ga\" data-selectable-paragraph=\"\">To download the model, you can adopt two different strategies.<\/p>\n<p id=\"0f70\" class=\"pw-post-body-paragraph lm ln iy bm b lo lp ki lq lr ls kl lt lu lv lw lx ly lz ma mb mc md me mf mg ir ga\" data-selectable-paragraph=\"\">In the first strategy, you can use the Comet interface. If you access the Comet Registry, you can either: 1) download the most recent version of the model through the \u2018<strong class=\"bm ns\">Get Model\u2019 button<\/strong>, or; 2) download any particular version by accessing the download icon, as shown in the following illustration:<\/p>\n<figure class=\"kx ky kz la gx lb gl gm paragraph-image\">\n<div class=\"lc ld do le ce lf\" tabindex=\"0\" role=\"button\">\n<figure><img loading=\"lazy\" decoding=\"async\" class=\"ce lg lh c aligncenter\" role=\"presentation\" src=\"https:\/\/miro.medium.com\/max\/1050\/1*IhjCLuTumlkmaZw88JWSbA.png\" alt=\"\" width=\"700\" height=\"242\"><\/figure><div class=\"gl gm oz\" style=\"text-align: center;\"><picture><source srcset=\"https:\/\/miro.medium.com\/max\/640\/1*IhjCLuTumlkmaZw88JWSbA.png 640w, https:\/\/miro.medium.com\/max\/720\/1*IhjCLuTumlkmaZw88JWSbA.png 720w, https:\/\/miro.medium.com\/max\/750\/1*IhjCLuTumlkmaZw88JWSbA.png 750w, https:\/\/miro.medium.com\/max\/786\/1*IhjCLuTumlkmaZw88JWSbA.png 786w, https:\/\/miro.medium.com\/max\/828\/1*IhjCLuTumlkmaZw88JWSbA.png 828w, https:\/\/miro.medium.com\/max\/1100\/1*IhjCLuTumlkmaZw88JWSbA.png 1100w, https:\/\/miro.medium.com\/max\/1400\/1*IhjCLuTumlkmaZw88JWSbA.png 1400w\" sizes=\"(min-resolution: 4dppx) and (max-width: 700px) 50vw, (-webkit-min-device-pixel-ratio: 4) and (max-width: 700px) 50vw, (min-resolution: 3dppx) and (max-width: 700px) 67vw, (-webkit-min-device-pixel-ratio: 3) and (max-width: 700px) 65vw, (min-resolution: 2.5dppx) and (max-width: 700px) 80vw, (-webkit-min-device-pixel-ratio: 2.5) and (max-width: 700px) 80vw, (min-resolution: 2dppx) and (max-width: 700px) 100vw, (-webkit-min-device-pixel-ratio: 2) and (max-width: 700px) 100vw, 700px\" data-testid=\"og\">Image by Author<\/picture><\/div>\n<\/div>\n<\/figure>\n<p id=\"1e27\" class=\"pw-post-body-paragraph lm ln iy bm b lo lp ki lq lr ls kl lt lu lv lw lx ly lz ma mb mc md me mf mg ir ga\" data-selectable-paragraph=\"\">This strategy, however, requires you to&nbsp;<em class=\"pa\">manually<\/em>&nbsp;download the model version you are interested in. Thus, every time you want to download the model, you need to access the Comet interface.<\/p>\n<p id=\"8fe5\" class=\"pw-post-body-paragraph lm ln iy bm b lo lp ki lq lr ls kl lt lu lv lw lx ly lz ma mb mc md me mf mg ir ga\" data-selectable-paragraph=\"\">In the second strategy, you can write code in your preferred language to download the model from the registry&nbsp;<em class=\"pa\">automatically<\/em>&nbsp;by using the Comet Python API.<\/p>\n<p id=\"03fa\" class=\"pw-post-body-paragraph lm ln iy bm b lo lp ki lq lr ls kl lt lu lv lw lx ly lz ma mb mc md me mf mg ir ga\" data-selectable-paragraph=\"\">Here I combine REST API and bash scripting to download the model.<\/p>\n<p id=\"3944\" class=\"pw-post-body-paragraph lm ln iy bm b lo lp ki lq lr ls kl lt lu lv lw lx ly lz ma mb mc md me mf mg ir ga\" data-selectable-paragraph=\"\">First, create a file named&nbsp;<code class=\"fp nt nu nv nw b\">get_model.sh<\/code>. Then, edit as follows:<\/p>\n<p id=\"c564\" class=\"pw-post-body-paragraph lm ln iy bm b lo lp ki lq lr ls kl lt lu lv lw lx ly lz ma mb mc md me mf mg ir ga\" data-selectable-paragraph=\"\">Define some variables containing your Comet API and your workspace:<\/p>\n<pre class=\"kx ky kz la gx nx bs ny\"><span id=\"1116\" class=\"ga nz mw iy nw b dm oa ob l oc\" data-selectable-paragraph=\"\">#!\/bin\/sh\n<\/span><span id=\"ffd9\" class=\"ga nz mw iy nw b dm pb pc pd pe pf ob l oc\" data-selectable-paragraph=\"\">COMET_API_KEY='YOUR_COMET_API_KEY'\nCOMET_WORKSPACE='YOUR_COMET_WORKSPACE'<\/span><\/pre>\n<p id=\"d9d0\" class=\"pw-post-body-paragraph lm ln iy bm b lo lp ki lq lr ls kl lt lu lv lw lx ly lz ma mb mc md me mf mg ir ga\" data-selectable-paragraph=\"\">Now define two additional variables containing the model name and the model version you want to download:<\/p>\n<pre class=\"kx ky kz la gx nx bs ny\"><span id=\"faef\" class=\"ga nz mw iy nw b dm oa ob l oc\" data-selectable-paragraph=\"\">MODEL_NAME='YOUR_MODEL_NAME'\nMODEL_VERSION='YOUR_MODEL_VERSION'<\/span><\/pre>\n<p id=\"4468\" class=\"pw-post-body-paragraph lm ln iy bm b lo lp ki lq lr ls kl lt lu lv lw lx ly lz ma mb mc md me mf mg ir ga\" data-selectable-paragraph=\"\">Finally, use the&nbsp;<code class=\"fp nt nu nv nw b\">curl<\/code>&nbsp;command to download the model:<\/p>\n<pre class=\"kx ky kz la gx nx bs ny\"><span id=\"c023\" class=\"ga nz mw iy nw b dm oa ob l oc\" data-selectable-paragraph=\"\">curl -o model.zip -s \"https:\/\/www.comet.com\/api\/rest\/v2\/registry-model\/item\/download \\ workspaceName=$COMET_WORKSPACE&amp;modelName=$MODEL_NAME&amp;version=$MODEL_VERSION\" -H \"Authorization: $COMET_API_KEY\"<\/span><\/pre>\n<p id=\"1e91\" class=\"pw-post-body-paragraph lm ln iy bm b lo lp ki lq lr ls kl lt lu lv lw lx ly lz ma mb mc md me mf mg ir ga\" data-selectable-paragraph=\"\">The downloaded model is stored in a file named&nbsp;<code class=\"fp nt nu nv nw b\">model.zip<\/code>. To restore this file to the original model, simply unzip it.<\/p>\n<p id=\"fa17\" class=\"pw-post-body-paragraph lm ln iy bm b lo lp ki lq lr ls kl lt lu lv lw lx ly lz ma mb mc md me mf mg ir ga\" data-selectable-paragraph=\"\">And that\u2019s all \u2014 quick and simple!<\/p>\n<h2 id=\"98e9\" class=\"mv mw iy bm mx my mz na nb nc nd ne nf kn ng ko nh kq ni kr nj kt nk ku nl nm ga\">Summary<\/h2>\n<p id=\"952f\" class=\"pw-post-body-paragraph lm ln iy bm b lo nn ki lq lr no kl lt lu np lw lx ly nq ma mb mc nr me mf mg ir ga\" data-selectable-paragraph=\"\">Congratulations! You have just learned the Comet REST API and how to use it to download a model from the Comet Model Registry.<\/p>\n<p id=\"58ae\" class=\"pw-post-body-paragraph lm ln iy bm b lo lp ki lq lr ls kl lt lu lv lw lx ly lz ma mb mc md me mf mg ir ga\" data-selectable-paragraph=\"\">You can use Comet REST API for different purposes, including the integration of Comet with a CI\/CD pipeline. You can find more information about it&nbsp;<a class=\"au ll\" href=\"https:\/\/www.comet.com\/docs\/v2\/guides\/model-management\/webhooks\/\" target=\"_blank\" rel=\"noopener ugc nofollow\">here<\/a>.<\/p>\n<p id=\"1182\" class=\"pw-post-body-paragraph lm ln iy bm b lo lp ki lq lr ls kl lt lu lv lw lx ly lz ma mb mc md me mf mg ir ga\" data-selectable-paragraph=\"\">Happy Coding! Happy&nbsp;<a class=\"au ll\" href=\"https:\/\/www.comet.com\/\" target=\"_blank\" rel=\"noopener ugc nofollow\">Comet<\/a>!<\/p>\n<\/div>\n","protected":false},"excerpt":{"rendered":"<p>Comet&nbsp;is an experimentation platform that allows you to track, monitor, and compare your Machine Learning experiments. You can write your code in your preferred language, and then compare the results of your experiments in the Comet interface. Originally, I had tested Comet using Python, but in some of my recent articles, I have described how [&hellip;]<\/p>\n","protected":false},"author":8,"featured_media":0,"comment_status":"closed","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"customer_name":"","customer_description":"","customer_industry":"","customer_technologies":"","customer_logo":"","footnotes":""},"categories":[6,9],"tags":[],"coauthors":[132],"class_list":["post-4141","post","type-post","status-publish","format-standard","hentry","category-machine-learning","category-product"],"yoast_head":"<!-- This site is optimized with the Yoast SEO Premium plugin v25.9 (Yoast SEO v25.9) - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>Getting Started with Comet REST API<\/title>\n<meta name=\"description\" content=\"Read an overview of how to get started with Comet REST API, including a practical example. Learn more.\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/www.comet.com\/site\/blog\/getting-started-with-comet-rest-api\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Getting Started with Comet REST API\" \/>\n<meta property=\"og:description\" content=\"Read an overview of how to get started with Comet REST API, including a practical example. Learn more.\" \/>\n<meta property=\"og:url\" content=\"https:\/\/www.comet.com\/site\/blog\/getting-started-with-comet-rest-api\/\" \/>\n<meta property=\"og:site_name\" content=\"Comet\" \/>\n<meta property=\"article:publisher\" content=\"https:\/\/www.facebook.com\/cometdotml\" \/>\n<meta property=\"article:published_time\" content=\"2022-10-20T21:34:16+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2025-04-24T17:17:02+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/miro.medium.com\/max\/1050\/1*IhjCLuTumlkmaZw88JWSbA.png\" \/>\n<meta name=\"author\" content=\"Angelica Lo Duca\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:creator\" content=\"@Cometml\" \/>\n<meta name=\"twitter:site\" content=\"@Cometml\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"Angelica Lo Duca\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"4 minutes\" \/>\n<!-- \/ Yoast SEO Premium plugin. -->","yoast_head_json":{"title":"Getting Started with Comet REST API","description":"Read an overview of how to get started with Comet REST API, including a practical example. Learn more.","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/www.comet.com\/site\/blog\/getting-started-with-comet-rest-api\/","og_locale":"en_US","og_type":"article","og_title":"Getting Started with Comet REST API","og_description":"Read an overview of how to get started with Comet REST API, including a practical example. Learn more.","og_url":"https:\/\/www.comet.com\/site\/blog\/getting-started-with-comet-rest-api\/","og_site_name":"Comet","article_publisher":"https:\/\/www.facebook.com\/cometdotml","article_published_time":"2022-10-20T21:34:16+00:00","article_modified_time":"2025-04-24T17:17:02+00:00","og_image":[{"url":"https:\/\/miro.medium.com\/max\/1050\/1*IhjCLuTumlkmaZw88JWSbA.png","type":"","width":"","height":""}],"author":"Angelica Lo Duca","twitter_card":"summary_large_image","twitter_creator":"@Cometml","twitter_site":"@Cometml","twitter_misc":{"Written by":"Angelica Lo Duca","Est. reading time":"4 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/www.comet.com\/site\/blog\/getting-started-with-comet-rest-api\/#article","isPartOf":{"@id":"https:\/\/www.comet.com\/site\/blog\/getting-started-with-comet-rest-api\/"},"author":{"name":"Team Comet Digital","@id":"https:\/\/www.comet.com\/site\/#\/schema\/person\/6266601170c60a7a82b3e0043fbe8ddf"},"headline":"Getting Started with Comet REST API","datePublished":"2022-10-20T21:34:16+00:00","dateModified":"2025-04-24T17:17:02+00:00","mainEntityOfPage":{"@id":"https:\/\/www.comet.com\/site\/blog\/getting-started-with-comet-rest-api\/"},"wordCount":833,"publisher":{"@id":"https:\/\/www.comet.com\/site\/#organization"},"image":{"@id":"https:\/\/www.comet.com\/site\/blog\/getting-started-with-comet-rest-api\/#primaryimage"},"thumbnailUrl":"https:\/\/miro.medium.com\/max\/1050\/1*IhjCLuTumlkmaZw88JWSbA.png","articleSection":["Machine Learning","Product"],"inLanguage":"en-US"},{"@type":"WebPage","@id":"https:\/\/www.comet.com\/site\/blog\/getting-started-with-comet-rest-api\/","url":"https:\/\/www.comet.com\/site\/blog\/getting-started-with-comet-rest-api\/","name":"Getting Started with Comet REST API","isPartOf":{"@id":"https:\/\/www.comet.com\/site\/#website"},"primaryImageOfPage":{"@id":"https:\/\/www.comet.com\/site\/blog\/getting-started-with-comet-rest-api\/#primaryimage"},"image":{"@id":"https:\/\/www.comet.com\/site\/blog\/getting-started-with-comet-rest-api\/#primaryimage"},"thumbnailUrl":"https:\/\/miro.medium.com\/max\/1050\/1*IhjCLuTumlkmaZw88JWSbA.png","datePublished":"2022-10-20T21:34:16+00:00","dateModified":"2025-04-24T17:17:02+00:00","description":"Read an overview of how to get started with Comet REST API, including a practical example. Learn more.","breadcrumb":{"@id":"https:\/\/www.comet.com\/site\/blog\/getting-started-with-comet-rest-api\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/www.comet.com\/site\/blog\/getting-started-with-comet-rest-api\/"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/www.comet.com\/site\/blog\/getting-started-with-comet-rest-api\/#primaryimage","url":"https:\/\/miro.medium.com\/max\/1050\/1*IhjCLuTumlkmaZw88JWSbA.png","contentUrl":"https:\/\/miro.medium.com\/max\/1050\/1*IhjCLuTumlkmaZw88JWSbA.png"},{"@type":"BreadcrumbList","@id":"https:\/\/www.comet.com\/site\/blog\/getting-started-with-comet-rest-api\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/www.comet.com\/site\/"},{"@type":"ListItem","position":2,"name":"Getting Started with Comet REST API"}]},{"@type":"WebSite","@id":"https:\/\/www.comet.com\/site\/#website","url":"https:\/\/www.comet.com\/site\/","name":"Comet","description":"Build Better Models Faster","publisher":{"@id":"https:\/\/www.comet.com\/site\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/www.comet.com\/site\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/www.comet.com\/site\/#organization","name":"Comet ML, Inc.","alternateName":"Comet","url":"https:\/\/www.comet.com\/site\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/www.comet.com\/site\/#\/schema\/logo\/image\/","url":"https:\/\/www.comet.com\/site\/wp-content\/uploads\/2025\/01\/logo_comet_square.png","contentUrl":"https:\/\/www.comet.com\/site\/wp-content\/uploads\/2025\/01\/logo_comet_square.png","width":310,"height":310,"caption":"Comet ML, Inc."},"image":{"@id":"https:\/\/www.comet.com\/site\/#\/schema\/logo\/image\/"},"sameAs":["https:\/\/www.facebook.com\/cometdotml","https:\/\/x.com\/Cometml","https:\/\/www.youtube.com\/channel\/UCmN63HKvfXSCS-UwVwmK8Hw"]},{"@type":"Person","@id":"https:\/\/www.comet.com\/site\/#\/schema\/person\/6266601170c60a7a82b3e0043fbe8ddf","name":"Team Comet Digital","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/www.comet.com\/site\/#\/schema\/person\/image\/4f0c0a8cc7c0e87c636ff6a420a6647c","url":"https:\/\/www.comet.com\/site\/wp-content\/uploads\/2023\/08\/Screen-Shot-2023-08-12-at-8.58.50-AM-96x96.png","contentUrl":"https:\/\/www.comet.com\/site\/wp-content\/uploads\/2023\/08\/Screen-Shot-2023-08-12-at-8.58.50-AM-96x96.png","caption":"Team Comet Digital"},"sameAs":["https:\/\/www.comet.ml\/"],"url":"https:\/\/www.comet.com\/site\/blog\/author\/teamcometdigital\/"}]}},"_links":{"self":[{"href":"https:\/\/www.comet.com\/site\/wp-json\/wp\/v2\/posts\/4141","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.comet.com\/site\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.comet.com\/site\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.comet.com\/site\/wp-json\/wp\/v2\/users\/8"}],"replies":[{"embeddable":true,"href":"https:\/\/www.comet.com\/site\/wp-json\/wp\/v2\/comments?post=4141"}],"version-history":[{"count":1,"href":"https:\/\/www.comet.com\/site\/wp-json\/wp\/v2\/posts\/4141\/revisions"}],"predecessor-version":[{"id":15670,"href":"https:\/\/www.comet.com\/site\/wp-json\/wp\/v2\/posts\/4141\/revisions\/15670"}],"wp:attachment":[{"href":"https:\/\/www.comet.com\/site\/wp-json\/wp\/v2\/media?parent=4141"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.comet.com\/site\/wp-json\/wp\/v2\/categories?post=4141"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.comet.com\/site\/wp-json\/wp\/v2\/tags?post=4141"},{"taxonomy":"author","embeddable":true,"href":"https:\/\/www.comet.com\/site\/wp-json\/wp\/v2\/coauthors?post=4141"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}