.. _auto_connection_restapi:

*REST-API CONNECTOR*
====================

Connects to an external REST API endpoint and retrieves records, including frame-level image/video data, using a configurable URL, API key, and optional query parameters. Use this worker to ingest remote datasets or video streams into the d3VIEW workflow via HTTP.

When to use
-----------

Tagged: ``api``, ``connection``, ``connector``, ``dataset``, ``frames``, ``http``, ``ingest``, ``movie``.

Inputs
------

.. list-table::
   :header-rows: 1
   :widths: 20 20 20 20 20 20

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - HTTP Url
     - url
     - input
     - —
     - ✓
     - Full HTTP/HTTPS endpoint URL of the REST API to call (e.g., https://api.example.com/v1/resource); must include protocol prefix.
   * - API Key
     - api_key
     - select
     - get_frames
     - ✓
     - Authentication/access mode for the API: choose 'Get Frames' to retrieve frame data using the built-in frames endpoint, or 'Custom' to supply a user-defined API/application key.
   * - Options
     - options
     - textarea
     - —
     - 
     - Optional comma-separated key=value query parameters appended to the request (e.g., 'a=b, c=d'); leave blank if no additional parameters are needed.

Outputs
-------

.. list-table::
   :header-rows: 1
   :widths: 20 20 20 20

   * - Label
     - ID
     - Type
     - Description
   * - Modified Movie
     - modified_movie
     - movie
     - Video/movie file reconstructed or returned from the REST API response, typically composed from the retrieved frames.
   * - Frames
     - data
     - dataset
     - Dataset of individual frames extracted from the API response, available for downstream image processing or analysis steps.

Disciplines
-----------

- data.dataset.ingest
- data.io.file
- platform.integration

.. raw:: html

   <hr style="margin-top:2em">
   <p style="font-size:11px;color:#888">
   Auto-generated from <code>platform</code> schema. Worker id: <code>connection_restapi</code>. Schema hash: <code>525405a28a32</code>. Hand-curated docs in <code>workerexamples/</code> override this page when present.
   </p>