Skip to main content
POST
Get artifact relationships

Authorizations

Authorization
string
header
required

API Key authentication using Bearer token. Example: "Authorization: Bearer {apiKey}"

Body

identifier
null | string
required

Full artifact identifier from a previous search, fetch, or relationship result.

output_format
null | enum<string>

Optional success projection. Omit to return both obj and rendered; use json for obj only; use agentic for rendered text only. Repairable errors always return both obj.error and rendered.

Available options:
json,
agentic
profile
null | enum<string>

Relationship profile. Default is calls_only.

Available options:
calls_only,
inheritance_only,
all_relevant,
references_only
max_count_per_type
null | integer<int32>

Maximum relationships to return per relationship type. Default is 50.

data_source
null | string

Optional repository or workspace name/id used to disambiguate the identifier.

Response

Success envelope. obj describes the traversal: sourceIdentifier, profile, found, relationships[] grouped by relationType with items[] (identifier, filePath, startLine, shortSummary) and truncation flags, plus availableRelationshipCounts; rendered is the JSON-serialized form of obj. Repairable failures (missing or invalid arguments, ambiguous or unknown data sources) also return HTTP 200 with obj.error = { code, message, retry, try } and a rendered <tool_error> block; repair the arguments and retry.

obj
any

Arbitrary JSON result for the tool. Present for omitted/json success projections and every repairable error.

rendered
null | string

Agent-facing result text. Present for omitted/agentic success projections and every repairable error.