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

# /create/graph

```
URL: http://<db.host>:<db.port>/create/graph
```

Creates a new graph network using given nodes, edges, weights, and
restrictions.

IMPORTANT: It's highly recommended that you review the
[Graphs and Solvers](../../graph_solver/network_graph_solver/) concepts
documentation, the [Graph REST Tutorial](../../guides/graph_rest_guide/),
and/or some [graph examples](/content/guides/tags/graph) before using this
endpoint.

## Input Parameter Description

<ParamField body="graph_name" type="string">
  Name of the graph resource to generate.
</ParamField>

<ParamField body="directed_graph" type="boolean">
  If set to *true*, the graph will be directed. If set to *false*, the graph will not be directed. Consult [Directed Graphs](../../graph_solver/network_graph_solver/#directed-graphs) for more details.

  The default value is `true`.

  The supported values are:

  * true
  * false
</ParamField>

<ParamField body="nodes" type="array of strings">
  Nodes represent fundamental topological units of a graph. Nodes must be specified using [identifiers](../../graph_solver/network_graph_solver/#identifiers); identifiers are grouped as [combinations](../../graph_solver/network_graph_solver/#id-combos). Identifiers can be used with existing column names, e.g., 'table.column AS NODE\_ID', expressions, e.g., 'ST\_MAKEPOINT(column1, column2) AS NODE\_WKTPOINT', or constant values, e.g., '\{9, 10, 11} AS NODE\_ID'. If using constant values in an identifier combination, the number of values specified must match across the combination.
</ParamField>

<ParamField body="edges" type="array of strings">
  Edges represent the required fundamental topological unit of a graph that typically connect nodes. Edges must be specified using [identifiers](../../graph_solver/network_graph_solver/#identifiers); identifiers are grouped as [combinations](../../graph_solver/network_graph_solver/#id-combos). Identifiers can be used with existing column names, e.g., 'table.column AS EDGE\_ID', expressions, e.g., 'SUBSTR(column, 1, 6) AS EDGE\_NODE1\_NAME', or constant values, e.g., "\{'family', 'coworker'} AS EDGE\_LABEL". If using constant values in an identifier combination, the number of values specified must match across the combination.
</ParamField>

<ParamField body="weights" type="array of strings">
  Weights represent a method of informing the graph solver of the cost of including a given edge in a solution. Weights must be specified using [identifiers](../../graph_solver/network_graph_solver/#identifiers); identifiers are grouped as [combinations](../../graph_solver/network_graph_solver/#id-combos). Identifiers can be used with existing column names, e.g., 'table.column AS WEIGHTS\_EDGE\_ID', expressions, e.g., 'ST\_LENGTH(wkt) AS WEIGHTS\_VALUESPECIFIED', or constant values, e.g., '\{4, 15} AS WEIGHTS\_VALUESPECIFIED'. If using constant values in an identifier combination, the number of values specified must match across the combination.
</ParamField>

<ParamField body="restrictions" type="array of strings">
  Restrictions represent a method of informing the graph solver which edges and/or nodes should be ignored for the solution. Restrictions must be specified using [identifiers](../../graph_solver/network_graph_solver/#identifiers); identifiers are grouped as [combinations](../../graph_solver/network_graph_solver/#id-combos). Identifiers can be used with existing column names, e.g., 'table.column AS RESTRICTIONS\_EDGE\_ID', expressions, e.g., 'column/2 AS RESTRICTIONS\_VALUECOMPARED', or constant values, e.g., '\{0, 0, 0, 1} AS RESTRICTIONS\_ONOFFCOMPARED'. If using constant values in an identifier combination, the number of values specified must match across the combination.
</ParamField>

<ParamField body="options" type="map of string to strings">
  Optional parameters.

  The default value is an empty map ( \{} ).

  <Expandable title="options">
    <ParamField body="merge_tolerance">
      If node geospatial positions are input (e.g., WKTPOINT, X, Y), determines the minimum separation allowed between unique nodes. If nodes are within the tolerance of each other, they will be merged as a single node.

      The default value is `1.0E-5`.
    </ParamField>

    <ParamField body="recreate">
      If set to *true* and the graph (using input parameter *graph\_name*) already exists, the graph is deleted and recreated.

      The default value is `false`.

      The supported values are:

      * true
      * false
    </ParamField>

    <ParamField body="save_persist">
      If set to *true*, the graph will be saved in the persist directory (see the [config reference](../../config/#config-main-persistence) for more information). If set to *false*, the graph will be removed when the graph server is shutdown.

      The default value is `false`.

      The supported values are:

      * true
      * false
    </ParamField>

    <ParamField body="add_table_monitor">
      Adds a table monitor to every table used in the creation of the graph; this table monitor will trigger the graph to update dynamically upon inserts to the source table(s). Note that upon database restart, if *save\_persist* is also set to *true*, the graph will be fully reconstructed and the table monitors will be reattached. For more details on table monitors, see [/create/tablemonitor](/content/api/rest/create_tablemonitor_rest).

      The default value is `false`.

      The supported values are:

      * true
      * false
    </ParamField>

    <ParamField body="graph_table">
      If specified, the created graph is also created as a table with the given name, in \[schema\_name.]table\_name format, using standard [name resolution rules](../../concepts/tables/#table-name-resolution) and meeting [table naming criteria](../../concepts/tables/#table-naming-criteria). The table will have the following identifier columns: 'EDGE\_ID', 'EDGE\_NODE1\_ID', 'EDGE\_NODE2\_ID'. If left blank, no table is created.

      The default value is ''.
    </ParamField>

    <ParamField body="add_turns">
      Adds dummy 'pillowed' edges around intersection nodes where there are more than three edges so that additional weight penalties can be imposed by the solve endpoints. (increases the total number of edges).

      The default value is `false`.

      The supported values are:

      * true
      * false
    </ParamField>

    <ParamField body="is_partitioned">
      The default value is `false`.

      The supported values are:

      * true
      * false
    </ParamField>

    <ParamField body="server_id">
      Indicates which graph server(s) to send the request to. Default is to send to the server with the most available memory.
    </ParamField>

    <ParamField body="use_rtree">
      Use an range tree structure to accelerate and improve the accuracy of snapping, especially to edges.

      The default value is `true`.

      The supported values are:

      * true
      * false
    </ParamField>

    <ParamField body="label_delimiter">
      If provided the label string will be split according to this delimiter and each sub-string will be applied as a separate label onto the specified edge.

      The default value is ''.
    </ParamField>

    <ParamField body="allow_multiple_edges">
      Multigraph choice; allowing multiple edges with the same node pairs if set to true, otherwise, new edges with existing same node pairs will not be inserted.

      The default value is `true`.

      The supported values are:

      * true
      * false
    </ParamField>

    <ParamField body="embedding_table">
      If table exists (should be generated by the match/graph match\_embedding solver), the vector embeddings for the newly inserted nodes will be appended into this table.

      The default value is ''.
    </ParamField>
  </Expandable>
</ParamField>

## Output Parameter Description

The Kinetica server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query.  Here is a description of the various fields of the wrapper:

<ResponseField name="status" type="String">
  'OK' or 'ERROR'
</ResponseField>

<ResponseField name="message" type="String">
  Empty if success or an error message
</ResponseField>

<ResponseField name="data_type" type="String">
  'create\_graph\_response' or 'none' in case of an error
</ResponseField>

<ResponseField name="data" type="String">
  Empty string
</ResponseField>

<ResponseField name="data_str" type="JSON or String">
  This embedded JSON represents the result of the /create/graph endpoint:

  <Expandable title="data_str">
    <ResponseField name="result" type="boolean">
      Indicates a successful creation on all servers.
    </ResponseField>

    <ResponseField name="num_nodes" type="long">
      Total number of nodes created.
    </ResponseField>

    <ResponseField name="num_edges" type="long">
      Total number of edges created.
    </ResponseField>

    <ResponseField name="edges_ids" type="array of longs">
      \[Deprecated] Edges given as pairs of node indices. Only populated if export\_create\_results internal option is set to true.
    </ResponseField>

    <ResponseField name="info" type="map of string to strings">
      Additional information.
    </ResponseField>
  </Expandable>

  Empty string in case of an error.
</ResponseField>
