:py:mod:`vendor_fabric.meshy.base`
==================================

.. py:module:: vendor_fabric.meshy.base

.. autodoc2-docstring:: vendor_fabric.meshy.base
   :parser: myst
   :allowtitles:

Module Contents
---------------

Functions
~~~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`configure <vendor_fabric.meshy.base.configure>`
     - .. autodoc2-docstring:: vendor_fabric.meshy.base.configure
          :parser: myst
          :summary:
   * - :py:obj:`get_api_key <vendor_fabric.meshy.base.get_api_key>`
     - .. autodoc2-docstring:: vendor_fabric.meshy.base.get_api_key
          :parser: myst
          :summary:
   * - :py:obj:`get_client <vendor_fabric.meshy.base.get_client>`
     - .. autodoc2-docstring:: vendor_fabric.meshy.base.get_client
          :parser: myst
          :summary:
   * - :py:obj:`close <vendor_fabric.meshy.base.close>`
     - .. autodoc2-docstring:: vendor_fabric.meshy.base.close
          :parser: myst
          :summary:
   * - :py:obj:`task_failure_message <vendor_fabric.meshy.base.task_failure_message>`
     - .. autodoc2-docstring:: vendor_fabric.meshy.base.task_failure_message
          :parser: myst
          :summary:
   * - :py:obj:`unexpected_response_message <vendor_fabric.meshy.base.unexpected_response_message>`
     - .. autodoc2-docstring:: vendor_fabric.meshy.base.unexpected_response_message
          :parser: myst
          :summary:
   * - :py:obj:`task_id_from_response <vendor_fabric.meshy.base.task_id_from_response>`
     - .. autodoc2-docstring:: vendor_fabric.meshy.base.task_id_from_response
          :parser: myst
          :summary:
   * - :py:obj:`task_payload_from_response <vendor_fabric.meshy.base.task_payload_from_response>`
     - .. autodoc2-docstring:: vendor_fabric.meshy.base.task_payload_from_response
          :parser: myst
          :summary:
   * - :py:obj:`request <vendor_fabric.meshy.base.request>`
     - .. autodoc2-docstring:: vendor_fabric.meshy.base.request
          :parser: myst
          :summary:
   * - :py:obj:`download <vendor_fabric.meshy.base.download>`
     - .. autodoc2-docstring:: vendor_fabric.meshy.base.download
          :parser: myst
          :summary:

Data
~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`BASE_URL <vendor_fabric.meshy.base.BASE_URL>`
     - .. autodoc2-docstring:: vendor_fabric.meshy.base.BASE_URL
          :parser: myst
          :summary:

API
~~~

.. py:exception:: RateLimitError()
   :canonical: vendor_fabric.meshy.base.RateLimitError

   Bases: :py:obj:`Exception`

   .. autodoc2-docstring:: vendor_fabric.meshy.base.RateLimitError
      :parser: myst

   .. rubric:: Initialization

   .. autodoc2-docstring:: vendor_fabric.meshy.base.RateLimitError.__init__
      :parser: myst

   .. py:method:: add_note()
      :canonical: vendor_fabric.meshy.base.RateLimitError.add_note

   .. py:class:: args
      :canonical: vendor_fabric.meshy.base.RateLimitError.args

   .. py:method:: with_traceback()
      :canonical: vendor_fabric.meshy.base.RateLimitError.with_traceback

.. py:exception:: MeshyAPIError(message: str, status_code: int | None = None)
   :canonical: vendor_fabric.meshy.base.MeshyAPIError

   Bases: :py:obj:`Exception`

   .. autodoc2-docstring:: vendor_fabric.meshy.base.MeshyAPIError
      :parser: myst

   .. rubric:: Initialization

   .. autodoc2-docstring:: vendor_fabric.meshy.base.MeshyAPIError.__init__
      :parser: myst

   .. py:method:: add_note()
      :canonical: vendor_fabric.meshy.base.MeshyAPIError.add_note

   .. py:class:: args
      :canonical: vendor_fabric.meshy.base.MeshyAPIError.args

   .. py:method:: with_traceback()
      :canonical: vendor_fabric.meshy.base.MeshyAPIError.with_traceback

.. py:data:: BASE_URL
   :canonical: vendor_fabric.meshy.base.BASE_URL
   :value: 'https://api.meshy.ai'

   .. autodoc2-docstring:: vendor_fabric.meshy.base.BASE_URL
      :parser: myst

.. py:function:: configure(api_key: str | None = None, **kwargs: typing.Any) -> None
   :canonical: vendor_fabric.meshy.base.configure

   .. autodoc2-docstring:: vendor_fabric.meshy.base.configure
      :parser: myst

.. py:function:: get_api_key() -> str
   :canonical: vendor_fabric.meshy.base.get_api_key

   .. autodoc2-docstring:: vendor_fabric.meshy.base.get_api_key
      :parser: myst

.. py:function:: get_client() -> httpx.Client
   :canonical: vendor_fabric.meshy.base.get_client

   .. autodoc2-docstring:: vendor_fabric.meshy.base.get_client
      :parser: myst

.. py:function:: close() -> None
   :canonical: vendor_fabric.meshy.base.close

   .. autodoc2-docstring:: vendor_fabric.meshy.base.close
      :parser: myst

.. py:function:: task_failure_message(error: typing.Any) -> str
   :canonical: vendor_fabric.meshy.base.task_failure_message

   .. autodoc2-docstring:: vendor_fabric.meshy.base.task_failure_message
      :parser: myst

.. py:function:: unexpected_response_message(data: typing.Any) -> str
   :canonical: vendor_fabric.meshy.base.unexpected_response_message

   .. autodoc2-docstring:: vendor_fabric.meshy.base.unexpected_response_message
      :parser: myst

.. py:function:: task_id_from_response(response: httpx.Response) -> extended_data.containers.ExtendedString
   :canonical: vendor_fabric.meshy.base.task_id_from_response

   .. autodoc2-docstring:: vendor_fabric.meshy.base.task_id_from_response
      :parser: myst

.. py:function:: task_payload_from_response(response: httpx.Response, model_type: type[pydantic.BaseModel], endpoint: str) -> extended_data.containers.ExtendedDict
   :canonical: vendor_fabric.meshy.base.task_payload_from_response

   .. autodoc2-docstring:: vendor_fabric.meshy.base.task_payload_from_response
      :parser: myst

.. py:function:: request(method: str, endpoint: str, *, version: str = 'v2', **kwargs: typing.Any) -> httpx.Response
   :canonical: vendor_fabric.meshy.base.request

   .. autodoc2-docstring:: vendor_fabric.meshy.base.request
      :parser: myst

.. py:function:: download(url: str, output_path: str) -> int
   :canonical: vendor_fabric.meshy.base.download

   .. autodoc2-docstring:: vendor_fabric.meshy.base.download
      :parser: myst