Skip to content

by Startups.Studio

Core grammar Thing

Thing.relate

POST /{namespace}/things/{thing}/relate

Relate links two Things by a Relationship their Nouns declare, readable from both ends at once.

Noun: Thing
Mode: do
Event: Thing.related

You, to your agent

Relate the latest thing.

curl -X POST https://api.sb/shiftnote.app/things/thing_1/relate \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"predicate":"Example predicate","to":"thing_1"}'

import { $ } from 'startup-builder'

const { relationship, thing } = await $.Thing.relate({ thing: 'thing_1', predicate: 'Example predicate', to: 'thing_1' })

npx startup-builder do Thing.relate --json '{"thing":"thing_1","predicate":"Example predicate","to":"thing_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Thing.relate({ thing: 'thing_1', predicate: 'Example predicate', to: 'thing_1' })"
  }
}

Inputs

Input	Type	Required	Description
`thing`	Thing	required	The source Thing.
`predicate`	`string`	required	The Relationship as read from the source, such as `places`.
`to`	Thing	required	The target Thing.

Outputs

Output	Type	Required	Description
`relationship`	Relationship	required	The Relationship, with its provenance.
`thing`	Thing	required	The Thing the Relationship starts from.

Effects

Emits Thing.related.
Performed by the Data Engineer.
Two-way: it runs at once, in the try, send and do modes.
Refuses a predicate that neither Noun declares.
On a to-one Relationship, replaces the old target; the old link stays in history.

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.	Thing.relate
A predicate that neither Noun declares	`refused`	Clear what the check names, then call it again.	Thing.relate

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`.

Thing.list

Previous Page

Thing.resolve

Next Page