[{"data":1,"prerenderedAt":831},["ShallowReactive",2],{"/api/concepts/objects":3,"/api/concepts/objects-surround":826},{"id":4,"title":5,"body":6,"description":817,"extension":818,"links":819,"meta":820,"navigation":821,"path":822,"seo":823,"stem":824,"__hash__":825},"docs/api/2.concepts/objects.md","Objects",{"type":7,"value":8,"toc":810},"minimark",[9,27,32,131,134,536,539,547,550,574,588,592,707,720,731,737,762,801,807],[10,11,12,13,17,18,26],"p",{},"An ",[14,15,16],"strong",{},"object"," is any piece of content in your space — a page, weblink, tag, daily note instance, or custom type. The primary representation is returned by ",[19,20,22],"a",{"href":21},"/api/reference",[23,24,25],"code",{},"GET /object",".",[28,29,31],"h2",{"id":30},"response-shape","Response shape",[33,34,35,48],"table",{},[36,37,38],"thead",{},[39,40,41,45],"tr",{},[42,43,44],"th",{},"Field",[42,46,47],{},"Description",[49,50,51,62,77,87,101,111,121],"tbody",{},[39,52,53,59],{},[54,55,56],"td",{},[23,57,58],{},"id",[54,60,61],{},"Object UUID",[39,63,64,69],{},[54,65,66],{},[23,67,68],{},"structureId",[54,70,71,72,76],{},"Structure / type id (see ",[19,73,75],{"href":74},"/api/concepts/structures","Structures",")",[39,78,79,84],{},[54,80,81],{},[23,82,83],{},"collections",[54,85,86],{},"UUIDs of collections (databases) this object is assigned to",[39,88,89,94],{},[54,90,91],{},[23,92,93],{},"properties",[54,95,96,97,76],{},"Map of property definition id → typed value (see ",[19,98,100],{"href":99},"/api/concepts/properties","Properties",[39,102,103,108],{},[54,104,105],{},[23,106,107],{},"blocks",[54,109,110],{},"Optional map of property id → block content",[39,112,113,118],{},[54,114,115],{},[23,116,117],{},"files",[54,119,120],{},"Optional signed download URLs for media types",[39,122,123,128],{},[54,124,125],{},[23,126,127],{},"mediaContent",[54,129,130],{},"Optional OCR text and colors for images when analysis is complete",[10,132,133],{},"Example (abbreviated):",[135,136,141],"pre",{"className":137,"code":138,"language":139,"meta":140,"style":140},"language-json shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","{\n  \"id\": \"7d2e7f8a-4c3b-4e1d-9f0a-123456789abc\",\n  \"structureId\": \"4ba6e5c6-3f31-45f2-93a0-27a8b2d91551\",\n  \"collections\": [\"9f20f3d7-7df6-4b4a-8f82-123456789abc\"],\n  \"properties\": {\n    \"title\": { \"type\": \"title\", \"title\": { \"value\": \"Example\" } }\n  },\n  \"blocks\": {\n    \"content\": [\n      {\n        \"id\": \"b1111111-1111-4111-8111-111111111111\",\n        \"type\": \"TextBlock\",\n        \"tokens\": [{ \"type\": \"TextToken\", \"text\": \"Hello\", \"style\": {} }],\n        \"blocks\": [],\n        \"hierarchy\": { \"key\": \"Base\", \"val\": 0 }\n      }\n    ]\n  }\n}\n","json","",[23,142,143,152,179,199,223,237,306,312,325,340,346,367,387,452,466,512,518,524,530],{"__ignoreMap":140},[144,145,148],"span",{"class":146,"line":147},"line",1,[144,149,151],{"class":150},"sMK4o","{\n",[144,153,155,158,161,164,167,170,174,176],{"class":146,"line":154},2,[144,156,157],{"class":150},"  \"",[144,159,58],{"class":160},"spNyl",[144,162,163],{"class":150},"\"",[144,165,166],{"class":150},":",[144,168,169],{"class":150}," \"",[144,171,173],{"class":172},"sfazB","7d2e7f8a-4c3b-4e1d-9f0a-123456789abc",[144,175,163],{"class":150},[144,177,178],{"class":150},",\n",[144,180,182,184,186,188,190,192,195,197],{"class":146,"line":181},3,[144,183,157],{"class":150},[144,185,68],{"class":160},[144,187,163],{"class":150},[144,189,166],{"class":150},[144,191,169],{"class":150},[144,193,194],{"class":172},"4ba6e5c6-3f31-45f2-93a0-27a8b2d91551",[144,196,163],{"class":150},[144,198,178],{"class":150},[144,200,202,204,206,208,210,213,215,218,220],{"class":146,"line":201},4,[144,203,157],{"class":150},[144,205,83],{"class":160},[144,207,163],{"class":150},[144,209,166],{"class":150},[144,211,212],{"class":150}," [",[144,214,163],{"class":150},[144,216,217],{"class":172},"9f20f3d7-7df6-4b4a-8f82-123456789abc",[144,219,163],{"class":150},[144,221,222],{"class":150},"],\n",[144,224,226,228,230,232,234],{"class":146,"line":225},5,[144,227,157],{"class":150},[144,229,93],{"class":160},[144,231,163],{"class":150},[144,233,166],{"class":150},[144,235,236],{"class":150}," {\n",[144,238,240,243,247,249,251,254,256,260,262,264,266,268,270,273,275,277,279,281,283,285,289,291,293,295,298,300,303],{"class":146,"line":239},6,[144,241,242],{"class":150},"    \"",[144,244,246],{"class":245},"sBMFI","title",[144,248,163],{"class":150},[144,250,166],{"class":150},[144,252,253],{"class":150}," {",[144,255,169],{"class":150},[144,257,259],{"class":258},"sbssI","type",[144,261,163],{"class":150},[144,263,166],{"class":150},[144,265,169],{"class":150},[144,267,246],{"class":172},[144,269,163],{"class":150},[144,271,272],{"class":150},",",[144,274,169],{"class":150},[144,276,246],{"class":258},[144,278,163],{"class":150},[144,280,166],{"class":150},[144,282,253],{"class":150},[144,284,169],{"class":150},[144,286,288],{"class":287},"swJcz","value",[144,290,163],{"class":150},[144,292,166],{"class":150},[144,294,169],{"class":150},[144,296,297],{"class":172},"Example",[144,299,163],{"class":150},[144,301,302],{"class":150}," }",[144,304,305],{"class":150}," }\n",[144,307,309],{"class":146,"line":308},7,[144,310,311],{"class":150},"  },\n",[144,313,315,317,319,321,323],{"class":146,"line":314},8,[144,316,157],{"class":150},[144,318,107],{"class":160},[144,320,163],{"class":150},[144,322,166],{"class":150},[144,324,236],{"class":150},[144,326,328,330,333,335,337],{"class":146,"line":327},9,[144,329,242],{"class":150},[144,331,332],{"class":245},"content",[144,334,163],{"class":150},[144,336,166],{"class":150},[144,338,339],{"class":150}," [\n",[144,341,343],{"class":146,"line":342},10,[144,344,345],{"class":150},"      {\n",[144,347,349,352,354,356,358,360,363,365],{"class":146,"line":348},11,[144,350,351],{"class":150},"        \"",[144,353,58],{"class":258},[144,355,163],{"class":150},[144,357,166],{"class":150},[144,359,169],{"class":150},[144,361,362],{"class":172},"b1111111-1111-4111-8111-111111111111",[144,364,163],{"class":150},[144,366,178],{"class":150},[144,368,370,372,374,376,378,380,383,385],{"class":146,"line":369},12,[144,371,351],{"class":150},[144,373,259],{"class":258},[144,375,163],{"class":150},[144,377,166],{"class":150},[144,379,169],{"class":150},[144,381,382],{"class":172},"TextBlock",[144,384,163],{"class":150},[144,386,178],{"class":150},[144,388,390,392,395,397,399,402,404,406,408,410,412,415,417,419,421,424,426,428,430,433,435,437,439,442,444,446,449],{"class":146,"line":389},13,[144,391,351],{"class":150},[144,393,394],{"class":258},"tokens",[144,396,163],{"class":150},[144,398,166],{"class":150},[144,400,401],{"class":150}," [{",[144,403,169],{"class":150},[144,405,259],{"class":287},[144,407,163],{"class":150},[144,409,166],{"class":150},[144,411,169],{"class":150},[144,413,414],{"class":172},"TextToken",[144,416,163],{"class":150},[144,418,272],{"class":150},[144,420,169],{"class":150},[144,422,423],{"class":287},"text",[144,425,163],{"class":150},[144,427,166],{"class":150},[144,429,169],{"class":150},[144,431,432],{"class":172},"Hello",[144,434,163],{"class":150},[144,436,272],{"class":150},[144,438,169],{"class":150},[144,440,441],{"class":287},"style",[144,443,163],{"class":150},[144,445,166],{"class":150},[144,447,448],{"class":150}," {}",[144,450,451],{"class":150}," }],\n",[144,453,455,457,459,461,463],{"class":146,"line":454},14,[144,456,351],{"class":150},[144,458,107],{"class":258},[144,460,163],{"class":150},[144,462,166],{"class":150},[144,464,465],{"class":150}," [],\n",[144,467,469,471,474,476,478,480,482,485,487,489,491,494,496,498,500,503,505,507,510],{"class":146,"line":468},15,[144,470,351],{"class":150},[144,472,473],{"class":258},"hierarchy",[144,475,163],{"class":150},[144,477,166],{"class":150},[144,479,253],{"class":150},[144,481,169],{"class":150},[144,483,484],{"class":287},"key",[144,486,163],{"class":150},[144,488,166],{"class":150},[144,490,169],{"class":150},[144,492,493],{"class":172},"Base",[144,495,163],{"class":150},[144,497,272],{"class":150},[144,499,169],{"class":150},[144,501,502],{"class":287},"val",[144,504,163],{"class":150},[144,506,166],{"class":150},[144,508,509],{"class":258}," 0",[144,511,305],{"class":150},[144,513,515],{"class":146,"line":514},16,[144,516,517],{"class":150},"      }\n",[144,519,521],{"class":146,"line":520},17,[144,522,523],{"class":150},"    ]\n",[144,525,527],{"class":146,"line":526},18,[144,528,529],{"class":150},"  }\n",[144,531,533],{"class":146,"line":532},19,[144,534,535],{"class":150},"}\n",[28,537,538],{"id":83},"Collections",[10,540,541,543,544,546],{},[14,542,538],{}," are Capacities databases that group objects of a structure. On read, ",[23,545,83],{}," lists the collection ids the object currently belongs to.",[10,548,549],{},"When creating or updating:",[551,552,553,557,568],"ul",{},[554,555,556],"li",{},"Pass specific collection ids to assign the object to those databases.",[554,558,559,560,563,564,567],{},"Pass ",[23,561,562],{},"collections: []"," to move the object back to its ",[14,565,566],{},"default"," database for that structure (when the structure supports collections).",[554,569,570,571,573],{},"Omit ",[23,572,83],{}," on create to use default placement behavior.",[10,575,576,577,579,580,583,584,587],{},"Only structures that support collections accept ",[23,578,83],{}," on ",[23,581,582],{},"POST /object"," and ",[23,585,586],{},"PATCH /object",". Others ignore or reject collection changes.",[28,589,591],{"id":590},"crud-overview","CRUD overview",[33,593,594,607],{},[36,595,596],{},[39,597,598,601,604],{},[42,599,600],{},"Operation",[42,602,603],{},"Endpoint",[42,605,606],{},"Required scope",[49,608,609,624,638,651,665,679,693],{},[39,610,611,614,619],{},[54,612,613],{},"Read",[54,615,616],{},[23,617,618],{},"GET /object?id=…",[54,620,621],{},[23,622,623],{},"api:read",[39,625,626,629,633],{},[54,627,628],{},"Create",[54,630,631],{},[23,632,582],{},[54,634,635],{},[23,636,637],{},"api:write",[39,639,640,643,647],{},[54,641,642],{},"Update",[54,644,645],{},[23,646,586],{},[54,648,649],{},[23,650,637],{},[39,652,653,656,661],{},[54,654,655],{},"Delete",[54,657,658],{},[23,659,660],{},"DELETE /object?id=…",[54,662,663],{},[23,664,637],{},[39,666,667,670,675],{},[54,668,669],{},"Create from URL",[54,671,672],{},[23,673,674],{},"POST /object/url",[54,676,677],{},[23,678,637],{},[39,680,681,684,689],{},[54,682,683],{},"Export Markdown",[54,685,686],{},[23,687,688],{},"GET /object/markdown?id=…",[54,690,691],{},[23,692,623],{},[39,694,695,698,703],{},[54,696,697],{},"Create from Markdown",[54,699,700],{},[23,701,702],{},"POST /object/markdown",[54,704,705],{},[23,706,637],{},[10,708,709,710,712,713,715,716,719],{},"Patch requires at least one of ",[23,711,93],{}," or ",[23,714,83],{},". Delete supports ",[23,717,718],{},"hardDelete=true"," to permanently remove an object instead of moving it to trash.",[10,721,722,723,726,727,26],{},"To create or export ",[14,724,725],{},"body content"," as Markdown instead of block trees, see ",[19,728,730],{"href":729},"/api/concepts/markdown","Markdown",[28,732,734,735,76],{"id":733},"media-analysis-mediacontent","Media analysis (",[23,736,127],{},[10,738,739,740,743,744,747,748,750,751,753,754,757,758,761],{},"For ",[14,741,742],{},"images"," (",[23,745,746],{},"MediaImage","), ",[23,749,25],{}," may include ",[23,752,127],{}," when AI analysis is complete (",[23,755,756],{},"mediaContentState"," is ",[23,759,760],{},"full","):",[33,763,764,772],{},[36,765,766],{},[39,767,768,770],{},[42,769,44],{},[42,771,47],{},[49,773,774,784],{},[39,775,776,781],{},[54,777,778],{},[23,779,780],{},"ocr.text",[54,782,783],{},"Text extracted from the image",[39,785,786,791],{},[54,787,788],{},[23,789,790],{},"colors",[54,792,793,794,797,798,76],{},"Dominant colors (",[23,795,796],{},"name",", ",[23,799,800],{},"hex",[10,802,803,804,806],{},"Other media types and fields (audio, weblinks, categories, etc.) are not exposed yet. While analysis is still running or failed, ",[23,805,127],{}," is omitted.",[441,808,809],{},"html pre.shiki code .sMK4o, html code.shiki .sMK4o{--shiki-light:#39ADB5;--shiki-default:#89DDFF;--shiki-dark:#89DDFF}html pre.shiki code .spNyl, html code.shiki .spNyl{--shiki-light:#9C3EDA;--shiki-default:#C792EA;--shiki-dark:#C792EA}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}html pre.shiki code .sBMFI, html code.shiki .sBMFI{--shiki-light:#E2931D;--shiki-default:#FFCB6B;--shiki-dark:#FFCB6B}html pre.shiki code .sbssI, html code.shiki .sbssI{--shiki-light:#F76D47;--shiki-default:#F78C6C;--shiki-dark:#F78C6C}html pre.shiki code .swJcz, html code.shiki .swJcz{--shiki-light:#E53935;--shiki-default:#F07178;--shiki-dark:#F07178}html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}",{"title":140,"searchDepth":147,"depth":154,"links":811},[812,813,814,815],{"id":30,"depth":154,"text":31},{"id":83,"depth":154,"text":538},{"id":590,"depth":154,"text":591},{"id":733,"depth":154,"text":816},"Media analysis (mediaContent)","How objects are represented in API responses and how collections work.","md",null,{},true,"/api/concepts/objects",{"title":5,"description":817},"api/2.concepts/objects","UpvFVQPAi6rbD5XQvTJ6VhidM-PS2HhfNzjsDzNLrqg",[827,829],{"title":730,"path":729,"stem":828,"children":-1},"api/2.concepts/markdown",{"title":100,"path":99,"stem":830,"children":-1},"api/2.concepts/properties",1781012286183]