2024-10-09 19:40:26 +00:00
2023-05-04 00:58:06 -07:00
<!DOCTYPE html>
2024-09-10 20:35:13 +00:00
< html class = "writer-html5" lang = "en" data-content_root = "../" >
2023-05-04 00:58:06 -07: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.file.create_file_surface_area.asyncio" / >
< meta property = "og:type" content = "website" / >
< meta property = "og:url" content = "_autosummary/kittycad.api.file.create_file_surface_area.asyncio.html" / >
< meta property = "og:site_name" content = "kittycad" / >
2023-05-04 00:58:06 -07:00
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" / >
2024-12-11 22:08:10 +00:00
< title > kittycad.api.file.create_file_surface_area.asyncio — 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 >
2023-05-04 00:58:06 -07:00
< 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.file.create_file_surface_area.asyncio_detailed" href = "kittycad.api.file.create_file_surface_area.asyncio_detailed.html" / >
< link rel = "prev" title = "kittycad.api.file.create_file_surface_area" href = "kittycad.api.file.create_file_surface_area.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 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 = "reference internal" href = "kittycad.api.html" > kittycad.api< / a > < ul class = "current" >
< 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.executor.html" > kittycad.api.executor< / a > < / li >
< li class = "toctree-l2 current" > < a class = "reference internal" href = "kittycad.api.file.html" > kittycad.api.file< / a > < ul class = "current" >
< 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 >
< li class = "toctree-l3" > < a class = "reference internal" href = "kittycad.api.file.create_file_conversion.html" > kittycad.api.file.create_file_conversion< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "kittycad.api.file.create_file_density.html" > kittycad.api.file.create_file_density< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "kittycad.api.file.create_file_mass.html" > kittycad.api.file.create_file_mass< / a > < / li >
< li class = "toctree-l3 current" > < a class = "reference internal" href = "kittycad.api.file.create_file_surface_area.html" > kittycad.api.file.create_file_surface_area< / a > < ul class = "current" >
< li class = "toctree-l4 current" > < a class = "current reference internal" href = "#" > kittycad.api.file.create_file_surface_area.asyncio< / a > < / li >
< li class = "toctree-l4" > < a class = "reference internal" href = "kittycad.api.file.create_file_surface_area.asyncio_detailed.html" > kittycad.api.file.create_file_surface_area.asyncio_detailed< / a > < / li >
< li class = "toctree-l4" > < a class = "reference internal" href = "kittycad.api.file.create_file_surface_area.sync.html" > kittycad.api.file.create_file_surface_area.sync< / a > < / li >
< li class = "toctree-l4" > < a class = "reference internal" href = "kittycad.api.file.create_file_surface_area.sync_detailed.html" > kittycad.api.file.create_file_surface_area.sync_detailed< / a > < / li >
2023-05-08 20:06:56 +00:00
< li class = "toctree-l4" > < a class = "reference internal" href = "kittycad.api.file.create_file_surface_area.html#kittycad.api.file.create_file_surface_area._build_response" > < code class = "docutils literal notranslate" > < span class = "pre" > _build_response()< / span > < / code > < / a > < / li >
< li class = "toctree-l4" > < a class = "reference internal" href = "kittycad.api.file.create_file_surface_area.html#kittycad.api.file.create_file_surface_area._get_kwargs" > < code class = "docutils literal notranslate" > < span class = "pre" > _get_kwargs()< / span > < / code > < / a > < / li >
< li class = "toctree-l4" > < a class = "reference internal" href = "kittycad.api.file.create_file_surface_area.html#kittycad.api.file.create_file_surface_area._parse_response" > < code class = "docutils literal notranslate" > < span class = "pre" > _parse_response()< / span > < / code > < / a > < / li >
< li class = "toctree-l4" > < a class = "reference internal" href = "kittycad.api.file.create_file_surface_area.html#kittycad.api.file.create_file_surface_area.asyncio" > < code class = "docutils literal notranslate" > < span class = "pre" > asyncio()< / span > < / code > < / a > < / li >
< li class = "toctree-l4" > < a class = "reference internal" href = "kittycad.api.file.create_file_surface_area.html#kittycad.api.file.create_file_surface_area.asyncio_detailed" > < code class = "docutils literal notranslate" > < span class = "pre" > asyncio_detailed()< / span > < / code > < / a > < / li >
< li class = "toctree-l4" > < a class = "reference internal" href = "kittycad.api.file.create_file_surface_area.html#kittycad.api.file.create_file_surface_area.sync" > < code class = "docutils literal notranslate" > < span class = "pre" > sync()< / span > < / code > < / a > < / li >
< li class = "toctree-l4" > < a class = "reference internal" href = "kittycad.api.file.create_file_surface_area.html#kittycad.api.file.create_file_surface_area.sync_detailed" > < code class = "docutils literal notranslate" > < span class = "pre" > sync_detailed()< / span > < / code > < / a > < / li >
2023-05-04 00:58:06 -07:00
< / ul >
< / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "kittycad.api.file.create_file_volume.html" > kittycad.api.file.create_file_volume< / a > < / li >
< / ul >
< / 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 >
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 >
2023-05-04 00:58:06 -07: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 >
2023-05-04 00:58:06 -07: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 >
2023-05-04 00:58:06 -07:00
< 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" > < a href = "kittycad.api.html" > kittycad.api< / a > < / li >
< li class = "breadcrumb-item" > < a href = "kittycad.api.file.html" > kittycad.api.file< / a > < / li >
< li class = "breadcrumb-item" > < a href = "kittycad.api.file.create_file_surface_area.html" > kittycad.api.file.create_file_surface_area< / a > < / li >
< li class = "breadcrumb-item active" > kittycad.api.file.create_file_surface_area.asyncio< / 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 = "kittycad-api-file-create-file-surface-area-asyncio" >
2024-07-28 22:52:47 +00:00
< h1 > kittycad.api.file.create_file_surface_area.asyncio< a class = "headerlink" href = "#kittycad-api-file-create-file-surface-area-asyncio" title = "Link to this heading" > < / a > < / h1 >
2023-05-04 00:58:06 -07:00
< dl class = "py function" >
< dt class = "sig sig-object py" id = "kittycad.api.file.create_file_surface_area.asyncio" >
2024-07-28 22:52:47 +00:00
< em class = "property" > < span class = "k" > < span class = "pre" > async< / span > < / span > < span class = "w" > < / span > < / em > < span class = "sig-prename descclassname" > < span class = "pre" > kittycad.api.file.create_file_surface_area.< / span > < / span > < span class = "sig-name descname" > < span class = "pre" > asyncio< / span > < / span > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > < span class = "pre" > output_unit< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > src_format< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > body< / span > < / span > < / em > , < em class = "sig-param" > < span class = "o" > < span class = "pre" > *< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > client< / span > < / span > < / em > < span class = "sig-paren" > )< / span > < a class = "reference external" href = "https://github.com/kittycad/kittycad.py/kittycad/api/file/create_file_surface_area.py" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "reference internal" href = "../_modules/kittycad/api/file/create_file_surface_area.html#asyncio" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "headerlink" href = "#kittycad.api.file.create_file_surface_area.asyncio" title = "Link to this definition" > < / a > < / dt >
2024-10-02 21:22:42 +00:00
< dd > < p > We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale.< / p >
< p > This endpoint returns the square measure units.< / p >
< p > In the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported.< / p >
< p > Get the surface area of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously.< / p >
< p > If the operation is performed asynchronously, the < a class = "reference internal" href = "kittycad.models.api_call_with_price.ApiCallWithPrice.html#kittycad.models.api_call_with_price.ApiCallWithPrice.id" title = "kittycad.models.api_call_with_price.ApiCallWithPrice.id" > < code class = "xref any py py-attr docutils literal notranslate" > < span class = "pre" > id< / span > < / code > < / a > of the operation will be returned. You can use the < a class = "reference internal" href = "kittycad.models.api_call_with_price.ApiCallWithPrice.html#kittycad.models.api_call_with_price.ApiCallWithPrice.id" title = "kittycad.models.api_call_with_price.ApiCallWithPrice.id" > < code class = "xref any py py-attr docutils literal notranslate" > < span class = "pre" > id< / span > < / code > < / a > returned from the request to get status information about the async operation from the < code class = "xref any docutils literal notranslate" > < span class = "pre" > /async/operations/{id}< / span > < / code > endpoint.< / p >
2023-05-04 00:58:06 -07:00
< dl class = "field-list simple" >
2023-05-08 20:06:56 +00:00
< dt class = "field-odd" > Return type< span class = "colon" > :< / span > < / dt >
2024-10-09 19:40:26 +00:00
< dd class = "field-odd" > < p > < span class = "sphinx_autodoc_typehints-type" > < a class = "reference external" href = "https://docs.python.org/3/library/typing.html#typing.Union" title = "(in Python v3.13)" > < code class = "xref py py-data docutils literal notranslate" > < span class = "pre" > Union< / span > < / code > < / a > [< a class = "reference internal" href = "kittycad.models.file_surface_area.FileSurfaceArea.html#kittycad.models.file_surface_area.FileSurfaceArea" title = "kittycad.models.file_surface_area.FileSurfaceArea" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > FileSurfaceArea< / span > < / code > < / a > , < a class = "reference internal" href = "kittycad.models.error.Error.html#kittycad.models.error.Error" title = "kittycad.models.error.Error" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > Error< / span > < / code > < / a > , < a class = "reference external" href = "https://docs.python.org/3/library/constants.html#None" title = "(in Python v3.13)" > < code class = "xref py py-obj docutils literal notranslate" > < span class = "pre" > None< / span > < / code > < / a > ]< / span > < / p >
2023-05-04 00:58:06 -07:00
< / dd >
< / dl >
< / dd > < / dl >
< / section >
< / div >
< / div >
< footer > < div class = "rst-footer-buttons" role = "navigation" aria-label = "Footer" >
< a href = "kittycad.api.file.create_file_surface_area.html" class = "btn btn-neutral float-left" title = "kittycad.api.file.create_file_surface_area" accesskey = "p" rel = "prev" > < span class = "fa fa-arrow-circle-left" aria-hidden = "true" > < / span > Previous< / a >
< a href = "kittycad.api.file.create_file_surface_area.asyncio_detailed.html" class = "btn btn-neutral float-right" title = "kittycad.api.file.create_file_surface_area.asyncio_detailed" accesskey = "n" rel = "next" > Next < span class = "fa fa-arrow-circle-right" aria-hidden = "true" > < / span > < / a >
< / div >
< hr / >
< div role = "contentinfo" >
2025-01-07 02:19:42 +00:00
< p > © Copyright 2025, KittyCAD Team Members.< / p >
2023-05-04 00:58:06 -07: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 >
