[{"_1":2,"_3":-5,"_4":-5},"loaderData",{"_5":6},"actionData","errors","routes/docs",{"_7":8,"_9":10,"_11":12,"_13":14,"_15":16},"locale","en","isLandingPage",false,"path","tools/reference/channel_join.mdx","markdownUrl","/en/llms.mdx/docs/tools/reference/channel_join/content.md","pageTree",{"_17":18,"_19":20},"$fumadocs_loader","page-tree","data",{"_21":22,"_23":24,"_25":26,"_27":28,"_29":-7,"_30":31},"type","root","$ref",{"_63":2420,"_72":2421},"$id","en:root","name","Docs","description","children",[32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53],{"_25":2414,"_21":55,"_27":2415,"_29":2416,"_58":2417,"_60":2418,"_23":2419},{"_25":2408,"_21":55,"_27":2409,"_29":2410,"_58":2411,"_60":2412,"_23":2413},{"_25":2402,"_21":55,"_27":2403,"_29":2404,"_58":2405,"_60":2406,"_23":2407},{"_25":2400,"_21":2300,"_58":-7,"_27":2401},{"_21":63,"_27":2366,"_22":-7,"_65":-7,"_29":-7,"_66":-7,"_30":2367,"_25":2368,"_23":2369,"_58":2370},{"_25":2360,"_21":55,"_27":2361,"_29":2362,"_58":2363,"_60":2364,"_23":2365},{"_25":2354,"_21":55,"_27":2355,"_29":2356,"_58":2357,"_60":2358,"_23":2359},{"_25":2352,"_21":2300,"_58":-7,"_27":2353},{"_25":2346,"_21":55,"_27":2347,"_29":2348,"_58":2349,"_60":2350,"_23":2351},{"_25":2340,"_21":55,"_27":2341,"_29":2342,"_58":2343,"_60":2344,"_23":2345},{"_25":2334,"_21":55,"_27":2335,"_29":2336,"_58":2337,"_60":2338,"_23":2339},{"_25":2332,"_21":2300,"_58":-7,"_27":2333},{"_25":2326,"_21":55,"_27":2327,"_29":2328,"_58":2329,"_60":2330,"_23":2331},{"_25":2320,"_21":55,"_27":2321,"_29":2322,"_58":2323,"_60":2324,"_23":2325},{"_25":2314,"_21":55,"_27":2315,"_29":2316,"_58":2317,"_60":2318,"_23":2319},{"_25":2308,"_21":55,"_27":2309,"_29":2310,"_58":2311,"_60":2312,"_23":2313},{"_25":2302,"_21":55,"_27":2303,"_29":2304,"_58":2305,"_60":2306,"_23":2307},{"_25":2299,"_21":2300,"_58":-7,"_27":2301},{"_21":63,"_27":1033,"_22":-7,"_65":-7,"_29":-7,"_66":-7,"_30":1034,"_25":1035,"_23":1036,"_58":1037},{"_21":63,"_27":103,"_22":-7,"_65":-7,"_29":-7,"_66":-7,"_30":104,"_25":105,"_23":106,"_58":107},{"_21":63,"_27":64,"_22":-7,"_65":-7,"_29":-7,"_66":-7,"_30":67,"_25":68,"_23":69,"_58":70},{"_25":54,"_21":55,"_27":56,"_29":57,"_58":59,"_60":61,"_23":62},"en:plugin.mdx","page","Plugin","Install InternKim's skills and tool server in Claude Code or Codex, and sign in as yourself.","icon","","url","/plugin","plugin.mdx","folder","The record","defaultOpen","collapsible",[74,75,76,77,78],"en:record",{"_63":71,"_72":73},"","record","meta","record/meta.json",{"_25":99,"_21":55,"_27":64,"_29":100,"_58":-7,"_60":101,"_23":102},{"_25":94,"_21":55,"_27":95,"_29":96,"_58":-7,"_60":97,"_23":98},{"_25":89,"_21":55,"_27":90,"_29":91,"_58":-7,"_60":92,"_23":93},{"_25":84,"_21":55,"_27":85,"_29":86,"_58":-7,"_60":87,"_23":88},{"_25":79,"_21":55,"_27":80,"_29":81,"_58":-7,"_60":82,"_23":83},"en:record/scheduled.mdx","Scheduled work","What pg_cron runs, and how often.","/record/scheduled","record/scheduled.mdx","en:record/edge-functions.mdx","Edge functions","The Deno functions deployed beside the record, and whether each verifies a JWT.","/record/edge-functions","record/edge-functions.mdx","en:record/rpc.mdx","Every RPC","Every function PostgREST exposes at /rest/v1/rpc, and who may call it.","/record/rpc","record/rpc.mdx","en:record/schema.mdx","What the tables mean","The decisions behind the schema that the column names do not say, and the rules a client has to keep.","/record/schema","record/schema.mdx","en:record/index.mdx","What answers underneath the API — Postgres functions, edge functions, and scheduled work.","/record","record/index.mdx","Tools",[110,111,112,113],"en:tools",{"_63":108,"_72":109},"","tools","tools/meta.json",{"_25":1029,"_21":55,"_27":103,"_29":1030,"_58":-7,"_60":1031,"_23":1032},{"_25":1024,"_21":55,"_27":1025,"_29":1026,"_58":-7,"_60":1027,"_23":1028},{"_25":1019,"_21":55,"_27":1020,"_29":1021,"_58":-7,"_60":1022,"_23":1023},{"_21":63,"_27":114,"_22":-7,"_65":-7,"_29":-7,"_66":-7,"_30":115,"_25":116,"_23":117,"_58":-7},"Every tool",[120,121,122,123,124,125,126,127,128,129,130,131,132,133,134,135,136,137,138,139,140,141,142,143,144,145,146,147,148,149,150,151,152,153,154,155,156,157,158,159,160,161,162,163,164,165,166,167,168,169,170,171,172,173,174,175,176,177,178,179,180,181,182,183,184,185,186,187,188,189,190,191,192,193,194,195,196,197,198,199,200,201,202,203,204,205,206,207,208,209,210,211,212,213,214,215,216,217,218,219,220,221,222,223,224,225,226,227,228,229,230,231,232,233,234,235,236,237,238,239,240,241,242,243,244,245,246,247,248,249,250,251,252,253,254,255,256,257,258,259,260,261,262,263,264,265,266,267,268,269],"en:tools/reference",{"_63":118,"_72":119},"tools/reference","tools/reference/meta.json",{"_25":1014,"_21":55,"_27":1015,"_29":1016,"_58":-7,"_60":1017,"_23":1018},{"_25":1009,"_21":55,"_27":1010,"_29":1011,"_58":-7,"_60":1012,"_23":1013},{"_25":1004,"_21":55,"_27":1005,"_29":1006,"_58":-7,"_60":1007,"_23":1008},{"_25":999,"_21":55,"_27":1000,"_29":1001,"_58":-7,"_60":1002,"_23":1003},{"_25":994,"_21":55,"_27":995,"_29":996,"_58":-7,"_60":997,"_23":998},{"_25":989,"_21":55,"_27":990,"_29":991,"_58":-7,"_60":992,"_23":993},{"_25":984,"_21":55,"_27":985,"_29":986,"_58":-7,"_60":987,"_23":988},{"_25":979,"_21":55,"_27":980,"_29":981,"_58":-7,"_60":982,"_23":983},{"_25":974,"_21":55,"_27":975,"_29":976,"_58":-7,"_60":977,"_23":978},{"_25":969,"_21":55,"_27":970,"_29":971,"_58":-7,"_60":972,"_23":973},{"_25":964,"_21":55,"_27":965,"_29":966,"_58":-7,"_60":967,"_23":968},{"_25":959,"_21":55,"_27":960,"_29":961,"_58":-7,"_60":962,"_23":963},{"_25":954,"_21":55,"_27":955,"_29":956,"_58":-7,"_60":957,"_23":958},{"_25":949,"_21":55,"_27":950,"_29":951,"_58":-7,"_60":952,"_23":953},{"_25":944,"_21":55,"_27":945,"_29":946,"_58":-7,"_60":947,"_23":948},{"_25":939,"_21":55,"_27":940,"_29":941,"_58":-7,"_60":942,"_23":943},{"_25":934,"_21":55,"_27":935,"_29":936,"_58":-7,"_60":937,"_23":938},{"_25":929,"_21":55,"_27":930,"_29":931,"_58":-7,"_60":932,"_23":933},{"_25":924,"_21":55,"_27":925,"_29":926,"_58":-7,"_60":927,"_23":928},{"_25":919,"_21":55,"_27":920,"_29":921,"_58":-7,"_60":922,"_23":923},{"_25":914,"_21":55,"_27":915,"_29":916,"_58":-7,"_60":917,"_23":918},{"_25":909,"_21":55,"_27":910,"_29":911,"_58":-7,"_60":912,"_23":913},{"_25":905,"_21":55,"_27":906,"_29":907,"_58":-7,"_60":908,"_23":12},{"_25":900,"_21":55,"_27":901,"_29":902,"_58":-7,"_60":903,"_23":904},{"_25":895,"_21":55,"_27":896,"_29":897,"_58":-7,"_60":898,"_23":899},{"_25":890,"_21":55,"_27":891,"_29":892,"_58":-7,"_60":893,"_23":894},{"_25":885,"_21":55,"_27":886,"_29":887,"_58":-7,"_60":888,"_23":889},{"_25":880,"_21":55,"_27":881,"_29":882,"_58":-7,"_60":883,"_23":884},{"_25":875,"_21":55,"_27":876,"_29":877,"_58":-7,"_60":878,"_23":879},{"_25":870,"_21":55,"_27":871,"_29":872,"_58":-7,"_60":873,"_23":874},{"_25":865,"_21":55,"_27":866,"_29":867,"_58":-7,"_60":868,"_23":869},{"_25":860,"_21":55,"_27":861,"_29":862,"_58":-7,"_60":863,"_23":864},{"_25":855,"_21":55,"_27":856,"_29":857,"_58":-7,"_60":858,"_23":859},{"_25":850,"_21":55,"_27":851,"_29":852,"_58":-7,"_60":853,"_23":854},{"_25":845,"_21":55,"_27":846,"_29":847,"_58":-7,"_60":848,"_23":849},{"_25":840,"_21":55,"_27":841,"_29":842,"_58":-7,"_60":843,"_23":844},{"_25":835,"_21":55,"_27":836,"_29":837,"_58":-7,"_60":838,"_23":839},{"_25":830,"_21":55,"_27":831,"_29":832,"_58":-7,"_60":833,"_23":834},{"_25":825,"_21":55,"_27":826,"_29":827,"_58":-7,"_60":828,"_23":829},{"_25":820,"_21":55,"_27":821,"_29":822,"_58":-7,"_60":823,"_23":824},{"_25":815,"_21":55,"_27":816,"_29":817,"_58":-7,"_60":818,"_23":819},{"_25":810,"_21":55,"_27":811,"_29":812,"_58":-7,"_60":813,"_23":814},{"_25":805,"_21":55,"_27":806,"_29":807,"_58":-7,"_60":808,"_23":809},{"_25":800,"_21":55,"_27":801,"_29":802,"_58":-7,"_60":803,"_23":804},{"_25":795,"_21":55,"_27":796,"_29":797,"_58":-7,"_60":798,"_23":799},{"_25":790,"_21":55,"_27":791,"_29":792,"_58":-7,"_60":793,"_23":794},{"_25":785,"_21":55,"_27":786,"_29":787,"_58":-7,"_60":788,"_23":789},{"_25":780,"_21":55,"_27":781,"_29":782,"_58":-7,"_60":783,"_23":784},{"_25":775,"_21":55,"_27":776,"_29":777,"_58":-7,"_60":778,"_23":779},{"_25":770,"_21":55,"_27":771,"_29":772,"_58":-7,"_60":773,"_23":774},{"_25":765,"_21":55,"_27":766,"_29":767,"_58":-7,"_60":768,"_23":769},{"_25":760,"_21":55,"_27":761,"_29":762,"_58":-7,"_60":763,"_23":764},{"_25":755,"_21":55,"_27":756,"_29":757,"_58":-7,"_60":758,"_23":759},{"_25":750,"_21":55,"_27":751,"_29":752,"_58":-7,"_60":753,"_23":754},{"_25":745,"_21":55,"_27":746,"_29":747,"_58":-7,"_60":748,"_23":749},{"_25":740,"_21":55,"_27":741,"_29":742,"_58":-7,"_60":743,"_23":744},{"_25":735,"_21":55,"_27":736,"_29":737,"_58":-7,"_60":738,"_23":739},{"_25":730,"_21":55,"_27":731,"_29":732,"_58":-7,"_60":733,"_23":734},{"_25":725,"_21":55,"_27":726,"_29":727,"_58":-7,"_60":728,"_23":729},{"_25":720,"_21":55,"_27":721,"_29":722,"_58":-7,"_60":723,"_23":724},{"_25":715,"_21":55,"_27":716,"_29":717,"_58":-7,"_60":718,"_23":719},{"_25":710,"_21":55,"_27":711,"_29":712,"_58":-7,"_60":713,"_23":714},{"_25":705,"_21":55,"_27":706,"_29":707,"_58":-7,"_60":708,"_23":709},{"_25":700,"_21":55,"_27":701,"_29":702,"_58":-7,"_60":703,"_23":704},{"_25":695,"_21":55,"_27":696,"_29":697,"_58":-7,"_60":698,"_23":699},{"_25":690,"_21":55,"_27":691,"_29":692,"_58":-7,"_60":693,"_23":694},{"_25":685,"_21":55,"_27":686,"_29":687,"_58":-7,"_60":688,"_23":689},{"_25":680,"_21":55,"_27":681,"_29":682,"_58":-7,"_60":683,"_23":684},{"_25":675,"_21":55,"_27":676,"_29":677,"_58":-7,"_60":678,"_23":679},{"_25":670,"_21":55,"_27":671,"_29":672,"_58":-7,"_60":673,"_23":674},{"_25":665,"_21":55,"_27":666,"_29":667,"_58":-7,"_60":668,"_23":669},{"_25":660,"_21":55,"_27":661,"_29":662,"_58":-7,"_60":663,"_23":664},{"_25":655,"_21":55,"_27":656,"_29":657,"_58":-7,"_60":658,"_23":659},{"_25":650,"_21":55,"_27":651,"_29":652,"_58":-7,"_60":653,"_23":654},{"_25":645,"_21":55,"_27":646,"_29":647,"_58":-7,"_60":648,"_23":649},{"_25":640,"_21":55,"_27":641,"_29":642,"_58":-7,"_60":643,"_23":644},{"_25":635,"_21":55,"_27":636,"_29":637,"_58":-7,"_60":638,"_23":639},{"_25":630,"_21":55,"_27":631,"_29":632,"_58":-7,"_60":633,"_23":634},{"_25":625,"_21":55,"_27":626,"_29":627,"_58":-7,"_60":628,"_23":629},{"_25":620,"_21":55,"_27":621,"_29":622,"_58":-7,"_60":623,"_23":624},{"_25":615,"_21":55,"_27":616,"_29":617,"_58":-7,"_60":618,"_23":619},{"_25":610,"_21":55,"_27":611,"_29":612,"_58":-7,"_60":613,"_23":614},{"_25":605,"_21":55,"_27":606,"_29":607,"_58":-7,"_60":608,"_23":609},{"_25":600,"_21":55,"_27":601,"_29":602,"_58":-7,"_60":603,"_23":604},{"_25":595,"_21":55,"_27":596,"_29":597,"_58":-7,"_60":598,"_23":599},{"_25":590,"_21":55,"_27":591,"_29":592,"_58":-7,"_60":593,"_23":594},{"_25":585,"_21":55,"_27":586,"_29":587,"_58":-7,"_60":588,"_23":589},{"_25":580,"_21":55,"_27":581,"_29":582,"_58":-7,"_60":583,"_23":584},{"_25":575,"_21":55,"_27":576,"_29":577,"_58":-7,"_60":578,"_23":579},{"_25":570,"_21":55,"_27":571,"_29":572,"_58":-7,"_60":573,"_23":574},{"_25":565,"_21":55,"_27":566,"_29":567,"_58":-7,"_60":568,"_23":569},{"_25":560,"_21":55,"_27":561,"_29":562,"_58":-7,"_60":563,"_23":564},{"_25":555,"_21":55,"_27":556,"_29":557,"_58":-7,"_60":558,"_23":559},{"_25":550,"_21":55,"_27":551,"_29":552,"_58":-7,"_60":553,"_23":554},{"_25":545,"_21":55,"_27":546,"_29":547,"_58":-7,"_60":548,"_23":549},{"_25":540,"_21":55,"_27":541,"_29":542,"_58":-7,"_60":543,"_23":544},{"_25":535,"_21":55,"_27":536,"_29":537,"_58":-7,"_60":538,"_23":539},{"_25":530,"_21":55,"_27":531,"_29":532,"_58":-7,"_60":533,"_23":534},{"_25":525,"_21":55,"_27":526,"_29":527,"_58":-7,"_60":528,"_23":529},{"_25":520,"_21":55,"_27":521,"_29":522,"_58":-7,"_60":523,"_23":524},{"_25":515,"_21":55,"_27":516,"_29":517,"_58":-7,"_60":518,"_23":519},{"_25":510,"_21":55,"_27":511,"_29":512,"_58":-7,"_60":513,"_23":514},{"_25":505,"_21":55,"_27":506,"_29":507,"_58":-7,"_60":508,"_23":509},{"_25":500,"_21":55,"_27":501,"_29":502,"_58":-7,"_60":503,"_23":504},{"_25":495,"_21":55,"_27":496,"_29":497,"_58":-7,"_60":498,"_23":499},{"_25":490,"_21":55,"_27":491,"_29":492,"_58":-7,"_60":493,"_23":494},{"_25":485,"_21":55,"_27":486,"_29":487,"_58":-7,"_60":488,"_23":489},{"_25":480,"_21":55,"_27":481,"_29":482,"_58":-7,"_60":483,"_23":484},{"_25":475,"_21":55,"_27":476,"_29":477,"_58":-7,"_60":478,"_23":479},{"_25":470,"_21":55,"_27":471,"_29":472,"_58":-7,"_60":473,"_23":474},{"_25":465,"_21":55,"_27":466,"_29":467,"_58":-7,"_60":468,"_23":469},{"_25":460,"_21":55,"_27":461,"_29":462,"_58":-7,"_60":463,"_23":464},{"_25":455,"_21":55,"_27":456,"_29":457,"_58":-7,"_60":458,"_23":459},{"_25":450,"_21":55,"_27":451,"_29":452,"_58":-7,"_60":453,"_23":454},{"_25":445,"_21":55,"_27":446,"_29":447,"_58":-7,"_60":448,"_23":449},{"_25":440,"_21":55,"_27":441,"_29":442,"_58":-7,"_60":443,"_23":444},{"_25":435,"_21":55,"_27":436,"_29":437,"_58":-7,"_60":438,"_23":439},{"_25":430,"_21":55,"_27":431,"_29":432,"_58":-7,"_60":433,"_23":434},{"_25":425,"_21":55,"_27":426,"_29":427,"_58":-7,"_60":428,"_23":429},{"_25":420,"_21":55,"_27":421,"_29":422,"_58":-7,"_60":423,"_23":424},{"_25":415,"_21":55,"_27":416,"_29":417,"_58":-7,"_60":418,"_23":419},{"_25":410,"_21":55,"_27":411,"_29":412,"_58":-7,"_60":413,"_23":414},{"_25":405,"_21":55,"_27":406,"_29":407,"_58":-7,"_60":408,"_23":409},{"_25":400,"_21":55,"_27":401,"_29":402,"_58":-7,"_60":403,"_23":404},{"_25":395,"_21":55,"_27":396,"_29":397,"_58":-7,"_60":398,"_23":399},{"_25":390,"_21":55,"_27":391,"_29":392,"_58":-7,"_60":393,"_23":394},{"_25":385,"_21":55,"_27":386,"_29":387,"_58":-7,"_60":388,"_23":389},{"_25":380,"_21":55,"_27":381,"_29":382,"_58":-7,"_60":383,"_23":384},{"_25":375,"_21":55,"_27":376,"_29":377,"_58":-7,"_60":378,"_23":379},{"_25":370,"_21":55,"_27":371,"_29":372,"_58":-7,"_60":373,"_23":374},{"_25":365,"_21":55,"_27":366,"_29":367,"_58":-7,"_60":368,"_23":369},{"_25":360,"_21":55,"_27":361,"_29":362,"_58":-7,"_60":363,"_23":364},{"_25":355,"_21":55,"_27":356,"_29":357,"_58":-7,"_60":358,"_23":359},{"_25":350,"_21":55,"_27":351,"_29":352,"_58":-7,"_60":353,"_23":354},{"_25":345,"_21":55,"_27":346,"_29":347,"_58":-7,"_60":348,"_23":349},{"_25":340,"_21":55,"_27":341,"_29":342,"_58":-7,"_60":343,"_23":344},{"_25":335,"_21":55,"_27":336,"_29":337,"_58":-7,"_60":338,"_23":339},{"_25":330,"_21":55,"_27":331,"_29":332,"_58":-7,"_60":333,"_23":334},{"_25":325,"_21":55,"_27":326,"_29":327,"_58":-7,"_60":328,"_23":329},{"_25":320,"_21":55,"_27":321,"_29":322,"_58":-7,"_60":323,"_23":324},{"_25":315,"_21":55,"_27":316,"_29":317,"_58":-7,"_60":318,"_23":319},{"_25":310,"_21":55,"_27":311,"_29":312,"_58":-7,"_60":313,"_23":314},{"_25":305,"_21":55,"_27":306,"_29":307,"_58":-7,"_60":308,"_23":309},{"_25":300,"_21":55,"_27":301,"_29":302,"_58":-7,"_60":303,"_23":304},{"_25":295,"_21":55,"_27":296,"_29":297,"_58":-7,"_60":298,"_23":299},{"_25":290,"_21":55,"_27":291,"_29":292,"_58":-7,"_60":293,"_23":294},{"_25":285,"_21":55,"_27":286,"_29":287,"_58":-7,"_60":288,"_23":289},{"_25":280,"_21":55,"_27":281,"_29":282,"_58":-7,"_60":283,"_23":284},{"_25":275,"_21":55,"_27":276,"_29":277,"_58":-7,"_60":278,"_23":279},{"_25":270,"_21":55,"_27":271,"_29":272,"_58":-7,"_60":273,"_23":274},"en:tools/reference/web_search.mdx","web_search","Search the public web and return ranked result snippets.","/tools/reference/web_search","tools/reference/web_search.mdx","en:tools/reference/web_fetch.mdx","web_fetch","Fetch and return the text content of one or more public URLs.","/tools/reference/web_fetch","tools/reference/web_fetch.mdx","en:tools/reference/team_update.mdx","team_update","Rename one team, move that organization under another one, or change where it sits among its siblings.","/tools/reference/team_update","tools/reference/team_update.mdx","en:tools/reference/team_list.mdx","team_list","Every team in the company — the organizations the organization chart holds — in the order it shows them, each with the organization it sits under and how many people belong to it.","/tools/reference/team_list","tools/reference/team_list.mdx","en:tools/reference/team_delete.mdx","team_delete","Remove one team from the organization chart, so that organization is gone.","/tools/reference/team_delete","tools/reference/team_delete.mdx","en:tools/reference/team_add.mdx","team_add","Create one team, an organization on the chart, optionally under another one.","/tools/reference/team_add","tools/reference/team_add.mdx","en:tools/reference/task_vocabulary_set.mdx","task_vocabulary_set","Set the task vocabulary: the business and task type labels this company files work under.","/tools/reference/task_vocabulary_set","tools/reference/task_vocabulary_set.mdx","en:tools/reference/task_update.mdx","task_update","Update explicit fields on an existing task, including who takes part in it, when canUpdate in task_list says the caller may change it.","/tools/reference/task_update","tools/reference/task_update.mdx","en:tools/reference/task_list.mdx","task_list","List workspace tasks with optional filters.","/tools/reference/task_list","tools/reference/task_list.mdx","en:tools/reference/task_delete.mdx","task_delete","Permanently delete a task.","/tools/reference/task_delete","tools/reference/task_delete.mdx","en:tools/reference/task_board_get.mdx","task_board_get","Get one task board week: its visible cards, including undated and overdue carry-over work, with direct-child progress across all weeks.","/tools/reference/task_board_get","tools/reference/task_board_get.mdx","en:tools/reference/task_add.mdx","task_add","Create a new workspace task with typed task fields.","/tools/reference/task_add","tools/reference/task_add.mdx","en:tools/reference/schedule_update.mdx","schedule_update","Change explicit fields on a reminder or recurring alert the requester set up, including how often it repeats and when it next arrives.","/tools/reference/schedule_update","tools/reference/schedule_update.mdx","en:tools/reference/schedule_list.mdx","schedule_list","List scheduled tasks created by the current requester.","/tools/reference/schedule_list","tools/reference/schedule_list.mdx","en:tools/reference/schedule_create.mdx","schedule_create","Schedule a reminder or a recurring alert: work the agent does later, once at a time you name or on a repeat.","/tools/reference/schedule_create","tools/reference/schedule_create.mdx","en:tools/reference/schedule_cancel.mdx","schedule_cancel","Stop a reminder or recurring alert the requester set up, so it stops arriving.","/tools/reference/schedule_cancel","tools/reference/schedule_cancel.mdx","en:tools/reference/persona_profile_update.mdx","persona_profile_update","Change the requester's persona profile, the only profile this ever changes.","/tools/reference/persona_profile_update","tools/reference/persona_profile_update.mdx","en:tools/reference/persona_profile_get.mdx","persona_profile_get","Read the requester's persona profile, which says how they want the agent to work with them: what to call them, what to know about them, their preferences, tone and reply language, and the daily morning briefing's time and whether it is on.","/tools/reference/persona_profile_get","tools/reference/persona_profile_get.mdx","en:tools/reference/persona_identity_update.mdx","persona_identity_update","Change the agent's persona identity for the whole company.","/tools/reference/persona_identity_update","tools/reference/persona_identity_update.mdx","en:tools/reference/persona_identity_get.mdx","persona_identity_get","Read the agent's persona identity: every name it answers to, the first being the one it introduces itself with, and its handle, role, creature, emoji and introduction.","/tools/reference/persona_identity_get","tools/reference/persona_identity_get.mdx","en:tools/reference/person_withdraw.mdx","person_withdraw","Withdraw one person from the company: their membership ends, they can no longer sign in, they leave the company messenger, and every screen stops showing them, while the attendance, leave and tasks they left behind still read.","/tools/reference/person_withdraw","tools/reference/person_withdraw.mdx","en:tools/reference/person_update.mdx","person_update","Change what the company directory holds about one person: their name, their job title, their organization, who they report to, their phone number, the day they started, whether they administer the company, and whether they still work here.","/tools/reference/person_update","tools/reference/person_update.mdx","en:tools/reference/person_password_reset.mdx","person_password_reset","Reset one person's password: their old password stops working and they get a temporary password to sign in with once.","/tools/reference/person_password_reset","tools/reference/person_password_reset.mdx","en:tools/reference/person_message_delete.mdx","person_message_delete","Delete every message one person has written in the company messenger, in every conversation, for somebody leaving or asking to be forgotten.","/tools/reference/person_message_delete","tools/reference/person_message_delete.mdx","en:tools/reference/person_list.mdx","person_list","Everyone who works here, with their exact name, email and mention, and what the company directory holds about them: their job title, their organization, who they report to, and when they started.","/tools/reference/person_list","tools/reference/person_list.mdx","en:tools/reference/person_invite.mdx","person_invite","Invite somebody to the company: it creates their account, gives them a temporary password to sign in with once, and puts them in the directory.","/tools/reference/person_invite","tools/reference/person_invite.mdx","en:tools/reference/notification_settings_set.mdx","notification_settings_set","Change the notification settings: which categories of notice the requester is told about at all, and which conversations are muted.","/tools/reference/notification_settings_set","tools/reference/notification_settings_set.mdx","en:tools/reference/notification_settings_get.mdx","notification_settings_get","The notification settings: what the requester is told about, category by category, and the conversations they have muted.","/tools/reference/notification_settings_get","tools/reference/notification_settings_get.mdx","en:tools/reference/message_update.mdx","message_update","Change a message the assistant or the requester wrote.","/tools/reference/message_update","tools/reference/message_update.mdx","en:tools/reference/message_send.mdx","message_send","Send a message to a direct message, channel, or the current conversation after approval.","/tools/reference/message_send","tools/reference/message_send.mdx","en:tools/reference/message_search.mdx","message_search","Find messages in an exact conversation scope, or read known ones in full.","/tools/reference/message_search","tools/reference/message_search.mdx","en:tools/reference/message_reaction_delete.mdx","message_reaction_delete","Take back a reaction the requester left on a message.","/tools/reference/message_reaction_delete","tools/reference/message_reaction_delete.mdx","en:tools/reference/message_reaction_add.mdx","message_reaction_add","Add an emoji reaction to a message as the requester, the way their messenger screen does.","/tools/reference/message_reaction_add","tools/reference/message_reaction_add.mdx","en:tools/reference/message_delete.mdx","message_delete","Permanently delete exact message IDs from message_search after approval.","/tools/reference/message_delete","tools/reference/message_delete.mdx","en:tools/reference/message_context.mdx","message_context","Return the conversation the message arrived in, exactly as the messenger holds it, with its thread, requester, and bot identities.","/tools/reference/message_context","tools/reference/message_context.mdx","en:tools/reference/mail_message_send.mdx","mail_message_send","Send an email message from the requester's connected mail account.","/tools/reference/mail_message_send","tools/reference/mail_message_send.mdx","en:tools/reference/mail_message_search.mdx","mail_message_search","Search mail messages by keyword, sender, or subject.","/tools/reference/mail_message_search","tools/reference/mail_message_search.mdx","en:tools/reference/mail_message_read.mdx","mail_message_read","Fetch the full content of a single mail message by its mailbox name and UID.","/tools/reference/mail_message_read","tools/reference/mail_message_read.mdx","en:tools/reference/mail_message_move.mdx","mail_message_move","Move one mail message to a different mailbox folder (e.g.","/tools/reference/mail_message_move","tools/reference/mail_message_move.mdx","en:tools/reference/mail_message_mark.mdx","mail_message_mark","Set the read (seen) or starred (flagged) status of one mail message.","/tools/reference/mail_message_mark","tools/reference/mail_message_mark.mdx","en:tools/reference/mail_message_list.mdx","mail_message_list","List the mail in a mailbox folder, one page of messages at a time.","/tools/reference/mail_message_list","tools/reference/mail_message_list.mdx","en:tools/reference/mail_mailbox_list.mdx","mail_mailbox_list","List the requester's mail folders with their unread and total counts.","/tools/reference/mail_mailbox_list","tools/reference/mail_mailbox_list.mdx","en:tools/reference/mail_connection_status.mdx","mail_connection_status","Check the mail connection: whether the requester's email account is connected.","/tools/reference/mail_connection_status","tools/reference/mail_connection_status.mdx","en:tools/reference/mail_connection_start.mdx","mail_connection_start","Start the mail account connection flow and return setup instructions for the requester.","/tools/reference/mail_connection_start","tools/reference/mail_connection_start.mdx","en:tools/reference/leave_update.mdx","leave_update","Correct a leave that was filed wrong: its days, its kind, how much entitlement it consumes, or the note.","/tools/reference/leave_update","tools/reference/leave_update.mdx","en:tools/reference/leave_return_early.mdx","leave_return_early","Return to work early, before the leave was due to end.","/tools/reference/leave_return_early","tools/reference/leave_return_early.mdx","en:tools/reference/leave_request.mdx","leave_request","File a leave request.","/tools/reference/leave_request","tools/reference/leave_request.mdx","en:tools/reference/leave_list.mdx","leave_list","List leave in the record.","/tools/reference/leave_list","tools/reference/leave_list.mdx","en:tools/reference/leave_grant_set.mdx","leave_grant_set","Set how much leave one person is entitled to in a year.","/tools/reference/leave_grant_set","tools/reference/leave_grant_set.mdx","en:tools/reference/leave_delete.mdx","leave_delete","Take a leave back out of the record entirely, as though it was never filed.","/tools/reference/leave_delete","tools/reference/leave_delete.mdx","en:tools/reference/leave_decide.mdx","leave_decide","Approve or reject a leave request.","/tools/reference/leave_decide","tools/reference/leave_decide.mdx","en:tools/reference/leave_balance.mdx","leave_balance","Read how much leave is left for a year.","/tools/reference/leave_balance","tools/reference/leave_balance.mdx","en:tools/reference/image_generate.mdx","image_generate","Generate a new image from a text prompt and save it to a workspace path.","/tools/reference/image_generate","tools/reference/image_generate.mdx","en:tools/reference/host_version_get.mdx","host_version_get","Read which version of internkim this company's host runs, the release channel it follows, how it is updated (apt, dnf, pacman or brew), and the latest stable release with its date and release notes, which says whether an update is available.","/tools/reference/host_version_get","tools/reference/host_version_get.mdx","en:tools/reference/host_update.mdx","host_update","Update this company's host to a stable release, or take it back to an older stable one.","/tools/reference/host_update","tools/reference/host_update.mdx","en:tools/reference/host_diagnostics_get.mdx","host_diagnostics_get","Read host diagnostics through the same execution records, event ledger, model exchanges, turn inputs, connector events, service logs and request metrics as the work-history web page.","/tools/reference/host_diagnostics_get","tools/reference/host_diagnostics_get.mdx","en:tools/reference/event_update.mdx","event_update","Update explicit fields on a calendar event.","/tools/reference/event_update","tools/reference/event_update.mdx","en:tools/reference/event_list.mdx","event_list","List calendar entries in a concrete time window.","/tools/reference/event_list","tools/reference/event_list.mdx","en:tools/reference/event_delete.mdx","event_delete","Permanently delete a calendar event.","/tools/reference/event_delete","tools/reference/event_delete.mdx","en:tools/reference/event_add.mdx","event_add","Create a calendar event with a concrete time range.","/tools/reference/event_add","tools/reference/event_add.mdx","en:tools/reference/dataroom_share_delete.mdx","dataroom_share_delete","Company dataroom: Revoke a data room share by its exact shareID from dataroom_get.","/tools/reference/dataroom_share_delete","tools/reference/dataroom_share_delete.mdx","en:tools/reference/dataroom_share_add.mdx","dataroom_share_add","Company dataroom: Share live data room categories with someone outside the company by lending them what one circle reads: an external email or an explicitly public audience.","/tools/reference/dataroom_share_add","tools/reference/dataroom_share_add.mdx","en:tools/reference/dataroom_links_get.mdx","dataroom_links_get","Company dataroom: Read your share links.","/tools/reference/dataroom_links_get","tools/reference/dataroom_links_get.mdx","en:tools/reference/dataroom_link_delete.mdx","dataroom_link_delete","Company dataroom: Revoke a link created by you, or any company link if you are an administrator.","/tools/reference/dataroom_link_delete","tools/reference/dataroom_link_delete.mdx","en:tools/reference/dataroom_link_add.mdx","dataroom_link_add","Company dataroom: Create a code-protected share link that reads as one circle, within your own permissions.","/tools/reference/dataroom_link_add","tools/reference/dataroom_link_add.mdx","en:tools/reference/dataroom_invitation_send.mdx","dataroom_invitation_send","Company dataroom: send the invitation email of an email share, so its recipient can sign in with that address and accept it.","/tools/reference/dataroom_invitation_send","tools/reference/dataroom_invitation_send.mdx","en:tools/reference/dataroom_invitation_accept.mdx","dataroom_invitation_accept","Company dataroom: accept an invitation another company sent to the requester's own verified email, which opens the categories it shares to the requester.","/tools/reference/dataroom_invitation_accept","tools/reference/dataroom_invitation_accept.mdx","en:tools/reference/dataroom_get.mdx","dataroom_get","Company dataroom: Read the company data room categories and its shares with people outside the company.","/tools/reference/dataroom_get","tools/reference/dataroom_get.mdx","en:tools/reference/dataroom_field_update.mdx","dataroom_field_update","Company dataroom: Choose who sees one company page field by naming the category whose readers see it; the field leaves the category that held it.","/tools/reference/dataroom_field_update","tools/reference/dataroom_field_update.mdx","en:tools/reference/dataroom_category_update.mdx","dataroom_category_update","Company dataroom: Create or rename a data room category.","/tools/reference/dataroom_category_update","tools/reference/dataroom_category_update.mdx","en:tools/reference/crm_vocabulary_set.mdx","crm_vocabulary_set","Set the CRM vocabulary: the organization types and pipelines this company runs its CRM in.","/tools/reference/crm_vocabulary_set","tools/reference/crm_vocabulary_set.mdx","en:tools/reference/crm_vocabulary_get.mdx","crm_vocabulary_get","The CRM vocabulary, the words this company runs its CRM in: the organization types it sorts relationships by, the pipelines it runs deals through, and the stages a deal can stand at with what each one means.","/tools/reference/crm_vocabulary_get","tools/reference/crm_vocabulary_get.mdx","en:tools/reference/crm_record_import.mdx","crm_record_import","Import many organization or contact records from one CSV in one write: every record is written, or none is.","/tools/reference/crm_record_import","tools/reference/crm_record_import.mdx","en:tools/reference/crm_organization_update.mdx","crm_organization_update","Change what this company holds about an organization; only the fields the call names change.","/tools/reference/crm_organization_update","tools/reference/crm_organization_update.mdx","en:tools/reference/crm_organization_list.mdx","crm_organization_list","The organizations this company sells to, partners with or buys from, with who owns each relationship — 'who are our customers'.","/tools/reference/crm_organization_list","tools/reference/crm_organization_list.mdx","en:tools/reference/crm_organization_archive.mdx","crm_organization_archive","Put an organization away, so it leaves the CRM screens while its people, its deals and everything recorded against it stay.","/tools/reference/crm_organization_archive","tools/reference/crm_organization_archive.mdx","en:tools/reference/crm_organization_add.mdx","crm_organization_add","Add an organization this company deals with, after crm_organization_list shows it is not one already held.","/tools/reference/crm_organization_add","tools/reference/crm_organization_add.mdx","en:tools/reference/crm_opportunity_update.mdx","crm_opportunity_update","Change what a deal is worth, who it is with, or when it should close; only the fields the call names change.","/tools/reference/crm_opportunity_update","tools/reference/crm_opportunity_update.mdx","en:tools/reference/crm_opportunity_move.mdx","crm_opportunity_move","Move a deal to another stage, or reorder it within the one it stands at.","/tools/reference/crm_opportunity_move","tools/reference/crm_opportunity_move.mdx","en:tools/reference/crm_opportunity_list.mdx","crm_opportunity_list","The deals this company is working on, each with its stage, what it is worth and how much work has been recorded against it — 'what are we closing this month'.","/tools/reference/crm_opportunity_list","tools/reference/crm_opportunity_list.mdx","en:tools/reference/crm_opportunity_archive.mdx","crm_opportunity_archive","Put a deal away, so it leaves the pipeline while everything recorded against it stays.","/tools/reference/crm_opportunity_archive","tools/reference/crm_opportunity_archive.mdx","en:tools/reference/crm_opportunity_add.mdx","crm_opportunity_add","Open a deal with an organization this company already holds.","/tools/reference/crm_opportunity_add","tools/reference/crm_opportunity_add.mdx","en:tools/reference/crm_contact_update.mdx","crm_contact_update","Change what this company holds about a contact, including moving that person to another organization; only the fields the call names change.","/tools/reference/crm_contact_update","tools/reference/crm_contact_update.mdx","en:tools/reference/crm_contact_list.mdx","crm_contact_list","The contacts this company deals with at other organizations — the people it talks to — with how to reach them — 'who do we talk to at ABC'.","/tools/reference/crm_contact_list","tools/reference/crm_contact_list.mdx","en:tools/reference/crm_contact_archive.mdx","crm_contact_archive","Put a contact away, so that person leaves the CRM screens while everything recorded against them stays, as when somebody leaves the organization.","/tools/reference/crm_contact_archive","tools/reference/crm_contact_archive.mdx","en:tools/reference/crm_contact_add.mdx","crm_contact_add","Add a contact, a person at an organization this company already holds, which crm_organization_add creates when it does not.","/tools/reference/crm_contact_add","tools/reference/crm_contact_add.mdx","en:tools/reference/crm_activity_save.mdx","crm_activity_save","Record work against an organization or a deal, or change work already recorded.","/tools/reference/crm_activity_save","tools/reference/crm_activity_save.mdx","en:tools/reference/crm_activity_list.mdx","crm_activity_list","The activity recorded against the organizations and deals this company holds, newest first, with the labels and colours the CRM screens draw it in.","/tools/reference/crm_activity_list","tools/reference/crm_activity_list.mdx","en:tools/reference/conversation_unmute.mdx","conversation_unmute","Tell the requester about a conversation again.","/tools/reference/conversation_unmute","tools/reference/conversation_unmute.mdx","en:tools/reference/conversation_reveal.mdx","conversation_reveal","Show a direct conversation the requester hid with conversation_hide in their conversation list again.","/tools/reference/conversation_reveal","tools/reference/conversation_reveal.mdx","en:tools/reference/conversation_mute.mdx","conversation_mute","Stop telling the requester about a conversation.","/tools/reference/conversation_mute","tools/reference/conversation_mute.mdx","en:tools/reference/conversation_hide.mdx","conversation_hide","Hide the requester's direct conversation with one person from their own conversation list.","/tools/reference/conversation_hide","tools/reference/conversation_hide.mdx","en:tools/reference/company_settings_update.mdx","company_settings_update","Change the company settings.","/tools/reference/company_settings_update","tools/reference/company_settings_update.mdx","en:tools/reference/company_settings_get.mdx","company_settings_get","The company settings: its name, country, language, time zone, base currency, the work locations attendance can be recorded at, the annual leave a person is granted, whether everybody may see the whole company's attendance, and the address of its picture.","/tools/reference/company_settings_get","tools/reference/company_settings_get.mdx","en:tools/reference/company_record_update.mdx","company_record_update","Update fields on an existing company record named by recordHint from a prior company_record_list result.","/tools/reference/company_record_update","tools/reference/company_record_update.mdx","en:tools/reference/company_record_list.mdx","company_record_list","List company history/asset records, newest first.","/tools/reference/company_record_list","tools/reference/company_record_list.mdx","en:tools/reference/company_record_delete.mdx","company_record_delete","Delete a company record named by recordHint from a prior company_record_list result.","/tools/reference/company_record_delete","tools/reference/company_record_delete.mdx","en:tools/reference/company_record_add.mdx","company_record_add","Add one company history/asset record: milestones, funding rounds, products, patents, certifications, awards, client references, government grants.","/tools/reference/company_record_add","tools/reference/company_record_add.mdx","en:tools/reference/company_metric_record.mdx","company_metric_record","Record or correct one company metric value for a period — annual revenue, operating profit, MAU, employee count, GMV and similar time-series numbers.","/tools/reference/company_metric_record","tools/reference/company_metric_record.mdx","en:tools/reference/company_metric_list.mdx","company_metric_list","List recorded company metrics sorted by period.","/tools/reference/company_metric_list","tools/reference/company_metric_list.mdx","en:tools/reference/company_info_set.mdx","company_info_set","Save or update the company master profile.","/tools/reference/company_info_set","tools/reference/company_info_set.mdx","en:tools/reference/company_info_get.mdx","company_info_get","Read the company master profile (name, representative, address, contact, bank account, country-specific legal attributes such as a business registration number).","/tools/reference/company_info_get","tools/reference/company_info_get.mdx","en:tools/reference/company_image_upload.mdx","company_image_upload","Ask for a place to keep a new version of a company image, such as the seal stamped on forms or the letterhead logo.","/tools/reference/company_image_upload","tools/reference/company_image_upload.mdx","en:tools/reference/company_holiday_update.mdx","company_holiday_update","Change the day, the name, or the yearly recurrence of a holiday the company already holds.","/tools/reference/company_holiday_update","tools/reference/company_holiday_update.mdx","en:tools/reference/company_holiday_list.mdx","company_holiday_list","The days this company is closed, earliest first.","/tools/reference/company_holiday_list","tools/reference/company_holiday_list.mdx","en:tools/reference/company_holiday_delete.mdx","company_holiday_delete","Take a day off the company holiday list, so it counts as a working day again.","/tools/reference/company_holiday_delete","tools/reference/company_holiday_delete.mdx","en:tools/reference/company_holiday_add.mdx","company_holiday_add","Add a day the company is closed.","/tools/reference/company_holiday_add","tools/reference/company_holiday_add.mdx","en:tools/reference/company_equity_list.mdx","company_equity_list","List the company's equity ledger and what each holder holds as of a day, with their share of the total.","/tools/reference/company_equity_list","tools/reference/company_equity_list.mdx","en:tools/reference/company_equity_delete.mdx","company_equity_delete","Delete one wrong line of the company's equity ledger named by its entryID from company_equity_list.","/tools/reference/company_equity_delete","tools/reference/company_equity_delete.mdx","en:tools/reference/company_equity_add.mdx","company_equity_add","Add one line to the company's equity ledger: shares or options a holder received or gave up on a date, as the shareholder register or a share issuance records it.","/tools/reference/company_equity_add","tools/reference/company_equity_add.mdx","en:tools/reference/company_document_upload.mdx","company_document_upload","Ask for a place in the company data room to put one file of a registered document.","/tools/reference/company_document_upload","tools/reference/company_document_upload.mdx","en:tools/reference/company_document_update.mdx","company_document_update","Update a registered company document's file path, title, counterpart, summary, or where it sits in the data room: its categoryCode, date, period, status, tags, hash, and the document it supersedes.","/tools/reference/company_document_update","tools/reference/company_document_update.mdx","en:tools/reference/company_document_search.mdx","company_document_search","Search registered company documents by a natural-language question ('the terms of the agreement with ABC').","/tools/reference/company_document_search","tools/reference/company_document_search.mdx","en:tools/reference/company_document_register.mdx","company_document_register","Register a company document in the document ledger and, for kind=issued, receive the official document number to print in the document plus the storage directory to save the final file in.","/tools/reference/company_document_register","tools/reference/company_document_register.mdx","en:tools/reference/company_document_list.mdx","company_document_list","List registered company documents newest first, with their numbers, counterparts, file paths, summaries, and where each sits in the data room.","/tools/reference/company_document_list","tools/reference/company_document_list.mdx","en:tools/reference/company_document_download.mdx","company_document_download","Fetch a company document's original, or one of the files derived from it, out of the data room.","/tools/reference/company_document_download","tools/reference/company_document_download.mdx","en:tools/reference/company_document_classify.mdx","company_document_classify","Classify a document against the company data room taxonomy in one model request.","/tools/reference/company_document_classify","tools/reference/company_document_classify.mdx","en:tools/reference/circle_update.mdx","circle_update","Company circles: Create or edit a circle.","/tools/reference/circle_update","tools/reference/circle_update.mdx","en:tools/reference/circle_member_update.mdx","circle_member_update","Company circles: Set the circles an active member belongs to, replacing them atomically.","/tools/reference/circle_member_update","tools/reference/circle_member_update.mdx","en:tools/reference/circle_list.mdx","circle_list","Company circles: Read every circle with the members who belong to it and the data room categories it reads.","/tools/reference/circle_list","tools/reference/circle_list.mdx","en:tools/reference/circle_channel_delete.mdx","circle_channel_delete","Company circles: Delete the circle's messenger channel, so nobody reads or writes in it again.","/tools/reference/circle_channel_delete","tools/reference/circle_channel_delete.mdx","en:tools/reference/circle_channel_add.mdx","circle_channel_add","Company circles: Add a private messenger channel of the circle's own.","/tools/reference/circle_channel_add","tools/reference/circle_channel_add.mdx","en:tools/reference/channel_owner_update.mdx","channel_owner_update","Hand a channel over: the person named becomes its owner and the requester stays as a plain member, which only another owner can undo.","/tools/reference/channel_owner_update","tools/reference/channel_owner_update.mdx","en:tools/reference/channel_owner_add.mdx","channel_owner_add","Make a member of a channel a co-owner beside the requester.","/tools/reference/channel_owner_add","tools/reference/channel_owner_add.mdx","en:tools/reference/channel_member_delete.mdx","channel_member_delete","Remove one member from a channel.","/tools/reference/channel_member_delete","tools/reference/channel_member_delete.mdx","en:tools/reference/channel_member_add.mdx","channel_member_add","Add company members to a channel the requester is in.","/tools/reference/channel_member_add","tools/reference/channel_member_add.mdx","en:tools/reference/channel_leave.mdx","channel_leave","Leave a channel the requester is in.","/tools/reference/channel_leave","tools/reference/channel_leave.mdx","en:tools/reference/channel_join.mdx","channel_join","Join an open channel the requester is not in yet.","/tools/reference/channel_join","en:tools/reference/channel_delete.mdx","channel_delete","Permanently delete a channel for everyone in it.","/tools/reference/channel_delete","tools/reference/channel_delete.mdx","en:tools/reference/channel_add.mdx","channel_add","Create a group channel in the company messenger with the requester as its owner, and add the members named.","/tools/reference/channel_add","tools/reference/channel_add.mdx","en:tools/reference/calendar_subscription_get.mdx","calendar_subscription_get","Whether the company calendar has a subscription address, the .ics feed a calendar app such as Google Calendar or Apple Calendar subscribes to.","/tools/reference/calendar_subscription_get","tools/reference/calendar_subscription_get.mdx","en:tools/reference/calendar_subscription_delete.mdx","calendar_subscription_delete","Revoke the company calendar subscription address, so no calendar app can read it any longer.","/tools/reference/calendar_subscription_delete","tools/reference/calendar_subscription_delete.mdx","en:tools/reference/calendar_subscription_add.mdx","calendar_subscription_add","Make a new subscription address for the company calendar and answer it.","/tools/reference/calendar_subscription_add","tools/reference/calendar_subscription_add.mdx","en:tools/reference/browser_wait.mdx","browser_wait","Wait for a browser target or a bounded interval.","/tools/reference/browser_wait","tools/reference/browser_wait.mdx","en:tools/reference/browser_snapshot.mdx","browser_snapshot","Read the current browser page structure and return stable interactive references for inspection and control.","/tools/reference/browser_snapshot","tools/reference/browser_snapshot.mdx","en:tools/reference/browser_select.mdx","browser_select","Select a value in a target on the current browser page.","/tools/reference/browser_select","tools/reference/browser_select.mdx","en:tools/reference/browser_screenshot.mdx","browser_screenshot","Capture the visible browser page as a PNG attachment for visual inspection.","/tools/reference/browser_screenshot","tools/reference/browser_screenshot.mdx","en:tools/reference/browser_press.mdx","browser_press","Press a key on the current browser page.","/tools/reference/browser_press","tools/reference/browser_press.mdx","en:tools/reference/browser_open.mdx","browser_open","Open an exact HTTP or HTTPS URL in the browser and return the resulting page identity and initial structure.","/tools/reference/browser_open","tools/reference/browser_open.mdx","en:tools/reference/browser_fill.mdx","browser_fill","Fill text into a target on the current browser page.","/tools/reference/browser_fill","tools/reference/browser_fill.mdx","en:tools/reference/browser_click.mdx","browser_click","Click one exact target from the current browser snapshot and return the completed action.","/tools/reference/browser_click","tools/reference/browser_click.mdx","en:tools/reference/attendance_work_policy_set.mdx","attendance_work_policy_set","Set the hours this company works, which attendance is judged against, from today on.","/tools/reference/attendance_work_policy_set","tools/reference/attendance_work_policy_set.mdx","en:tools/reference/attendance_work_policy_get.mdx","attendance_work_policy_get","The hours this company works, which attendance is judged against: the policy in force and every earlier one with the day it took effect, so a past day is judged by the policy of that day.","/tools/reference/attendance_work_policy_get","tools/reference/attendance_work_policy_get.mdx","en:tools/reference/attendance_update.mdx","attendance_update","Correct the day, the time, or the work location of attendance records that were written wrong, all in one call.","/tools/reference/attendance_update","tools/reference/attendance_update.mdx","en:tools/reference/attendance_list.mdx","attendance_list","List clock-ins and clock-outs as the record holds them.","/tools/reference/attendance_list","tools/reference/attendance_list.mdx","en:tools/reference/attendance_leave_policy_set.mdx","attendance_leave_policy_set","Set the leave this company offers, which attendance and time off are judged against.","/tools/reference/attendance_leave_policy_set","tools/reference/attendance_leave_policy_set.mdx","en:tools/reference/attendance_leave_policy_get.mdx","attendance_leave_policy_get","The leave policy this company offers, which attendance and time off are judged against: every type with whether it is paid, how much it grants and in what portions of a day it may be taken, and the day the leave year starts.","/tools/reference/attendance_leave_policy_get","tools/reference/attendance_leave_policy_get.mdx","en:tools/reference/attendance_delete.mdx","attendance_delete","Remove an attendance record that should never have been there.","/tools/reference/attendance_delete","tools/reference/attendance_delete.mdx","en:tools/reference/attendance_add.mdx","attendance_add","Write one attendance record, a clock-in or clock-out, at the moment it actually happened.","/tools/reference/attendance_add","tools/reference/attendance_add.mdx","en:tools/reference/artifact_review.mdx","artifact_review","Review rendered artifact screenshots against a concrete intent and rubric, returning typed visual issues and suggested fixes.","/tools/reference/artifact_review","tools/reference/artifact_review.mdx","en:tools/workspace.mdx","Files and the terminal","The workspace tools, the POSIX identity they run as, and how finished work leaves the workspace.","/tools/workspace","tools/workspace.mdx","en:tools/catalog.mdx","Tool catalog","Every capability tool, by namespace, generated from the canonical catalog.","/tools/catalog","tools/catalog.mdx","en:tools/index.mdx","What the agent can call, what each call costs, and when it stops to ask you first.","/tools","tools/index.mdx","API",[1040,1041,1042,1043],"en:api",{"_63":1038,"_72":1039},"","api","api/meta.json",{"_25":2294,"_21":55,"_27":2295,"_29":2296,"_58":-7,"_60":2297,"_23":2298},{"_25":2289,"_21":55,"_27":2290,"_29":2291,"_58":-7,"_60":2292,"_23":2293},{"_25":2284,"_21":55,"_27":2285,"_29":2286,"_58":-7,"_60":2287,"_23":2288},{"_21":63,"_27":1044,"_22":-7,"_65":-7,"_29":-7,"_66":-7,"_30":1045,"_25":1046,"_23":1047,"_58":-7},"Every endpoint",[1050,1051,1052,1053,1054,1055,1056,1057,1058,1059,1060,1061,1062,1063,1064,1065,1066,1067,1068,1069,1070,1071,1072,1073,1074,1075,1076,1077,1078],"en:api/reference",{"_63":1048,"_72":1049},"api/reference","api/reference/meta.json",{"_21":63,"_27":2266,"_22":-7,"_65":1080,"_29":-7,"_66":10,"_30":2267,"_25":2268,"_23":2269,"_58":-7},{"_21":63,"_27":2254,"_22":-7,"_65":1080,"_29":-7,"_66":10,"_30":2255,"_25":2256,"_23":2257,"_58":-7},{"_21":63,"_27":2177,"_22":-7,"_65":1080,"_29":-7,"_66":10,"_30":2178,"_25":2179,"_23":2180,"_58":-7},{"_21":63,"_27":2129,"_22":-7,"_65":1080,"_29":-7,"_66":10,"_30":2130,"_25":2131,"_23":2132,"_58":-7},{"_21":63,"_27":2075,"_22":-7,"_65":1080,"_29":-7,"_66":10,"_30":2076,"_25":2077,"_23":2078,"_58":-7},{"_21":63,"_27":2039,"_22":-7,"_65":1080,"_29":-7,"_66":10,"_30":2040,"_25":2041,"_23":2042,"_58":-7},{"_21":63,"_27":1865,"_22":-7,"_65":1080,"_29":-7,"_66":10,"_30":1866,"_25":1867,"_23":1868,"_58":-7},{"_21":63,"_27":1751,"_22":-7,"_65":1080,"_29":-7,"_66":10,"_30":1752,"_25":1753,"_23":1754,"_58":-7},{"_21":63,"_27":1704,"_22":-7,"_65":1080,"_29":-7,"_66":10,"_30":1705,"_25":1706,"_23":1707,"_58":-7},{"_21":63,"_27":1638,"_22":-7,"_65":1080,"_29":-7,"_66":10,"_30":1639,"_25":1640,"_23":1641,"_58":-7},{"_21":63,"_27":1626,"_22":-7,"_65":1080,"_29":-7,"_66":10,"_30":1627,"_25":1628,"_23":1629,"_58":-7},{"_21":63,"_27":1596,"_22":-7,"_65":1080,"_29":-7,"_66":10,"_30":1597,"_25":1598,"_23":1599,"_58":-7},{"_21":63,"_27":1584,"_22":-7,"_65":1080,"_29":-7,"_66":10,"_30":1585,"_25":1586,"_23":1587,"_58":-7},{"_21":63,"_27":1572,"_22":-7,"_65":1080,"_29":-7,"_66":10,"_30":1573,"_25":1574,"_23":1575,"_58":-7},{"_21":63,"_27":1548,"_22":-7,"_65":1080,"_29":-7,"_66":10,"_30":1549,"_25":1550,"_23":1551,"_58":-7},{"_21":63,"_27":1530,"_22":-7,"_65":1080,"_29":-7,"_66":10,"_30":1531,"_25":1532,"_23":1533,"_58":-7},{"_21":63,"_27":1476,"_22":-7,"_65":1080,"_29":-7,"_66":10,"_30":1477,"_25":1478,"_23":1479,"_58":-7},{"_21":63,"_27":1416,"_22":-7,"_65":1080,"_29":-7,"_66":10,"_30":1417,"_25":1418,"_23":1419,"_58":-7},{"_21":63,"_27":1404,"_22":-7,"_65":1080,"_29":-7,"_66":10,"_30":1405,"_25":1406,"_23":1407,"_58":-7},{"_21":63,"_27":1392,"_22":-7,"_65":1080,"_29":-7,"_66":10,"_30":1393,"_25":1394,"_23":1395,"_58":-7},{"_21":63,"_27":1332,"_22":-7,"_65":1080,"_29":-7,"_66":10,"_30":1333,"_25":1334,"_23":1335,"_58":-7},{"_21":63,"_27":1302,"_22":-7,"_65":1080,"_29":-7,"_66":10,"_30":1303,"_25":1304,"_23":1305,"_58":-7},{"_21":63,"_27":1260,"_22":-7,"_65":1080,"_29":-7,"_66":10,"_30":1261,"_25":1262,"_23":1263,"_58":-7},{"_21":63,"_27":1230,"_22":-7,"_65":1080,"_29":-7,"_66":10,"_30":1231,"_25":1232,"_23":1233,"_58":-7},{"_21":63,"_27":1200,"_22":-7,"_65":1080,"_29":-7,"_66":10,"_30":1201,"_25":1202,"_23":1203,"_58":-7},{"_21":63,"_27":1152,"_22":-7,"_65":1080,"_29":-7,"_66":10,"_30":1153,"_25":1154,"_23":1155,"_58":-7},{"_21":63,"_27":1122,"_22":-7,"_65":1080,"_29":-7,"_66":10,"_30":1123,"_25":1124,"_23":1125,"_58":-7},{"_21":63,"_27":1098,"_22":-7,"_65":1080,"_29":-7,"_66":10,"_30":1099,"_25":1100,"_23":1101,"_58":-7},{"_21":63,"_27":1079,"_22":-7,"_65":1080,"_29":-7,"_66":10,"_30":1081,"_25":1082,"_23":1083,"_58":-7},"Web",true,[1086,1087],"en:api/reference/web",{"_63":1084,"_72":1085},"api/reference/web","api/reference/web/meta.json",{"_25":1093,"_21":55,"_27":1094,"_29":1095,"_58":-7,"_60":1096,"_23":1097},{"_25":1088,"_21":55,"_27":1089,"_29":1090,"_58":-7,"_60":1091,"_23":1092},"en:api/reference/web/web_search.mdx","web_search POST","Search the public web and return ranked result snippets. Use this when you need current information, facts, or links that are not already in context. Do not use for workspace data, calendar, mail, or tasks — those have dedicated tools.\n\n`read` · v1","/api/reference/web/web_search","api/reference/web/web_search.mdx","en:api/reference/web/web_fetch.mdx","web_fetch POST","Fetch and return the text content of one or more public URLs. Use after web_search when you need the full page content, not just a snippet. Do not fetch localhost or private network addresses — those are blocked.\n\n`read` · v1","/api/reference/web/web_fetch","api/reference/web/web_fetch.mdx","Tokens",[1104,1105,1106],"en:api/reference/tokens",{"_63":1102,"_72":1103},"api/reference/tokens","api/reference/tokens/meta.json",{"_25":1117,"_21":55,"_27":1118,"_29":1119,"_58":-7,"_60":1120,"_23":1121},{"_25":1112,"_21":55,"_27":1113,"_29":1114,"_58":-7,"_60":1115,"_23":1116},{"_25":1107,"_21":55,"_27":1108,"_29":1109,"_58":-7,"_60":1110,"_23":1111},"en:api/reference/tokens/revokeToken.mdx","Revoke a token DELETE","Revokes one token by name. The token authenticating the call cannot be the one revoked: see the replacement answer first, then revoke the old one with it.","/api/reference/tokens/revokeToken","api/reference/tokens/revokeToken.mdx","en:api/reference/tokens/listTokens.mdx","List tokens GET","The names, rungs, expiry and last use of the tokens this token's owner holds. No token value is kept anywhere, so none is answered.","/api/reference/tokens/listTokens","api/reference/tokens/listTokens.mdx","en:api/reference/tokens/createToken.mdx","Make a token POST","Issues a token to the same person as the one calling. `permission` defaults to the calling rung and may not reach past it. Omitting `name` takes the first ordinal nobody holds. A token expires after `expiresInDays`, 90 when omitted and at most 365; an expired one is renewed by making another by the same name. The `token` field is shown this once and never again.","/api/reference/tokens/createToken","api/reference/tokens/createToken.mdx","Team",[1128,1129,1130,1131],"en:api/reference/team",{"_63":1126,"_72":1127},"api/reference/team","api/reference/team/meta.json",{"_25":1147,"_21":55,"_27":1148,"_29":1149,"_58":-7,"_60":1150,"_23":1151},{"_25":1142,"_21":55,"_27":1143,"_29":1144,"_58":-7,"_60":1145,"_23":1146},{"_25":1137,"_21":55,"_27":1138,"_29":1139,"_58":-7,"_60":1140,"_23":1141},{"_25":1132,"_21":55,"_27":1133,"_29":1134,"_58":-7,"_60":1135,"_23":1136},"en:api/reference/team/team_update.mdx","team_update POST","Rename one team, move that organization under another one, or change where it sits among its siblings. Only the fields the call names change, and only an administrator edits the organization chart. Moving an organization under one of its own descendants is refused.\n\n`workspace_write` · v1","/api/reference/team/team_update","api/reference/team/team_update.mdx","en:api/reference/team/team_list.mdx","team_list POST","Every team in the company — the organizations the organization chart holds — in the order it shows them, each with the organization it sits under and how many people belong to it. Call this before naming an organization in another call, and when an organization hint was refused with candidates to choose between.\n\n`read` · v1","/api/reference/team/team_list","api/reference/team/team_list.mdx","en:api/reference/team/team_delete.mdx","team_delete POST","Remove one team from the organization chart, so that organization is gone. Everybody who belonged to it keeps their directory entry and belongs to no organization until somebody moves them. An organization with organizations under it is refused; remove or move those first. Requires approval; this action is irreversible.\n\n`destructive` · approval · v1","/api/reference/team/team_delete","api/reference/team/team_delete.mdx","en:api/reference/team/team_add.mdx","team_add POST","Create one team, an organization on the chart, optionally under another one. Only an administrator edits the organization chart. Creating an organization puts nobody in it; person_update moves people.\n\n`workspace_write` · v1","/api/reference/team/team_add","api/reference/team/team_add.mdx","Task",[1158,1159,1160,1161,1162,1163,1164],"en:api/reference/task",{"_63":1156,"_72":1157},"api/reference/task","api/reference/task/meta.json",{"_25":1195,"_21":55,"_27":1196,"_29":1197,"_58":-7,"_60":1198,"_23":1199},{"_25":1190,"_21":55,"_27":1191,"_29":1192,"_58":-7,"_60":1193,"_23":1194},{"_25":1185,"_21":55,"_27":1186,"_29":1187,"_58":-7,"_60":1188,"_23":1189},{"_25":1180,"_21":55,"_27":1181,"_29":1182,"_58":-7,"_60":1183,"_23":1184},{"_25":1175,"_21":55,"_27":1176,"_29":1177,"_58":-7,"_60":1178,"_23":1179},{"_25":1170,"_21":55,"_27":1171,"_29":1172,"_58":-7,"_60":1173,"_23":1174},{"_25":1165,"_21":55,"_27":1166,"_29":1167,"_58":-7,"_60":1168,"_23":1169},"en:api/reference/task/task_vocabulary_set.mdx","task_vocabulary_set POST","Set the task vocabulary: the business and task type labels this company files work under. Each list sent is written at once, so read registeredLabels from a task_list result first and send it back with what changes; a list left out is kept. A label a task still carries cannot be dropped. This is an administrator’s.\n\n`workspace_write` · v1","/api/reference/task/task_vocabulary_set","api/reference/task/task_vocabulary_set.mdx","en:api/reference/task/task_update.mdx","task_update POST","Update explicit fields on an existing task, including who takes part in it, when canUpdate in task_list says the caller may change it. Classification fields use registeredLabels from task_list: business is a workspace label, while organizationHint and opportunityHint link CRM records. Choose classification values from those labels and the work context when the requester delegates that judgment. taskHint is the exact task ID or exact task title from a task_list result, resolved server-side to the canonical task; use task_list first when neither is known. At least one mutable field is required.\n\n`workspace_write` · v6","/api/reference/task/task_update","api/reference/task/task_update.mdx","en:api/reference/task/task_list.mdx","task_list POST","List workspace tasks with optional filters. Use this to answer 'what tasks does X have', 'what is on my plate', or 'show incomplete items this week'. It reads the requester's own tasks unless personHints names other people or scope is all.\n\n`read` · v4","/api/reference/task/task_list","api/reference/task/task_list.mdx","en:api/reference/task/task_label_get.mdx","task_label_get POST","Get the business, type and size labels a new task should carry, decided by the company's model from the task's title and note against the company's registered definitions. A label nothing fits comes back as an empty string.\n\n`computation` · v1","/api/reference/task/task_label_get","api/reference/task/task_label_get.mdx","en:api/reference/task/task_delete.mdx","task_delete POST","Permanently delete a task. taskHint is the exact task ID or exact task title from a task_list result, resolved server-side to the canonical task; use task_list first when neither is known. Only an admin, the member who asked for the task, or the one person taking part in it can delete it; task_list says so in canDelete. Requires approval; this action is irreversible.\n\n`destructive` · approval · v3","/api/reference/task/task_delete","api/reference/task/task_delete.mdx","en:api/reference/task/task_board_get.mdx","task_board_get POST","Get one task board week: its visible cards, including undated and overdue carry-over work, with direct-child progress across all weeks. Counts describe this board selection; use task_list for complete history and reports. Uses the same person scope and read permissions as task_list.\n\n`read` · v1","/api/reference/task/task_board_get","api/reference/task/task_board_get.mdx","en:api/reference/task/task_add.mdx","task_add POST","Create a new workspace task with typed task fields. Never ask the user to classify it: send the business when you know it, and the record decides whatever business, type and size is left out from the company definitions. Use this to add a todo or assignment for the requester or another team member. Use task_update for existing work.\n\n`workspace_write` · v7","/api/reference/task/task_add","api/reference/task/task_add.mdx","Schedule",[1206,1207,1208,1209],"en:api/reference/schedule",{"_63":1204,"_72":1205},"api/reference/schedule","api/reference/schedule/meta.json",{"_25":1225,"_21":55,"_27":1226,"_29":1227,"_58":-7,"_60":1228,"_23":1229},{"_25":1220,"_21":55,"_27":1221,"_29":1222,"_58":-7,"_60":1223,"_23":1224},{"_25":1215,"_21":55,"_27":1216,"_29":1217,"_58":-7,"_60":1218,"_23":1219},{"_25":1210,"_21":55,"_27":1211,"_29":1212,"_58":-7,"_60":1213,"_23":1214},"en:api/reference/schedule/schedule_update.mdx","schedule_update POST","Change explicit fields on a reminder or recurring alert the requester set up, including how often it repeats and when it next arrives. Use schedule_list first when neither the schedule ID nor its current description is known. At least one field to change is required.\n\n`workspace_write` · v1","/api/reference/schedule/schedule_update","api/reference/schedule/schedule_update.mdx","en:api/reference/schedule/schedule_list.mdx","schedule_list POST","List scheduled tasks created by the current requester. Filter by active, failed, or expired status and cap the result with limit. Use it to answer what reminders or recurring tasks are scheduled.\n\n`read` · v1","/api/reference/schedule/schedule_list","api/reference/schedule/schedule_list.mdx","en:api/reference/schedule/schedule_create.mdx","schedule_create POST","Schedule a reminder or a recurring alert: work the agent does later, once at a time you name or on a repeat. It arrives in the conversation it was asked in, so it can only be created from one. Use schedule_update to change one that already exists.\n\n`workspace_write` · v1","/api/reference/schedule/schedule_create","api/reference/schedule/schedule_create.mdx","en:api/reference/schedule/schedule_cancel.mdx","schedule_cancel POST","Stop a reminder or recurring alert the requester set up, so it stops arriving. Use schedule_list first when neither the schedule IDs nor their current descriptions are known. A cancelled schedule never runs again; schedule_create makes a new one. Silencing a whole category of notice instead is notification_settings_set's.\n\n`workspace_write` · v1","/api/reference/schedule/schedule_cancel","api/reference/schedule/schedule_cancel.mdx","Persona",[1236,1237,1238,1239],"en:api/reference/persona",{"_63":1234,"_72":1235},"api/reference/persona","api/reference/persona/meta.json",{"_25":1255,"_21":55,"_27":1256,"_29":1257,"_58":-7,"_60":1258,"_23":1259},{"_25":1250,"_21":55,"_27":1251,"_29":1252,"_58":-7,"_60":1253,"_23":1254},{"_25":1245,"_21":55,"_27":1246,"_29":1247,"_58":-7,"_60":1248,"_23":1249},{"_25":1240,"_21":55,"_27":1241,"_29":1242,"_58":-7,"_60":1243,"_23":1244},"en:api/reference/persona/persona_profile_update.mdx","persona_profile_update POST","Change the requester's persona profile, the only profile this ever changes. Only the fields the call names change, down to one nested field: morningBriefing with only enabled false turns the briefing off and keeps its time. A list such as preferences replaces the whole list. The whole profile is answered back.\n\n`workspace_write` · v1","/api/reference/persona/persona_profile_update","api/reference/persona/persona_profile_update.mdx","en:api/reference/persona/persona_profile_get.mdx","persona_profile_get POST","Read the requester's persona profile, which says how they want the agent to work with them: what to call them, what to know about them, their preferences, tone and reply language, and the daily morning briefing's time and whether it is on. It is always the requester's own.\n\n`read` · v1","/api/reference/persona/persona_profile_get","api/reference/persona/persona_profile_get.mdx","en:api/reference/persona/persona_identity_update.mdx","persona_identity_update POST","Change the agent's persona identity for the whole company. Only an administrator may. Only the fields the call names change, and names replaces the whole list. Every colleague meets the agent by these names, so put it to the requester before calling. The whole identity is answered back.\n\n`workspace_write` · approval · v1","/api/reference/persona/persona_identity_update","api/reference/persona/persona_identity_update.mdx","en:api/reference/persona/persona_identity_get.mdx","persona_identity_get POST","Read the agent's persona identity: every name it answers to, the first being the one it introduces itself with, and its handle, role, creature, emoji and introduction. There is one for the whole company, and any member may read it.\n\n`read` · v1","/api/reference/persona/persona_identity_get","api/reference/persona/persona_identity_get.mdx","Person",[1266,1267,1268,1269,1270,1271],"en:api/reference/person",{"_63":1264,"_72":1265},"api/reference/person","api/reference/person/meta.json",{"_25":1297,"_21":55,"_27":1298,"_29":1299,"_58":-7,"_60":1300,"_23":1301},{"_25":1292,"_21":55,"_27":1293,"_29":1294,"_58":-7,"_60":1295,"_23":1296},{"_25":1287,"_21":55,"_27":1288,"_29":1289,"_58":-7,"_60":1290,"_23":1291},{"_25":1282,"_21":55,"_27":1283,"_29":1284,"_58":-7,"_60":1285,"_23":1286},{"_25":1277,"_21":55,"_27":1278,"_29":1279,"_58":-7,"_60":1280,"_23":1281},{"_25":1272,"_21":55,"_27":1273,"_29":1274,"_58":-7,"_60":1275,"_23":1276},"en:api/reference/person/person_withdraw.mdx","person_withdraw POST","Withdraw one person from the company: their membership ends, they can no longer sign in, they leave the company messenger, and every screen stops showing them, while the attendance, leave and tasks they left behind still read. Only an administrator withdraws people, and never themselves. With purge, the person is deleted outright instead when nothing refers to them. To delete what they wrote in the messenger, call person_message_delete first, while they are still in the directory. Requires approval; this action is irreversible.\n\n`destructive` · approval · v1","/api/reference/person/person_withdraw","api/reference/person/person_withdraw.mdx","en:api/reference/person/person_update.mdx","person_update POST","Change what the company directory holds about one person: their name, their job title, their organization, who they report to, their phone number, the day they started, whether they administer the company, and whether they still work here. Only the fields the call names change. A person may correct their own phone number and start date; every other field, and anybody else's, is an administrator's. Ask the requester first before raising or lowering administrator rights or marking somebody departed; both are wide changes somebody has to mean.\n\n`workspace_write` · v2","/api/reference/person/person_update","api/reference/person/person_update.mdx","en:api/reference/person/person_password_reset.mdx","person_password_reset POST","Reset one person's password: their old password stops working and they get a temporary password to sign in with once. Only an administrator resets a password, and an administrator's password only its owner resets. The answer carries the temporary password, which is the only time it is readable, so pass it to the person who asked. Requires approval; the old password cannot be brought back.\n\n`destructive` · approval · v1","/api/reference/person/person_password_reset","api/reference/person/person_password_reset.mdx","en:api/reference/person/person_message_delete.mdx","person_message_delete POST","Delete every message one person has written in the company messenger, in every conversation, for somebody leaving or asking to be forgotten. Only an administrator may. It reaches only a person still in the directory, so call it before person_withdraw. The answer counts what was deleted. Requires approval; deleted messages cannot be brought back.\n\n`destructive` · approval · v1","/api/reference/person/person_message_delete","api/reference/person/person_message_delete.mdx","en:api/reference/person/person_list.mdx","person_list POST","Everyone who works here, with their exact name, email and mention, and what the company directory holds about them: their job title, their organization, who they report to, and when they started. Call this when somebody asks who a person is or who works here, and when a person hint was refused with a list of candidates to choose between. Do not call it to turn a fragment into a name before another call: person hints take the fragment as it was written and the server resolves it, so a name given partly or by a given name alone is already enough. requesterID names which of them is asking.\n\n`read` · v4","/api/reference/person/person_list","api/reference/person/person_list.mdx","en:api/reference/person/person_invite.mdx","person_invite POST","Invite somebody to the company: it creates their account, gives them a temporary password to sign in with once, and puts them in the directory. Only an administrator invites people. The answer carries the temporary password, which is the only time it is readable, so pass it to whoever is bringing the person in. Requires approval; an account and an address are hard to take back.\n\n`workspace_write` · approval · v1","/api/reference/person/person_invite","api/reference/person/person_invite.mdx","Notification",[1308,1309,1310,1311],"en:api/reference/notification",{"_63":1306,"_72":1307},"api/reference/notification","api/reference/notification/meta.json",{"_25":1327,"_21":55,"_27":1328,"_29":1329,"_58":-7,"_60":1330,"_23":1331},{"_25":1322,"_21":55,"_27":1323,"_29":1324,"_58":-7,"_60":1325,"_23":1326},{"_25":1317,"_21":55,"_27":1318,"_29":1319,"_58":-7,"_60":1320,"_23":1321},{"_25":1312,"_21":55,"_27":1313,"_29":1314,"_58":-7,"_60":1315,"_23":1316},"en:api/reference/notification/notification_settings_set.mdx","notification_settings_set POST","Change the notification settings: which categories of notice the requester is told about at all, and which conversations are muted. This is the standing preference, not one arriving reminder: a repeating alert the requester set up is stopped with schedule_cancel. Only the categories the call names change, and the whole setting is answered back. A category the requester may not choose is refused by name rather than quietly dropped.\n\n`workspace_write` · v1","/api/reference/notification/notification_settings_set","api/reference/notification/notification_settings_set.mdx","en:api/reference/notification/notification_settings_get.mdx","notification_settings_get POST","The notification settings: what the requester is told about, category by category, and the conversations they have muted. The kinds of thing a person is told about: message for something somebody wrote them, task for work assigned to them, approval for something waiting on their decision, attendance for their own clock, leave for the requests colleagues send, calendar for an event about to start, and mail for a new message in a connected mailbox. A category the requester may not choose is answered with isChoosable false, so a change to it would be refused.\n\n`read` · v1","/api/reference/notification/notification_settings_get","api/reference/notification/notification_settings_get.mdx","en:api/reference/notification/conversation_unmute.mdx","conversation_unmute POST","Tell the requester about a conversation again. Read notification_settings_get for the conversations that are muted now.\n\n`workspace_write` · v1","/api/reference/notification/conversation_unmute","api/reference/notification/conversation_unmute.mdx","en:api/reference/notification/conversation_mute.mdx","conversation_mute POST","Stop telling the requester about a conversation. The messages keep arriving; the requester is not notified of them. This is the requester's own, and it changes nothing for anybody else in the conversation.\n\n`workspace_write` · v1","/api/reference/notification/conversation_mute","api/reference/notification/conversation_mute.mdx","Message",[1338,1339,1340,1341,1342,1343,1344,1345,1346],"en:api/reference/message",{"_63":1336,"_72":1337},"api/reference/message","api/reference/message/meta.json",{"_25":1387,"_21":55,"_27":1388,"_29":1389,"_58":-7,"_60":1390,"_23":1391},{"_25":1382,"_21":55,"_27":1383,"_29":1384,"_58":-7,"_60":1385,"_23":1386},{"_25":1377,"_21":55,"_27":1378,"_29":1379,"_58":-7,"_60":1380,"_23":1381},{"_25":1372,"_21":55,"_27":1373,"_29":1374,"_58":-7,"_60":1375,"_23":1376},{"_25":1367,"_21":55,"_27":1368,"_29":1369,"_58":-7,"_60":1370,"_23":1371},{"_25":1362,"_21":55,"_27":1363,"_29":1364,"_58":-7,"_60":1365,"_23":1366},{"_25":1357,"_21":55,"_27":1358,"_29":1359,"_58":-7,"_60":1360,"_23":1361},{"_25":1352,"_21":55,"_27":1353,"_29":1354,"_58":-7,"_60":1355,"_23":1356},{"_25":1347,"_21":55,"_27":1348,"_29":1349,"_58":-7,"_60":1350,"_23":1351},"en:api/reference/message/message_update.mdx","message_update POST","Change a message the assistant or the requester wrote. To correct it, pass oldText, one exact span copied verbatim from a message_search preview or from the message you sent, and newText; the rest stays untouched, and oldText must appear exactly once or the call fails without changing anything and returns the message as it currently reads, so retry with a span copied from that. To rewrite it, pass text, which replaces the whole message; read it in full first with message_search messageIDs. This is the tool for every correction to something you already posted: when the user points out a mistake, fix that message instead of posting a correction as a new one. It runs immediately without asking the user to confirm. attachments uploads workspace files into the edited message; pass it alone to add a file, such as an inbound image original, without changing the text.\n\n`external_write` · v3","/api/reference/message/message_update","api/reference/message/message_update.mdx","en:api/reference/message/message_send.mdx","message_send POST","Send a message to a direct message, channel, or the current conversation after approval. attachments uploads workspace files with the message. For targetType=channel, name the channel with channelName; only pass a channelID a tool result gave you. Never answer the person you are replying to with this tool — the final reply is delivered for you. To correct a sent message, use message_update.\n\n`external_send` · approval · v3","/api/reference/message/message_send","api/reference/message/message_send.mdx","en:api/reference/message/message_search.mdx","message_search POST","Find messages in an exact conversation scope, or read known ones in full. Searching by queries returns message IDs with a short preview around the match. Passing messageIDs instead returns those messages complete, which is what you need before rewriting or summarising a long message rather than a phrase inside it.\n\n`read` · v2","/api/reference/message/message_search","api/reference/message/message_search.mdx","en:api/reference/message/message_reaction_delete.mdx","message_reaction_delete POST","Take back a reaction the requester left on a message. Name the emoji the same way it was added; a reaction the requester never left changes nothing.\n\n`external_write` · v1","/api/reference/message/message_reaction_delete","api/reference/message/message_reaction_delete.mdx","en:api/reference/message/message_reaction_add.mdx","message_reaction_add POST","Add an emoji reaction to a message as the requester, the way their messenger screen does.\n\n`external_write` · v1","/api/reference/message/message_reaction_add","api/reference/message/message_reaction_add.mdx","en:api/reference/message/message_delete.mdx","message_delete POST","Permanently delete exact message IDs from message_search after approval. You may delete yours, the assistant's, or anyone's if you hold the channel admin role. List only the exact messages the user asked to remove; when several search matches quote or mention the same text, pick the one message that is the target itself, never the whole match list.\n\n`destructive` · approval · v2","/api/reference/message/message_delete","api/reference/message/message_delete.mdx","en:api/reference/message/message_context.mdx","message_context POST","Return the conversation the message arrived in, exactly as the messenger holds it, with its thread, requester, and bot identities.\n\n`read` · v2","/api/reference/message/message_context","api/reference/message/message_context.mdx","en:api/reference/message/conversation_reveal.mdx","conversation_reveal POST","Show a direct conversation the requester hid with conversation_hide in their conversation list again.\n\n`external_write` · v1","/api/reference/message/conversation_reveal","api/reference/message/conversation_reveal.mdx","en:api/reference/message/conversation_hide.mdx","conversation_hide POST","Hide the requester's direct conversation with one person from their own conversation list. Nothing is deleted and nobody else is affected; conversation_reveal shows it again.\n\n`external_write` · v1","/api/reference/message/conversation_hide","api/reference/message/conversation_hide.mdx","Member",[1398],"en:api/reference/member",{"_63":1396,"_72":1397},"api/reference/member","api/reference/member/meta.json",{"_25":1399,"_21":55,"_27":1400,"_29":1401,"_58":-7,"_60":1402,"_23":1403},"en:api/reference/member/keepMemberPicture.mdx","Keep my picture POST","The picture the member set on their messenger, or when there is none the gradient the app draws from their email, sent in the `file` field of `multipart/form-data` as PNG, JPEG, WebP, GIF, HEIC or HEIF and kept as that member's picture. A notification cannot draw, so it can only show a picture that is kept. A picture kept through this endpoint is replaced by a new one; a picture set anywhere else, or the same picture again, is left as it is and `kept` is `false`.","/api/reference/member/keepMemberPicture","api/reference/member/keepMemberPicture.mdx","Mcp",[1410],"en:api/reference/mcp",{"_63":1408,"_72":1409},"api/reference/mcp","api/reference/mcp/meta.json",{"_25":1411,"_21":55,"_27":1412,"_29":1413,"_58":-7,"_60":1414,"_23":1415},"en:api/reference/mcp/speakMCP.mdx","Reach the same tools over MCP POST","The same tools, served over the Model Context Protocol on Streamable HTTP. It takes the same Bearer token as the rest of this API, and a client reads the tool list and the schemas with MCP's own tools/list, which is why neither is written out here.","/api/reference/mcp/speakMCP","api/reference/mcp/speakMCP.mdx","Mail",[1422,1423,1424,1425,1426,1427,1428,1429,1430],"en:api/reference/mail",{"_63":1420,"_72":1421},"api/reference/mail","api/reference/mail/meta.json",{"_25":1471,"_21":55,"_27":1472,"_29":1473,"_58":-7,"_60":1474,"_23":1475},{"_25":1466,"_21":55,"_27":1467,"_29":1468,"_58":-7,"_60":1469,"_23":1470},{"_25":1461,"_21":55,"_27":1462,"_29":1463,"_58":-7,"_60":1464,"_23":1465},{"_25":1456,"_21":55,"_27":1457,"_29":1458,"_58":-7,"_60":1459,"_23":1460},{"_25":1451,"_21":55,"_27":1452,"_29":1453,"_58":-7,"_60":1454,"_23":1455},{"_25":1446,"_21":55,"_27":1447,"_29":1448,"_58":-7,"_60":1449,"_23":1450},{"_25":1441,"_21":55,"_27":1442,"_29":1443,"_58":-7,"_60":1444,"_23":1445},{"_25":1436,"_21":55,"_27":1437,"_29":1438,"_58":-7,"_60":1439,"_23":1440},{"_25":1431,"_21":55,"_27":1432,"_29":1433,"_58":-7,"_60":1434,"_23":1435},"en:api/reference/mail/mail_message_send.mdx","mail_message_send POST","Send an email message from the requester's connected mail account. Provide at least one recipient in 'to', a subject, and a body. Requires approval before sending.\n\n`external_send` · approval · v1","/api/reference/mail/mail_message_send","api/reference/mail/mail_message_send.mdx","en:api/reference/mail/mail_message_search.mdx","mail_message_search POST","Search mail messages by keyword, sender, or subject. Returns matching messages with their UIDs for use with mail.message.read. Do not put pagination cursors in the query field.\n\n`read` · v1","/api/reference/mail/mail_message_search","api/reference/mail/mail_message_search.mdx","en:api/reference/mail/mail_message_read.mdx","mail_message_read POST","Fetch the full content of a single mail message by its mailbox name and UID. The UID must come from a prior mail_message_list or mail_message_search result — never invent a UID.\n\n`read` · v1","/api/reference/mail/mail_message_read","api/reference/mail/mail_message_read.mdx","en:api/reference/mail/mail_message_move.mdx","mail_message_move POST","Move one mail message to a different mailbox folder (e.g. Archive, Trash). The UID and mailbox must come from a prior list or search result. Use this to archive or sort messages.\n\n`workspace_write` · v1","/api/reference/mail/mail_message_move","api/reference/mail/mail_message_move.mdx","en:api/reference/mail/mail_message_mark.mdx","mail_message_mark POST","Set the read (seen) or starred (flagged) status of one mail message. The UID and mailbox must come from a prior list or search result. Omit a flag field to leave it unchanged.\n\n`workspace_write` · v1","/api/reference/mail/mail_message_mark","api/reference/mail/mail_message_mark.mdx","en:api/reference/mail/mail_message_list.mdx","mail_message_list POST","List the mail in a mailbox folder, one page of messages at a time. Use this to browse recent email; use mail_message_search when you need to find by keyword or subject.\n\n`read` · v1","/api/reference/mail/mail_message_list","api/reference/mail/mail_message_list.mdx","en:api/reference/mail/mail_mailbox_list.mdx","mail_mailbox_list POST","List the requester's mail folders with their unread and total counts. Call this to learn the folder names the other mail tools take as `mailbox`, rather than guessing them.\n\n`read` · v1","/api/reference/mail/mail_mailbox_list","api/reference/mail/mail_mailbox_list.mdx","en:api/reference/mail/mail_connection_status.mdx","mail_connection_status POST","Check the mail connection: whether the requester's email account is connected. Answers this when a mail call has failed for want of an account, or when none has been made yet.\n\n`read` · v1","/api/reference/mail/mail_connection_status","api/reference/mail/mail_connection_status.mdx","en:api/reference/mail/mail_connection_start.mdx","mail_connection_start POST","Start the mail account connection flow and return setup instructions for the requester. Requires the user to be present (RequiresUserPresence=true). Only call this when mail_connection_status reports mail is not connected.\n\n`connect` · approval · presence · v1","/api/reference/mail/mail_connection_start","api/reference/mail/mail_connection_start.mdx","Leave",[1482,1483,1484,1485,1486,1487,1488,1489],"en:api/reference/leave",{"_63":1480,"_72":1481},"api/reference/leave","api/reference/leave/meta.json",{"_25":1525,"_21":55,"_27":1526,"_29":1527,"_58":-7,"_60":1528,"_23":1529},{"_25":1520,"_21":55,"_27":1521,"_29":1522,"_58":-7,"_60":1523,"_23":1524},{"_25":1515,"_21":55,"_27":1516,"_29":1517,"_58":-7,"_60":1518,"_23":1519},{"_25":1510,"_21":55,"_27":1511,"_29":1512,"_58":-7,"_60":1513,"_23":1514},{"_25":1505,"_21":55,"_27":1506,"_29":1507,"_58":-7,"_60":1508,"_23":1509},{"_25":1500,"_21":55,"_27":1501,"_29":1502,"_58":-7,"_60":1503,"_23":1504},{"_25":1495,"_21":55,"_27":1496,"_29":1497,"_58":-7,"_60":1498,"_23":1499},{"_25":1490,"_21":55,"_27":1491,"_29":1492,"_58":-7,"_60":1493,"_23":1494},"en:api/reference/leave/leave_update.mdx","leave_update POST","Correct a leave that was filed wrong: its days, its kind, how much entitlement it consumes, or the note. A person corrects their own while it is still waiting on a decision; an administrator corrects anybody's at any time, which is how a leave filed for the wrong year is moved to the right one. Only the fields you pass change.\n\n`workspace_write` · approval · v2","/api/reference/leave/leave_update","api/reference/leave/leave_update.mdx","en:api/reference/leave/leave_return_early.mdx","leave_return_early POST","Return to work early, before the leave was due to end. The leave the requester is on stops at this moment, the entitlement it no longer spends comes back to them, and they are clocked in. Use it when somebody who is away says they are back; clocking in on an ordinary day is attendance_add. It is the requester's own leave and nobody else's. shortened is false when no leave was covering the moment, and they are clocked in either way.\n\n`workspace_write` · v1","/api/reference/leave/leave_return_early","api/reference/leave/leave_return_early.mdx","en:api/reference/leave/leave_request.mdx","leave_request POST","File a leave request. It is filed as requested and grants nothing until somebody decides it. Whether the leave is paid and whether it consumes the entitlement follow from the kind, so do not ask the requester for either. It is the requester's own leave unless personHint names somebody else, which only an administrator may do.\n\n`workspace_write` · v2","/api/reference/leave/leave_request","api/reference/leave/leave_request.mdx","en:api/reference/leave/leave_list.mdx","leave_list POST","List leave in the record. Use this to answer 'when am I off', 'who is away next week', or 'what have I not had decided yet'. It reads the requester's own leave unless personHints names other people or scope is all. registeredKinds in the result names the leave types this company offers, which is what leave_request takes.\n\n`read` · v2","/api/reference/leave/leave_list","api/reference/leave/leave_list.mdx","en:api/reference/leave/leave_grant_set.mdx","leave_grant_set POST","Set how much leave one person is entitled to in a year. Only an administrator may, and the record refuses anybody else. The number replaces every grant they hold, so 'give them three more days' is read with leave_balance first and written as the total. Somebody who has never been given a number of their own holds the company's annual grant, which company_settings_get answers as leaveDays. Requires approval; an entitlement is what every later leave is spent against.\n\n`workspace_write` · approval · v1","/api/reference/leave/leave_grant_set","api/reference/leave/leave_grant_set.mdx","en:api/reference/leave/leave_delete.mdx","leave_delete POST","Take a leave back out of the record entirely, as though it was never filed. A person takes back their own while it is still waiting on a decision; an administrator takes back anybody's. Entitlement an approved leave spent comes back with it. To refuse a leave rather than erase it, decide it rejected.\n\n`destructive` · approval · v2","/api/reference/leave/leave_delete","api/reference/leave/leave_delete.mdx","en:api/reference/leave/leave_decide.mdx","leave_decide POST","Approve or reject a leave request. Only an administrator may, and the record refuses anybody else. An approval is what spends the entitlement, so it requires approval from the person asking for it.\n\n`workspace_write` · approval · v2","/api/reference/leave/leave_decide","api/reference/leave/leave_decide.mdx","en:api/reference/leave/leave_balance.mdx","leave_balance POST","Read how much leave is left for a year. Use this to answer 'how many days do I have left'. The default scope is the requester; scope all is everybody who works here, which is what reviewing entitlements wants. tracking is unlimited when the company grants no fixed entitlement, and then the day counts are null rather than zero. Somebody whose balance the requester may not read comes back with null day counts rather than failing.\n\n`read` · v2","/api/reference/leave/leave_balance","api/reference/leave/leave_balance.mdx","Image",[1536,1537],"en:api/reference/image",{"_63":1534,"_72":1535},"api/reference/image","api/reference/image/meta.json",{"_25":1543,"_21":55,"_27":1544,"_29":1545,"_58":-7,"_60":1546,"_23":1547},{"_25":1538,"_21":55,"_27":1539,"_29":1540,"_58":-7,"_60":1541,"_23":1542},"en:api/reference/image/image_read.mdx","image_read POST","Read a workspace image and return a base64 attachment. path takes an exact /workspace path, or an attachment's exact url copied verbatim from the conversation — an image attached to an earlier message is fetched by that url. Never invent a filesystem path from a url. Use document_read for document files.\n\n`read` · v1","/api/reference/image/image_read","api/reference/image/image_read.mdx","en:api/reference/image/image_generate.mdx","image_generate POST","Generate a new image from a text prompt and save it to a workspace path. Provide an absolute /workspace output path ending in .png. Optionally set aspectRatio. Returns the saved image as an attachment. Use image_read instead if you need to read an existing image file.\n\n`external_write` · v1","/api/reference/image/image_generate","api/reference/image/image_generate.mdx","Host",[1554,1555,1556],"en:api/reference/host",{"_63":1552,"_72":1553},"api/reference/host","api/reference/host/meta.json",{"_25":1567,"_21":55,"_27":1568,"_29":1569,"_58":-7,"_60":1570,"_23":1571},{"_25":1562,"_21":55,"_27":1563,"_29":1564,"_58":-7,"_60":1565,"_23":1566},{"_25":1557,"_21":55,"_27":1558,"_29":1559,"_58":-7,"_60":1560,"_23":1561},"en:api/reference/host/host_version_get.mdx","host_version_get POST","Read which version of internkim this company's host runs, the release channel it follows, how it is updated (apt, dnf, pacman or brew), and the latest stable release with its date and release notes, which says whether an update is available. previousStable is the stable release before the installed one. Any member may ask.\n\n`read` · v1","/api/reference/host/host_version_get","api/reference/host/host_version_get.mdx","en:api/reference/host/host_update.mdx","host_update POST","Update this company's host to a stable release, or take it back to an older stable one. Only an administrator may, and only on a host that follows the stable channel. The requester is asked to confirm with the consequences and a choice of when; the agent, relay and messenger then restart, and the agent reports the result in this conversation when it is back.\n\n`destructive` · approval · v1","/api/reference/host/host_update","api/reference/host/host_update.mdx","en:api/reference/host/host_diagnostics_get.mdx","host_diagnostics_get POST","Read host diagnostics through the same execution records, event ledger, model exchanges, turn inputs, connector events, service logs and request metrics as the work-history web page. Only a company administrator may ask. Use recorded IDs for detail views. This reads existing evidence and executes no commands supplied by the caller.\n\n`read` · v1","/api/reference/host/host_diagnostics_get","api/reference/host/host_diagnostics_get.mdx","Files",[1578],"en:api/reference/files",{"_63":1576,"_72":1577},"api/reference/files","api/reference/files/meta.json",{"_25":1579,"_21":55,"_27":1580,"_29":1581,"_58":-7,"_60":1582,"_23":1583},"en:api/reference/files/uploadFile.mdx","Upload a file POST","Keeps a file for use as an attachment and answers with the place a tool can be handed.","/api/reference/files/uploadFile","api/reference/files/uploadFile.mdx","Document",[1590],"en:api/reference/document",{"_63":1588,"_72":1589},"api/reference/document","api/reference/document/meta.json",{"_25":1591,"_21":55,"_27":1592,"_29":1593,"_58":-7,"_60":1594,"_23":1595},"en:api/reference/document/document_read.mdx","document_read POST","Read a workspace document and return Markdown content. path takes an exact /workspace path, or an attachment's exact url copied verbatim from the conversation — a document attached to an earlier message is fetched by that url. Never invent a filesystem path from a url. Use image_read for image files.\n\n`read` · v1","/api/reference/document/document_read","api/reference/document/document_read.mdx","Discovery",[1602,1603,1604,1605],"en:api/reference/discovery",{"_63":1600,"_72":1601},"api/reference/discovery","api/reference/discovery/meta.json",{"_25":1621,"_21":55,"_27":1622,"_29":1623,"_58":-7,"_60":1624,"_23":1625},{"_25":1616,"_21":55,"_27":1617,"_29":1618,"_58":-7,"_60":1619,"_23":1620},{"_25":1611,"_21":55,"_27":1612,"_29":1613,"_58":-7,"_60":1614,"_23":1615},{"_25":1606,"_21":55,"_27":1607,"_29":1608,"_58":-7,"_60":1609,"_23":1610},"en:api/reference/discovery/readTool.mdx","Read one tool GET","Includes the input schema and the side-effect class.","/api/reference/discovery/readTool","api/reference/discovery/readTool.mdx","en:api/reference/discovery/previewTool.mdx","Look at what a call would touch POST","For a tool whose call names a record with a hint, ask what that call would touch. `input` is the same input the call takes and nothing is written. The hint resolves through the same function the call itself uses, so the row previewed and the row touched cannot differ. This is for a client that puts an irreversible action to a person first: narrow the input with the answer's `target.inputField` and `target.id` and the approved call will not resolve the hint again. A tool with nothing to look at answers `target: null`.","/api/reference/discovery/previewTool","api/reference/discovery/previewTool.mdx","en:api/reference/discovery/listTools.mdx","List the tools this token may call GET","Returns only the tools the token's permission reaches. Tools that come and go with circumstance are discovered here.","/api/reference/discovery/listTools","api/reference/discovery/listTools.mdx","en:api/reference/discovery/invokeTool.mdx","Invoke a tool POST","`input` follows that tool's own input schema. `toolName`, `actor` and `context` come from the token and the descriptor, so a body that carries them is ignored.","/api/reference/discovery/invokeTool","api/reference/discovery/invokeTool.mdx","Diagnostics",[1632],"en:api/reference/diagnostics",{"_63":1630,"_72":1631},"api/reference/diagnostics","api/reference/diagnostics/meta.json",{"_25":1633,"_21":55,"_27":1634,"_29":1635,"_58":-7,"_60":1636,"_23":1637},"en:api/reference/diagnostics/readHostDiagnostics.mdx","Read the existing work-history view as a company administrator GET","Read host diagnostics through the same execution records, event ledger, model exchanges, turn inputs, connector events, service logs and request metrics as the work-history web page. Only a company administrator may ask. Use recorded IDs for detail views. This reads existing evidence and executes no commands supplied by the caller.","/api/reference/diagnostics/readHostDiagnostics","api/reference/diagnostics/readHostDiagnostics.mdx","Dataroom",[1644,1645,1646,1647,1648,1649,1650,1651,1652,1653],"en:api/reference/dataroom",{"_63":1642,"_72":1643},"api/reference/dataroom","api/reference/dataroom/meta.json",{"_25":1699,"_21":55,"_27":1700,"_29":1701,"_58":-7,"_60":1702,"_23":1703},{"_25":1694,"_21":55,"_27":1695,"_29":1696,"_58":-7,"_60":1697,"_23":1698},{"_25":1689,"_21":55,"_27":1690,"_29":1691,"_58":-7,"_60":1692,"_23":1693},{"_25":1684,"_21":55,"_27":1685,"_29":1686,"_58":-7,"_60":1687,"_23":1688},{"_25":1679,"_21":55,"_27":1680,"_29":1681,"_58":-7,"_60":1682,"_23":1683},{"_25":1674,"_21":55,"_27":1675,"_29":1676,"_58":-7,"_60":1677,"_23":1678},{"_25":1669,"_21":55,"_27":1670,"_29":1671,"_58":-7,"_60":1672,"_23":1673},{"_25":1664,"_21":55,"_27":1665,"_29":1666,"_58":-7,"_60":1667,"_23":1668},{"_25":1659,"_21":55,"_27":1660,"_29":1661,"_58":-7,"_60":1662,"_23":1663},{"_25":1654,"_21":55,"_27":1655,"_29":1656,"_58":-7,"_60":1657,"_23":1658},"en:api/reference/dataroom/dataroom_share_delete.mdx","dataroom_share_delete POST","Company dataroom: Revoke a data room share by its exact shareID from dataroom_get. Other active grants still apply. Already downloaded files cannot be recalled; existing signed URLs expire within ten minutes.\n\n`workspace_write` · approval · v1","/api/reference/dataroom/dataroom_share_delete","api/reference/dataroom/dataroom_share_delete.mdx","en:api/reference/dataroom/dataroom_share_add.mdx","dataroom_share_add POST","Company dataroom: Share live data room categories with someone outside the company by lending them what one circle reads: an external email or an explicitly public audience. Current and future documents in those categories become readable. Confirm the audience and scope first. Recipients must accept using their verified email; do not invite them as company members. Company members read through the circles they belong to, set with circle_member_update. Public publication is a distinct explicit request and never includes X.\n\n`workspace_write` · approval · v1","/api/reference/dataroom/dataroom_share_add","api/reference/dataroom/dataroom_share_add.mdx","en:api/reference/dataroom/dataroom_links_get.mdx","dataroom_links_get POST","Company dataroom: Read your share links. Administrators can also see links created by other employees. Access codes are never returned again.\n\n`read` · v1","/api/reference/dataroom/dataroom_links_get","api/reference/dataroom/dataroom_links_get.mdx","en:api/reference/dataroom/dataroom_link_delete.mdx","dataroom_link_delete POST","Company dataroom: Revoke a link created by you, or any company link if you are an administrator. Existing guest sessions lose access immediately; downloaded files cannot be recalled.\n\n`workspace_write` · approval · v1","/api/reference/dataroom/dataroom_link_delete","api/reference/dataroom/dataroom_link_delete.mdx","en:api/reference/dataroom/dataroom_link_add.mdx","dataroom_link_add POST","Company dataroom: Create a code-protected share link that reads as one circle, within your own permissions. Every category follows the circle and creator permissions. Lifetime defaults to three days and cannot exceed seven days. Returns a newly generated six digit code once. Recipients must acknowledge the confidentiality notice.\n\n`workspace_write` · approval · v1","/api/reference/dataroom/dataroom_link_add","api/reference/dataroom/dataroom_link_add.mdx","en:api/reference/dataroom/dataroom_invitation_send.mdx","dataroom_invitation_send POST","Company dataroom: send the invitation email of an email share, so its recipient can sign in with that address and accept it. Only a company administrator sends invitations; a revoked or expired share is refused. Requires approval; the email reaches someone outside the company.\n\n`external_send` · approval · v1","/api/reference/dataroom/dataroom_invitation_send","api/reference/dataroom/dataroom_invitation_send.mdx","en:api/reference/dataroom/dataroom_invitation_accept.mdx","dataroom_invitation_accept POST","Company dataroom: accept an invitation another company sent to the requester's own verified email, which opens the categories it shares to the requester. Answers the inviting company's ID. An invitation addressed to another email, revoked, expired, or accepted by someone else is refused.\n\n`workspace_write` · v1","/api/reference/dataroom/dataroom_invitation_accept","api/reference/dataroom/dataroom_invitation_accept.mdx","en:api/reference/dataroom/dataroom_get.mdx","dataroom_get POST","Company dataroom: Read the company data room categories and its shares with people outside the company. A parent code grants all current and future children. Reads expose only permitted categories; administrators can manage the template. Circles and who belongs to them are circle_list.\n\n`read` · v1","/api/reference/dataroom/dataroom_get","api/reference/dataroom/dataroom_get.mdx","en:api/reference/dataroom/dataroom_field_update.mdx","dataroom_field_update POST","Company dataroom: Choose who sees one company page field by naming the category whose readers see it; the field leaves the category that held it. Confirm the audience first: every circle and share that reads the category sees the value.\n\n`workspace_write` · approval · v1","/api/reference/dataroom/dataroom_field_update","api/reference/dataroom/dataroom_field_update.mdx","en:api/reference/dataroom/dataroom_category_update.mdx","dataroom_category_update POST","Company dataroom: Create or rename a data room category. Use one uppercase mnemonic letter for a parent and two for a filing category. Code identity and ancestry remain stable. X is the reserved unclassified inbox. A new child is readable by every existing recipient of its parent; confirm that audience first.\n\n`workspace_write` · approval · v1","/api/reference/dataroom/dataroom_category_update","api/reference/dataroom/dataroom_category_update.mdx","Data Room",[1710,1711,1712,1713,1714,1715,1716],"en:api/reference/data-room",{"_63":1708,"_72":1709},"api/reference/data-room","api/reference/data-room/meta.json",{"_25":1747,"_21":55,"_27":1748,"_29":-7,"_58":-7,"_60":1749,"_23":1750},{"_25":1742,"_21":55,"_27":1743,"_29":1744,"_58":-7,"_60":1745,"_23":1746},{"_25":1737,"_21":55,"_27":1738,"_29":1739,"_58":-7,"_60":1740,"_23":1741},{"_25":1732,"_21":55,"_27":1733,"_29":1734,"_58":-7,"_60":1735,"_23":1736},{"_25":1727,"_21":55,"_27":1728,"_29":1729,"_58":-7,"_60":1730,"_23":1731},{"_25":1722,"_21":55,"_27":1723,"_29":1724,"_58":-7,"_60":1725,"_23":1726},{"_25":1717,"_21":55,"_27":1718,"_29":1719,"_58":-7,"_60":1720,"_23":1721},"en:api/reference/data-room/unlockDataRoomLink.mdx","Open a share link with its six digit code and confidentiality acknowledgment POST","Requires a same-origin share page request. Issues an HttpOnly cookie scoped to this link for up to one hour. Codes are rate limited; expired and revoked links cannot be opened.","/api/reference/data-room/unlockDataRoomLink","api/reference/data-room/unlockDataRoomLink.mdx","en:api/reference/data-room/sendDataRoomInvitation.mdx","Email a data room invitation POST","A company administrator sends the selected recipient a sign-in link to their active invitation. Creates no company membership.","/api/reference/data-room/sendDataRoomInvitation","api/reference/data-room/sendDataRoomInvitation.mdx","en:api/reference/data-room/readDataRoomLink.mdx","Read the documents permitted by an opened share link GET","Requires the HttpOnly session cookie issued after code entry and acknowledgment. The link, its circle, and the permissions of its creator are checked on every read. Original downloads require a grant; signed URLs expire within one minute.","/api/reference/data-room/readDataRoomLink","api/reference/data-room/readDataRoomLink.mdx","en:api/reference/data-room/readDataRoomCompany.mdx","Read the company page the calling member may see GET","Answers the company profile fields, metrics and records whose data room category the member reads. Each category names its fields; a field no category names is shown only to readers of X. The filtering happens in the database, so a field outside the caller's categories is never sent.","/api/reference/data-room/readDataRoomCompany","api/reference/data-room/readDataRoomCompany.mdx","en:api/reference/data-room/readDataRoom.mdx","Read a shared data room or request a permitted file URL GET","Uses a Supabase session bearer token or an explicitly published anonymous grant. Guest invitations must be accepted first. Original downloads require a download grant. Signed URLs expire after ten minutes.","/api/reference/data-room/readDataRoom","api/reference/data-room/readDataRoom.mdx","en:api/reference/data-room/previewDataRoomCircle.mdx","Read what a share link for a circle would show, before creating one GET","Answers a member who could share the circle with exactly the categories and documents its link would show. canDownload=1 previews a link that allows original downloads, when the member could create one. Signed URLs expire after one minute.","/api/reference/data-room/previewDataRoomCircle","api/reference/data-room/previewDataRoomCircle.mdx","en:api/reference/data-room/acceptDataRoomInvitation.mdx","Accept an invitation as its verified email recipient POST","/api/reference/data-room/acceptDataRoomInvitation","api/reference/data-room/acceptDataRoomInvitation.mdx","Crm",[1757,1758,1759,1760,1761,1762,1763,1764,1765,1766,1767,1768,1769,1770,1771,1772,1773,1774],"en:api/reference/crm",{"_63":1755,"_72":1756},"api/reference/crm","api/reference/crm/meta.json",{"_25":1860,"_21":55,"_27":1861,"_29":1862,"_58":-7,"_60":1863,"_23":1864},{"_25":1855,"_21":55,"_27":1856,"_29":1857,"_58":-7,"_60":1858,"_23":1859},{"_25":1850,"_21":55,"_27":1851,"_29":1852,"_58":-7,"_60":1853,"_23":1854},{"_25":1845,"_21":55,"_27":1846,"_29":1847,"_58":-7,"_60":1848,"_23":1849},{"_25":1840,"_21":55,"_27":1841,"_29":1842,"_58":-7,"_60":1843,"_23":1844},{"_25":1835,"_21":55,"_27":1836,"_29":1837,"_58":-7,"_60":1838,"_23":1839},{"_25":1830,"_21":55,"_27":1831,"_29":1832,"_58":-7,"_60":1833,"_23":1834},{"_25":1825,"_21":55,"_27":1826,"_29":1827,"_58":-7,"_60":1828,"_23":1829},{"_25":1820,"_21":55,"_27":1821,"_29":1822,"_58":-7,"_60":1823,"_23":1824},{"_25":1815,"_21":55,"_27":1816,"_29":1817,"_58":-7,"_60":1818,"_23":1819},{"_25":1810,"_21":55,"_27":1811,"_29":1812,"_58":-7,"_60":1813,"_23":1814},{"_25":1805,"_21":55,"_27":1806,"_29":1807,"_58":-7,"_60":1808,"_23":1809},{"_25":1800,"_21":55,"_27":1801,"_29":1802,"_58":-7,"_60":1803,"_23":1804},{"_25":1795,"_21":55,"_27":1796,"_29":1797,"_58":-7,"_60":1798,"_23":1799},{"_25":1790,"_21":55,"_27":1791,"_29":1792,"_58":-7,"_60":1793,"_23":1794},{"_25":1785,"_21":55,"_27":1786,"_29":1787,"_58":-7,"_60":1788,"_23":1789},{"_25":1780,"_21":55,"_27":1781,"_29":1782,"_58":-7,"_60":1783,"_23":1784},{"_25":1775,"_21":55,"_27":1776,"_29":1777,"_58":-7,"_60":1778,"_23":1779},"en:api/reference/crm/crm_vocabulary_set.mdx","crm_vocabulary_set POST","Set the CRM vocabulary: the organization types and pipelines this company runs its CRM in. Both lists are written at once, so read crm_vocabulary_get first and send it back with what changes. The stages are the product’s and are not set here. This is an administrator’s.\n\n`workspace_write` · v1","/api/reference/crm/crm_vocabulary_set","api/reference/crm/crm_vocabulary_set.mdx","en:api/reference/crm/crm_vocabulary_get.mdx","crm_vocabulary_get POST","The CRM vocabulary, the words this company runs its CRM in: the organization types it sorts relationships by, the pipelines it runs deals through, and the stages a deal can stand at with what each one means.\n\n`read` · v1","/api/reference/crm/crm_vocabulary_get","api/reference/crm/crm_vocabulary_get.mdx","en:api/reference/crm/crm_record_import.mdx","crm_record_import POST","Import many organization or contact records from one CSV in one write: every record is written, or none is. Name the file in attachments and say in columns which of its columns fills each field. A record whose name is already held is skipped or updated as onDuplicate says, and an updated record keeps any field the file leaves empty. The person asking approves the import after seeing how many records it creates and updates; a file with a line that cannot be imported is refused with each such line and why. dryRun checks them all and writes nothing.\n\n`workspace_write` · approval · v2","/api/reference/crm/crm_record_import","api/reference/crm/crm_record_import.mdx","en:api/reference/crm/crm_organization_update.mdx","crm_organization_update POST","Change what this company holds about an organization; only the fields the call names change.\n\n`workspace_write` · v1","/api/reference/crm/crm_organization_update","api/reference/crm/crm_organization_update.mdx","en:api/reference/crm/crm_organization_list.mdx","crm_organization_list POST","The organizations this company sells to, partners with or buys from, with who owns each relationship — 'who are our customers'.\n\n`read` · v1","/api/reference/crm/crm_organization_list","api/reference/crm/crm_organization_list.mdx","en:api/reference/crm/crm_organization_archive.mdx","crm_organization_archive POST","Put an organization away, so it leaves the CRM screens while its people, its deals and everything recorded against it stay.\n\n`destructive` · approval · v1","/api/reference/crm/crm_organization_archive","api/reference/crm/crm_organization_archive.mdx","en:api/reference/crm/crm_organization_add.mdx","crm_organization_add POST","Add an organization this company deals with, after crm_organization_list shows it is not one already held.\n\n`workspace_write` · v1","/api/reference/crm/crm_organization_add","api/reference/crm/crm_organization_add.mdx","en:api/reference/crm/crm_opportunity_update.mdx","crm_opportunity_update POST","Change what a deal is worth, who it is with, or when it should close; only the fields the call names change. Its stage is crm_opportunity_move’s.\n\n`workspace_write` · v1","/api/reference/crm/crm_opportunity_update","api/reference/crm/crm_opportunity_update.mdx","en:api/reference/crm/crm_opportunity_move.mdx","crm_opportunity_move POST","Move a deal to another stage, or reorder it within the one it stands at. A move into done or lost settles what it was worth and cannot be undone, so put it to the requester first.\n\n`workspace_write` · approval · v1","/api/reference/crm/crm_opportunity_move","api/reference/crm/crm_opportunity_move.mdx","en:api/reference/crm/crm_opportunity_list.mdx","crm_opportunity_list POST","The deals this company is working on, each with its stage, what it is worth and how much work has been recorded against it — 'what are we closing this month'.\n\n`read` · v1","/api/reference/crm/crm_opportunity_list","api/reference/crm/crm_opportunity_list.mdx","en:api/reference/crm/crm_opportunity_archive.mdx","crm_opportunity_archive POST","Put a deal away, so it leaves the pipeline while everything recorded against it stays. A deal that was lost is moved to lost instead.\n\n`destructive` · approval · v1","/api/reference/crm/crm_opportunity_archive","api/reference/crm/crm_opportunity_archive.mdx","en:api/reference/crm/crm_opportunity_add.mdx","crm_opportunity_add POST","Open a deal with an organization this company already holds. A deal already won or lost is opened here and then closed with crm_opportunity_move.\n\n`workspace_write` · v1","/api/reference/crm/crm_opportunity_add","api/reference/crm/crm_opportunity_add.mdx","en:api/reference/crm/crm_contact_update.mdx","crm_contact_update POST","Change what this company holds about a contact, including moving that person to another organization; only the fields the call names change.\n\n`workspace_write` · v1","/api/reference/crm/crm_contact_update","api/reference/crm/crm_contact_update.mdx","en:api/reference/crm/crm_contact_list.mdx","crm_contact_list POST","The contacts this company deals with at other organizations — the people it talks to — with how to reach them — 'who do we talk to at ABC'. Colleagues are person_list's.\n\n`read` · v1","/api/reference/crm/crm_contact_list","api/reference/crm/crm_contact_list.mdx","en:api/reference/crm/crm_contact_archive.mdx","crm_contact_archive POST","Put a contact away, so that person leaves the CRM screens while everything recorded against them stays, as when somebody leaves the organization.\n\n`destructive` · approval · v1","/api/reference/crm/crm_contact_archive","api/reference/crm/crm_contact_archive.mdx","en:api/reference/crm/crm_contact_add.mdx","crm_contact_add POST","Add a contact, a person at an organization this company already holds, which crm_organization_add creates when it does not.\n\n`workspace_write` · v1","/api/reference/crm/crm_contact_add","api/reference/crm/crm_contact_add.mdx","en:api/reference/crm/crm_activity_save.mdx","crm_activity_save POST","Record work against an organization or a deal, or change work already recorded. An activity is a task, so this writes what task_add and task_update write, plus the calendar entry when the work goes in the calendar.\n\n`workspace_write` · v1","/api/reference/crm/crm_activity_save","api/reference/crm/crm_activity_save.mdx","en:api/reference/crm/crm_activity_list.mdx","crm_activity_list POST","The activity recorded against the organizations and deals this company holds, newest first, with the labels and colours the CRM screens draw it in. The same rows task_list answers, shaped for the CRM.\n\n`read` · v1","/api/reference/crm/crm_activity_list","api/reference/crm/crm_activity_list.mdx","Company",[1871,1872,1873,1874,1875,1876,1877,1878,1879,1880,1881,1882,1883,1884,1885,1886,1887,1888,1889,1890,1891,1892,1893,1894,1895,1896,1897,1898],"en:api/reference/company",{"_63":1869,"_72":1870},"api/reference/company","api/reference/company/meta.json",{"_25":2034,"_21":55,"_27":2035,"_29":2036,"_58":-7,"_60":2037,"_23":2038},{"_25":2029,"_21":55,"_27":2030,"_29":2031,"_58":-7,"_60":2032,"_23":2033},{"_25":2024,"_21":55,"_27":2025,"_29":2026,"_58":-7,"_60":2027,"_23":2028},{"_25":2019,"_21":55,"_27":2020,"_29":2021,"_58":-7,"_60":2022,"_23":2023},{"_25":2014,"_21":55,"_27":2015,"_29":2016,"_58":-7,"_60":2017,"_23":2018},{"_25":2009,"_21":55,"_27":2010,"_29":2011,"_58":-7,"_60":2012,"_23":2013},{"_25":2004,"_21":55,"_27":2005,"_29":2006,"_58":-7,"_60":2007,"_23":2008},{"_25":1999,"_21":55,"_27":2000,"_29":2001,"_58":-7,"_60":2002,"_23":2003},{"_25":1994,"_21":55,"_27":1995,"_29":1996,"_58":-7,"_60":1997,"_23":1998},{"_25":1989,"_21":55,"_27":1990,"_29":1991,"_58":-7,"_60":1992,"_23":1993},{"_25":1984,"_21":55,"_27":1985,"_29":1986,"_58":-7,"_60":1987,"_23":1988},{"_25":1979,"_21":55,"_27":1980,"_29":1981,"_58":-7,"_60":1982,"_23":1983},{"_25":1974,"_21":55,"_27":1975,"_29":1976,"_58":-7,"_60":1977,"_23":1978},{"_25":1969,"_21":55,"_27":1970,"_29":1971,"_58":-7,"_60":1972,"_23":1973},{"_25":1964,"_21":55,"_27":1965,"_29":1966,"_58":-7,"_60":1967,"_23":1968},{"_25":1959,"_21":55,"_27":1960,"_29":1961,"_58":-7,"_60":1962,"_23":1963},{"_25":1954,"_21":55,"_27":1955,"_29":1956,"_58":-7,"_60":1957,"_23":1958},{"_25":1949,"_21":55,"_27":1950,"_29":1951,"_58":-7,"_60":1952,"_23":1953},{"_25":1944,"_21":55,"_27":1945,"_29":1946,"_58":-7,"_60":1947,"_23":1948},{"_25":1939,"_21":55,"_27":1940,"_29":1941,"_58":-7,"_60":1942,"_23":1943},{"_25":1934,"_21":55,"_27":1935,"_29":1936,"_58":-7,"_60":1937,"_23":1938},{"_25":1929,"_21":55,"_27":1930,"_29":1931,"_58":-7,"_60":1932,"_23":1933},{"_25":1924,"_21":55,"_27":1925,"_29":1926,"_58":-7,"_60":1927,"_23":1928},{"_25":1919,"_21":55,"_27":1920,"_29":1921,"_58":-7,"_60":1922,"_23":1923},{"_25":1914,"_21":55,"_27":1915,"_29":1916,"_58":-7,"_60":1917,"_23":1918},{"_25":1909,"_21":55,"_27":1910,"_29":1911,"_58":-7,"_60":1912,"_23":1913},{"_25":1904,"_21":55,"_27":1905,"_29":1906,"_58":-7,"_60":1907,"_23":1908},{"_25":1899,"_21":55,"_27":1900,"_29":1901,"_58":-7,"_60":1902,"_23":1903},"en:api/reference/company/saveCompanyPicture.mdx","Upload the company's picture POST","The company's logo or portrait, sent as `multipart/form-data` in a `file` field. A picture arrives as bytes and the rest of this API takes JSON, which is why this one is an endpoint rather than a tool. The answer's `profileImageURL` is readable for an hour, and `company_settings_get` answers the same address. Only an administrator may change it.","/api/reference/company/saveCompanyPicture","api/reference/company/saveCompanyPicture.mdx","en:api/reference/company/forgetCompanyPicture.mdx","Take the company's picture down DELETE","Removes the company's picture. Only an administrator may take it down, and the answer's `profileImageURL` is `null`.","/api/reference/company/forgetCompanyPicture","api/reference/company/forgetCompanyPicture.mdx","en:api/reference/company/company_settings_update.mdx","company_settings_update POST","Change the company settings. Only the fields the call names change. This is an administrator's, and it is company-wide: the time zone and the language decide what every colleague sees, so put it to the requester before calling.\n\n`workspace_write` · approval · v2","/api/reference/company/company_settings_update","api/reference/company/company_settings_update.mdx","en:api/reference/company/company_settings_get.mdx","company_settings_get POST","The company settings: its name, country, language, time zone, base currency, the work locations attendance can be recorded at, the annual leave a person is granted, whether everybody may see the whole company's attendance, and the address of its picture. Read this to answer 'what time zone are we on', 'which currency do we use', or 'where can we clock in from'. The work location names are what attendance_add's location takes.\n\n`read` · v2","/api/reference/company/company_settings_get","api/reference/company/company_settings_get.mdx","en:api/reference/company/company_record_update.mdx","company_record_update POST","Update fields on an existing company record named by recordHint from a prior company_record_list result. Only provided fields change.\n\n`workspace_write` · v1","/api/reference/company/company_record_update","api/reference/company/company_record_update.mdx","en:api/reference/company/company_record_list.mdx","company_record_list POST","List company history/asset records, newest first. Filter by category (history, funding, product, certification, ip, award, reference, grant …) or keyword query. Use to build company timelines, funding tables, and product overviews.\n\n`read` · v1","/api/reference/company/company_record_list","api/reference/company/company_record_list.mdx","en:api/reference/company/company_record_delete.mdx","company_record_delete POST","Delete a company record named by recordHint from a prior company_record_list result. Use only when the user asks to remove a wrong entry.\n\n`destructive` · approval · v1","/api/reference/company/company_record_delete","api/reference/company/company_record_delete.mdx","en:api/reference/company/company_record_add.mdx","company_record_add POST","Add one company history/asset record: milestones, funding rounds, products, patents, certifications, awards, client references, government grants. Set category, date, title; put structured details (amount, investors, round …) into attributes as a label-to-value JSON object string.\n\n`workspace_write` · v1","/api/reference/company/company_record_add","api/reference/company/company_record_add.mdx","en:api/reference/company/company_metric_record.mdx","company_metric_record POST","Record or correct one company metric value for a period — annual revenue, operating profit, MAU, employee count, GMV and similar time-series numbers. Money goes in amount with its USD equivalent; anything else goes in value with a unit. Add quarter (1-4) OR month (1-12) for sub-annual periods, never both. Same call overwrites the same period.\n\n`workspace_write` · v1","/api/reference/company/company_metric_record","api/reference/company/company_metric_record.mdx","en:api/reference/company/company_metric_list.mdx","company_metric_list POST","List recorded company metrics sorted by period. Filter by metric key and year range. Use for IR decks, business plans, and grant applications that need revenue/headcount/usage time series.\n\n`read` · v1","/api/reference/company/company_metric_list","api/reference/company/company_metric_list.mdx","en:api/reference/company/company_info_set.mdx","company_info_set POST","Save or update the company master profile. Partial update: only provided fields are written, into the given language's slot for localized fields. Use after the user supplies company details, or when they report one has changed. Put country-specific identifiers (a business registration number, a corporate registration number, an industry classification, an EIN …) into legalAttributes as a label-to-value JSON object string. A seal or logo image the user gives is kept with sealImage or logoImage, after company_image_upload.\n\n`workspace_write` · v1","/api/reference/company/company_info_set","api/reference/company/company_info_set.mdx","en:api/reference/company/company_info_get.mdx","company_info_get POST","Read the company master profile (name, representative, address, contact, bank account, country-specific legal attributes such as a business registration number). Pass language ('ko' or 'en') to get the view for that document language plus missingFields listing empty core fields. The answer also carries that view as the file company-profile.json, with the newest seal and logo images from the data room beside it, for a document to print from as it is. Call this before creating any company letterhead document; if missingFields is empty, never ask the user for company info again.\n\n`read` · v1","/api/reference/company/company_info_get","api/reference/company/company_info_get.mdx","en:api/reference/company/company_image_upload.mdx","company_image_upload POST","Ask for a place to keep a new version of a company image, such as the seal stamped on forms or the letterhead logo. Each version is a data room document of its own, dated the day it took effect, and every form prints the newest. Answers the storagePath and a signed URL to PUT the image's bytes to, good for two hours. Once the image is there, keep it with company_info_set, passing the storagePath as sealImage or logoImage; keep a 'picture' with company_settings_update's profileImage instead, PUT with its image Content-Type. Only an administrator may keep a company image.\n\n`workspace_write` · v1","/api/reference/company/company_image_upload","api/reference/company/company_image_upload.mdx","en:api/reference/company/company_holiday_update.mdx","company_holiday_update POST","Change the day, the name, or the yearly recurrence of a holiday the company already holds. Only the fields the call names change. Changing a holiday is an administrator's.\n\n`workspace_write` · v1","/api/reference/company/company_holiday_update","api/reference/company/company_holiday_update.mdx","en:api/reference/company/company_holiday_list.mdx","company_holiday_list POST","The days this company is closed, earliest first. Use this to answer 'are we closed on the third of October' or to find the holiday another company_holiday tool is about to change. A holiday that recurs annually falls on the same date every year, so it is answered for whichever year is asked for.\n\n`read` · v1","/api/reference/company/company_holiday_list","api/reference/company/company_holiday_list.mdx","en:api/reference/company/company_holiday_delete.mdx","company_holiday_delete POST","Take a day off the company holiday list, so it counts as a working day again. Removing a holiday is an administrator's, and it changes what every colleague is expected to work, so put it to the requester before calling.\n\n`destructive` · approval · v1","/api/reference/company/company_holiday_delete","api/reference/company/company_holiday_delete.mdx","en:api/reference/company/company_holiday_add.mdx","company_holiday_add POST","Add a day the company is closed. Adding a holiday is an administrator's. A date the company already holds a holiday on is refused, so read company_holiday_list first when the requester may be repeating one.\n\n`workspace_write` · v1","/api/reference/company/company_holiday_add","api/reference/company/company_holiday_add.mdx","en:api/reference/company/company_equity_list.mdx","company_equity_list POST","List the company's equity ledger and what each holder holds as of a day, with their share of the total. Use for cap tables, ownership questions and dilution after a round.\n\n`read` · v1","/api/reference/company/company_equity_list","api/reference/company/company_equity_list.mdx","en:api/reference/company/company_equity_delete.mdx","company_equity_delete POST","Delete one wrong line of the company's equity ledger named by its entryID from company_equity_list. A real transfer or cancellation is a new line, not a delete.\n\n`destructive` · approval · v1","/api/reference/company/company_equity_delete","api/reference/company/company_equity_delete.mdx","en:api/reference/company/company_equity_add.mdx","company_equity_add POST","Add one line to the company's equity ledger: shares or options a holder received or gave up on a date, as the shareholder register or a share issuance records it. What anyone holds is the sum of their lines, so record a transfer as two lines, one negative and one positive. Only an administrator keeps the ledger.\n\n`workspace_write` · v1","/api/reference/company/company_equity_add","api/reference/company/company_equity_add.mdx","en:api/reference/company/company_document_upload.mdx","company_document_upload POST","Ask for a place in the company data room to put one file of a registered document. Answers the storagePath, which is the document's category folder and .., and a signed URL to PUT the bytes to. Upload the original first with originalFileName, then each derived file with its fileName, which sits beside it as ... Whoever may change the document may upload its files. The URL is good for two hours.\n\n`workspace_write` · v1","/api/reference/company/company_document_upload","api/reference/company/company_document_upload.mdx","en:api/reference/company/company_document_update.mdx","company_document_update POST","Update a registered company document's file path, title, counterpart, summary, or where it sits in the data room: its categoryCode, date, period, status, tags, hash, and the document it supersedes. Name the document with documentHint from a prior list or search result. Use when a file was moved or renamed so the ledger keeps tracking it, or when an administrator reclassifies it. Category changes require administrator access and move the document's files to the new category's folder.\n\n`workspace_write` · v2","/api/reference/company/company_document_update","api/reference/company/company_document_update.mdx","en:api/reference/company/company_document_search.mdx","company_document_search POST","Search registered company documents by a natural-language question ('the terms of the agreement with ABC'). Matches the question against each document's title, counterpart, summary and type, best match first. Answer from the summary first and open the file only when detail is needed.\n\n`read` · v1","/api/reference/company/company_document_search","api/reference/company/company_document_search.mdx","en:api/reference/company/company_document_register.mdx","company_document_register POST","Register a company document in the document ledger and, for kind=issued, receive the official document number to print in the document plus the storage directory to save the final file in. Call BEFORE rendering an official document so the number appears in it. Always include a 2-3 sentence summary of the document's key terms (parties, amounts, dates) so later questions can be answered without re-reading the file. A document filed in the data room names its categoryCode, date and hash, and its files are uploaded with company_document_upload once it is registered; one that replaces an older document names it with supersedesHint instead of editing it.\n\n`workspace_write` · v2","/api/reference/company/company_document_register","api/reference/company/company_document_register.mdx","en:api/reference/company/company_document_recall.mdx","company_document_recall POST","Recall the data room documents a request names by title or counterpart, or whose summary holds what it asks, one sentence each. The agent asks this beside its own memory whenever it recalls, so what the requester may read now arrives without being copied into memory.\n\n`read` · v1","/api/reference/company/company_document_recall","api/reference/company/company_document_recall.mdx","en:api/reference/company/company_document_list.mdx","company_document_list POST","List registered company documents newest first, with their numbers, counterparts, file paths, summaries, and where each sits in the data room. Filter by category, type, counterpart, or keyword. Category grants decide visibility. Use to answer 'what quotes did we send to X'.\n\n`read` · v2","/api/reference/company/company_document_list","api/reference/company/company_document_list.mdx","en:api/reference/company/company_document_download.mdx","company_document_download POST","Fetch a company document's original, or one of the files derived from it, out of the data room. Name the document with documentHint and add fileName for a derived file. Answers a signed URL good for ten minutes; category permissions and the share's download setting decide access. Read the sidecar and the summary first and fetch the original only when they cannot answer; an original goes to the requester themselves and passing it on is their own act.\n\n`read` · v1","/api/reference/company/company_document_download","api/reference/company/company_document_download.mdx","en:api/reference/company/company_document_classify.mdx","company_document_classify POST","Classify a document against the company data room taxonomy in one model request. Supply its title and extracted text or a factual summary. The result is an exact permitted leaf category code, including a parent without children, or X when ambiguous. Parents with children are never choices. Classify before uploading and registering a new document.\n\n`computation` · v1","/api/reference/company/company_document_classify","api/reference/company/company_document_classify.mdx","Circle",[2045,2046,2047,2048,2049],"en:api/reference/circle",{"_63":2043,"_72":2044},"api/reference/circle","api/reference/circle/meta.json",{"_25":2070,"_21":55,"_27":2071,"_29":2072,"_58":-7,"_60":2073,"_23":2074},{"_25":2065,"_21":55,"_27":2066,"_29":2067,"_58":-7,"_60":2068,"_23":2069},{"_25":2060,"_21":55,"_27":2061,"_29":2062,"_58":-7,"_60":2063,"_23":2064},{"_25":2055,"_21":55,"_27":2056,"_29":2057,"_58":-7,"_60":2058,"_23":2059},{"_25":2050,"_21":55,"_27":2051,"_29":2052,"_58":-7,"_60":2053,"_23":2054},"en:api/reference/circle/circle_update.mdx","circle_update POST","Company circles: Create or edit a circle. id is its lowercase English name, such as sales-team, and never changes; name is what people read and is given only to a circle the company made, since the product names its default circles in every language. readableCategories names the data room categories its members read, and a parent grants all descendants. Members change access immediately, so read circle_list and confirm who is affected first. A circle confers no administrative or editing rights.\n\n`workspace_write` · approval · v1","/api/reference/circle/circle_update","api/reference/circle/circle_update.mdx","en:api/reference/circle/circle_member_update.mdx","circle_member_update POST","Company circles: Set the circles an active member belongs to, replacing them atomically. Only administrators place people in circles. A member gains each circle's workspace folder, memory and data room categories, and joins its channel when it has one.\n\n`workspace_write` · approval · v1","/api/reference/circle/circle_member_update","api/reference/circle/circle_member_update.mdx","en:api/reference/circle/circle_list.mdx","circle_list POST","Company circles: Read every circle with the members who belong to it and the data room categories it reads. A circle is also a shared workspace folder and a shared memory on the company computer. A parent category grants all its children.\n\n`read` · v1","/api/reference/circle/circle_list","api/reference/circle/circle_list.mdx","en:api/reference/circle/circle_channel_delete.mdx","circle_channel_delete POST","Company circles: Delete the circle's messenger channel, so nobody reads or writes in it again. Takes the channel's exact current name from circle_list as confirmation and refuses any other. Only administrators delete one, and the circle itself stays.\n\n`destructive` · approval · v1","/api/reference/circle/circle_channel_delete","api/reference/circle/circle_channel_delete.mdx","en:api/reference/circle/circle_channel_add.mdx","circle_channel_add POST","Company circles: Add a private messenger channel of the circle's own. Its members are exactly the circle's, kept so as people join and leave the circle, and nobody adds or removes anyone by hand. A circle has at most one channel. Only administrators add one.\n\n`workspace_write` · approval · v1","/api/reference/circle/circle_channel_add","api/reference/circle/circle_channel_add.mdx","Channel",[2081,2082,2083,2084,2085,2086,2087,2088],"en:api/reference/channel",{"_63":2079,"_72":2080},"api/reference/channel","api/reference/channel/meta.json",{"_25":2124,"_21":55,"_27":2125,"_29":2126,"_58":-7,"_60":2127,"_23":2128},{"_25":2119,"_21":55,"_27":2120,"_29":2121,"_58":-7,"_60":2122,"_23":2123},{"_25":2114,"_21":55,"_27":2115,"_29":2116,"_58":-7,"_60":2117,"_23":2118},{"_25":2109,"_21":55,"_27":2110,"_29":2111,"_58":-7,"_60":2112,"_23":2113},{"_25":2104,"_21":55,"_27":2105,"_29":2106,"_58":-7,"_60":2107,"_23":2108},{"_25":2099,"_21":55,"_27":2100,"_29":2101,"_58":-7,"_60":2102,"_23":2103},{"_25":2094,"_21":55,"_27":2095,"_29":2096,"_58":-7,"_60":2097,"_23":2098},{"_25":2089,"_21":55,"_27":2090,"_29":2091,"_58":-7,"_60":2092,"_23":2093},"en:api/reference/channel/channel_owner_update.mdx","channel_owner_update POST","Hand a channel over: the person named becomes its owner and the requester stays as a plain member, which only another owner can undo. Only an owner of the channel may do this. It is done as the requester, exactly as their messenger screen does it, and refused for the same reasons. Requires approval.\n\n`external_write` · approval · v1","/api/reference/channel/channel_owner_update","api/reference/channel/channel_owner_update.mdx","en:api/reference/channel/channel_owner_add.mdx","channel_owner_add POST","Make a member of a channel a co-owner beside the requester. Only an owner of the channel may do this. It is done as the requester, exactly as their messenger screen does it, and refused for the same reasons.\n\n`external_write` · v1","/api/reference/channel/channel_owner_add","api/reference/channel/channel_owner_add.mdx","en:api/reference/channel/channel_member_delete.mdx","channel_member_delete POST","Remove one member from a channel. Only an owner of the channel may do this. An owner cannot be removed. It is done as the requester, exactly as their messenger screen does it, and refused for the same reasons.\n\n`external_write` · v1","/api/reference/channel/channel_member_delete","api/reference/channel/channel_member_delete.mdx","en:api/reference/channel/channel_member_add.mdx","channel_member_add POST","Add company members to a channel the requester is in. It is done as the requester, exactly as their messenger screen does it, and refused for the same reasons.\n\n`external_write` · v1","/api/reference/channel/channel_member_add","api/reference/channel/channel_member_add.mdx","en:api/reference/channel/channel_leave.mdx","channel_leave POST","Leave a channel the requester is in. The only owner cannot leave; hand the channel over first with channel_owner_update. It is done as the requester, exactly as their messenger screen does it, and refused for the same reasons.\n\n`external_write` · v1","/api/reference/channel/channel_leave","api/reference/channel/channel_leave.mdx","en:api/reference/channel/channel_join.mdx","channel_join POST","Join an open channel the requester is not in yet. It is done as the requester, exactly as their messenger screen does it, and refused for the same reasons.\n\n`external_write` · v1","/api/reference/channel/channel_join","api/reference/channel/channel_join.mdx","en:api/reference/channel/channel_delete.mdx","channel_delete POST","Permanently delete a channel for everyone in it. Only an owner of the channel may do this. It is done as the requester, exactly as their messenger screen does it, and refused for the same reasons. Requires approval; this action is irreversible.\n\n`destructive` · approval · v1","/api/reference/channel/channel_delete","api/reference/channel/channel_delete.mdx","en:api/reference/channel/channel_add.mdx","channel_add POST","Create a group channel in the company messenger with the requester as its owner, and add the members named. It is done as the requester, exactly as their messenger screen does it, and refused for the same reasons.\n\n`external_write` · v1","/api/reference/channel/channel_add","api/reference/channel/channel_add.mdx","Calendar",[2135,2136,2137,2138,2139,2140,2141],"en:api/reference/calendar",{"_63":2133,"_72":2134},"api/reference/calendar","api/reference/calendar/meta.json",{"_25":2172,"_21":55,"_27":2173,"_29":2174,"_58":-7,"_60":2175,"_23":2176},{"_25":2167,"_21":55,"_27":2168,"_29":2169,"_58":-7,"_60":2170,"_23":2171},{"_25":2162,"_21":55,"_27":2163,"_29":2164,"_58":-7,"_60":2165,"_23":2166},{"_25":2157,"_21":55,"_27":2158,"_29":2159,"_58":-7,"_60":2160,"_23":2161},{"_25":2152,"_21":55,"_27":2153,"_29":2154,"_58":-7,"_60":2155,"_23":2156},{"_25":2147,"_21":55,"_27":2148,"_29":2149,"_58":-7,"_60":2150,"_23":2151},{"_25":2142,"_21":55,"_27":2143,"_29":2144,"_58":-7,"_60":2145,"_23":2146},"en:api/reference/calendar/event_update.mdx","event_update POST","Update explicit fields on a calendar event. Only the people in it, the member who asked for it, or an admin can change it, and anyone in the company can change an event open to the whole company; event_list marks the rest readOnly. eventHint is the exact event ID or exact event title from a event_list result, resolved server-side to the canonical event; use event_list first when neither is known. At least one mutable field is required.\n\n`workspace_write` · v3","/api/reference/calendar/event_update","api/reference/calendar/event_update.mdx","en:api/reference/calendar/event_list.mdx","event_list POST","List calendar entries in a concrete time window. Reads the requester's own schedule unless personHints names other people or scope is all. Personal schedules include events they attend and company-open events. Each entry names its source; approved leave is read-only. Resolve natural-language dates to startsAt and endsAt before calling.\n\n`read` · v4","/api/reference/calendar/event_list","api/reference/calendar/event_list.mdx","en:api/reference/calendar/event_delete.mdx","event_delete POST","Permanently delete a calendar event. Only the people in it, the member who asked for it, or an admin can delete it, and anyone in the company can delete an event open to the whole company. eventHint is the exact event ID or exact event title from a event_list result, resolved server-side to the canonical event; use event_list first when neither is known. Requires approval; this action is irreversible.\n\n`destructive` · approval · v2","/api/reference/calendar/event_delete","api/reference/calendar/event_delete.mdx","en:api/reference/calendar/event_add.mdx","event_add POST","Create a calendar event with a concrete time range. Resolve natural-language dates and times before calling. Use event_update for an existing event.\n\n`workspace_write` · v2","/api/reference/calendar/event_add","api/reference/calendar/event_add.mdx","en:api/reference/calendar/calendar_subscription_get.mdx","calendar_subscription_get POST","Whether the company calendar has a subscription address, the .ics feed a calendar app such as Google Calendar or Apple Calendar subscribes to. The address itself is shown only when it is made, so this answers only whether one exists.\n\n`read` · v1","/api/reference/calendar/calendar_subscription_get","api/reference/calendar/calendar_subscription_get.mdx","en:api/reference/calendar/calendar_subscription_delete.mdx","calendar_subscription_delete POST","Revoke the company calendar subscription address, so no calendar app can read it any longer. Only a company administrator revokes it. Requires approval; a revoked address never works again, and calendar_subscription_add makes a new one.\n\n`destructive` · approval · v1","/api/reference/calendar/calendar_subscription_delete","api/reference/calendar/calendar_subscription_delete.mdx","en:api/reference/calendar/calendar_subscription_add.mdx","calendar_subscription_add POST","Make a new subscription address for the company calendar and answer it. It is shown only this once. Any earlier address stops working at once, so every calendar app subscribed to it must subscribe again. Only a company administrator makes one. Requires approval.\n\n`workspace_write` · approval · v1","/api/reference/calendar/calendar_subscription_add","api/reference/calendar/calendar_subscription_add.mdx","Attendance",[2183,2184,2185,2186,2187,2188,2189,2190,2191,2192,2193,2194],"en:api/reference/attendance",{"_63":2181,"_72":2182},"api/reference/attendance","api/reference/attendance/meta.json",{"_25":2249,"_21":55,"_27":2250,"_29":2251,"_58":-7,"_60":2252,"_23":2253},{"_25":2244,"_21":55,"_27":2245,"_29":2246,"_58":-7,"_60":2247,"_23":2248},{"_25":2239,"_21":55,"_27":2240,"_29":2241,"_58":-7,"_60":2242,"_23":2243},{"_25":2234,"_21":55,"_27":2235,"_29":2236,"_58":-7,"_60":2237,"_23":2238},{"_25":2229,"_21":55,"_27":2230,"_29":2231,"_58":-7,"_60":2232,"_23":2233},{"_25":2224,"_21":55,"_27":2225,"_29":2226,"_58":-7,"_60":2227,"_23":2228},{"_25":2219,"_21":55,"_27":2220,"_29":2221,"_58":-7,"_60":2222,"_23":2223},{"_25":2215,"_21":55,"_27":2216,"_29":2212,"_58":-7,"_60":2217,"_23":2218},{"_25":2210,"_21":55,"_27":2211,"_29":2212,"_58":-7,"_60":2213,"_23":2214},{"_25":2205,"_21":55,"_27":2206,"_29":2207,"_58":-7,"_60":2208,"_23":2209},{"_25":2200,"_21":55,"_27":2201,"_29":2202,"_58":-7,"_60":2203,"_23":2204},{"_25":2195,"_21":55,"_27":2196,"_29":2197,"_58":-7,"_60":2198,"_23":2199},"en:api/reference/attendance/attendance_work_policy_set.mdx","attendance_work_policy_set POST","Set the hours this company works, which attendance is judged against, from today on. The earlier policies stay, each with the day it took effect, so nothing already worked is re-judged. The whole policy is written at once, so read attendance_work_policy_get first and send it back with the fields that change. This is an administrator's and it is company-wide.\n\n`workspace_write` · approval · v1","/api/reference/attendance/attendance_work_policy_set","api/reference/attendance/attendance_work_policy_set.mdx","en:api/reference/attendance/attendance_work_policy_get.mdx","attendance_work_policy_get POST","The hours this company works, which attendance is judged against: the policy in force and every earlier one with the day it took effect, so a past day is judged by the policy of that day. Use this to answer 'what are our working hours', 'is Saturday a working day', or 'when did the four-day week start'. people carries the work hours and daily minimum held for one colleague where they differ from the company's.\n\n`read` · v1","/api/reference/attendance/attendance_work_policy_get","api/reference/attendance/attendance_work_policy_get.mdx","en:api/reference/attendance/attendance_update.mdx","attendance_update POST","Correct the day, the time, or the work location of attendance records that were written wrong, all in one call. What the record held before the correction is kept alongside it, with the reason. A person corrects their own records from the last three days. Correcting an older one, or anybody else's, is an administrator's: asked by anybody else it comes back with status asked, the administrators have been told, and the task is done. Say an administrator was asked; do not call this again.\n\n`workspace_write` · approval · v1","/api/reference/attendance/attendance_update","api/reference/attendance/attendance_update.mdx","en:api/reference/attendance/attendance_team_page_get.mdx","attendance_team_page_get POST","Read one authorized page of team attendance counts or employees for the current company day. Team cards contain true current-state counts, recent recorded clock events and recorded work locations. Employee search and location filtering happen before paging. Historical records are read separately.\n\n`read` · v1","/api/reference/attendance/attendance_team_page_get","api/reference/attendance/attendance_team_page_get.mdx","en:api/reference/attendance/attendance_team_dashboard_get.mdx","attendance_team_dashboard_get POST","/api/reference/attendance/attendance_team_dashboard_get","api/reference/attendance/attendance_team_dashboard_get.mdx","en:api/reference/attendance/attendance_list.mdx","attendance_list POST","List clock-ins and clock-outs as the record holds them. Use this to answer 'when did I come in', 'was anybody late this week', or to find the record another attendance tool is about to correct. Dates are yyyy-mm-dd and times are 24-hour HH:MM, both in the company time zone. Without from and to it covers the last thirty days. It reads the requester's own attendance unless personHints names other people or scope is all. Each row says whether it was written by hand: reason is what the writer gave, and originalDate with originalTime are the moment it was moved from, both null when it was never moved. handWrittenOnly keeps those rows alone. serverTime is the record's own clock, which is the one to compare a moment against rather than the caller's; backdatedAfterMinutes is how far into the past a moment has to be before writing it counts as writing after the fact.\n\n`read` · v3","/api/reference/attendance/attendance_list","api/reference/attendance/attendance_list.mdx","en:api/reference/attendance/attendance_leave_policy_set.mdx","attendance_leave_policy_set POST","Set the leave this company offers, which attendance and time off are judged against. The whole policy is written at once, so read attendance_leave_policy_get first and send it back with the types that change. A type left out that somebody has already taken leave under is kept, deactivated, because the leave rows point at it. This is an administrator's and it is company-wide.\n\n`workspace_write` · approval · v1","/api/reference/attendance/attendance_leave_policy_set","api/reference/attendance/attendance_leave_policy_set.mdx","en:api/reference/attendance/attendance_leave_policy_get.mdx","attendance_leave_policy_get POST","The leave policy this company offers, which attendance and time off are judged against: every type with whether it is paid, how much it grants and in what portions of a day it may be taken, and the day the leave year starts. Use this to answer 'what leave can I take' or 'is sick leave paid'. The type names are what leave_request's kind takes.\n\n`read` · v1","/api/reference/attendance/attendance_leave_policy_get","api/reference/attendance/attendance_leave_policy_get.mdx","en:api/reference/attendance/attendance_delete.mdx","attendance_delete POST","Remove an attendance record that should never have been there. The record stops counting, and who removed it and why stays in the record. A person removes their own records from the last three days. Removing an older one, or anybody else's, is an administrator's: asked by anybody else it comes back with status asked, the administrators have been told, and the task is done. Say an administrator was asked; do not call this again.\n\n`destructive` · approval · v1","/api/reference/attendance/attendance_delete","api/reference/attendance/attendance_delete.mdx","en:api/reference/attendance/attendance_current_get.mdx","attendance_current_get POST","Read the authenticated requester's actionable attendance state in one record snapshot: company time zone and clock, registered work locations, today's events, the latest event across all dates, and currently active approved leave. Accepts no member or company selection. This snapshot contains no colleague rows or period totals; use attendance_list for history.\n\n`read` · v1","/api/reference/attendance/attendance_current_get","api/reference/attendance/attendance_current_get.mdx","en:api/reference/attendance/attendance_changes_page_get.mdx","attendance_changes_page_get POST","List clock-ins and clock-outs as the record holds them. Use this to answer 'when did I come in', 'was anybody late this week', or to find the record another attendance tool is about to correct. Dates are yyyy-mm-dd and times are 24-hour HH:MM, both in the company time zone. Without from and to it covers the last thirty days. It reads the requester's own attendance unless personHints names other people or scope is all. Each row says whether it was written by hand: reason is what the writer gave, and originalDate with originalTime are the moment it was moved from, both null when it was never moved. handWrittenOnly keeps those rows alone. serverTime is the record's own clock, which is the one to compare a moment against rather than the caller's; backdatedAfterMinutes is how far into the past a moment has to be before writing it counts as writing after the fact.\n\n`read` · v1","/api/reference/attendance/attendance_changes_page_get","api/reference/attendance/attendance_changes_page_get.mdx","en:api/reference/attendance/attendance_add.mdx","attendance_add POST","Write one attendance record, a clock-in or clock-out, at the moment it actually happened. Omit date and time for right now, which is what somebody clocking in as they arrive means. A person writes their own record from the last three days and it goes in at once, with status added and its eventID. A press right now that reverses the one before it within a minute, clocking back in at the same place or clocking straight out again, takes that earlier record back instead of adding one: status removed, eventID names the record taken back, and that is a finished answer too. A clock-in right now while a shift is still open clocks that shift out at the same moment before the new one starts, so moving to another place ends one shift where the next begins. Reaching further back is an administrator's to write, for anybody. Asked by anybody else it comes back with status asked and no eventID, and the administrators have already been told what was asked for: that is a finished answer and the task is done. Say an administrator was asked and leave it there; do not call this again. A moment in the future is refused. location names a work location this company has registered and clock_out does not use it. reason says why a record is being written by hand, and is kept when given, never demanded.\n\n`workspace_write` · v4","/api/reference/attendance/attendance_add","api/reference/attendance/attendance_add.mdx","Artifact",[2260],"en:api/reference/artifact",{"_63":2258,"_72":2259},"api/reference/artifact","api/reference/artifact/meta.json",{"_25":2261,"_21":55,"_27":2262,"_29":2263,"_58":-7,"_60":2264,"_23":2265},"en:api/reference/artifact/artifact_review.mdx","artifact_review POST","Review rendered artifact screenshots against a concrete intent and rubric, returning typed visual issues and suggested fixes.\n\n`read` · v2","/api/reference/artifact/artifact_review","api/reference/artifact/artifact_review.mdx","Agent",[2272,2273],"en:api/reference/agent",{"_63":2270,"_72":2271},"api/reference/agent","api/reference/agent/meta.json",{"_25":2279,"_21":55,"_27":2280,"_29":2281,"_58":-7,"_60":2282,"_23":2283},{"_25":2274,"_21":55,"_27":2275,"_29":2276,"_58":-7,"_60":2277,"_23":2278},"en:api/reference/agent/sendAgentMessage.mdx","Send the agent a message POST","Asks the agent for work the way a message in the messenger does. Omit `conversationID` to open a new conversation; the response carries the one it opened.","/api/reference/agent/sendAgentMessage","api/reference/agent/sendAgentMessage.mdx","en:api/reference/agent/readAgentReplies.mdx","Read the agent's replies GET","Returns what the agent has said so far in one conversation.","/api/reference/agent/readAgentReplies","api/reference/agent/readAgentReplies.mdx","en:api/agent.mdx","Driving the agent","Send a message and let the agent choose the tools.","/api/agent","api/agent.mdx","en:api/tools.mdx","Invoking tools","List the tools, call one, and read what actually changed.","/api/tools","api/tools.mdx","en:api/index.mdx","API overview","A token belongs to a person, and every call runs as that person.","/api","api/index.mdx","en:_3","separator","Build","en:glossary.mdx","Glossary","The words this documentation uses precisely, and where each thing lives in the tree.","","/glossary","glossary.mdx","en:boundaries.mdx","Boundaries","Two things decide what may happen, and each is complete in its own territory.","","/boundaries","boundaries.mdx","en:what-lives-where.mdx","What lives where","If that computer burned down tonight, what has to still be true tomorrow.","","/what-lives-where","what-lives-where.mdx","en:architecture.mdx","Architecture","What talks to what, which process owns which step, and where each one lives in the tree.","","/architecture","architecture.mdx","en:introduction.mdx","How it fits together","How the records, the host and the software split up and fit together.","","/introduction","introduction.mdx","en:_2","How it works","en:kim-mini.mdx","Kim mini","How a box that arrives in the post becomes a company's host without a connection file.","","/kim-mini","kim-mini.mdx","en:self-hosting.mdx","Self-hosting levels","Three ways to run internkim, from the host on your own computer to a host you can reach from any network.","","/self-hosting","self-hosting.mdx","en:running-the-host.mdx","Running the host","Install the company host, check its services, and find local data and logs.","","/running-the-host","running-the-host.mdx","en:_1","Operate","en:notifications.mdx","Notifications","What pushes to whom, the two switches a person holds, and the one key pair a deployment sets once.","","/notifications","notifications.mdx","en:office.mdx","Office files","How the agent makes and edits decks, spreadsheets, Word documents and PDFs on any host, and how it checks them before you see them.","","/office","office.mdx","Data room",[2373,2374,2375,2376,2377],"en:data-room",{"_63":2371,"_72":2372},"","data-room","data-room/meta.json",{"_25":2395,"_21":55,"_27":2396,"_29":2397,"_58":-7,"_60":2398,"_23":2399},{"_25":2391,"_21":55,"_27":2392,"_29":-7,"_58":-7,"_60":2393,"_23":2394},{"_25":2386,"_21":55,"_27":2387,"_29":2388,"_58":-7,"_60":2389,"_23":2390},{"_25":2382,"_21":55,"_27":2383,"_29":-7,"_58":-7,"_60":2384,"_23":2385},{"_25":2378,"_21":55,"_27":2379,"_29":-7,"_58":-7,"_60":2380,"_23":2381},"en:data-room/agent.mdx","Agent workflow","/data-room/agent","data-room/agent.mdx","en:data-room/metadata.mdx","Document metadata","/data-room/metadata","data-room/metadata.mdx","en:data-room/access.mdx","Access and sharing","Circles, invitations and publication.","/data-room/access","data-room/access.mdx","en:data-room/layout.mdx","Categories and default circles","/data-room/layout","data-room/layout.mdx","en:data-room/index.mdx","The data room","The company's document archive, read through circles and shared by link.","/data-room","data-room/index.mdx","en:_0","Use","en:quickstart.mdx","Quickstart","Create a company, connect its always-on computer, and invite the first people.","","/quickstart","quickstart.mdx","en:using.mdx","Handing InternKim work","Where and how to ask, what it can take on, and when it checks with you first.","","/using","using.mdx","en:index.mdx","Overview","An AI workspace a company without developers can use from day one. The place your team works and an AI coworker inside it, built together.","","/","index.mdx","","meta.json"]

Namespace	`channel`
Effect	external_write
Approval	not required
Presence	not required
Privacy	`platform_message`
Version	v1

channel_join

What the model reads

Call it over HTTP