Skip to content

by Startups.Studio

Core grammar Relationship

Relationship.create

POST /{namespace}/relationships

Creates a Relationship.

Noun: Relationship
Mode: do
Event: Relationship.created

You, to your agent

Add a relationship to QuietCopy.

curl -X POST https://api.sb/quietcopy.com/relationships \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"predicate":"Example predicate","inverse":"Example inverse"}'

import { $ } from 'startup-builder'

const relationship = await $.Relationship.create({ predicate: 'Example predicate', inverse: 'Example inverse' })

npx startup-builder do Relationship.create --json '{"predicate":"Example predicate","inverse":"Example inverse"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Relationship.create({ predicate: 'Example predicate', inverse: 'Example inverse' })"
  }
}

Create makes a new Relationship from the inputs below. It is inherited: every Noun has get, list, create, update and delete.

Inputs

Input	Type	Required	Description
`predicate`	`string`	required	The name read from the source, such as `makes`.
`inverse`	`string`	required	The name read from the target, such as `madeBy`.
`provenance`	`string`		Who asserted it: `Stated`, `Ratified`, `Inferred`, or `Observed`.
`verb`	Verb		A Relationship reads through a Verb whose forms name it from each side, such as `makes` and `madeBy`.

Outputs

Output	Type	Required	Description
`relationship`	Relationship	required	The Relationship.

Effects

Emits Relationship.created.
Two-way: try, send, do.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	Relationship.create

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Relationship

Previous Page

Relationship.delete

Next Page