Using JetStream API
===================

There are two ways of working with JetStream API:

1. Python API
2. Command Line API (e.g. bash)

Both interfaces accept the same functions and arguments.

Python
------
The Python API module can be integrated into other projects or tools, and is completely independent and does not require any of the JetStream Server binaries.

.. seealso::
  * :doc:`/api/python/index`


Command Line
------------

The command line API relies on the :command:`jetstream` server executable, however, you do not need a license to use the JetStream API. The :command:`jetstream` executable can be found in:

  * Linux: ``/usr/local/bin/jetstream``
  * MacOS: ``/usr/local/jetstream/bin/jetstream``
  * Windows: ``C:\Program Files\Jet Digital Inc\JetStream Server\bin\jetstream.exe``
  
The JetStream Client API executable can be found in:
    
  * Linux: ``/usr/local/bin/jetstream-apiclient``
  * MacOS: ``/usr/local/jetstream-apiclient/bin/jetstream-apiclient-service``
  * Windows: ``C:\Program Files\Jet Digital Inc\JetStream API Client\bin\jetstream-apiclient-service.exe``

To access the API, specify the ``api`` subcommand:

.. code-block:: none

    jetstream api

For a list of API commands add a ``help`` parameter:

.. code-block:: shell-session

    jetstream api help

For detailed help about a particular API function, run the following command, or refer to the :doc:`/api/python/index`.

.. code-block:: none

    jetstream api help [api-function]

.. seealso::
  For further help with the :command:`jetstream api` command, refer to :doc:`/api/console/index`.

