Graph API Documentation

Overview

The Graph API Service provides endpoints for generating and managing organizational graphs, shareholder relationships, and Visual Link Analysis (VLA) functionality.

Endpoints

1. Shareholder Graph Creation

Initiate the process of creating a shareholder graph.

Endpoint: /v1/api/graph/shareholder
Method: POST
Content-Type: application/json

API Details

Request Body Parameters

Example Request

curl -X 'POST' \
  'https://your-api-domain.com/v1/api/graph/shareholder' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
    "link": "https://braegen.ai/data",
    "source_name": "Company Registry",
    "entity_id": "ENT123",
    "client_id": "CLIENT456",
    "levels": 3,
    "min_indirect_percentage": 10,
    "max_indirect_percentage": 100,
    "username": "john.doe",
    "session_id": "SESSION789"
  }'

2. Generated Graph Retrieval

Retrieve a generated graph using its request ID.

Endpoint: /v1/api/graphshareholder/{request_id}
Method: GET

API Details

Path Parameters

3. VLA CSV Upload

Upload a CSV file for Visual Link Analysis.

Endpoint: /v1/api/vla/upload_csv
Method: POST
Content-Type: multipart/form-data

API Details

Parameters

Example Request

curl -X 'POST' \
  'https://your-api-domain.com/v1/api/vla/upload_csv?graph_name=my_graph' \
  -H 'accept: application/json' \
  -H 'Content-Type: multipart/form-data' \
  -F '[email protected]'

4. Graph Type Retrieval

Get information about a specific graph type.

Endpoint: /v1/api/vla/graph_type
Method: GET

API Details

Query Parameters

Error Responses

Validation Error Response

{
	"detail": [
		{
			"loc": ["field_name"],
			"msg": "error message",
			"type": "error_type"
		}
	]
}

Response Codes

Notes

• File uploads must be in CSV format for VLA functionality
• Graph levels should be specified as positive integers
• Percentage thresholds should be between 0 and 100
• Authentication details should be specified by the implementation
• Rate limiting details should be specified by the implementation
• Session IDs should be maintained throughout the graph generation process