relationships

Create Relationship

Create a new relationship between two sources.

Args: request: CreateRelationshipRequest with relationship details relationship_service: Relationship service (injected via DI)

post/relationships

Request

  • Base URL: https://api.pandas-ai.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.pandas-ai.com/relationships
  • Auth: none declared

Request body

primary_source_idstring required

ID of the primary/left source

foreign_source_idstring required

ID of the foreign/right source

primary_columnstring required

Column name in primary source for joining

foreign_columnstring required

Column name in foreign source for joining

descriptionstring nullable

Optional description of the relationship

metadataobject nullable

Additional metadata

Response

Successful Response

idstring required
user_idstring required
primary_source_idstring required
foreign_source_idstring required
primary_columnstring required
foreign_columnstring required
descriptionstring nullable
metadataobject
created_atstring date-time required
updated_atstring date-time required
primary_source_namestring nullable
foreign_source_namestring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.