Skip to content

by Startups.Studio

Keyword.create

POST /{namespace}/keywords

Creates a Keyword.

Noun: Keyword
Mode: do
Event: Keyword.created

You, to your agent

Add a keyword to LedgerLark.

curl -X POST https://api.sb/ledgerlark.com/keywords \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"phrase":"Example phrase"}'

import { $ } from 'startup-builder'

const keyword = await $.Keyword.create({ phrase: 'Example phrase' })

npx startup-builder do Keyword.create --json '{"phrase":"Example phrase"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Keyword.create({ phrase: 'Example phrase' })"
  }
}

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

Inputs

Input	Type	Required	Description
`phrase`	`string`	required	The words searched or asked.
`form`	`string`		One of `search` or `question`.

Outputs

Output	Type	Required	Description
`keyword`	Keyword	required	The Keyword.

Effects

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

Keyword

Previous Page

Keyword.delete

Next Page