• AI reference · Always listed

records_get

Read a record. Read one record of a module by its key, read only.

Where it is

Always listed: call it by its name.

Does it need a yes?

Reads only: it changes nothing. Here: one record.

Inputs

InputTypeNeededAbout
modulestringyesThe module's id, e.g. class-booking (lower case, digits, dashes). · format `^[a-z0-9][a-z0-9-]{0,39}$`
keystringyesThe record's key, e.g. 2026-11-03:yoga. Letters, digits, dots, dashes, underscores and colons, up to 120. · format `^[A-Za-z0-9][A-Za-z0-9._:-]{0,119}$`
key_emailstringnoA person's email, added to the key (which then ends in ":", e.g. calm:). · up to 254 characters · format `^[^\s@<>",;]+@[^\s@<>",;]+\.[^\s@<>",;]+$`
include_deletedtruenotrue: a deleted record too.
run_idstringnoThe run_id from start. Pass it on every call: it keeps your task held. · 1 to 100 characters

Example

{
  "name": "records_get",
  "arguments": {
    "module": "class-booking",
    "key": "2026-11-03:yoga"
  }
}

When it is refused

  • invalid: The input isn't right. The sentence names the field and the fix; nothing was done. Fix it and call again.
  • not_found: No such thing in this company (a task, file, person, record). Check the number or name, or list first.
  • not_allowed: Not without another step: the owner's yes, your own task held with pick_up, or a setting the owner turns on. The sentence says which.
  • taken: Someone else holds it (another AI on that task). Pick another task.
  • stale: It changed since you read it. Read it again and use the new version.
  • failed: On our side or a service's, never your input. Try again in a minute; if it keeps failing, call report_problem.