===============
File Upload API
===============

File Uploads
============

Example Use Inside of an Adapter Action

.. code-block:: python

    @action()
    async def file_upload(self, actx: ActionExecutionContext) -> None:
        await self.artificial_api.file_upload_api_v1.upload_file(
            actx=actx,
            file_contents=b'File contents',
            uploaded_filename='FileName.txt',
            description='Example File',
            notes='Example File Upload',
            metadata={'metadata_key': 'metadata_value'},
            tags=['tag_name'],
        )



.. automodule:: artificial.client.fileuploadapi.v1.fileuploadapi
   :members:
   :exclude-members:
   :undoc-members:

.. toctree::
   :maxdepth: 1
   :hidden: