> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt
> Use this file to discover all available pages before exploring further.

# CreateVideoRequest

> CreateVideoRequest — Kinetica TypeScript API

<div className="kinetica-typedoc">
  <div className="tsd-page-title" />

  <div className="tsd-signature"><span className="tsd-signature-keyword">interface</span> <span className="tsd-kind-interface">CreateVideoRequest</span> <span className="tsd-signature-symbol">{"{"}</span><br /> <a className="tsd-kind-property" href="#attribute">attribute</a><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">string</span><span className="tsd-signature-symbol">;</span><br /> <a className="tsd-kind-property" href="#begin">begin</a><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">string</span><span className="tsd-signature-symbol">;</span><br /> <a className="tsd-kind-property" href="#duration_seconds">duration\_seconds</a><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">number</span><span className="tsd-signature-symbol">;</span><br /> <a className="tsd-kind-property" href="#end">end</a><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">string</span><span className="tsd-signature-symbol">;</span><br /> <a className="tsd-kind-property" href="#frames_per_second">frames\_per\_second</a><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">number</span><span className="tsd-signature-symbol">;</span><br /> <a className="tsd-kind-property" href="#options">options</a><span className="tsd-signature-symbol">?:</span> <span className="tsd-signature-type">Record</span><span className="tsd-signature-symbol">\<</span><span className="tsd-signature-type">string</span><span className="tsd-signature-symbol">,</span> <span className="tsd-signature-type">string</span><span className="tsd-signature-symbol">></span><span className="tsd-signature-symbol">;</span><br /> <a className="tsd-kind-property" href="#path">path</a><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">string</span><span className="tsd-signature-symbol">;</span><br /> <a className="tsd-kind-property" href="#style">style</a><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">string</span><span className="tsd-signature-symbol">;</span><br /> <a className="tsd-kind-property" href="#style_parameters">style\_parameters</a><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">string</span><span className="tsd-signature-symbol">;</span><br /><span className="tsd-signature-symbol">{"}"}</span></div>

  <div className="aside tsd-sources">
    <ul>
      <li>Defined in <a href="https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L2153">src/types.ts:2153</a></li>
    </ul>
  </div>

  <div className="section tsd-panel-group tsd-index-group">
    <div className="section tsd-panel tsd-index-panel">
      <div className="details tsd-index-content tsd-accordion" open="">
        <div className="summary tsd-accordion-summary tsd-index-summary">
          <h5 className="tsd-index-heading uppercase">Index</h5>
        </div>

        <div className="tsd-accordion-details">
          <div className="section tsd-index-section">
            <h3 className="tsd-index-heading tsd-anchor-link" id="properties">Properties</h3>
            <div className="tsd-index-list"><a href="#attribute" className="tsd-index-link"><span>attribute</span></a> <a href="#begin" className="tsd-index-link"><span>begin</span></a> <a href="#duration_seconds" className="tsd-index-link"><span>duration\_seconds</span></a> <a href="#end" className="tsd-index-link"><span>end</span></a> <a href="#frames_per_second" className="tsd-index-link"><span>frames\_per\_second</span></a> <a href="#options" className="tsd-index-link"><span>options?</span></a> <a href="#path" className="tsd-index-link"><span>path</span></a> <a href="#style" className="tsd-index-link"><span>style</span></a> <a href="#style_parameters" className="tsd-index-link"><span>style\_parameters</span></a> </div>
          </div>
        </div>
      </div>
    </div>
  </div>

  <div className="details tsd-panel-group tsd-member-group tsd-accordion" open="">
    <div className="summary tsd-accordion-summary" data-key="section-Properties">
      <h2 className="tsd-anchor-link" id="properties-1">Properties</h2>
    </div>

    <div className="section">
      <div className="section tsd-panel tsd-member">
        <h3 className="tsd-anchor-link" id="attribute"><span>attribute</span></h3>
        <div className="tsd-signature"><span className="tsd-kind-property">attribute</span><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">string</span></div>

        <div className="tsd-comment tsd-typography">
          <p>The animated attribute to map to the video's frames. Must be present in the LAYERS specified for the visualization. This is often a time-related field but may be any numeric type.</p>
        </div>

        <div className="aside tsd-sources">
          <ul>
            <li>Defined in <a href="https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L2155">src/types.ts:2155</a></li>
          </ul>
        </div>
      </div>

      <div className="section tsd-panel tsd-member">
        <h3 className="tsd-anchor-link" id="begin"><span>begin</span></h3>
        <div className="tsd-signature"><span className="tsd-kind-property">begin</span><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">string</span></div>

        <div className="tsd-comment tsd-typography">
          <p>The start point for the video. Accepts an expression evaluable over the <code>attribute</code>.</p>
        </div>

        <div className="aside tsd-sources">
          <ul>
            <li>Defined in <a href="https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L2157">src/types.ts:2157</a></li>
          </ul>
        </div>
      </div>

      <div className="section tsd-panel tsd-member">
        <h3 className="tsd-anchor-link" id="duration_seconds"><span>duration\_seconds</span></h3>
        <div className="tsd-signature"><span className="tsd-kind-property">duration\_seconds</span><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">number</span></div>

        <div className="tsd-comment tsd-typography">
          <p>Seconds of video to produce.</p>
        </div>

        <div className="aside tsd-sources">
          <ul>
            <li>Defined in <a href="https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L2159">src/types.ts:2159</a></li>
          </ul>
        </div>
      </div>

      <div className="section tsd-panel tsd-member">
        <h3 className="tsd-anchor-link" id="end"><span>end</span></h3>
        <div className="tsd-signature"><span className="tsd-kind-property">end</span><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">string</span></div>

        <div className="tsd-comment tsd-typography">
          <p>The end point for the video. Accepts an expression evaluable over the <code>attribute</code>.</p>
        </div>

        <div className="aside tsd-sources">
          <ul>
            <li>Defined in <a href="https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L2161">src/types.ts:2161</a></li>
          </ul>
        </div>
      </div>

      <div className="section tsd-panel tsd-member">
        <h3 className="tsd-anchor-link" id="frames_per_second"><span>frames\_per\_second</span></h3>
        <div className="tsd-signature"><span className="tsd-kind-property">frames\_per\_second</span><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">number</span></div>

        <div className="tsd-comment tsd-typography">
          <p>The presentation frame rate of the encoded video in frames per second.</p>
        </div>

        <div className="aside tsd-sources">
          <ul>
            <li>Defined in <a href="https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L2163">src/types.ts:2163</a></li>
          </ul>
        </div>
      </div>

      <div className="section tsd-panel tsd-member">
        <h3 className="tsd-anchor-link" id="options"><code className="tsd-tag">Optional</code><span>options</span></h3>
        <div className="tsd-signature"><span className="tsd-kind-property">options</span><span className="tsd-signature-symbol">?:</span> <span className="tsd-signature-type">Record</span><span className="tsd-signature-symbol">\<</span><span className="tsd-signature-type">string</span><span className="tsd-signature-symbol">,</span> <span className="tsd-signature-type">string</span><span className="tsd-signature-symbol">></span></div>

        <div className="tsd-comment tsd-typography">
          <p>Optional parameters.</p>
        </div>

        <div className="aside tsd-sources">
          <ul>
            <li>Defined in <a href="https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L2171">src/types.ts:2171</a></li>
          </ul>
        </div>
      </div>

      <div className="section tsd-panel tsd-member">
        <h3 className="tsd-anchor-link" id="path"><span>path</span></h3>
        <div className="tsd-signature"><span className="tsd-kind-property">path</span><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">string</span></div>

        <div className="tsd-comment tsd-typography">
          <p>Fully-qualified KiFS path. Write access is required. A file must not exist at that path, unless replace\_if\_exists is true.</p>
        </div>

        <div className="aside tsd-sources">
          <ul>
            <li>Defined in <a href="https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L2167">src/types.ts:2167</a></li>
          </ul>
        </div>
      </div>

      <div className="section tsd-panel tsd-member">
        <h3 className="tsd-anchor-link" id="style"><span>style</span></h3>
        <div className="tsd-signature"><span className="tsd-kind-property">style</span><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">string</span></div>

        <div className="tsd-comment tsd-typography">
          <p>The name of the visualize mode; should correspond to the schema used for the <code>style\_parameters</code> field.</p>
        </div>

        <div className="aside tsd-sources">
          <ul>
            <li>Defined in <a href="https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L2165">src/types.ts:2165</a></li>
          </ul>
        </div>
      </div>

      <div className="section tsd-panel tsd-member">
        <h3 className="tsd-anchor-link" id="style_parameters"><span>style\_parameters</span></h3>
        <div className="tsd-signature"><span className="tsd-kind-property">style\_parameters</span><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">string</span></div>

        <div className="tsd-comment tsd-typography">
          <p>A string containing the JSON-encoded visualize request. Must correspond to the visualize mode specified in the <code>style</code> field.</p>
        </div>

        <div className="aside tsd-sources">
          <ul>
            <li>Defined in <a href="https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L2169">src/types.ts:2169</a></li>
          </ul>
        </div>
      </div>
    </div>
  </div>
</div>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.