ONE name:check
← Receivers

name:check

name family

mcp

Is this workspace name free? A free read over the one namespace (text/workspace-names-plan.md): answers available, or the reason it is not (bad_shape, uuid_shaped, reserved, blocked, taken, is_a_workspace, is_an_actor). An anonymous caller gets taken in place of is_a_workspace and is_an_actor, so it learns only taken or free; a signed-in caller sees why; names are public URLs

Effect
ask
Awaits an outcome — the call returns the response below.
Caller
public
The class of authority the caller must already hold, decided from the attested context with no round trip.
Cost
free
What one call costs, so you can budget before acting.
Reversible
yes
The effect can be undone by a later call.
Idempotent
yes
Safe to retry as-is.
Version
1.0.0
Pin this to keep a contract stable; additive bumps never break callers.

Send it with your agent

One click hands your coding agent a prompt that registers the substrate, reads this contract, and makes the call. Launch opens the app; the others copy the prompt.

Claude Code
Codex
Cursor
Gemini CLI
Claude Desktop
ChatGPT
curl -X POST https://one.ie/api/ask/name:check \
  -H "Authorization: Bearer $ONE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"data": { "name": "acme" }}'

The key is never in a link. npx -y @oneie/cli login writes it to ~/.config/oneie/key on your machine.

Request

Validated before dispatch — an invalid payload is refused with the fix, never half-applied.

  • name string required The name to check, as it would appear in one.ie/u/<name>: lowercase letters, digits and single dashes, 3 to 40 characters

Response

What comes back from the call.

  • ok boolean
  • name string
  • available boolean
  • reason string Why it is not available: bad_shape · uuid_shaped · reserved · blocked · taken · is_a_workspace · is_an_actor (the last two only to a signed-in caller; anonymous gets taken)
  • url string
  • error string names_not_ready when the names table has not shipped; lookup_failed when the read failed (unknown, never free)

Traffic

Every call to name:check, counted where it is dispatched — over HTTP or in-process alike. Aggregate only — no actor, no payload, no workspace.

Counting…

Wiring

Every place in the open source that names name:check, and the file that answers it. Read from the tree at build time — a receiver is reached by NAME through one door, so there is no import edge to follow and a grep is the honest shape of the question. Structure, not volume — the count is in Traffic above.

Called from

API route 2
  • one.ie/web/src/lib/names/client.ts:60
  • one.ie/web/src/lib/receiver-index.generated.ts:256
CLI 2
  • packages/cli/src/lib/journey.ts:363
  • packages/cli/src/name.ts:53
→

Answered by

name:check one.ie/web/src/lib/resolvers/names.ts:81 Dispatched through POST /api/ask/name:check, after the envelope validates the payload.

name family · 2 more

JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name to check, as it would appear in one.ie/u/<name>: lowercase letters, digits and single dashes, 3 to 40 characters"
    }
  },
  "required": [
    "name"
  ]
}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean"
    },
    "name": {
      "type": "string"
    },
    "available": {
      "type": "boolean"
    },
    "reason": {
      "description": "Why it is not available: bad_shape · uuid_shaped · reserved · blocked · taken · is_a_workspace · is_an_actor (the last two only to a signed-in caller; anonymous gets taken)",
      "type": "string"
    },
    "url": {
      "type": "string"
    },
    "error": {
      "description": "names_not_ready when the names table has not shipped; lookup_failed when the read failed (unknown, never free)",
      "type": "string"
    }
  },
  "required": [
    "ok"
  ]
}