Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
curl --request PATCH \
--url http://localhost:3000/v2/pages/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"icon": {
"file": {},
"external": {},
"file_upload": {}
},
"erase_content": true,
"agent": {
"type": "agent_id",
"agent_id": "agt_123"
},
"assignee": [
{
"type": "user_id",
"user_id": "usr_123"
},
{
"type": "agent_id",
"agent_id": "agt_123"
}
],
"targets": [
{}
],
"files": [
{
"type": "file_upload",
"name": "document.pdf",
"file_upload": {
"id": "<string>"
}
}
],
"content": {
"rich_text": [
{
"type": "text",
"annotations": {
"bold": true,
"italic": true,
"strikethrough": true,
"underline": true,
"code": true,
"color": "<string>"
},
"plain_text": "<string>",
"href": "<string>"
}
],
"color": "<string>"
},
"parent": {
"page_id": "<string>",
"block_id": "<string>",
"org": true,
"company_id": "<string>"
},
"pipelines": {},
"properties": {},
"relations": {}
}
'import requests
url = "http://localhost:3000/v2/pages/{id}"
payload = {
"icon": {
"file": {},
"external": {},
"file_upload": {}
},
"erase_content": True,
"agent": {
"type": "agent_id",
"agent_id": "agt_123"
},
"assignee": [
{
"type": "user_id",
"user_id": "usr_123"
},
{
"type": "agent_id",
"agent_id": "agt_123"
}
],
"targets": [{}],
"files": [
{
"type": "file_upload",
"name": "document.pdf",
"file_upload": { "id": "<string>" }
}
],
"content": {
"rich_text": [
{
"type": "text",
"annotations": {
"bold": True,
"italic": True,
"strikethrough": True,
"underline": True,
"code": True,
"color": "<string>"
},
"plain_text": "<string>",
"href": "<string>"
}
],
"color": "<string>"
},
"parent": {
"page_id": "<string>",
"block_id": "<string>",
"org": True,
"company_id": "<string>"
},
"pipelines": {},
"properties": {},
"relations": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
icon: {file: {}, external: {}, file_upload: {}},
erase_content: true,
agent: {type: 'agent_id', agent_id: 'agt_123'},
assignee: [{type: 'user_id', user_id: 'usr_123'}, {type: 'agent_id', agent_id: 'agt_123'}],
targets: [{}],
files: [{type: 'file_upload', name: 'document.pdf', file_upload: {id: '<string>'}}],
content: {
rich_text: [
{
type: 'text',
annotations: {
bold: true,
italic: true,
strikethrough: true,
underline: true,
code: true,
color: '<string>'
},
plain_text: '<string>',
href: '<string>'
}
],
color: '<string>'
},
parent: {page_id: '<string>', block_id: '<string>', org: true, company_id: '<string>'},
pipelines: {},
properties: {},
relations: {}
})
};
fetch('http://localhost:3000/v2/pages/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/v2/pages/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'icon' => [
'file' => [
],
'external' => [
],
'file_upload' => [
]
],
'erase_content' => true,
'agent' => [
'type' => 'agent_id',
'agent_id' => 'agt_123'
],
'assignee' => [
[
'type' => 'user_id',
'user_id' => 'usr_123'
],
[
'type' => 'agent_id',
'agent_id' => 'agt_123'
]
],
'targets' => [
[
]
],
'files' => [
[
'type' => 'file_upload',
'name' => 'document.pdf',
'file_upload' => [
'id' => '<string>'
]
]
],
'content' => [
'rich_text' => [
[
'type' => 'text',
'annotations' => [
'bold' => true,
'italic' => true,
'strikethrough' => true,
'underline' => true,
'code' => true,
'color' => '<string>'
],
'plain_text' => '<string>',
'href' => '<string>'
]
],
'color' => '<string>'
],
'parent' => [
'page_id' => '<string>',
'block_id' => '<string>',
'org' => true,
'company_id' => '<string>'
],
'pipelines' => [
],
'properties' => [
],
'relations' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:3000/v2/pages/{id}"
payload := strings.NewReader("{\n \"icon\": {\n \"file\": {},\n \"external\": {},\n \"file_upload\": {}\n },\n \"erase_content\": true,\n \"agent\": {\n \"type\": \"agent_id\",\n \"agent_id\": \"agt_123\"\n },\n \"assignee\": [\n {\n \"type\": \"user_id\",\n \"user_id\": \"usr_123\"\n },\n {\n \"type\": \"agent_id\",\n \"agent_id\": \"agt_123\"\n }\n ],\n \"targets\": [\n {}\n ],\n \"files\": [\n {\n \"type\": \"file_upload\",\n \"name\": \"document.pdf\",\n \"file_upload\": {\n \"id\": \"<string>\"\n }\n }\n ],\n \"content\": {\n \"rich_text\": [\n {\n \"type\": \"text\",\n \"annotations\": {\n \"bold\": true,\n \"italic\": true,\n \"strikethrough\": true,\n \"underline\": true,\n \"code\": true,\n \"color\": \"<string>\"\n },\n \"plain_text\": \"<string>\",\n \"href\": \"<string>\"\n }\n ],\n \"color\": \"<string>\"\n },\n \"parent\": {\n \"page_id\": \"<string>\",\n \"block_id\": \"<string>\",\n \"org\": true,\n \"company_id\": \"<string>\"\n },\n \"pipelines\": {},\n \"properties\": {},\n \"relations\": {}\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("http://localhost:3000/v2/pages/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"icon\": {\n \"file\": {},\n \"external\": {},\n \"file_upload\": {}\n },\n \"erase_content\": true,\n \"agent\": {\n \"type\": \"agent_id\",\n \"agent_id\": \"agt_123\"\n },\n \"assignee\": [\n {\n \"type\": \"user_id\",\n \"user_id\": \"usr_123\"\n },\n {\n \"type\": \"agent_id\",\n \"agent_id\": \"agt_123\"\n }\n ],\n \"targets\": [\n {}\n ],\n \"files\": [\n {\n \"type\": \"file_upload\",\n \"name\": \"document.pdf\",\n \"file_upload\": {\n \"id\": \"<string>\"\n }\n }\n ],\n \"content\": {\n \"rich_text\": [\n {\n \"type\": \"text\",\n \"annotations\": {\n \"bold\": true,\n \"italic\": true,\n \"strikethrough\": true,\n \"underline\": true,\n \"code\": true,\n \"color\": \"<string>\"\n },\n \"plain_text\": \"<string>\",\n \"href\": \"<string>\"\n }\n ],\n \"color\": \"<string>\"\n },\n \"parent\": {\n \"page_id\": \"<string>\",\n \"block_id\": \"<string>\",\n \"org\": true,\n \"company_id\": \"<string>\"\n },\n \"pipelines\": {},\n \"properties\": {},\n \"relations\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/v2/pages/{id}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"icon\": {\n \"file\": {},\n \"external\": {},\n \"file_upload\": {}\n },\n \"erase_content\": true,\n \"agent\": {\n \"type\": \"agent_id\",\n \"agent_id\": \"agt_123\"\n },\n \"assignee\": [\n {\n \"type\": \"user_id\",\n \"user_id\": \"usr_123\"\n },\n {\n \"type\": \"agent_id\",\n \"agent_id\": \"agt_123\"\n }\n ],\n \"targets\": [\n {}\n ],\n \"files\": [\n {\n \"type\": \"file_upload\",\n \"name\": \"document.pdf\",\n \"file_upload\": {\n \"id\": \"<string>\"\n }\n }\n ],\n \"content\": {\n \"rich_text\": [\n {\n \"type\": \"text\",\n \"annotations\": {\n \"bold\": true,\n \"italic\": true,\n \"strikethrough\": true,\n \"underline\": true,\n \"code\": true,\n \"color\": \"<string>\"\n },\n \"plain_text\": \"<string>\",\n \"href\": \"<string>\"\n }\n ],\n \"color\": \"<string>\"\n },\n \"parent\": {\n \"page_id\": \"<string>\",\n \"block_id\": \"<string>\",\n \"org\": true,\n \"company_id\": \"<string>\"\n },\n \"pipelines\": {},\n \"properties\": {},\n \"relations\": {}\n}"
response = http.request(request)
puts response.read_body{
"object": "page",
"id": "p_abc123",
"createdAt": "2024-01-15T10:30:00.000Z",
"updatedAt": "2024-01-15T14:45:00.000Z",
"kind": "report",
"title": "<string>",
"agent": {
"type": "none"
},
"assignee": [
{
"type": "user_id",
"user_id": "<string>"
}
],
"targets": [
{
"type": "company",
"company": {
"id": "cmp_abc123",
"document": "12345678000190",
"tradeName": "Acme Corp",
"legalName": "Acme Ltda",
"icon": {
"type": "emoji",
"emoji": "page_icon",
"external": {
"url": "https://example.com/image.jpg"
},
"file_upload": {
"id": "fu_abc123"
},
"domain": "acme.com",
"file": {
"url": "https://s3.amazonaws.com/...",
"expiryTime": "2024-01-15T10:30:00.000Z"
},
"lucide": "file-text",
"brand": "github",
"dicebear": {
"style": "notionists-neutral",
"seed": "0256de50-f90c-49a8-81f0-3988b2b89d8d",
"backgroundColor": "b6e3f4,b6e3f4",
"options": {
"brows": "<string>",
"eyes": "<string>",
"glasses": "<string>",
"lips": "<string>",
"nose": "<string>",
"flip": true,
"rotate": 123,
"scale": 123,
"radius": 123,
"size": 123,
"backgroundType": "solid",
"backgroundRotation": [
123
],
"translateX": 123,
"translateY": 123,
"clip": true,
"randomizeIds": true
}
},
"background": "blue",
"empty": true,
"updatedBy": "dataset:empresas"
}
}
}
],
"permissions": {
"allow": [
"<string>"
],
"deny": [
"<string>"
],
"ask": [
"<string>"
]
},
"files": [
{
"type": "file_upload",
"name": "<string>",
"file_upload": {
"id": "<string>"
}
}
],
"pipelines": {},
"properties": {},
"relations": {},
"summary": "<string>",
"createdBy": {
"object": "user",
"id": "u_abc123",
"apiKeyId": "bsk_abc123"
},
"updatedBy": {
"object": "user",
"id": "u_abc123",
"apiKeyId": "bsk_abc123"
},
"icon": {
"type": "emoji",
"emoji": "page_icon",
"external": {
"url": "https://example.com/image.jpg"
},
"file_upload": {
"id": "fu_abc123"
},
"domain": "acme.com",
"file": {
"url": "https://s3.amazonaws.com/...",
"expiryTime": "2024-01-15T10:30:00.000Z"
},
"lucide": "file-text",
"brand": "github",
"dicebear": {
"style": "notionists-neutral",
"seed": "0256de50-f90c-49a8-81f0-3988b2b89d8d",
"backgroundColor": "b6e3f4,b6e3f4",
"options": {
"brows": "<string>",
"eyes": "<string>",
"glasses": "<string>",
"lips": "<string>",
"nose": "<string>",
"flip": true,
"rotate": 123,
"scale": 123,
"radius": 123,
"size": 123,
"backgroundType": "solid",
"backgroundRotation": [
123
],
"translateX": 123,
"translateY": 123,
"clip": true,
"randomizeIds": true
}
},
"background": "blue",
"empty": true,
"updatedBy": "dataset:empresas"
},
"agentFileId": "<string>",
"content": {
"rich_text": [
{
"type": "text",
"text": {
"content": "<string>",
"link": {
"url": "<string>"
}
},
"annotations": {
"bold": true,
"italic": true,
"strikethrough": true,
"underline": true,
"code": true,
"color": "<string>",
"trend": "up"
},
"plain_text": "<string>",
"href": "<string>"
}
],
"color": "<string>"
},
"parent": {
"type": "page_id",
"page_id": "<string>"
},
"usage": {
"input": 123,
"output": 123,
"total": 123,
"cacheReadInputTokens": 123,
"cacheCreationInputTokens": 123,
"cacheCreationEphemeral1hInputTokens": 123,
"cacheCreationEphemeral5mInputTokens": 123,
"totalInputTokens": 123,
"durationSeconds": 123,
"activeSeconds": 123,
"claudeUsage": {},
"claudeStats": {}
},
"runSessionId": {
"object": "session",
"id": "<string>",
"status": "provisioning",
"userId": "<string>"
},
"url": "<string>"
}Updates a page.
curl --request PATCH \
--url http://localhost:3000/v2/pages/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"icon": {
"file": {},
"external": {},
"file_upload": {}
},
"erase_content": true,
"agent": {
"type": "agent_id",
"agent_id": "agt_123"
},
"assignee": [
{
"type": "user_id",
"user_id": "usr_123"
},
{
"type": "agent_id",
"agent_id": "agt_123"
}
],
"targets": [
{}
],
"files": [
{
"type": "file_upload",
"name": "document.pdf",
"file_upload": {
"id": "<string>"
}
}
],
"content": {
"rich_text": [
{
"type": "text",
"annotations": {
"bold": true,
"italic": true,
"strikethrough": true,
"underline": true,
"code": true,
"color": "<string>"
},
"plain_text": "<string>",
"href": "<string>"
}
],
"color": "<string>"
},
"parent": {
"page_id": "<string>",
"block_id": "<string>",
"org": true,
"company_id": "<string>"
},
"pipelines": {},
"properties": {},
"relations": {}
}
'import requests
url = "http://localhost:3000/v2/pages/{id}"
payload = {
"icon": {
"file": {},
"external": {},
"file_upload": {}
},
"erase_content": True,
"agent": {
"type": "agent_id",
"agent_id": "agt_123"
},
"assignee": [
{
"type": "user_id",
"user_id": "usr_123"
},
{
"type": "agent_id",
"agent_id": "agt_123"
}
],
"targets": [{}],
"files": [
{
"type": "file_upload",
"name": "document.pdf",
"file_upload": { "id": "<string>" }
}
],
"content": {
"rich_text": [
{
"type": "text",
"annotations": {
"bold": True,
"italic": True,
"strikethrough": True,
"underline": True,
"code": True,
"color": "<string>"
},
"plain_text": "<string>",
"href": "<string>"
}
],
"color": "<string>"
},
"parent": {
"page_id": "<string>",
"block_id": "<string>",
"org": True,
"company_id": "<string>"
},
"pipelines": {},
"properties": {},
"relations": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
icon: {file: {}, external: {}, file_upload: {}},
erase_content: true,
agent: {type: 'agent_id', agent_id: 'agt_123'},
assignee: [{type: 'user_id', user_id: 'usr_123'}, {type: 'agent_id', agent_id: 'agt_123'}],
targets: [{}],
files: [{type: 'file_upload', name: 'document.pdf', file_upload: {id: '<string>'}}],
content: {
rich_text: [
{
type: 'text',
annotations: {
bold: true,
italic: true,
strikethrough: true,
underline: true,
code: true,
color: '<string>'
},
plain_text: '<string>',
href: '<string>'
}
],
color: '<string>'
},
parent: {page_id: '<string>', block_id: '<string>', org: true, company_id: '<string>'},
pipelines: {},
properties: {},
relations: {}
})
};
fetch('http://localhost:3000/v2/pages/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/v2/pages/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'icon' => [
'file' => [
],
'external' => [
],
'file_upload' => [
]
],
'erase_content' => true,
'agent' => [
'type' => 'agent_id',
'agent_id' => 'agt_123'
],
'assignee' => [
[
'type' => 'user_id',
'user_id' => 'usr_123'
],
[
'type' => 'agent_id',
'agent_id' => 'agt_123'
]
],
'targets' => [
[
]
],
'files' => [
[
'type' => 'file_upload',
'name' => 'document.pdf',
'file_upload' => [
'id' => '<string>'
]
]
],
'content' => [
'rich_text' => [
[
'type' => 'text',
'annotations' => [
'bold' => true,
'italic' => true,
'strikethrough' => true,
'underline' => true,
'code' => true,
'color' => '<string>'
],
'plain_text' => '<string>',
'href' => '<string>'
]
],
'color' => '<string>'
],
'parent' => [
'page_id' => '<string>',
'block_id' => '<string>',
'org' => true,
'company_id' => '<string>'
],
'pipelines' => [
],
'properties' => [
],
'relations' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:3000/v2/pages/{id}"
payload := strings.NewReader("{\n \"icon\": {\n \"file\": {},\n \"external\": {},\n \"file_upload\": {}\n },\n \"erase_content\": true,\n \"agent\": {\n \"type\": \"agent_id\",\n \"agent_id\": \"agt_123\"\n },\n \"assignee\": [\n {\n \"type\": \"user_id\",\n \"user_id\": \"usr_123\"\n },\n {\n \"type\": \"agent_id\",\n \"agent_id\": \"agt_123\"\n }\n ],\n \"targets\": [\n {}\n ],\n \"files\": [\n {\n \"type\": \"file_upload\",\n \"name\": \"document.pdf\",\n \"file_upload\": {\n \"id\": \"<string>\"\n }\n }\n ],\n \"content\": {\n \"rich_text\": [\n {\n \"type\": \"text\",\n \"annotations\": {\n \"bold\": true,\n \"italic\": true,\n \"strikethrough\": true,\n \"underline\": true,\n \"code\": true,\n \"color\": \"<string>\"\n },\n \"plain_text\": \"<string>\",\n \"href\": \"<string>\"\n }\n ],\n \"color\": \"<string>\"\n },\n \"parent\": {\n \"page_id\": \"<string>\",\n \"block_id\": \"<string>\",\n \"org\": true,\n \"company_id\": \"<string>\"\n },\n \"pipelines\": {},\n \"properties\": {},\n \"relations\": {}\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("http://localhost:3000/v2/pages/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"icon\": {\n \"file\": {},\n \"external\": {},\n \"file_upload\": {}\n },\n \"erase_content\": true,\n \"agent\": {\n \"type\": \"agent_id\",\n \"agent_id\": \"agt_123\"\n },\n \"assignee\": [\n {\n \"type\": \"user_id\",\n \"user_id\": \"usr_123\"\n },\n {\n \"type\": \"agent_id\",\n \"agent_id\": \"agt_123\"\n }\n ],\n \"targets\": [\n {}\n ],\n \"files\": [\n {\n \"type\": \"file_upload\",\n \"name\": \"document.pdf\",\n \"file_upload\": {\n \"id\": \"<string>\"\n }\n }\n ],\n \"content\": {\n \"rich_text\": [\n {\n \"type\": \"text\",\n \"annotations\": {\n \"bold\": true,\n \"italic\": true,\n \"strikethrough\": true,\n \"underline\": true,\n \"code\": true,\n \"color\": \"<string>\"\n },\n \"plain_text\": \"<string>\",\n \"href\": \"<string>\"\n }\n ],\n \"color\": \"<string>\"\n },\n \"parent\": {\n \"page_id\": \"<string>\",\n \"block_id\": \"<string>\",\n \"org\": true,\n \"company_id\": \"<string>\"\n },\n \"pipelines\": {},\n \"properties\": {},\n \"relations\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/v2/pages/{id}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"icon\": {\n \"file\": {},\n \"external\": {},\n \"file_upload\": {}\n },\n \"erase_content\": true,\n \"agent\": {\n \"type\": \"agent_id\",\n \"agent_id\": \"agt_123\"\n },\n \"assignee\": [\n {\n \"type\": \"user_id\",\n \"user_id\": \"usr_123\"\n },\n {\n \"type\": \"agent_id\",\n \"agent_id\": \"agt_123\"\n }\n ],\n \"targets\": [\n {}\n ],\n \"files\": [\n {\n \"type\": \"file_upload\",\n \"name\": \"document.pdf\",\n \"file_upload\": {\n \"id\": \"<string>\"\n }\n }\n ],\n \"content\": {\n \"rich_text\": [\n {\n \"type\": \"text\",\n \"annotations\": {\n \"bold\": true,\n \"italic\": true,\n \"strikethrough\": true,\n \"underline\": true,\n \"code\": true,\n \"color\": \"<string>\"\n },\n \"plain_text\": \"<string>\",\n \"href\": \"<string>\"\n }\n ],\n \"color\": \"<string>\"\n },\n \"parent\": {\n \"page_id\": \"<string>\",\n \"block_id\": \"<string>\",\n \"org\": true,\n \"company_id\": \"<string>\"\n },\n \"pipelines\": {},\n \"properties\": {},\n \"relations\": {}\n}"
response = http.request(request)
puts response.read_body{
"object": "page",
"id": "p_abc123",
"createdAt": "2024-01-15T10:30:00.000Z",
"updatedAt": "2024-01-15T14:45:00.000Z",
"kind": "report",
"title": "<string>",
"agent": {
"type": "none"
},
"assignee": [
{
"type": "user_id",
"user_id": "<string>"
}
],
"targets": [
{
"type": "company",
"company": {
"id": "cmp_abc123",
"document": "12345678000190",
"tradeName": "Acme Corp",
"legalName": "Acme Ltda",
"icon": {
"type": "emoji",
"emoji": "page_icon",
"external": {
"url": "https://example.com/image.jpg"
},
"file_upload": {
"id": "fu_abc123"
},
"domain": "acme.com",
"file": {
"url": "https://s3.amazonaws.com/...",
"expiryTime": "2024-01-15T10:30:00.000Z"
},
"lucide": "file-text",
"brand": "github",
"dicebear": {
"style": "notionists-neutral",
"seed": "0256de50-f90c-49a8-81f0-3988b2b89d8d",
"backgroundColor": "b6e3f4,b6e3f4",
"options": {
"brows": "<string>",
"eyes": "<string>",
"glasses": "<string>",
"lips": "<string>",
"nose": "<string>",
"flip": true,
"rotate": 123,
"scale": 123,
"radius": 123,
"size": 123,
"backgroundType": "solid",
"backgroundRotation": [
123
],
"translateX": 123,
"translateY": 123,
"clip": true,
"randomizeIds": true
}
},
"background": "blue",
"empty": true,
"updatedBy": "dataset:empresas"
}
}
}
],
"permissions": {
"allow": [
"<string>"
],
"deny": [
"<string>"
],
"ask": [
"<string>"
]
},
"files": [
{
"type": "file_upload",
"name": "<string>",
"file_upload": {
"id": "<string>"
}
}
],
"pipelines": {},
"properties": {},
"relations": {},
"summary": "<string>",
"createdBy": {
"object": "user",
"id": "u_abc123",
"apiKeyId": "bsk_abc123"
},
"updatedBy": {
"object": "user",
"id": "u_abc123",
"apiKeyId": "bsk_abc123"
},
"icon": {
"type": "emoji",
"emoji": "page_icon",
"external": {
"url": "https://example.com/image.jpg"
},
"file_upload": {
"id": "fu_abc123"
},
"domain": "acme.com",
"file": {
"url": "https://s3.amazonaws.com/...",
"expiryTime": "2024-01-15T10:30:00.000Z"
},
"lucide": "file-text",
"brand": "github",
"dicebear": {
"style": "notionists-neutral",
"seed": "0256de50-f90c-49a8-81f0-3988b2b89d8d",
"backgroundColor": "b6e3f4,b6e3f4",
"options": {
"brows": "<string>",
"eyes": "<string>",
"glasses": "<string>",
"lips": "<string>",
"nose": "<string>",
"flip": true,
"rotate": 123,
"scale": 123,
"radius": 123,
"size": 123,
"backgroundType": "solid",
"backgroundRotation": [
123
],
"translateX": 123,
"translateY": 123,
"clip": true,
"randomizeIds": true
}
},
"background": "blue",
"empty": true,
"updatedBy": "dataset:empresas"
},
"agentFileId": "<string>",
"content": {
"rich_text": [
{
"type": "text",
"text": {
"content": "<string>",
"link": {
"url": "<string>"
}
},
"annotations": {
"bold": true,
"italic": true,
"strikethrough": true,
"underline": true,
"code": true,
"color": "<string>",
"trend": "up"
},
"plain_text": "<string>",
"href": "<string>"
}
],
"color": "<string>"
},
"parent": {
"type": "page_id",
"page_id": "<string>"
},
"usage": {
"input": 123,
"output": 123,
"total": 123,
"cacheReadInputTokens": 123,
"cacheCreationInputTokens": 123,
"cacheCreationEphemeral1hInputTokens": 123,
"cacheCreationEphemeral5mInputTokens": 123,
"totalInputTokens": 123,
"durationSeconds": 123,
"activeSeconds": 123,
"claudeUsage": {},
"claudeStats": {}
},
"runSessionId": {
"object": "session",
"id": "<string>",
"status": "provisioning",
"userId": "<string>"
},
"url": "<string>"
}OAuth2 Authorization Code flow
Page ID
Page icon
Show child attributes
Delete all block children of the page. Used to clear content before applying a agent.
Agent to apply to the page
Show child attributes
{ "type": "agent_id", "agent_id": "agt_123" }
Page assignees. Supports users and agents.
Show child attributes
[
{ "type": "user_id", "user_id": "usr_123" },
{ "type": "agent_id", "agent_id": "agt_123" }
]
Targets for report pages (company or person references)
Show child attributes
Permissions for report pages
Show child attributes
Files attached to the page
Show child attributes
Page-level content. Uses the same schema as block.content and renders before child blocks.
Show child attributes
Parent relationship (Notion-compatible).
Show child attributes
Board placements patch keyed by pipeline id. Value { stage, position } upserts; null removes.
Show child attributes
Custom properties patch (scalar). Key upserts; null removes. Merge semantics.
Relations patch keyed by relation name. Ref { object, value } / array; null removes. Merge semantics.
Object kind. Changing it re-validates properties against the new kind schema.
report, deal Page updated successfully
Object type
"page"
Unique identifier
"p_abc123"
Creation timestamp
"2024-01-15T10:30:00.000Z"
Last update timestamp
"2024-01-15T14:45:00.000Z"
Object kind (report | deal).
report, deal Page title
Agent reference
Show child attributes
Page assignees. Supports users and agents.
Show child attributes
Page targets
Show child attributes
Show child attributes
Show child attributes
Board placements keyed by pipeline id ({ stage, position }). Empty when not on any board.
Show child attributes
Custom properties (scalar values) keyed by property name. Filter/group via properties.<name>.
Relation values keyed by relation name (target key or array). Filter via relations.<name>.
Principal who created this object
Show child attributes
{
"object": "user",
"id": "u_abc123",
"apiKeyId": "bsk_abc123"
}
Principal who last updated this object
Show child attributes
{
"object": "user",
"id": "u_abc123",
"apiKeyId": "bsk_abc123"
}
Page icon
Show child attributes
Source PPTX file ID for the full deck used by this page agent
Page-level content. Uses the same schema as block.content and renders before child blocks.
Show child attributes
Parent relationship (Notion-compatible).
Show child attributes
Token usage summary for the page
Show child attributes
Associated page run session reference. Use expand=runSessionId.status or expand=runSessionId.userId to include run metadata.
Show child attributes
Absolute app URL for the page. Included only when requested with expand=url.