fcd317aae4
* bump Signed-off-by: Jess Frazelle <github@jessfraz.com> * some fixes Signed-off-by: Jess Frazelle <github@jessfraz.com> * YOYO NEW API SPEC! * reformat Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * fixups Signed-off-by: Jess Frazelle <github@jessfraz.com> * for now force true Signed-off-by: Jess Frazelle <github@jessfraz.com> * run the tests on generations Signed-off-by: Jess Frazelle <github@jessfraz.com> * add tests Signed-off-by: Jess Frazelle <github@jessfraz.com> * update Signed-off-by: Jess Frazelle <github@jessfraz.com> * update Signed-off-by: Jess Frazelle <github@jessfraz.com> * update Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * update Signed-off-by: Jess Frazelle <github@jessfraz.com> * fix some types Signed-off-by: Jess Frazelle <github@jessfraz.com> * float to top Signed-off-by: Jess Frazelle <github@jessfraz.com> * fix mypy Signed-off-by: Jess Frazelle <github@jessfraz.com> * more noqa Signed-off-by: Jess Frazelle <github@jessfraz.com> * fixups Signed-off-by: Jess Frazelle <github@jessfraz.com> * ruff pass Signed-off-by: Jess Frazelle <github@jessfraz.com> * add docs Signed-off-by: Jess Frazelle <github@jessfraz.com> * fix Signed-off-by: Jess Frazelle <github@jessfraz.com> * fix Signed-off-by: Jess Frazelle <github@jessfraz.com> * fix Signed-off-by: Jess Frazelle <github@jessfraz.com> * fixes Signed-off-by: Jess Frazelle <github@jessfraz.com> * even less mypy errors Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * add test Signed-off-by: Jess Frazelle <github@jessfraz.com> * fixes Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * fixes Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * fixups Signed-off-by: Jess Frazelle <github@jessfraz.com> * fixes Signed-off-by: Jess Frazelle <github@jessfraz.com> * cleanup Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * fix Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * fix Signed-off-by: Jess Frazelle <github@jessfraz.com> * new path Signed-off-by: Jess Frazelle <github@jessfraz.com> * fixes for mypy Signed-off-by: Jess Frazelle <github@jessfraz.com> * skip tests Signed-off-by: Jess Frazelle <github@jessfraz.com> --------- Signed-off-by: Jess Frazelle <github@jessfraz.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
194 lines
13 KiB
HTML
194 lines
13 KiB
HTML
<!DOCTYPE html>
|
||
<html class="writer-html5" lang="en" >
|
||
<head>
|
||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||
|
||
<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:description" content="Contains methods for accessing the API Modules" />
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||
<title>kittycad.api — kittycad v0.3.8 documentation</title>
|
||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
|
||
<link rel="stylesheet" href="../_static/graphviz.css" type="text/css" />
|
||
<link rel="stylesheet" href="../_static/copybutton.css" type="text/css" />
|
||
<link rel="stylesheet" href="../_static/autoclasstoc.css" type="text/css" />
|
||
<!--[if lt IE 9]>
|
||
<script src="../_static/js/html5shiv.min.js"></script>
|
||
<![endif]-->
|
||
|
||
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
|
||
<script src="../_static/jquery.js"></script>
|
||
<script src="../_static/underscore.js"></script>
|
||
<script src="../_static/doctools.js"></script>
|
||
<script src="../_static/clipboard.min.js"></script>
|
||
<script src="../_static/copybutton.js"></script>
|
||
<script src="../_static/js/theme.js"></script>
|
||
<link rel="index" title="Index" href="../genindex.html" />
|
||
<link rel="search" title="Search" href="../search.html" />
|
||
<link rel="next" title="kittycad.api.ai" href="kittycad.api.ai.html" />
|
||
<link rel="prev" title="Welcome to kittycad’s documentation!" href="../index.html" />
|
||
</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" >
|
||
|
||
|
||
|
||
<a href="../index.html" class="icon icon-home">
|
||
kittycad
|
||
</a>
|
||
<div class="version">
|
||
v0.3.8
|
||
</div>
|
||
<div role="search">
|
||
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
|
||
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||
<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">
|
||
<ul class="current">
|
||
<li class="toctree-l1 current"><a class="current reference internal" href="#">kittycad.api</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.api.ai.html">kittycad.api.ai</a></li>
|
||
<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>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.api.apps.html">kittycad.api.apps</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.api.beta.html">kittycad.api.beta</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.api.constant.html">kittycad.api.constant</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.api.drawing.html">kittycad.api.drawing</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.api.executor.html">kittycad.api.executor</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.api.file.html">kittycad.api.file</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.api.hidden.html">kittycad.api.hidden</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.api.meta.html">kittycad.api.meta</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.api.oauth2.html">kittycad.api.oauth2</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.api.payments.html">kittycad.api.payments</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.api.unit.html">kittycad.api.unit</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.api.users.html">kittycad.api.users</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="kittycad.client.html">kittycad.client</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="kittycad.models.html">kittycad.models</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="kittycad.types.html">kittycad.types</a></li>
|
||
</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">
|
||
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||
<li class="breadcrumb-item active">kittycad.api</li>
|
||
<li class="wy-breadcrumbs-aside">
|
||
</li>
|
||
</ul>
|
||
<hr/>
|
||
</div>
|
||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||
<div itemprop="articleBody">
|
||
|
||
<section id="module-kittycad.api">
|
||
<span id="kittycad-api"></span><h1>kittycad.api<a class="headerlink" href="#module-kittycad.api" title="Permalink to this headline"></a></h1>
|
||
<p>Contains methods for accessing the API</p>
|
||
<p class="rubric">Modules</p>
|
||
<table class="autosummary longtable docutils align-default">
|
||
<colgroup>
|
||
<col style="width: 10%" />
|
||
<col style="width: 90%" />
|
||
</colgroup>
|
||
<tbody>
|
||
<tr class="row-odd"><td><p><a class="reference internal" href="kittycad.api.ai.html#module-kittycad.api.ai" title="kittycad.api.ai"><code class="xref py py-obj docutils literal notranslate"><span class="pre">kittycad.api.ai</span></code></a></p></td>
|
||
<td><p>Contains methods for accessing the ai API paths: AI uses machine learning to generate 3D meshes.</p></td>
|
||
</tr>
|
||
<tr class="row-even"><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">kittycad.api.api_calls</span></code></a></p></td>
|
||
<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>
|
||
</tr>
|
||
<tr class="row-odd"><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">kittycad.api.api_tokens</span></code></a></p></td>
|
||
<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>
|
||
</tr>
|
||
<tr class="row-even"><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">kittycad.api.apps</span></code></a></p></td>
|
||
<td><p>Contains methods for accessing the apps API paths: Endpoints for third party app grant flows.</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><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">kittycad.api.beta</span></code></a></p></td>
|
||
<td><p>Contains methods for accessing the beta API paths: Beta API endpoints.</p></td>
|
||
</tr>
|
||
<tr class="row-even"><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">kittycad.api.constant</span></code></a></p></td>
|
||
<td><p>Contains methods for accessing the constant API paths: Constants.</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><a class="reference internal" href="kittycad.api.drawing.html#module-kittycad.api.drawing" title="kittycad.api.drawing"><code class="xref py py-obj docutils literal notranslate"><span class="pre">kittycad.api.drawing</span></code></a></p></td>
|
||
<td><p>Contains methods for accessing the drawing API paths: Drawing API for updating your 3D files using the KittyCAD engine.</p></td>
|
||
</tr>
|
||
<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">kittycad.api.executor</span></code></a></p></td>
|
||
<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>
|
||
<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">kittycad.api.file</span></code></a></p></td>
|
||
<td><p>Contains methods for accessing the file API paths: CAD file operations.</p></td>
|
||
</tr>
|
||
<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">kittycad.api.hidden</span></code></a></p></td>
|
||
<td><p>Contains methods for accessing the hidden API paths: Hidden API endpoints that should not show up in the docs.</p></td>
|
||
</tr>
|
||
<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">kittycad.api.meta</span></code></a></p></td>
|
||
<td><p>Contains methods for accessing the meta API paths: Meta information about the API.</p></td>
|
||
</tr>
|
||
<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">kittycad.api.oauth2</span></code></a></p></td>
|
||
<td><p>Contains methods for accessing the oauth2 API paths: Endpoints that implement OAuth 2.0 grant flows.</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><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">kittycad.api.payments</span></code></a></p></td>
|
||
<td><p>Contains methods for accessing the payments API paths: Operations around payments and billing.</p></td>
|
||
</tr>
|
||
<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">kittycad.api.unit</span></code></a></p></td>
|
||
<td><p>Contains methods for accessing the unit API paths: Unit conversion operations.</p></td>
|
||
</tr>
|
||
<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">kittycad.api.users</span></code></a></p></td>
|
||
<td><p>Contains methods for accessing the users API paths: A user is someone who uses the KittyCAD API.</p></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</section>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
<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’s documentation!" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||
<a href="kittycad.api.ai.html" class="btn btn-neutral float-right" title="kittycad.api.ai" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||
</div>
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>© Copyright 2023, KittyCAD Team Members.</p>
|
||
</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> |