Skip to content

by startups.studio

by Startups.Studio

Core grammar Resource

Resource.get

GET /{namespace}/resources/{id}

Returns one Resource by id.

Noun: Resource
Mode: read

You, to your agent

Show me the latest resource.

curl https://api.sb/ratebook.dev/resources/resource_hIVWDprAyZ \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

import { $ } from 'startup-builder'

const resource = await $.Resource.get({ id: 'resource_hIVWDprAyZ' })

npx startup-builder do Resource.get --json '{"id":"resource_hIVWDprAyZ"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Resource.get({ id: 'resource_hIVWDprAyZ' })"
  }
}

Get returns one Resource by id. It is inherited: every Noun has get, list, create, update and delete.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Resource.
`at`	`string`		A time or Version name: the record as it stood then. Unset: as it stands now.

Outputs

Output	Type	Required	Description
`resource`	Resource	required	The Resource.

Effects

Fact	Value
Action class	None: a read
Modes	`try`, `do` (default): a read runs at once
Idempotent	Yes: a read changes nothing
Undo	Nothing to undo: a read changes nothing
Emits	No Event: a read changes nothing

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

When it waits

Never: a read runs at once.

Resource

Previous

Resource.list

Next