To query the nodegoat API you need a valid domain, a valid path, and a valid query component. The following example URLs contain some of the possible basic domain, path, and query parameters:

Unauthenticated domain 'demo', access default Project, get the OpenAPI description:

GET 'https://demo.nodegoat.io/.openapi'

Unauthenticated domain 'demo', access default Project, inspect the Project as an MCP server:

GET 'https://demo.nodegoat.io/.mcp'

Authenticated, access Project 1, access Project’s data, Type 2, apply Scope 3, apply Filter 4, request Object 5 & 6 & 7, request Object 8, quick search for 'A', apply a JSON-formatted filter form:

GET 'https://nodegoat.io/project/1/data/type/2/scope/3/filter/4/object/5,6,7?object_id=8&search=A&filter={}' -H 'Authorization: Bearer TOKEN'

Authenticated, access Project 1, access Project’s data Model, request Types 2 & 3 & 4

GET 'https://nodegoat.io/project/1/model/type/2,3,4' -H 'Authorization: Bearer TOKEN'

Authenticated, access Project 1, access Project’s Filters, request Filter 2 & 3:

GET 'https://nodegoat.io/project/1/feature/filter/2,3' -H 'Authorization: Bearer TOKEN'

Domain

The domain indicates whether you are creating an authenticated or unauthenticated/open request.

Authenticated

When making an authenticated request, HTTPS is required and should query nodegoat’s main API domain at nodegoat.io or api.nodegoat.net.

Unauthenticated

To make an unauthenticated request, you use the subdomain of your nodegoat Domain’s to query the nodegoat API over unencrypted HTTP at DOMAIN.nodegoat.io or api.DOMAIN.nodegoat.net. When you have an institutional installation of nodegoat you use the main API domain, you also have the option to use HTTPS.

Path

The path tells the API what Project and what data you want to access.

//nodegoat/A

Specify which nodegoat Project to access. Optional.

//nodegoat/A.openapi

Append .openapi to access the OpenAPI description for using the nodegoat API with the selected Project. The .openapi is set-up to provide a full machine-readable and promptable description for the Project. Optional.

//nodegoat/A.mcp

Append .mcp to access the selected Project as an MCP server. The .mcp is generated from the Project’s .openapi description and presents every operation as a tool an AI client can call. Optional.

An MCP client connects over Streamable HTTP: it posts its JSON-RPC to the .mcp URL with Content-Type: application/json and Accept: application/json, text/event-stream. The Authorization header is passed on to the API, so an authenticated MCP client has the same access as an authenticated request. Any other request to .mcp returns the server’s identity, its instructions, and its tools, showing what an AI client is presented with.

//nodegoat/A/B

Specify the mode. One of the following parameters has to be provided.

//nodegoat/A/B:data/C

Specify for which Type you want to access the data.

//nodegoat/A/B:data/C/D

Apply Project- and Type-specific operations to the request. More than one of the following parameters can be provided. Optional.

//nodegoat/A/B:data/C/D/E

Specify the data requested.

//nodegoat/A/B:model/C

Specify for which Type(s) to access the data Model.

//nodegoat/A/B:feature/C

Specify which Project feature to access. One of the following parameters has to be provided.

//nodegoat/A/B:feature/C/D

Specify which of the stored features to access. Optional.

//nodegoat/A/B:graph/C

Specify for which Type to access the graph's available Analysis settings.

//nodegoat/A/B:graph/C/D

Apply Project- and Type-specific operations to the request. Optional.

//nodegoat/A/B:graph/C/D/E

Get the graph from Analysis.

Component

The query component allows you to further specify your request by means of search parameters. It is also possible to POST the query component instead of using GET (e.g. when using JSON in the request).

//nodegoat/A/B:data/C/D/E?Q

All parameters in the query component are optional. When combined, each additional parameter will filter the result (AND).

Query the API for a Type's data Model to get an overview of the possible IDs for Object Descriptions, Sub-Object Details, and Sub-Object Descriptions.

{
"object": {
"object_name": "direction",
"object_analysis": "direction",
"object_description_ID": "direction",
"date": "direction"
},
"object_subs": {
Sub-Object Details ID: {
"object_sub_details_name": "direction",
"object_sub_details_date_start": "direction",
"object_sub_details_date_end": "direction",
"object_sub_description_ID": "direction"
}
}
}

//nodegoat/A/B:model/C?Q

All parameters in the query component are optional.

//nodegoat/A/B:feature/C?Q

All parameters in the query component are optional.

Response: Model & Data

The result from your request to the nodegoat API can be found in the JSON response under the key data. The result is a JSON dictionary that promotes direct lookup and access to its structure.

The specific response depends on the mode (model or data, see the previous Query section) of your request.

Model

In mode = model the result contains the requested Type IDs with the Type's configuration.

Data

In mode = data the result contains the requested or queried Object IDs with the Object's definition.

Response: Feature

The result from your request to the nodegoat API can be found in the JSON response under the key data.

In mode = feature the result contains the requested Filters, Scopes, or Conditions under the key filters, scopes, or conditions. Each holds its own ID, the ID of the Type it belongs to, its name and description, and the form as it is stored, ready to be copied into the query component and adjusted. A Filter that has Endpoint Dictionary parameters lists those under parameters. A Condition that reaches other Types lists those under model_conditions.

The key instructions describes how to compose a Filter or a Scope form, and what a Condition changes in the output.

Response: Graph

The result from your request to the nodegoat API is a CSV file that includes the following columns:

• key Identifier for the edge
• from Start node
• to End node
• weight
• time When applicable, this includes a sequence (white-space   separated) of start and end timestamps (comma , separated)