Skip to content

by Startups.Studio

Product Domains and access Domain

Domain.search

POST /{namespace}/domains/search

Search lists candidate names with availability, first-year price, renewal price and the rules of each extension.

Noun: Domain
Mode: do
Event: Domain.searched

You, to your agent

Search the latest domain.

curl -X POST https://api.sb/kilnbakery.com/domains/search \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"Example query"}'

import { $ } from 'startup-builder'

const candidates = await $.Domain.search({ query: 'Example query' })

npx startup-builder do Domain.search --json '{"query":"Example query"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Domain.search({ query: 'Example query' })"
  }
}

Inputs

Input	Type	Required	Description
`query`	`string`	required	A name, or a word to build names from.
`extensions`	`string[]`		Extensions to check, such as `com` or `ai`.

Outputs

Output	Type	Required	Description
`candidates`	list of Domain	required	Candidate Domains, each with its prices, three-year cost and extension rules.

Effects

Emits Domain.searched.
Performed by the Engineering Lead.
Two-way: it runs at once, in the try, send and do modes.
Drops a candidate whose extension rules the owner of record fails, such as a local-presence rule.

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.	Domain.search

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

Domain.renew

Previous Page

Domain.transfer

Next Page