Skip to content

by Startups.Studio

Cohort.create

POST /{namespace}/cohorts

Creates a Cohort.

Noun: Cohort
Mode: do
Event: Cohort.created

You, to your agent

Add a cohort to ShiftNote.

curl -X POST https://api.sb/shiftnote.app/cohorts \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":{}}'

import { $ } from 'startup-builder'

const cohort = await $.Cohort.create({ query: {} })

npx startup-builder do Cohort.create --json '{"query":{}}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Cohort.create({ query: {} })"
  }
}

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

Inputs

Input	Type	Required	Description
`query`	`json`	required	The Portfolio query that selects its Startups.
`control`	`boolean`		True when the Cohort stays on the prior Version as the control.
`portfolio`	Portfolio		A Cohort selects its Startups from one Portfolio by a saved query.
`version`	Version		Every Startup in a Cohort runs the same Version of a shared definition; a control Cohort keeps the prior one.

Outputs

Output	Type	Required	Description
`cohort`	Cohort	required	The Cohort.

Effects

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