Get relationship overview

Interface Description

Read a compact overview of available file relationships.

Endpoint

Field	Value
Method	GET
Path	/openapi/v2/knowledge-bases/{knowledgeBaseId}/graph/overview
Operation ID	getGraphOverview
Authentication	Bearer OpenAPI key

Parameters

Name	Location	Required	Type	Example	Description
knowledgeBaseId	path	Yes	string	knowledge-base-11111111-1111-4111-8111-111111111111	Knowledge-base identifier returned by knowledge-base APIs.

Request Body

This operation has no request body.

Request Example

curl -X GET "https://openapi.example.com/openapi/v2/knowledge-bases/knowledge-base-11111111-1111-4111-8111-111111111111/graph/overview" \
  -H "Authorization: Bearer <openapi-key>"

Successful Responses

200

Relationship counts and links for exploring the currently readable knowledge-base version.

Field	Required	Type	Description
activeContentRevision	Yes	integer	Current readable knowledge-base content revision.
availability	Yes	available | empty | unavailable	Whether the readable knowledge-base version contains readable relationship data. An empty result does not mean the knowledge base is empty.
summary	Yes	object	File relationship counts.
resources	Yes	object	Relationship files and API links available for further exploration.
readActions	Yes	object	Developer OpenAPI links for reading this file or exploring its relationships.

Success Response Example

{
  "activeContentRevision": 1,
  "availability": "available",
  "summary": {
    "readableFileCount": 24,
    "relationshipCount": 18
  },
  "resources": {
    "graphIndexPath": "_graph/index.md",
    "byDirectoryPath": "_graph/by-directory",
    "byFilePath": "_graph/by-file"
  },
  "readActions": {
    "graphIndexContent": "/openapi/v2/knowledge-bases/knowledge-base-11111111-1111-4111-8111-111111111111/files/content?path=_graph%2Findex.md",
    "listGraphRoot": "/openapi/v2/knowledge-bases/knowledge-base-11111111-1111-4111-8111-111111111111/tree?parentPath=_graph",
    "listRelationshipsByDirectory": "/openapi/v2/knowledge-bases/knowledge-base-11111111-1111-4111-8111-111111111111/tree?parentPath=_graph%2Fby-directory",
    "listRelationshipsByFile": "/openapi/v2/knowledge-bases/knowledge-base-11111111-1111-4111-8111-111111111111/tree?parentPath=_graph%2Fby-file"
  }
}

Error Codes

The table below lists every error response documented for this operation.

HTTP Status	Error Code	Explanation
401	UNAUTHORIZED	The Bearer API key is missing, malformed, unknown, revoked, or deleted.
404	NOT_FOUND	The requested resource was not found.
429	RATE_LIMITED	The request exceeded the configured rate limits.
500	INTERNAL_ERROR	The API encountered an internal error.
503	DATABASE_REPOSITORY_UNAVAILABLE	The data required by this operation is temporarily unavailable.

Next Steps

• List file tree
• Search readable files