Skip to content

by Startups.Studio

Handle.create

POST /{namespace}/handles

Creates a Handle.

Noun: Handle
Mode: do
Event: Handle.created

You, to your agent

Add a handle to QuietCopy.

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

import { $ } from 'startup-builder'

const handle = await $.Handle.create({ venue: 'Example venue', name: 'QuietCopy' })

npx startup-builder do Handle.create --json '{"venue":"Example venue","name":"QuietCopy"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Handle.create({ venue: 'Example venue', name: 'QuietCopy' })"
  }
}

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

Inputs

Input	Type	Required	Description
`venue`	`string`	required	The venue it lives on, by id.
`name`	`string`	required	The name as the platform shows it, such as `@example`.
`shared`	`boolean`		True for a Studio account shared across sibling Startups; every Post names the Startup it speaks for.
`agent`	`boolean`		True when an Agent runs it; its bio says so.
`integration`	Integration		The Integration credential it publishes through.

Outputs

Output	Type	Required	Description
`handle`	Handle	required	The Handle.

Effects

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

Handle.connect

Previous Page

Handle.get

Next Page