Skip to content

by Startups.Studio

Team Worker Human

Human.recruit

POST /{namespace}/humans/recruit

Recruit invites a person to supply credentialed work to a Startup through its supply App.

Noun: Human
Mode: do
Event: Human.recruited

You, to your agent

Recruit Priya Natarajan.

curl -X POST https://api.sb/ledgerlark.com/humans/recruit \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"email":"priya@ledgerlark.com"}'

import { $ } from 'startup-builder'

const human = await $.Human.recruit({ email: 'priya@ledgerlark.com' })

npx startup-builder do Human.recruit --json '{"email":"priya@ledgerlark.com"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Human.recruit({ email: 'priya@ledgerlark.com' })"
  }
}

Inputs

Input	Type	Required	Description
`email`	`email`	required	Where the invitation goes.
`credential`	`string`		The Credential the work requires.

Outputs

Output	Type	Required	Description
`human`	Human	required	The recruited Human.

Effects

Emits Human.recruited.
Performed by the Supply Manager.

Refuses when

Check	Error	Fix	Then call
The input does not match the schema of the operation.	`invalid-input`	Read the schema of the operation, then send every required field with the right type.	Human.recruit
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.	Human.recruit
The record is not in a state that allows this Verb, so the call is refused.	`refused`	Read the record, run the Verb that moves it to an allowed state, then retry.	Human.recruit

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

Human.onboard

Previous Page

Human.release

Next Page