Python SDK Reference

The Interactive Python SDK allows users to seamlessly connect to Interactive or Insight(Groot) and harness their powerful features for graph management, stored procedure management, and query execution.

Documentation for Service APIs

The Service APIs in interactive SDK are divided into five categories.

• GraphManagementApi

• ProcedureManagementApi

• JobManagementApi

• ServiceManagementApi

• QueryServiceApi

• VertexApi

• EdgeApi

All URIs are relative to ${INTERACTIVE_ADMIN_ENDPOINT}

Class	Method	HTTP request	Description	Interactive Support	Insight Support
GraphManagementApi	BulkLoading	POST /v1/graph/{graph_id}/dataloading		[x]	[ ]
GraphManagementApi	CreateGraph	POST /v1/graph		[x]	[x]
GraphManagementApi	DeleteGraph	DELETE /v1/graph/{graph_id}		[x]	[x]
GraphManagementApi	GetGraphMeta	GET /v1/graph/{graph_id}		[x]	[ ]
GraphManagementApi	GetGraphSchema	GET /v1/graph/{graph_id}/schema		[x]	[x]
GraphManagementApi	createVertexType	POST /v1/graph/{graph_id}/schema/vertex		[ ]	[x]
GraphManagementApi	updateVertexType	PUT /v1/graph/{graph_id}/schema/vertex		[ ]	[x]
GraphManagementApi	deleteVertexType	Delete /v1/graph/{graph_id}/schema/vertex		[ ]	[x]
GraphManagementApi	createEdgeType	POST /v1/graph/{graph_id}/schema/edge		[ ]	[x]
GraphManagementApi	updateEdgeType	PUT /v1/graph/{graph_id}/schema/edge		[ ]	[x]
GraphManagementApi	deleteEdgeType	Delete /v1/graph/{graph_id}/schema/edge		[ ]	[x]
GraphManagementApi	ListGraphs	GET /v1/graph		[x]	[ ]
GraphManagementApi	GetGraphStatistics	GET /v1/graph/{graph_id}/statistics		[x]	[ ]
GraphManagementApi	getSnapshotStatus	GET /v1/graph/{graph_id}/snapshot/{snapshot_id}/status		[ ]	[x]
JobManagementApi	CancelJob	DELETE /v1/job/{job_id}		[x]	[ ]
JobManagementApi	GetJobById	GET /v1/job/{job_id}		[x]	[ ]
JobManagementApi	ListJobs	GET /v1/job		[x]	[ ]
ProcedureManagementApi	CreateProcedure	POST /v1/graph/{graph_id}/procedure		[x]	[ ]
ProcedureManagementApi	DeleteProcedure	DELETE /v1/graph/{graph_id}/procedure/{procedure_id}		[x]	[ ]
ProcedureManagementApi	GetProcedure	GET /v1/graph/{graph_id}/procedure/{procedure_id}		[x]	[ ]
ProcedureManagementApi	ListProcedures	GET /v1/graph/{graph_id}/procedure		[x]	[ ]
ProcedureManagementApi	UpdateProcedure	PUT /v1/graph/{graph_id}/procedure/{procedure_id}		[x]	[ ]
ServiceManagementApi	GetServiceStatus	GET /v1/service/status		[x]	[x]
ServiceManagementApi	RestartService	POST /v1/service/restart		[x]	[ ]
ServiceManagementApi	StartService	POST /v1/service/start		[x]	[ ]
ServiceManagementApi	StopService	POST /v1/service/stop		[x]	[ ]
QueryServiceApi	CallProcedure	POST /v1/graph/{graph_id}/query		[x]	[ ]
QueryServiceApi	CallProcedureOnCurrentGraph	POST /v1/graph/current/query		[x]	[ ]
VertexApi	addVertex	POST /v1/graph/{graph_id}/vertex	Add vertex to the graph	[x]	[x]
VertexApi	getVertex	GET /v1/graph/{graph_id}/vertex	Get the vertex’s properties with vertex primary key.	[x]	[ ]
VertexApi	updateVertex	PUT /v1/graph/{graph_id}/vertex	Update vertex’s property	[x]	[x]
VertexApi	deleteVertex	DELETE /v1/graph/{graph_id}/vertex	Delete vertex from the graph	[ ]	[x]
EdgeApi	addEdge	POST /v1/graph/{graph_id}/edge	Add edge to the graph	[x]	[x]
EdgeApi	getEdge	GET /v1/graph/{graph_id}/edge	Get the edge’s properties with src and dst vertex primary keys.	[x]	[ ]
EdgeApi	updateEdge	PUT /v1/graph/{graph_id}/edge	Update edge’s property	[x]	[x]
EdgeApi	deleteEdge	DELETE /v1/graph/{graph_id}/edge	Delete the edge from the graph	[ ]	[x]

Documentation for Utilities APIs

• Driver

• Session

• Result

• Status

• Encoder&Decoder

Documentation for Data Structures

• APIResponseWithCode

• BaseEdgeType

• BaseEdgeTypeVertexTypePairRelationsInner

• BaseEdgeTypeVertexTypePairRelationsInnerXCsrParams

• BasePropertyMeta

• BaseVertexType

• BaseVertexTypeXCsrParams

• ColumnMapping

• CreateEdgeType

• CreateGraphRequest

• CreateGraphResponse

• CreateGraphSchemaRequest

• CreateProcedureRequest

• CreateProcedureResponse

• CreatePropertyMeta

• CreateVertexType

• DateType

• EdgeData

• EdgeMapping

• EdgeMappingDestinationVertexMappingsInner

• EdgeMappingSourceVertexMappingsInner

• EdgeMappingSourceVertexMappingsInnerColumn

• EdgeMappingTypeTriplet

• EdgeRequest

• EdgeStatistics

• FixedChar

• FixedCharChar

• GSDataType

• GetEdgeType

• GetGraphResponse

• GetGraphSchemaResponse

• GetGraphStatisticsResponse

• GetProcedureResponse

• GetPropertyMeta

• GetVertexType

• JobResponse

• JobStatus

• LongText

• Parameter

• PrimitiveType

• Property

• QueryRequest

• SchemaMapping

• SchemaMappingLoadingConfig

• SchemaMappingLoadingConfigDataSource

• SchemaMappingLoadingConfigFormat

• SchemaMappingLoadingConfigXCsrParams

• ServiceStatus

• StartServiceRequest

• StoredProcedureMeta

• StringType

• StringTypeString

• TemporalType

• TemporalTypeTemporal

• TimeStampType

• TypedValue

• UpdateProcedureRequest

• UploadFileResponse

• VarChar

• VarCharVarChar

• VertexData

• VertexEdgeRequest

• VertexMapping

• VertexRequest

• VertexStatistics

• VertexTypePairStatistics

Documentation For Authorization

Authentication is not supported yet, and we will be introducing authorization-related implementation in the near future.