Sign in
v1/Links

Create a new link between blocks

Changed on

Creates a directed link between two memory blocks with a specified relation type.

post/api/v1/links

Request

  • The document declares no server URL.
  • Auth: none declared

Query parameters

from_idstring required
to_idstring required
relation'related_to' | 'mentions' | 'child_of' | 'parent_of' | 'duplicate_of' | 'part_of' | 'contains' | 'requires' | 'provides' | 'owned_by' | 'owns' | 'subtask_of' | 'depends_on' | 'blocks' | 'is_blocked_by' | 'belongs_to_epic' | 'epic_contains' | 'bug_affects' | 'has_bug' | 'derived_from' | 'supersedes' | 'references' | 'source_of' | 'cited_by' required
priorityinteger
created_bystring nullable

Request body

object nullable required

Response

Successful Response

to_idstring required

ID of the target block in the link

from_idstring required

ID of the source block in the link

relation'related_to' | 'mentions' | 'child_of' | 'parent_of' | 'duplicate_of' | 'part_of' | 'contains' | 'requires' | 'provides' | 'owned_by' | 'owns' | 'subtask_of' | 'depends_on' | 'blocks' | 'is_blocked_by' | 'belongs_to_epic' | 'epic_contains' | 'bug_affects' | 'has_bug' | 'derived_from' | 'supersedes' | 'references' | 'source_of' | 'cited_by' required

The type of relationship between the blocks

priorityinteger nullable

Priority of the link (higher numbers = higher priority)

link_metadataobject nullable

Additional metadata about the link

created_bystring nullable

ID of the agent/user who created the link

created_atstring date-time

When the link was created

Changes