2024-10-09 19:40:26 +00:00
2021-12-15 03:54:43 -08:00
<!DOCTYPE html>
2024-09-10 20:35:13 +00:00
< html class = "writer-html5" lang = "en" data-content_root = "../" >
2021-12-15 03:54:43 -08:00
< head >
2024-09-10 20:35:13 +00:00
< meta charset = "utf-8" / > < meta name = "viewport" content = "width=device-width, initial-scale=1" / >
2023-05-08 20:06:56 +00:00
< meta property = "og:title" content = "kittycad.api" / >
< meta property = "og:type" content = "website" / >
< meta property = "og:url" content = "_autosummary/kittycad.api.html" / >
< meta property = "og:site_name" content = "kittycad" / >
< meta property = "og:description" content = "Contains methods for accessing the API Modules" / >
< meta name = "description" content = "Contains methods for accessing the API Modules" / >
2021-12-15 03:54:43 -08:00
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" / >
2024-12-11 22:08:10 +00:00
< title > kittycad.api — kittycad v0.7.4 documentation< / title >
2024-09-10 20:35:13 +00:00
< link rel = "stylesheet" type = "text/css" href = "../_static/pygments.css?v=d10597a4" / >
2024-10-11 00:43:49 +00:00
< link rel = "stylesheet" type = "text/css" href = "../_static/css/theme.css?v=e59714d7" / >
2024-09-10 20:35:13 +00:00
< link rel = "stylesheet" type = "text/css" href = "../_static/graphviz.css?v=fd3f3429" / >
< link rel = "stylesheet" type = "text/css" href = "../_static/copybutton.css?v=76b2166b" / >
< link rel = "stylesheet" type = "text/css" href = "../_static/autoclasstoc.css?v=08871587" / >
2024-10-09 19:40:26 +00:00
< script src = "../_static/jquery.js?v=5d32c60e" > < / script >
< script src = "../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c" > < / script >
2024-12-11 22:08:10 +00:00
< script src = "../_static/documentation_options.js?v=f9b80c38" > < / script >
2024-10-09 19:40:26 +00:00
< script src = "../_static/doctools.js?v=9a2dae69" > < / script >
< script src = "../_static/sphinx_highlight.js?v=dc90522c" > < / script >
< script src = "../_static/clipboard.min.js?v=a7894cd8" > < / script >
< script src = "../_static/copybutton.js?v=f281be69" > < / script >
2021-12-15 03:54:43 -08:00
< script src = "../_static/js/theme.js" > < / script >
< link rel = "index" title = "Index" href = "../genindex.html" / >
2022-02-27 22:38:36 -08:00
< link rel = "search" title = "Search" href = "../search.html" / >
2024-08-10 04:16:23 +00:00
< link rel = "next" title = "kittycad.api.api_calls" href = "kittycad.api.api_calls.html" / >
2022-02-27 22:38:36 -08:00
< link rel = "prev" title = "Welcome to kittycad’ href = "../index.html" / >
2021-12-15 03:54:43 -08:00
< / head >
< body class = "wy-body-for-nav" >
< div class = "wy-grid-for-nav" >
< nav data-toggle = "wy-nav-shift" class = "wy-nav-side" >
< div class = "wy-side-scroll" >
< div class = "wy-side-nav-search" >
2023-05-04 00:58:06 -07:00
< a href = "../index.html" class = "icon icon-home" >
kittycad
2021-12-15 03:54:43 -08:00
< / a >
< div role = "search" >
< form id = "rtd-search-form" class = "wy-form" action = "../search.html" method = "get" >
2023-05-04 00:58:06 -07:00
< input type = "text" name = "q" placeholder = "Search docs" aria-label = "Search docs" / >
2021-12-15 03:54:43 -08:00
< input type = "hidden" name = "check_keywords" value = "yes" / >
< input type = "hidden" name = "area" value = "default" / >
< / form >
< / div >
< / div > < div class = "wy-menu wy-menu-vertical" data-spy = "affix" role = "navigation" aria-label = "Navigation menu" >
2022-02-27 22:38:36 -08:00
< ul class = "current" >
2022-02-27 22:41:34 -08:00
< li class = "toctree-l1 current" > < a class = "current reference internal" href = "#" > kittycad.api< / a > < ul >
2023-05-04 00:58:06 -07:00
< li class = "toctree-l2" > < a class = "reference internal" href = "kittycad.api.api_calls.html" > kittycad.api.api_calls< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "kittycad.api.api_tokens.html" > kittycad.api.api_tokens< / a > < / li >
2022-07-21 03:31:10 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "kittycad.api.apps.html" > kittycad.api.apps< / a > < / li >
2022-06-12 01:37:38 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "kittycad.api.beta.html" > kittycad.api.beta< / a > < / li >
2022-07-26 00:15:59 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "kittycad.api.constant.html" > kittycad.api.constant< / a > < / li >
2023-05-04 00:58:06 -07:00
< li class = "toctree-l2" > < a class = "reference internal" href = "kittycad.api.executor.html" > kittycad.api.executor< / a > < / li >
2022-02-27 22:41:34 -08:00
< li class = "toctree-l2" > < a class = "reference internal" href = "kittycad.api.file.html" > kittycad.api.file< / a > < / li >
2022-06-12 01:37:38 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "kittycad.api.hidden.html" > kittycad.api.hidden< / a > < / li >
2022-02-27 22:41:34 -08:00
< li class = "toctree-l2" > < a class = "reference internal" href = "kittycad.api.meta.html" > kittycad.api.meta< / a > < / li >
2024-08-10 04:16:23 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "kittycad.api.ml.html" > kittycad.api.ml< / a > < / li >
2023-05-23 21:30:43 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "kittycad.api.modeling.html" > kittycad.api.modeling< / a > < / li >
2022-07-05 22:47:27 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "kittycad.api.oauth2.html" > kittycad.api.oauth2< / a > < / li >
2024-07-28 22:52:47 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "kittycad.api.orgs.html" > kittycad.api.orgs< / a > < / li >
2022-06-12 01:37:38 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "kittycad.api.payments.html" > kittycad.api.payments< / a > < / li >
2024-07-28 22:52:47 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "kittycad.api.service_accounts.html" > kittycad.api.service_accounts< / a > < / li >
2024-10-05 18:33:07 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "kittycad.api.shortlinks.html" > kittycad.api.shortlinks< / a > < / li >
2024-07-28 22:52:47 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "kittycad.api.store.html" > kittycad.api.store< / a > < / li >
2022-06-16 19:06:05 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "kittycad.api.unit.html" > kittycad.api.unit< / a > < / li >
2022-04-07 03:38:23 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "kittycad.api.users.html" > kittycad.api.users< / a > < / li >
2022-02-27 22:41:34 -08:00
< / ul >
< / li >
2022-02-27 22:38:36 -08:00
< li class = "toctree-l1" > < a class = "reference internal" href = "kittycad.client.html" > kittycad.client< / a > < / li >
2022-06-16 19:06:05 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "kittycad.models.html" > kittycad.models< / a > < / li >
2022-02-27 22:38:36 -08:00
< li class = "toctree-l1" > < a class = "reference internal" href = "kittycad.types.html" > kittycad.types< / a > < / li >
2021-12-15 03:54:43 -08:00
< / ul >
< / div >
< / div >
< / nav >
< section data-toggle = "wy-nav-shift" class = "wy-nav-content-wrap" > < nav class = "wy-nav-top" aria-label = "Mobile navigation menu" >
< i data-toggle = "wy-nav-top" class = "fa fa-bars" > < / i >
< a href = "../index.html" > kittycad< / a >
< / nav >
< div class = "wy-nav-content" >
< div class = "rst-content" >
< div role = "navigation" aria-label = "Page navigation" >
< ul class = "wy-breadcrumbs" >
2023-05-04 00:58:06 -07:00
< li > < a href = "../index.html" class = "icon icon-home" aria-label = "Home" > < / a > < / li >
< li class = "breadcrumb-item active" > kittycad.api< / li >
2021-12-15 03:54:43 -08:00
< li class = "wy-breadcrumbs-aside" >
< / li >
< / ul >
< hr / >
< / div >
< div role = "main" class = "document" itemscope = "itemscope" itemtype = "http://schema.org/Article" >
< div itemprop = "articleBody" >
2022-02-27 22:38:36 -08:00
< section id = "module-kittycad.api" >
2024-07-28 22:52:47 +00:00
< span id = "kittycad-api" > < / span > < h1 > kittycad.api< a class = "headerlink" href = "#module-kittycad.api" title = "Link to this heading" > < / a > < / h1 >
2022-02-27 22:38:36 -08:00
< p > Contains methods for accessing the API< / p >
2022-02-27 22:41:34 -08:00
< p class = "rubric" > Modules< / p >
2023-05-04 00:58:06 -07:00
< table class = "autosummary longtable docutils align-default" >
2022-02-27 22:41:34 -08:00
< tbody >
2024-09-10 20:35:13 +00:00
< tr class = "row-odd" > < td > < p > < a class = "reference internal" href = "kittycad.api.api_calls.html#module-kittycad.api.api_calls" title = "kittycad.api.api_calls" > < code class = "xref py py-obj docutils literal notranslate" > < span class = "pre" > api_calls< / span > < / code > < / a > < / p > < / td >
2023-05-04 00:58:06 -07:00
< td > < p > Contains methods for accessing the api_calls API paths: API calls that have been performed by users can be queried by the API.< / p > < / td >
2022-04-07 03:38:23 +00:00
< / tr >
2024-09-10 20:35:13 +00:00
< tr class = "row-even" > < td > < p > < a class = "reference internal" href = "kittycad.api.api_tokens.html#module-kittycad.api.api_tokens" title = "kittycad.api.api_tokens" > < code class = "xref py py-obj docutils literal notranslate" > < span class = "pre" > api_tokens< / span > < / code > < / a > < / p > < / td >
2023-05-04 00:58:06 -07:00
< td > < p > Contains methods for accessing the api_tokens API paths: API tokens allow users to call the API outside of their session token that is used as a cookie in the user interface.< / p > < / td >
2022-04-07 03:38:23 +00:00
< / tr >
2024-09-10 20:35:13 +00:00
< tr class = "row-odd" > < td > < p > < a class = "reference internal" href = "kittycad.api.apps.html#module-kittycad.api.apps" title = "kittycad.api.apps" > < code class = "xref py py-obj docutils literal notranslate" > < span class = "pre" > apps< / span > < / code > < / a > < / p > < / td >
2022-07-21 03:31:10 +00:00
< td > < p > Contains methods for accessing the apps API paths: Endpoints for third party app grant flows.< / p > < / td >
< / tr >
2024-09-10 20:35:13 +00:00
< tr class = "row-even" > < td > < p > < a class = "reference internal" href = "kittycad.api.beta.html#module-kittycad.api.beta" title = "kittycad.api.beta" > < code class = "xref py py-obj docutils literal notranslate" > < span class = "pre" > beta< / span > < / code > < / a > < / p > < / td >
2022-06-12 01:37:38 +00:00
< td > < p > Contains methods for accessing the beta API paths: Beta API endpoints.< / p > < / td >
< / tr >
2024-09-10 20:35:13 +00:00
< tr class = "row-odd" > < td > < p > < a class = "reference internal" href = "kittycad.api.constant.html#module-kittycad.api.constant" title = "kittycad.api.constant" > < code class = "xref py py-obj docutils literal notranslate" > < span class = "pre" > constant< / span > < / code > < / a > < / p > < / td >
2022-07-26 00:15:59 +00:00
< td > < p > Contains methods for accessing the constant API paths: Constants.< / p > < / td >
< / tr >
2024-09-10 20:35:13 +00:00
< tr class = "row-even" > < td > < p > < a class = "reference internal" href = "kittycad.api.executor.html#module-kittycad.api.executor" title = "kittycad.api.executor" > < code class = "xref py py-obj docutils literal notranslate" > < span class = "pre" > executor< / span > < / code > < / a > < / p > < / td >
2023-05-04 00:58:06 -07:00
< td > < p > Contains methods for accessing the executor API paths: Endpoints that allow for code execution or creation of code execution environments.< / p > < / td >
< / tr >
2024-09-10 20:35:13 +00:00
< tr class = "row-odd" > < td > < p > < a class = "reference internal" href = "kittycad.api.file.html#module-kittycad.api.file" title = "kittycad.api.file" > < code class = "xref py py-obj docutils literal notranslate" > < span class = "pre" > file< / span > < / code > < / a > < / p > < / td >
2022-02-27 22:41:34 -08:00
< td > < p > Contains methods for accessing the file API paths: CAD file operations.< / p > < / td >
< / tr >
2024-09-10 20:35:13 +00:00
< tr class = "row-even" > < td > < p > < a class = "reference internal" href = "kittycad.api.hidden.html#module-kittycad.api.hidden" title = "kittycad.api.hidden" > < code class = "xref py py-obj docutils literal notranslate" > < span class = "pre" > hidden< / span > < / code > < / a > < / p > < / td >
2022-06-12 01:37:38 +00:00
< td > < p > Contains methods for accessing the hidden API paths: Hidden API endpoints that should not show up in the docs.< / p > < / td >
< / tr >
2024-09-10 20:35:13 +00:00
< tr class = "row-odd" > < td > < p > < a class = "reference internal" href = "kittycad.api.meta.html#module-kittycad.api.meta" title = "kittycad.api.meta" > < code class = "xref py py-obj docutils literal notranslate" > < span class = "pre" > meta< / span > < / code > < / a > < / p > < / td >
2022-04-07 03:38:23 +00:00
< td > < p > Contains methods for accessing the meta API paths: Meta information about the API.< / p > < / td >
< / tr >
2024-09-10 20:35:13 +00:00
< tr class = "row-even" > < td > < p > < a class = "reference internal" href = "kittycad.api.ml.html#module-kittycad.api.ml" title = "kittycad.api.ml" > < code class = "xref py py-obj docutils literal notranslate" > < span class = "pre" > ml< / span > < / code > < / a > < / p > < / td >
2024-08-10 04:16:23 +00:00
< td > < p > Contains methods for accessing the ml API paths: Machine learning to generate CAD models and other things.< / p > < / td >
< / tr >
2024-09-10 20:35:13 +00:00
< tr class = "row-odd" > < td > < p > < a class = "reference internal" href = "kittycad.api.modeling.html#module-kittycad.api.modeling" title = "kittycad.api.modeling" > < code class = "xref py py-obj docutils literal notranslate" > < span class = "pre" > modeling< / span > < / code > < / a > < / p > < / td >
2024-07-28 22:52:47 +00:00
< td > < p > Contains methods for accessing the modeling API paths: Modeling API for updating your 3D files using the Zoo engine.< / p > < / td >
2023-05-23 21:30:43 +00:00
< / tr >
2024-09-10 20:35:13 +00:00
< tr class = "row-even" > < td > < p > < a class = "reference internal" href = "kittycad.api.oauth2.html#module-kittycad.api.oauth2" title = "kittycad.api.oauth2" > < code class = "xref py py-obj docutils literal notranslate" > < span class = "pre" > oauth2< / span > < / code > < / a > < / p > < / td >
2022-07-05 22:47:27 +00:00
< td > < p > Contains methods for accessing the oauth2 API paths: Endpoints that implement OAuth 2.0 grant flows.< / p > < / td >
< / tr >
2024-09-10 20:35:13 +00:00
< tr class = "row-odd" > < td > < p > < a class = "reference internal" href = "kittycad.api.orgs.html#module-kittycad.api.orgs" title = "kittycad.api.orgs" > < code class = "xref py py-obj docutils literal notranslate" > < span class = "pre" > orgs< / span > < / code > < / a > < / p > < / td >
2024-07-28 22:52:47 +00:00
< td > < p > Contains methods for accessing the orgs API paths: An organization is a group of users of the Zoo API.< / p > < / td >
< / tr >
2024-09-10 20:35:13 +00:00
< tr class = "row-even" > < td > < p > < a class = "reference internal" href = "kittycad.api.payments.html#module-kittycad.api.payments" title = "kittycad.api.payments" > < code class = "xref py py-obj docutils literal notranslate" > < span class = "pre" > payments< / span > < / code > < / a > < / p > < / td >
2022-06-12 01:37:38 +00:00
< td > < p > Contains methods for accessing the payments API paths: Operations around payments and billing.< / p > < / td >
< / tr >
2024-09-10 20:35:13 +00:00
< tr class = "row-odd" > < td > < p > < a class = "reference internal" href = "kittycad.api.service_accounts.html#module-kittycad.api.service_accounts" title = "kittycad.api.service_accounts" > < code class = "xref py py-obj docutils literal notranslate" > < span class = "pre" > service_accounts< / span > < / code > < / a > < / p > < / td >
2024-07-28 22:52:47 +00:00
< td > < p > Contains methods for accessing the service_accounts API paths: Service accounts allow organizations to call the API.< / p > < / td >
< / tr >
2024-10-05 18:33:07 +00:00
< tr class = "row-even" > < td > < p > < a class = "reference internal" href = "kittycad.api.shortlinks.html#module-kittycad.api.shortlinks" title = "kittycad.api.shortlinks" > < code class = "xref py py-obj docutils literal notranslate" > < span class = "pre" > shortlinks< / span > < / code > < / a > < / p > < / td >
< td > < p > Contains methods for accessing the shortlinks API paths: Shortlinks are a way to create a short URL that redirects to a longer URL.< / p > < / td >
< / tr >
< tr class = "row-odd" > < td > < p > < a class = "reference internal" href = "kittycad.api.store.html#module-kittycad.api.store" title = "kittycad.api.store" > < code class = "xref py py-obj docutils literal notranslate" > < span class = "pre" > store< / span > < / code > < / a > < / p > < / td >
2024-07-28 22:52:47 +00:00
< td > < p > Contains methods for accessing the store API paths: Operations involving our swag store.< / p > < / td >
< / tr >
2024-10-05 18:33:07 +00:00
< tr class = "row-even" > < td > < p > < a class = "reference internal" href = "kittycad.api.unit.html#module-kittycad.api.unit" title = "kittycad.api.unit" > < code class = "xref py py-obj docutils literal notranslate" > < span class = "pre" > unit< / span > < / code > < / a > < / p > < / td >
2022-06-16 19:06:05 +00:00
< td > < p > Contains methods for accessing the unit API paths: Unit conversion operations.< / p > < / td >
< / tr >
2024-10-05 18:33:07 +00:00
< tr class = "row-odd" > < td > < p > < a class = "reference internal" href = "kittycad.api.users.html#module-kittycad.api.users" title = "kittycad.api.users" > < code class = "xref py py-obj docutils literal notranslate" > < span class = "pre" > users< / span > < / code > < / a > < / p > < / td >
2024-07-28 22:52:47 +00:00
< td > < p > Contains methods for accessing the users API paths: A user is someone who uses the Zoo API.< / p > < / td >
2022-02-27 22:41:34 -08:00
< / tr >
< / tbody >
< / table >
2021-12-15 03:54:43 -08:00
< / section >
< / div >
< / div >
2022-02-27 22:38:36 -08:00
< footer > < div class = "rst-footer-buttons" role = "navigation" aria-label = "Footer" >
< a href = "../index.html" class = "btn btn-neutral float-left" title = "Welcome to kittycad’ accesskey = "p" rel = "prev" > < span class = "fa fa-arrow-circle-left" aria-hidden = "true" > < / span > Previous< / a >
2024-08-10 04:16:23 +00:00
< a href = "kittycad.api.api_calls.html" class = "btn btn-neutral float-right" title = "kittycad.api.api_calls" accesskey = "n" rel = "next" > Next < span class = "fa fa-arrow-circle-right" aria-hidden = "true" > < / span > < / a >
2022-02-27 22:38:36 -08:00
< / div >
2021-12-15 03:54:43 -08:00
< hr / >
< div role = "contentinfo" >
2025-01-07 02:19:42 +00:00
< p > © Copyright 2025, KittyCAD Team Members.< / p >
2021-12-15 03:54:43 -08:00
< / div >
Built with < a href = "https://www.sphinx-doc.org/" > Sphinx< / a > using a
< a href = "https://github.com/readthedocs/sphinx_rtd_theme" > theme< / a >
provided by < a href = "https://readthedocs.org" > Read the Docs< / a > .
< / footer >
< / div >
< / div >
< / section >
< / div >
< script >
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
< / script >
< / body >
< / html >
