BREAGEN Logo
Knowledge Graph

Visual Link Analysis

VLA Operations - Upload CSV POST /v1/api/vla/upload_csv

Resource URL/v1/api/vla/upload_csv
Response FormatJSON
Requires AuthenticationNot specified
Rate LimitedNot specified
HTTPSAssumed Yes

Parameters

ParameterDescriptionRequiredTypeDefault Value
graph_nameName of the graphYesStringN/A
fileCSV file to uploadYesBinaryN/A

Example Request

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

Example Response

{
    "is_error": false,
    "message": "CSV uploaded successfully",
    "results": {
        "graph_name": "example_graph",
        "upload_id": "xyz789"
    }
}

HTTP Responses

HTTP CodeMessage
200Successful Response
422Validation Error

VLA Operations - Get Graph Type GET /v1/api/vla/graph_type

Resource URL/v1/api/vla/graph_type
Response FormatJSON
Requires AuthenticationNot specified
Rate LimitedNot specified
HTTPSAssumed Yes

Parameters

ParameterDescriptionRequiredTypeDefault Value
graph_idID of the graphYesStringN/A
graph_typeType of the graphYesStringN/A

Example Request

curl -X 'GET' \
'https://braegen.ai/v1/api/vla/graph_type?graph_id=123&graph_type=bar' \
-H 'accept: application/json'

Example Response

{
    "is_error": false,
    "message": "Graph type retrieved successfully",
    "results": {
        "graph_id": "123",
        "graph_type": "bar"
    }
}

HTTP Responses

HTTP CodeMessage
200Successful Response
422Validation Error

VLA Operations - Generate Correlation Graph GET /v1/api/vla/opportunity/{opportunity_id}

Resource URL/v1/api/vla/opportunity/{opportunity_id}
Response FormatJSON
Requires AuthenticationNot specified
Rate LimitedNot specified
HTTPSAssumed Yes

Parameters

ParameterDescriptionRequiredTypeDefault Value
opportunity_idID of the opportunityYesStringN/A

Example Request

curl -X 'GET' \
'https://braegen.ai/v1/api/vla/opportunity/opp123' \
-H 'accept: application/json'

Example Response

{
    "is_error": false,
    "message": "Correlation graph generated successfully",
    "results": {
        "opportunity_id": "opp123",
        "correlation_graph": {
            "nodes": [{"id": "1", "name": "VariableA"}, {"id": "2", "name": "VariableB"}],
            "edges": [{"source": "1", "target": "2", "correlation": 0.85}]
        }
    }
}

HTTP Responses

HTTP CodeMessage
200Successful Response
422Validation Error

VLA Operations - Get Document Kg GET /v1/api/vla/document/{document_id}

Resource URL/v1/api/vla/document/{document_id}
Response FormatJSON
Requires AuthenticationNot specified
Rate LimitedNot specified
HTTPSAssumed Yes

Parameters

ParameterDescriptionRequiredTypeDefault Value
document_idID of the documentYesStringN/A

Example Request

curl -X 'GET' \
'https://braegen.ai/v1/api/vla/document/doc123' \
-H 'accept: application/json'

Example Respomse

{
    "is_error": false,
    "message": "Document knowledge graph retrieved successfully",
    "results": {
        "document_id": "doc123",
        "knowledge_graph": {
            "nodes": [{"id": "1", "label": "EntityA"}, {"id": "2", "label": "EntityB"}],
            "edges": [{"source": "1", "target": "2", "relation": "related_to"}]
        }
    }
}

HTTP Responses

HTTP CodeMessage
200Successful Response
422Validation Error

Previous

Shareholder Graph

Next

Fetcher Management

On this page