Skip to content

by Startups.Studio

Product Build and ship Mapping

Mapping.create

POST /{namespace}/mappings

Creates a Mapping.

Noun: Mapping
Mode: do
Event: Mapping.created

You, to your agent

Add a mapping to Kiln Bakery.

curl -X POST https://api.sb/kilnbakery.com/mappings \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"verb":"Meeting.book"}'

import { $ } from 'startup-builder'

const mapping = await $.Mapping.create({ verb: 'Meeting.book' })

npx startup-builder do Mapping.create --json '{"verb":"Meeting.book"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Mapping.create({ verb: 'Meeting.book' })"
  }
}

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

Inputs

Input	Type	Required	Description
`verb`	`string`		The Verb it serves, such as `Meeting.book`; a Verb has many Mappings, ranked.
`fields`	`json`		Each outside field or event and the Noun property or Event it maps to.
`direction`	`string`		`both` still keeps db.sb the record; the outside tool never becomes a second one.
`convert`	`text`		How a value changes on the way, such as cents to money or a picklist to closed values.
`rank`	`integer`		Order tried when the preferred Mapping fails or finds nothing; the Policy orders it by cost per accepted result.
`preferred`	`boolean`		True for the Mapping a Verb tries first.
`door`	`string`		How the outside endpoint is classed; an unclassed write is one-way and waits its delay window.
`source`	Source		A Source reaches the registry’s Nouns and Verbs through its Mappings, one per Verb it serves.

Outputs

Output	Type	Required	Description
`mapping`	Mapping	required	The Mapping.

Effects

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

Mapping

Previous Page

Mapping.delete

Next Page