2022-02-27 22:41:34 -08:00
<!DOCTYPE html>
< html class = "writer-html5" lang = "en" >
< head >
2023-05-08 20:06:56 +00:00
< meta charset = "utf-8" / > < meta name = "generator" content = "Docutils 0.18.1: http://docutils.sourceforge.net/" / >
< meta property = "og:title" content = "kittycad.api.file" / >
< meta property = "og:type" content = "website" / >
< meta property = "og:url" content = "_autosummary/kittycad.api.file.html" / >
< meta property = "og:site_name" content = "kittycad" / >
< meta property = "og:description" content = "Contains methods for accessing the file API paths: CAD file operations. Create, get, and list CAD file conversions. More endpoints will be added here in the future as we build out transforms, etc o..." / >
< meta property = "og:image:width" content = "1146" / >
< meta property = "og:image:height" content = "600" / >
< meta property = "og:image" content = "/_images/social_previews/summary__autosummary_kittycad.api.file_b5fe50b3.png" / >
< meta property = "og:image:alt" content = "Contains methods for accessing the file API paths: CAD file operations. Create, get, and list CAD file conversions. More endpoints will be added here in the..." / >
< meta name = "description" content = "Contains methods for accessing the file API paths: CAD file operations. Create, get, and list CAD file conversions. More endpoints will be added here in the future as we build out transforms, etc o..." / >
< meta name = "twitter:card" content = "summary_large_image" / >
2022-02-27 22:41:34 -08:00
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" / >
2023-05-08 20:06:56 +00:00
< title > kittycad.api.file — kittycad v0.4.0 documentation< / title >
2022-02-27 22:41:34 -08:00
< 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" / >
2023-05-04 00:58:06 -07:00
< link rel = "stylesheet" href = "../_static/copybutton.css" type = "text/css" / >
< link rel = "stylesheet" href = "../_static/autoclasstoc.css" type = "text/css" / >
2022-02-27 22:41:34 -08:00
<!-- [if lt IE 9]>
< script src = "../_static/js/html5shiv.min.js" > < / script >
<![endif]-->
< script src = "../_static/jquery.js" > < / script >
2023-05-08 20:06:56 +00:00
< script src = "../_static/_sphinx_javascript_frameworks_compat.js" > < / script >
< script data-url_root = "../" id = "documentation_options" src = "../_static/documentation_options.js" > < / script >
2022-02-27 22:41:34 -08:00
< script src = "../_static/doctools.js" > < / script >
2023-05-08 20:06:56 +00:00
< script src = "../_static/sphinx_highlight.js" > < / script >
2023-05-04 00:58:06 -07:00
< script src = "../_static/clipboard.min.js" > < / script >
< script src = "../_static/copybutton.js" > < / script >
2022-02-27 22:41:34 -08:00
< script src = "../_static/js/theme.js" > < / script >
< link rel = "index" title = "Index" href = "../genindex.html" / >
< link rel = "search" title = "Search" href = "../search.html" / >
2022-08-15 20:01:02 +00:00
< link rel = "next" title = "kittycad.api.file.create_file_center_of_mass" href = "kittycad.api.file.create_file_center_of_mass.html" / >
2023-05-04 00:58:06 -07:00
< link rel = "prev" title = "kittycad.api.executor.create_file_execution.sync_detailed" href = "kittycad.api.executor.create_file_execution.sync_detailed.html" / >
2022-02-27 22:41:34 -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
2022-02-27 22:41:34 -08:00
< / a >
< div class = "version" >
2023-05-08 20:06:56 +00:00
v0.4.0
2022-02-27 22:41:34 -08:00
< / div >
< 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" / >
2022-02-27 22:41:34 -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" >
< ul class = "current" >
< li class = "toctree-l1 current" > < a class = "reference internal" href = "kittycad.api.html" > kittycad.api< / a > < ul class = "current" >
2023-05-04 00:58:06 -07:00
< 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 >
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.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 >
2022-04-27 20:34:57 +00:00
< li class = "toctree-l2 current" > < a class = "current reference internal" href = "#" > kittycad.api.file< / a > < ul >
2022-08-15 20:01:02 +00:00
< li class = "toctree-l3" > < a class = "reference internal" href = "kittycad.api.file.create_file_center_of_mass.html" > kittycad.api.file.create_file_center_of_mass< / a > < / li >
2022-04-27 20:34:57 +00:00
< li class = "toctree-l3" > < a class = "reference internal" href = "kittycad.api.file.create_file_conversion.html" > kittycad.api.file.create_file_conversion< / a > < / li >
2022-10-03 19:08:51 +00:00
< li class = "toctree-l3" > < a class = "reference internal" href = "kittycad.api.file.create_file_conversion_with_base64_helper.html" > kittycad.api.file.create_file_conversion_with_base64_helper< / a > < / li >
2022-06-16 01:22:56 +00:00
< li class = "toctree-l3" > < a class = "reference internal" href = "kittycad.api.file.create_file_density.html" > kittycad.api.file.create_file_density< / a > < / li >
2022-06-12 01:37:38 +00:00
< li class = "toctree-l3" > < a class = "reference internal" href = "kittycad.api.file.create_file_mass.html" > kittycad.api.file.create_file_mass< / a > < / li >
2022-08-15 20:01:02 +00:00
< li class = "toctree-l3" > < a class = "reference internal" href = "kittycad.api.file.create_file_surface_area.html" > kittycad.api.file.create_file_surface_area< / a > < / li >
2022-06-12 01:37:38 +00:00
< li class = "toctree-l3" > < a class = "reference internal" href = "kittycad.api.file.create_file_volume.html" > kittycad.api.file.create_file_volume< / a > < / li >
2023-05-04 00:58:06 -07:00
< li class = "toctree-l3" > < a class = "reference internal" href = "kittycad.api.file.get_file_conversion_with_base64_helper.html" > kittycad.api.file.get_file_conversion_with_base64_helper< / a > < / li >
2022-04-27 20:34:57 +00:00
< / ul >
< / 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 >
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 >
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 >
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 >
< 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:41:34 -08:00
< 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" >
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" > < a href = "kittycad.api.html" > kittycad.api< / a > < / li >
< li class = "breadcrumb-item active" > kittycad.api.file< / li >
2022-02-27 22:41:34 -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" >
< section id = "module-kittycad.api.file" >
2023-05-08 20:06:56 +00:00
< span id = "kittycad-api-file" > < / span > < h1 > kittycad.api.file< a class = "headerlink" href = "#module-kittycad.api.file" title = "Permalink to this heading" > < / a > < / h1 >
2022-04-07 03:38:23 +00:00
< p > Contains methods for accessing the file API paths: CAD file operations. Create, get, and list CAD file conversions. More endpoints will be added here in the future as we build out transforms, etc on CAD models.< / 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 >
2022-08-15 20:01:02 +00:00
< tr class = "row-odd" > < td > < p > < a class = "reference internal" href = "kittycad.api.file.create_file_center_of_mass.html#module-kittycad.api.file.create_file_center_of_mass" title = "kittycad.api.file.create_file_center_of_mass" > < code class = "xref py py-obj docutils literal notranslate" > < span class = "pre" > kittycad.api.file.create_file_center_of_mass< / span > < / code > < / a > < / p > < / td >
2022-04-27 20:34:57 +00:00
< td > < p > < / p > < / td >
< / tr >
2022-08-15 20:01:02 +00:00
< tr class = "row-even" > < td > < p > < a class = "reference internal" href = "kittycad.api.file.create_file_conversion.html#module-kittycad.api.file.create_file_conversion" title = "kittycad.api.file.create_file_conversion" > < code class = "xref py py-obj docutils literal notranslate" > < span class = "pre" > kittycad.api.file.create_file_conversion< / span > < / code > < / a > < / p > < / td >
2022-04-27 20:34:57 +00:00
< td > < p > < / p > < / td >
< / tr >
2022-10-03 19:08:51 +00:00
< tr class = "row-odd" > < td > < p > < a class = "reference internal" href = "kittycad.api.file.create_file_conversion_with_base64_helper.html#module-kittycad.api.file.create_file_conversion_with_base64_helper" title = "kittycad.api.file.create_file_conversion_with_base64_helper" > < code class = "xref py py-obj docutils literal notranslate" > < span class = "pre" > kittycad.api.file.create_file_conversion_with_base64_helper< / span > < / code > < / a > < / p > < / td >
2022-04-27 20:34:57 +00:00
< td > < p > < / p > < / td >
< / tr >
2022-10-03 19:08:51 +00:00
< tr class = "row-even" > < td > < p > < a class = "reference internal" href = "kittycad.api.file.create_file_density.html#module-kittycad.api.file.create_file_density" title = "kittycad.api.file.create_file_density" > < code class = "xref py py-obj docutils literal notranslate" > < span class = "pre" > kittycad.api.file.create_file_density< / span > < / code > < / a > < / p > < / td >
2022-04-27 20:34:57 +00:00
< td > < p > < / p > < / td >
< / tr >
2023-05-04 00:58:06 -07:00
< tr class = "row-odd" > < td > < p > < a class = "reference internal" href = "kittycad.api.file.create_file_mass.html#module-kittycad.api.file.create_file_mass" title = "kittycad.api.file.create_file_mass" > < code class = "xref py py-obj docutils literal notranslate" > < span class = "pre" > kittycad.api.file.create_file_mass< / span > < / code > < / a > < / p > < / td >
2022-08-15 20:01:02 +00:00
< td > < p > < / p > < / td >
< / tr >
2023-05-04 00:58:06 -07:00
< tr class = "row-even" > < td > < p > < a class = "reference internal" href = "kittycad.api.file.create_file_surface_area.html#module-kittycad.api.file.create_file_surface_area" title = "kittycad.api.file.create_file_surface_area" > < code class = "xref py py-obj docutils literal notranslate" > < span class = "pre" > kittycad.api.file.create_file_surface_area< / span > < / code > < / a > < / p > < / td >
2022-08-15 20:01:02 +00:00
< td > < p > < / p > < / td >
< / tr >
2023-05-04 00:58:06 -07:00
< tr class = "row-odd" > < td > < p > < a class = "reference internal" href = "kittycad.api.file.create_file_volume.html#module-kittycad.api.file.create_file_volume" title = "kittycad.api.file.create_file_volume" > < code class = "xref py py-obj docutils literal notranslate" > < span class = "pre" > kittycad.api.file.create_file_volume< / span > < / code > < / a > < / p > < / td >
2022-10-03 19:08:51 +00:00
< td > < p > < / p > < / td >
< / tr >
2023-05-04 00:58:06 -07:00
< tr class = "row-even" > < td > < p > < a class = "reference internal" href = "kittycad.api.file.get_file_conversion_with_base64_helper.html#module-kittycad.api.file.get_file_conversion_with_base64_helper" title = "kittycad.api.file.get_file_conversion_with_base64_helper" > < code class = "xref py py-obj docutils literal notranslate" > < span class = "pre" > kittycad.api.file.get_file_conversion_with_base64_helper< / span > < / code > < / a > < / p > < / td >
2022-04-27 20:34:57 +00:00
< td > < p > < / p > < / td >
< / tr >
2022-02-27 22:41:34 -08:00
< / tbody >
< / table >
< / section >
< / div >
< / div >
< footer > < div class = "rst-footer-buttons" role = "navigation" aria-label = "Footer" >
2023-05-04 00:58:06 -07:00
< a href = "kittycad.api.executor.create_file_execution.sync_detailed.html" class = "btn btn-neutral float-left" title = "kittycad.api.executor.create_file_execution.sync_detailed" accesskey = "p" rel = "prev" > < span class = "fa fa-arrow-circle-left" aria-hidden = "true" > < / span > Previous< / a >
2022-08-15 20:01:02 +00:00
< a href = "kittycad.api.file.create_file_center_of_mass.html" class = "btn btn-neutral float-right" title = "kittycad.api.file.create_file_center_of_mass" accesskey = "n" rel = "next" > Next < span class = "fa fa-arrow-circle-right" aria-hidden = "true" > < / span > < / a >
2022-02-27 22:41:34 -08:00
< / div >
< hr / >
< div role = "contentinfo" >
2023-05-04 00:58:06 -07:00
< p > © Copyright 2023, KittyCAD Team Members.< / p >
2022-02-27 22:41:34 -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 >
