> ## 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.

# InsertSymbolRequest

> InsertSymbolRequest — Kinetica JavaScript API

interface InsertSymbolRequest \{\
&#x20;[options](#options)?: Record\<string, string>;\
&#x20;[symbol\_data](#symbol_data): string;\
&#x20;[symbol\_format](#symbol_format): string;\
&#x20;[symbol\_id](#symbol_id): string;\
}

<ul>
  <li>Defined in [src/types.ts:3881](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L3881)</li>
</ul>

##### Index

### Properties

[options?](#options) [symbol\_data](#symbol_data) [symbol\_format](#symbol_format) [symbol\_id](#symbol_id)&#x20;

## Properties

### `Optional`options

options?: Record\<string, string>

Optional parameters.

<ul>
  <li>Defined in [src/types.ts:3889](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L3889)</li>
</ul>

### symbol\_data

symbol\_data: string

The actual symbol data. If `symbol_format` is 'svg' then this should be the raw bytes representing an svg file. If `symbol_format` is svg path then this should be an svg path string; for example: 'M25.979,12.896,5.979,12.896,5.979,19.562,25.979,19.562z'.

<ul>
  <li>Defined in [src/types.ts:3887](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L3887)</li>
</ul>

### symbol\_format

symbol\_format: string

Specifies the symbol format. Must be either 'svg' or 'svg\_path'.

<ul>
  <li>Defined in [src/types.ts:3885](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L3885)</li>
</ul>

### symbol\_id

symbol\_id: string

The id of the symbol being added. This is the same id that should be in the 'SYMBOLCODE' column for objects using this symbol.

<ul>
  <li>Defined in [src/types.ts:3883](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L3883)</li>
</ul>


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