Skip to content

by Startups.Studio

Team Credential

Credential.create

POST /{namespace}/credentials

Creates a Credential.

Noun: Credential
Mode: do
Event: Credential.created

You, to your agent

Add a credential to ShiftNote.

curl -X POST https://api.sb/shiftnote.app/credentials \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"issuer":"Example issuer","jurisdiction":"US-DE"}'

import { $ } from 'startup-builder'

const credential = await $.Credential.create({ issuer: 'Example issuer', jurisdiction: 'US-DE' })

npx startup-builder do Credential.create --json '{"issuer":"Example issuer","jurisdiction":"US-DE"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Credential.create({ issuer: 'Example issuer', jurisdiction: 'US-DE' })"
  }
}

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

Inputs

Input	Type	Required	Description
`issuer`	`string`	required	The regulator or registry that grants it.
`jurisdiction`	`string`	required	Where it applies.
`standing`	`string`		Whether it is in good standing, read fresh on every use.
`supplier`	Supplier		The Credentials a Supplier holds decide which Reserved Acts it may perform; standing is read fresh on every use.
`worker`	Worker		A Worker performs a Reserved Act only while it holds the Credential that authorizes it, in good standing.

Outputs

Output	Type	Required	Description
`credential`	Credential	required	The Credential.

Effects

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

Credential

Previous Page

Credential.delete

Next Page