.. _auto_simulation_get_time_history:

*GET TIME HISTORY RESPONSES*
============================

Retrieves time-history response data (forces, energies, displacements, etc.) from an LS-DYNA simulation stored in d3VIEW. Can enumerate available responses with metadata or return sampled curve data points, and renders results as either a Markdown table or structured JSON for downstream LLM or workflow consumption.

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

Tagged: ``binout``, ``curves``, ``displacements``, ``energies``, ``forces``, ``llm_tool``, ``lsdyna``, ``responses``.

Inputs
------

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

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - Simulation Id
     - simulation_id
     - remote_lookup
     - —
     - ✓
     - Unique platform identifier of the LS-DYNA simulation whose time-history responses will be queried; resolved via the simulations remote lookup — required, no default.
   * - Response Name Filter
     - response_name
     - text
     - —
     - 
     - Optional partial-match string to filter responses by name (e.g. 'Energy', 'Contact Force', 'Displacement'); leave blank (default) to return all responses.
   * - Response Type
     - response_type
     - select
     - all
     - 
     - Restricts results to vector (time-history curves), scalar (single-value), or all response types (default: 'all').
   * - Include Data Points
     - include_data
     - select
     - false
     - 
     - When set to 'true', attaches actual X/Y curve data sampled to a maximum of 50 points per response to avoid overloading LLM context; default 'false' returns summary metadata only.
   * - Output Format
     - format
     - select
     - markdown
     - 
     - Controls output serialization: 'markdown' (default) produces human-readable tables suited for LLM display; 'json' produces structured data for programmatic downstream use.

Outputs
-------

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

   * - Label
     - ID
     - Type
     - Description
   * - Time History Responses
     - responses
     - text
     - Formatted list of time-history responses including name, source, and type metadata; when include_data is enabled, each vector response also contains X/Y value ranges and up to 50 sampled data points, rendered as Markdown or JSON per the format input.

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

- ai_ml.agents
- cae.postprocessing.extraction
- cae.postprocessing.response

.. raw:: html

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