--- title: "List indexed website pages" method: GET path: "/integrations/web_crawler/websites/pages" tags: ["Integrations"] --- # List indexed website pages `GET /integrations/web_crawler/websites/pages` ## Request - Base URL: `https://api.hyperspell.com` - URL: `https://api.hyperspell.com/integrations/web_crawler/websites/pages` - Auth: HTTP bearer List accessible pages in an exact website collection. ## Query parameters - `url` string, required - `cursor` string, nullable - `limit` integer ## Headers - `X-Hyperspell-Response-Profile` 'api' | 'mcp' - `X-As-User` string, nullable: Optionally set this header to act as a specific user when using an API Key, equivalent to first exchanging the API Key for a User Token ## Response `200` Successful Response - DocumentListPage - `items` DocumentResponse[], required - `resource_id` string, required - `body_status` 'full' | 'excerpt' | 'preview' | 'omitted' - `source` 'reddit' | 'notion' | 'slack' | 'google_calendar' | 'google_mail' | 'imap' | 'google_meet' | 'box' | 'dropbox' | 'github' | 'gitlab' | 'google_drive' | 'vault' | 'web_crawler' | 'trace' | 'microsoft_outlook' | 'microsoft_teams' | 'granola' | 'fathom' | 'fireflies' | 'figma' | 'linear' | 'hubspot' | 'salesforce' | 'coda' | 'confluence' | 'jira' | 'metabase' | 'gong' | 'clickup' | 'lightfield' | 'pylon' | 'fellow' | 'odoo' | 'external_mcp' | 'page', required - `type` string, required: Hyperdoc document type discriminator (document, message, file, event, ...). - `title` string, nullable: Human-readable document title. - `status` 'pending' | 'processing' | 'completed' | 'failed' | 'pending_review' | 'skipped' | 'filtered' | 'cancelled' - `collection` string, nullable: The document's collection, if any. - `metadata` object: Filterable custom metadata attached to the document. - `ingested_at` string, date-time, nullable: When Hyperspell first indexed the document. - `last_modified_at` string, date-time, nullable: When the source document was last modified, if supplied by the source. - `document_date` string, date-time, nullable: The document's own date (e.g. email sent date, event date). - `document` union, required - Document - `type` 'document' - `id` string - `metadata` Metadata: Optional annotations carried by a hyperdoc node. Includes the sources a node is grounded in, human edit attribution, and on a generated page the template block that wrote the node. Unset metadata is omitted from serialized responses. - `sources` SourceRef[], nullable - `chunk_id` string, nullable - `resource_id` string, nullable - `source` string, nullable - `score` number, nullable - `edited_by` string, nullable - `template_block` string, nullable - `placeholder` string, nullable - `text` string, nullable - `children` union[] - union - Person - … - Blob: Represents embedded binary data using data URI scheme. Format: data:[][;base64], Example: data:text/html;base64,PGh0bWw+... - … - Callout - … - Chunk - … - Code - … - Comment - … - Description: A document's standfirst: one or two sentences under the title. A distinct type rather than "the first paragraph", because position is not meaning — a renderer that styles children[0] differently breaks the moment a writer puts a heading first, and a reader extracting the summary would have to guess. One per document by convention; nothing enforces it. - … - Divider - … - Equation - … - Footnote - … - Heading - … - Image - … - Link - … - LineBreak - … - List - … - ListItem - … - Page - … - Paragraph - … - Quote - … - Reference: A pointer to another document in the brain. Carries the display title and the ``(provider, resource_id)`` pair that names the document — the same coordinates a ``SourceRef`` uses, so a reader can resolve it through the same grant-filtered lookup as a citation. Unlike a citation it is content: it stands on its own as a block rather than annotating one. - … - Table - … - TableCell - … - TableRow - … - TaskList: A block of tasks, rendered as one row per task. Children are ``Task`` documents and nothing else — a task list is the one place a task appears as a row inside another document rather than as the document itself, so the row renderer can rely on every child carrying status, due date and priority. The type is a separate container rather than a ``List`` of ``ToDo`` items because a to-do is a checkbox with text, while a task is a document with a lifecycle. - … - Text - … - ToDo - … - ToolCall: A tool/function call made by the assistant. - … - ToolResult: The result of a tool call. - … - TraceMessage: A message in an agent trace (user message, assistant message, or thinking). - … - Utterance: A speaker-attributed segment of a transcript. Start and end times are offsets in seconds from the beginning of the transcript. - … - `title` string, nullable - `comments` Message[], nullable - `type` 'message' - `id` string - `metadata` Metadata: Optional annotations carried by a hyperdoc node. Includes the sources a node is grounded in, human edit attribution, and on a generated page the template block that wrote the node. Unset metadata is omitted from serialized responses. - `sources` SourceRef[], nullable - … - `edited_by` string, nullable - `template_block` string, nullable - `placeholder` string, nullable - `text` string, nullable - `children` union[] - union - … - `sender` Person, required - `type` 'person' - `id` string - `metadata` Metadata: Optional annotations carried by a hyperdoc node. Includes the sources a node is grounded in, human edit attribution, and on a generated page the template block that wrote the node. Unset metadata is omitted from serialized responses. - … - `text` string, nullable - `children` union[] - … - `name` string, nullable - `email` string, nullable - `username` string, nullable - `image_url` string, nullable - `provider` string, nullable: Source system that issued `external_id`, e.g. `slack` - `external_id` string, nullable: The person's user id in the source system - `alt_names` string[], nullable - `is_bot` boolean, nullable - `is_app_user` boolean, nullable - `job_title` string, nullable - `department` string, nullable - `company` string, nullable - `lifecycle_stage` string, nullable - `lead_status` string, nullable - `employment_role` string, nullable - `employment_seniority` string, nullable - `employment_sub_role` string, nullable - `industry` string, nullable - `timezone` string, nullable - `persona` string, nullable - `buying_roles` string[], nullable - `website` string, nullable - `linkedin_url` string, nullable - `original_source` string, nullable - `marketing_contact_status` string, nullable - `last_sales_activity_at` string, nullable - `last_sales_activity_type` string, nullable - `emails` string[], nullable: All known email addresses; `email` holds the primary one - `phone_numbers` string[], nullable - `address` string, nullable - `tags` string[], nullable - `date_of_birth` string, date, nullable - `deal_ids` string[], nullable - `company_ids` string[], nullable - `link_urls` string[], nullable - `date` string, date-time, required - `title` string, nullable: The subject or title of the message - `upvotes` integer, nullable: The number of upvotes, likes, or reactions on the message - `replies` Message[], nullable: The replies or comments to the message - `channel` string, nullable: The channel or platform where the message was posted, if this Message is not explicitly part of a conversation - `external_id` string, nullable: Provider message id (e.g. Slack ts, Gmail message id) — merge-dedup key - `is_self` boolean, nullable - `updated_at` string, date-time, nullable - `num_replies` integer, nullable - `thread_id` string, nullable - `mentioned_users` Person[], nullable - `type` 'person' - `id` string - `metadata` Metadata: Optional annotations carried by a hyperdoc node. Includes the sources a node is grounded in, human edit attribution, and on a generated page the template block that wrote the node. Unset metadata is omitted from serialized responses. - … - `text` string, nullable - `children` union[] - … - `name` string, nullable - `email` string, nullable - `username` string, nullable - `image_url` string, nullable - `provider` string, nullable: Source system that issued `external_id`, e.g. `slack` - `external_id` string, nullable: The person's user id in the source system - `alt_names` string[], nullable - `is_bot` boolean, nullable - `is_app_user` boolean, nullable - `job_title` string, nullable - `department` string, nullable - `company` string, nullable - `lifecycle_stage` string, nullable - `lead_status` string, nullable - `employment_role` string, nullable - `employment_seniority` string, nullable - `employment_sub_role` string, nullable - `industry` string, nullable - `timezone` string, nullable - `persona` string, nullable - `buying_roles` string[], nullable - `website` string, nullable - `linkedin_url` string, nullable - `original_source` string, nullable - `marketing_contact_status` string, nullable - `last_sales_activity_at` string, nullable - `last_sales_activity_type` string, nullable - `emails` string[], nullable: All known email addresses; `email` holds the primary one - `phone_numbers` string[], nullable - `address` string, nullable - `tags` string[], nullable - `date_of_birth` string, date, nullable - `deal_ids` string[], nullable - `company_ids` string[], nullable - `link_urls` string[], nullable - `speaker_role` string, nullable - Website - `type` 'website' - `id` string - `metadata` Metadata: Optional annotations carried by a hyperdoc node. Includes the sources a node is grounded in, human edit attribution, and on a generated page the template block that wrote the node. Unset metadata is omitted from serialized responses. - `sources` SourceRef[], nullable - `chunk_id` string, nullable - `resource_id` string, nullable - `source` string, nullable - `score` number, nullable - `edited_by` string, nullable - `template_block` string, nullable - `placeholder` string, nullable - `text` string, nullable - `children` union[] - union - Person - … - Blob: Represents embedded binary data using data URI scheme. Format: data:[][;base64], Example: data:text/html;base64,PGh0bWw+... - … - Callout - … - Chunk - … - Code - … - Comment - … - Description: A document's standfirst: one or two sentences under the title. A distinct type rather than "the first paragraph", because position is not meaning — a renderer that styles children[0] differently breaks the moment a writer puts a heading first, and a reader extracting the summary would have to guess. One per document by convention; nothing enforces it. - … - Divider - … - Equation - … - Footnote - … - Heading - … - Image - … - Link - … - LineBreak - … - List - … - ListItem - … - Page - … - Paragraph - … - Quote - … - Reference: A pointer to another document in the brain. Carries the display title and the ``(provider, resource_id)`` pair that names the document — the same coordinates a ``SourceRef`` uses, so a reader can resolve it through the same grant-filtered lookup as a citation. Unlike a citation it is content: it stands on its own as a block rather than annotating one. - … - Table - … - TableCell - … - TableRow - … - TaskList: A block of tasks, rendered as one row per task. Children are ``Task`` documents and nothing else — a task list is the one place a task appears as a row inside another document rather than as the document itself, so the row renderer can rely on every child carrying status, due date and priority. The type is a separate container rather than a ``List`` of ``ToDo`` items because a to-do is a checkbox with text, while a task is a document with a lifecycle. - … - Text - … - ToDo - … - ToolCall: A tool/function call made by the assistant. - … - ToolResult: The result of a tool call. - … - TraceMessage: A message in an agent trace (user message, assistant message, or thinking). - … - Utterance: A speaker-attributed segment of a transcript. Start and end times are offsets in seconds from the beginning of the transcript. - … - `url` string, required - `description` string, nullable - `title` string, nullable - `image_url` string, nullable - `language` string, nullable - `favicon` string, nullable - Task - `type` 'task' - `id` string - `metadata` Metadata: Optional annotations carried by a hyperdoc node. Includes the sources a node is grounded in, human edit attribution, and on a generated page the template block that wrote the node. Unset metadata is omitted from serialized responses. - `sources` SourceRef[], nullable - `chunk_id` string, nullable - `resource_id` string, nullable - `source` string, nullable - `score` number, nullable - `edited_by` string, nullable - `template_block` string, nullable - `placeholder` string, nullable - `text` string, nullable - `children` union[] - union - Person - … - Blob: Represents embedded binary data using data URI scheme. Format: data:[][;base64], Example: data:text/html;base64,PGh0bWw+... - … - Callout - … - Chunk - … - Code - … - Comment - … - Description: A document's standfirst: one or two sentences under the title. A distinct type rather than "the first paragraph", because position is not meaning — a renderer that styles children[0] differently breaks the moment a writer puts a heading first, and a reader extracting the summary would have to guess. One per document by convention; nothing enforces it. - … - Divider - … - Equation - … - Footnote - … - Heading - … - Image - … - Link - … - LineBreak - … - List - … - ListItem - … - Page - … - Paragraph - … - Quote - … - Reference: A pointer to another document in the brain. Carries the display title and the ``(provider, resource_id)`` pair that names the document — the same coordinates a ``SourceRef`` uses, so a reader can resolve it through the same grant-filtered lookup as a citation. Unlike a citation it is content: it stands on its own as a block rather than annotating one. - … - Table - … - TableCell - … - TableRow - … - TaskList: A block of tasks, rendered as one row per task. Children are ``Task`` documents and nothing else — a task list is the one place a task appears as a row inside another document rather than as the document itself, so the row renderer can rely on every child carrying status, due date and priority. The type is a separate container rather than a ``List`` of ``ToDo`` items because a to-do is a checkbox with text, while a task is a document with a lifecycle. - … - Text - … - ToDo - … - ToolCall: A tool/function call made by the assistant. - … - ToolResult: The result of a tool call. - … - TraceMessage: A message in an agent trace (user message, assistant message, or thinking). - … - Utterance: A speaker-attributed segment of a transcript. Start and end times are offsets in seconds from the beginning of the transcript. - … - `title` string, nullable - `comments` Message[], nullable - `type` 'message' - `id` string - `metadata` Metadata: Optional annotations carried by a hyperdoc node. Includes the sources a node is grounded in, human edit attribution, and on a generated page the template block that wrote the node. Unset metadata is omitted from serialized responses. - `sources` SourceRef[], nullable - … - `edited_by` string, nullable - `template_block` string, nullable - `placeholder` string, nullable - `text` string, nullable - `children` union[] - union - … - `sender` Person, required - `type` 'person' - `id` string - `metadata` Metadata: Optional annotations carried by a hyperdoc node. Includes the sources a node is grounded in, human edit attribution, and on a generated page the template block that wrote the node. Unset metadata is omitted from serialized responses. - … - `text` string, nullable - `children` union[] - … - `name` string, nullable - `email` string, nullable - `username` string, nullable - `image_url` string, nullable - `provider` string, nullable: Source system that issued `external_id`, e.g. `slack` - `external_id` string, nullable: The person's user id in the source system - `alt_names` string[], nullable - `is_bot` boolean, nullable - `is_app_user` boolean, nullable - `job_title` string, nullable - `department` string, nullable - `company` string, nullable - `lifecycle_stage` string, nullable - `lead_status` string, nullable - `employment_role` string, nullable - `employment_seniority` string, nullable - `employment_sub_role` string, nullable - `industry` string, nullable - `timezone` string, nullable - `persona` string, nullable - `buying_roles` string[], nullable - `website` string, nullable - `linkedin_url` string, nullable - `original_source` string, nullable - `marketing_contact_status` string, nullable - `last_sales_activity_at` string, nullable - `last_sales_activity_type` string, nullable - `emails` string[], nullable: All known email addresses; `email` holds the primary one - `phone_numbers` string[], nullable - `address` string, nullable - `tags` string[], nullable - `date_of_birth` string, date, nullable - `deal_ids` string[], nullable - `company_ids` string[], nullable - `link_urls` string[], nullable - `date` string, date-time, required - `title` string, nullable: The subject or title of the message - `upvotes` integer, nullable: The number of upvotes, likes, or reactions on the message - `replies` Message[], nullable: The replies or comments to the message - `channel` string, nullable: The channel or platform where the message was posted, if this Message is not explicitly part of a conversation - `external_id` string, nullable: Provider message id (e.g. Slack ts, Gmail message id) — merge-dedup key - `is_self` boolean, nullable - `updated_at` string, date-time, nullable - `num_replies` integer, nullable - `thread_id` string, nullable - `mentioned_users` Person[], nullable - `type` 'person' - `id` string - `metadata` Metadata: Optional annotations carried by a hyperdoc node. Includes the sources a node is grounded in, human edit attribution, and on a generated page the template block that wrote the node. Unset metadata is omitted from serialized responses. - … - `text` string, nullable - `children` union[] - … - `name` string, nullable - `email` string, nullable - `username` string, nullable - `image_url` string, nullable - `provider` string, nullable: Source system that issued `external_id`, e.g. `slack` - `external_id` string, nullable: The person's user id in the source system - `alt_names` string[], nullable - `is_bot` boolean, nullable - `is_app_user` boolean, nullable - `job_title` string, nullable - `department` string, nullable - `company` string, nullable - `lifecycle_stage` string, nullable - `lead_status` string, nullable - `employment_role` string, nullable - `employment_seniority` string, nullable - `employment_sub_role` string, nullable - `industry` string, nullable - `timezone` string, nullable - `persona` string, nullable - `buying_roles` string[], nullable - `website` string, nullable - `linkedin_url` string, nullable - `original_source` string, nullable - `marketing_contact_status` string, nullable - `last_sales_activity_at` string, nullable - `last_sales_activity_type` string, nullable - `emails` string[], nullable: All known email addresses; `email` holds the primary one - `phone_numbers` string[], nullable - `address` string, nullable - `tags` string[], nullable - `date_of_birth` string, date, nullable - `deal_ids` string[], nullable - `company_ids` string[], nullable - `link_urls` string[], nullable - `speaker_role` string, nullable - `due_at` string, date-time, nullable - `status` 'completed' | 'not_started' | 'in_progress' | 'cancelled' - `priority` 'urgent' | 'high' | 'medium' | 'low' - Person - `type` 'person' - `id` string - `metadata` Metadata: Optional annotations carried by a hyperdoc node. Includes the sources a node is grounded in, human edit attribution, and on a generated page the template block that wrote the node. Unset metadata is omitted from serialized responses. - `sources` SourceRef[], nullable - `chunk_id` string, nullable - `resource_id` string, nullable - `source` string, nullable - `score` number, nullable - `edited_by` string, nullable - `template_block` string, nullable - `placeholder` string, nullable - `text` string, nullable - `children` union[] - union - Person (recursive) - Blob: Represents embedded binary data using data URI scheme. Format: data:[][;base64], Example: data:text/html;base64,PGh0bWw+... - … - Callout - … - Chunk - … - Code - … - Comment - … - Description: A document's standfirst: one or two sentences under the title. A distinct type rather than "the first paragraph", because position is not meaning — a renderer that styles children[0] differently breaks the moment a writer puts a heading first, and a reader extracting the summary would have to guess. One per document by convention; nothing enforces it. - … - Divider - … - Equation - … - Footnote - … - Heading - … - Image - … - Link - … - LineBreak - … - List - … - ListItem - … - Page - … - Paragraph - … - Quote - … - Reference: A pointer to another document in the brain. Carries the display title and the ``(provider, resource_id)`` pair that names the document — the same coordinates a ``SourceRef`` uses, so a reader can resolve it through the same grant-filtered lookup as a citation. Unlike a citation it is content: it stands on its own as a block rather than annotating one. - … - Table - … - TableCell - … - TableRow - … - TaskList: A block of tasks, rendered as one row per task. Children are ``Task`` documents and nothing else — a task list is the one place a task appears as a row inside another document rather than as the document itself, so the row renderer can rely on every child carrying status, due date and priority. The type is a separate container rather than a ``List`` of ``ToDo`` items because a to-do is a checkbox with text, while a task is a document with a lifecycle. - … - Text - … - ToDo - … - ToolCall: A tool/function call made by the assistant. - … - ToolResult: The result of a tool call. - … - TraceMessage: A message in an agent trace (user message, assistant message, or thinking). - … - Utterance: A speaker-attributed segment of a transcript. Start and end times are offsets in seconds from the beginning of the transcript. - … - `name` string, nullable - `email` string, nullable - `username` string, nullable - `image_url` string, nullable - `provider` string, nullable: Source system that issued `external_id`, e.g. `slack` - `external_id` string, nullable: The person's user id in the source system - `alt_names` string[], nullable - `is_bot` boolean, nullable - `is_app_user` boolean, nullable - `job_title` string, nullable - `department` string, nullable - `company` string, nullable - `lifecycle_stage` string, nullable - `lead_status` string, nullable - `employment_role` string, nullable - `employment_seniority` string, nullable - `employment_sub_role` string, nullable - `industry` string, nullable - `timezone` string, nullable - `persona` string, nullable - `buying_roles` string[], nullable - `website` string, nullable - `linkedin_url` string, nullable - `original_source` string, nullable - `marketing_contact_status` string, nullable - `last_sales_activity_at` string, nullable - `last_sales_activity_type` string, nullable - `emails` string[], nullable: All known email addresses; `email` holds the primary one - `phone_numbers` string[], nullable - `address` string, nullable - `tags` string[], nullable - `date_of_birth` string, date, nullable - `deal_ids` string[], nullable - `company_ids` string[], nullable - `link_urls` string[], nullable - Message - `type` 'message' - `id` string - `metadata` Metadata: Optional annotations carried by a hyperdoc node. Includes the sources a node is grounded in, human edit attribution, and on a generated page the template block that wrote the node. Unset metadata is omitted from serialized responses. - `sources` SourceRef[], nullable - `chunk_id` string, nullable - `resource_id` string, nullable - `source` string, nullable - `score` number, nullable - `edited_by` string, nullable - `template_block` string, nullable - `placeholder` string, nullable - `text` string, nullable - `children` union[] - union - Person - … - Blob: Represents embedded binary data using data URI scheme. Format: data:[][;base64], Example: data:text/html;base64,PGh0bWw+... - … - Callout - … - Chunk - … - Code - … - Comment - … - Description: A document's standfirst: one or two sentences under the title. A distinct type rather than "the first paragraph", because position is not meaning — a renderer that styles children[0] differently breaks the moment a writer puts a heading first, and a reader extracting the summary would have to guess. One per document by convention; nothing enforces it. - … - Divider - … - Equation - … - Footnote - … - Heading - … - Image - … - Link - … - LineBreak - … - List - … - ListItem - … - Page - … - Paragraph - … - Quote - … - Reference: A pointer to another document in the brain. Carries the display title and the ``(provider, resource_id)`` pair that names the document — the same coordinates a ``SourceRef`` uses, so a reader can resolve it through the same grant-filtered lookup as a citation. Unlike a citation it is content: it stands on its own as a block rather than annotating one. - … - Table - … - TableCell - … - TableRow - … - TaskList: A block of tasks, rendered as one row per task. Children are ``Task`` documents and nothing else — a task list is the one place a task appears as a row inside another document rather than as the document itself, so the row renderer can rely on every child carrying status, due date and priority. The type is a separate container rather than a ``List`` of ``ToDo`` items because a to-do is a checkbox with text, while a task is a document with a lifecycle. - … - Text - … - ToDo - … - ToolCall: A tool/function call made by the assistant. - … - ToolResult: The result of a tool call. - … - TraceMessage: A message in an agent trace (user message, assistant message, or thinking). - … - Utterance: A speaker-attributed segment of a transcript. Start and end times are offsets in seconds from the beginning of the transcript. - … - `sender` Person, required - `type` 'person' - `id` string - `metadata` Metadata: Optional annotations carried by a hyperdoc node. Includes the sources a node is grounded in, human edit attribution, and on a generated page the template block that wrote the node. Unset metadata is omitted from serialized responses. - `sources` SourceRef[], nullable - … - `edited_by` string, nullable - `template_block` string, nullable - `placeholder` string, nullable - `text` string, nullable - `children` union[] - union - … - `name` string, nullable - `email` string, nullable - `username` string, nullable - `image_url` string, nullable - `provider` string, nullable: Source system that issued `external_id`, e.g. `slack` - `external_id` string, nullable: The person's user id in the source system - `alt_names` string[], nullable - `is_bot` boolean, nullable - `is_app_user` boolean, nullable - `job_title` string, nullable - `department` string, nullable - `company` string, nullable - `lifecycle_stage` string, nullable - `lead_status` string, nullable - `employment_role` string, nullable - `employment_seniority` string, nullable - `employment_sub_role` string, nullable - `industry` string, nullable - `timezone` string, nullable - `persona` string, nullable - `buying_roles` string[], nullable - `website` string, nullable - `linkedin_url` string, nullable - `original_source` string, nullable - `marketing_contact_status` string, nullable - `last_sales_activity_at` string, nullable - `last_sales_activity_type` string, nullable - `emails` string[], nullable: All known email addresses; `email` holds the primary one - `phone_numbers` string[], nullable - `address` string, nullable - `tags` string[], nullable - `date_of_birth` string, date, nullable - `deal_ids` string[], nullable - `company_ids` string[], nullable - `link_urls` string[], nullable - `date` string, date-time, required - `title` string, nullable: The subject or title of the message - `upvotes` integer, nullable: The number of upvotes, likes, or reactions on the message - `replies` Message[], nullable: The replies or comments to the message - `channel` string, nullable: The channel or platform where the message was posted, if this Message is not explicitly part of a conversation - `external_id` string, nullable: Provider message id (e.g. Slack ts, Gmail message id) — merge-dedup key - `is_self` boolean, nullable - `updated_at` string, date-time, nullable - `num_replies` integer, nullable - `thread_id` string, nullable - `mentioned_users` Person[], nullable - `type` 'person' - `id` string - `metadata` Metadata: Optional annotations carried by a hyperdoc node. Includes the sources a node is grounded in, human edit attribution, and on a generated page the template block that wrote the node. Unset metadata is omitted from serialized responses. - `sources` SourceRef[], nullable - … - `edited_by` string, nullable - `template_block` string, nullable - `placeholder` string, nullable - `text` string, nullable - `children` union[] - union - … - `name` string, nullable - `email` string, nullable - `username` string, nullable - `image_url` string, nullable - `provider` string, nullable: Source system that issued `external_id`, e.g. `slack` - `external_id` string, nullable: The person's user id in the source system - `alt_names` string[], nullable - `is_bot` boolean, nullable - `is_app_user` boolean, nullable - `job_title` string, nullable - `department` string, nullable - `company` string, nullable - `lifecycle_stage` string, nullable - `lead_status` string, nullable - `employment_role` string, nullable - `employment_seniority` string, nullable - `employment_sub_role` string, nullable - `industry` string, nullable - `timezone` string, nullable - `persona` string, nullable - `buying_roles` string[], nullable - `website` string, nullable - `linkedin_url` string, nullable - `original_source` string, nullable - `marketing_contact_status` string, nullable - `last_sales_activity_at` string, nullable - `last_sales_activity_type` string, nullable - `emails` string[], nullable: All known email addresses; `email` holds the primary one - `phone_numbers` string[], nullable - `address` string, nullable - `tags` string[], nullable - `date_of_birth` string, date, nullable - `deal_ids` string[], nullable - `company_ids` string[], nullable - `link_urls` string[], nullable - `speaker_role` string, nullable - Event - `type` 'event' - `id` string - `metadata` Metadata: Optional annotations carried by a hyperdoc node. Includes the sources a node is grounded in, human edit attribution, and on a generated page the template block that wrote the node. Unset metadata is omitted from serialized responses. - `sources` SourceRef[], nullable - `chunk_id` string, nullable - `resource_id` string, nullable - `source` string, nullable - `score` number, nullable - `edited_by` string, nullable - `template_block` string, nullable - `placeholder` string, nullable - `text` string, nullable - `children` union[] - union - Person - … - Blob: Represents embedded binary data using data URI scheme. Format: data:[][;base64], Example: data:text/html;base64,PGh0bWw+... - … - Callout - … - Chunk - … - Code - … - Comment - … - Description: A document's standfirst: one or two sentences under the title. A distinct type rather than "the first paragraph", because position is not meaning — a renderer that styles children[0] differently breaks the moment a writer puts a heading first, and a reader extracting the summary would have to guess. One per document by convention; nothing enforces it. - … - Divider - … - Equation - … - Footnote - … - Heading - … - Image - … - Link - … - LineBreak - … - List - … - ListItem - … - Page - … - Paragraph - … - Quote - … - Reference: A pointer to another document in the brain. Carries the display title and the ``(provider, resource_id)`` pair that names the document — the same coordinates a ``SourceRef`` uses, so a reader can resolve it through the same grant-filtered lookup as a citation. Unlike a citation it is content: it stands on its own as a block rather than annotating one. - … - Table - … - TableCell - … - TableRow - … - TaskList: A block of tasks, rendered as one row per task. Children are ``Task`` documents and nothing else — a task list is the one place a task appears as a row inside another document rather than as the document itself, so the row renderer can rely on every child carrying status, due date and priority. The type is a separate container rather than a ``List`` of ``ToDo`` items because a to-do is a checkbox with text, while a task is a document with a lifecycle. - … - Text - … - ToDo - … - ToolCall: A tool/function call made by the assistant. - … - ToolResult: The result of a tool call. - … - TraceMessage: A message in an agent trace (user message, assistant message, or thinking). - … - Utterance: A speaker-attributed segment of a transcript. Start and end times are offsets in seconds from the beginning of the transcript. - … - `title` string, nullable - `start_at` string, date-time, nullable - `end_at` string, date-time, nullable - `meeting_url` string, nullable - `location` string, nullable - `attendees` Person[] - `type` 'person' - `id` string - `metadata` Metadata: Optional annotations carried by a hyperdoc node. Includes the sources a node is grounded in, human edit attribution, and on a generated page the template block that wrote the node. Unset metadata is omitted from serialized responses. - `sources` SourceRef[], nullable - … - `edited_by` string, nullable - `template_block` string, nullable - `placeholder` string, nullable - `text` string, nullable - `children` union[] - union - … - `name` string, nullable - `email` string, nullable - `username` string, nullable - `image_url` string, nullable - `provider` string, nullable: Source system that issued `external_id`, e.g. `slack` - `external_id` string, nullable: The person's user id in the source system - `alt_names` string[], nullable - `is_bot` boolean, nullable - `is_app_user` boolean, nullable - `job_title` string, nullable - `department` string, nullable - `company` string, nullable - `lifecycle_stage` string, nullable - `lead_status` string, nullable - `employment_role` string, nullable - `employment_seniority` string, nullable - `employment_sub_role` string, nullable - `industry` string, nullable - `timezone` string, nullable - `persona` string, nullable - `buying_roles` string[], nullable - `website` string, nullable - `linkedin_url` string, nullable - `original_source` string, nullable - `marketing_contact_status` string, nullable - `last_sales_activity_at` string, nullable - `last_sales_activity_type` string, nullable - `emails` string[], nullable: All known email addresses; `email` holds the primary one - `phone_numbers` string[], nullable - `address` string, nullable - `tags` string[], nullable - `date_of_birth` string, date, nullable - `deal_ids` string[], nullable - `company_ids` string[], nullable - `link_urls` string[], nullable - File - `type` 'file' - `id` string - `metadata` Metadata: Optional annotations carried by a hyperdoc node. Includes the sources a node is grounded in, human edit attribution, and on a generated page the template block that wrote the node. Unset metadata is omitted from serialized responses. - `sources` SourceRef[], nullable - `chunk_id` string, nullable - `resource_id` string, nullable - `source` string, nullable - `score` number, nullable - `edited_by` string, nullable - `template_block` string, nullable - `placeholder` string, nullable - `text` string, nullable - `children` union[] - union - Person - … - Blob: Represents embedded binary data using data URI scheme. Format: data:[][;base64], Example: data:text/html;base64,PGh0bWw+... - … - Callout - … - Chunk - … - Code - … - Comment - … - Description: A document's standfirst: one or two sentences under the title. A distinct type rather than "the first paragraph", because position is not meaning — a renderer that styles children[0] differently breaks the moment a writer puts a heading first, and a reader extracting the summary would have to guess. One per document by convention; nothing enforces it. - … - Divider - … - Equation - … - Footnote - … - Heading - … - Image - … - Link - … - LineBreak - … - List - … - ListItem - … - Page - … - Paragraph - … - Quote - … - Reference: A pointer to another document in the brain. Carries the display title and the ``(provider, resource_id)`` pair that names the document — the same coordinates a ``SourceRef`` uses, so a reader can resolve it through the same grant-filtered lookup as a citation. Unlike a citation it is content: it stands on its own as a block rather than annotating one. - … - Table - … - TableCell - … - TableRow - … - TaskList: A block of tasks, rendered as one row per task. Children are ``Task`` documents and nothing else — a task list is the one place a task appears as a row inside another document rather than as the document itself, so the row renderer can rely on every child carrying status, due date and priority. The type is a separate container rather than a ``List`` of ``ToDo`` items because a to-do is a checkbox with text, while a task is a document with a lifecycle. - … - Text - … - ToDo - … - ToolCall: A tool/function call made by the assistant. - … - ToolResult: The result of a tool call. - … - TraceMessage: A message in an agent trace (user message, assistant message, or thinking). - … - Utterance: A speaker-attributed segment of a transcript. Start and end times are offsets in seconds from the beginning of the transcript. - … - `filename` string, required - `content_type` string, required - `path` string[], nullable - `title` string, nullable - `content_truncated` boolean, nullable: Whether the stored readable body is a capped preview of the full file. - Conversation - `type` 'conversation' - `id` string - `metadata` Metadata: Optional annotations carried by a hyperdoc node. Includes the sources a node is grounded in, human edit attribution, and on a generated page the template block that wrote the node. Unset metadata is omitted from serialized responses. - `sources` SourceRef[], nullable - `chunk_id` string, nullable - `resource_id` string, nullable - `source` string, nullable - `score` number, nullable - `edited_by` string, nullable - `template_block` string, nullable - `placeholder` string, nullable - `text` string, nullable - `children` Message[] - `type` 'message' - `id` string - `metadata` Metadata: Optional annotations carried by a hyperdoc node. Includes the sources a node is grounded in, human edit attribution, and on a generated page the template block that wrote the node. Unset metadata is omitted from serialized responses. - `sources` SourceRef[], nullable - … - `edited_by` string, nullable - `template_block` string, nullable - `placeholder` string, nullable - `text` string, nullable - `children` union[] - union - … - `sender` Person, required - `type` 'person' - `id` string - `metadata` Metadata: Optional annotations carried by a hyperdoc node. Includes the sources a node is grounded in, human edit attribution, and on a generated page the template block that wrote the node. Unset metadata is omitted from serialized responses. - … - `text` string, nullable - `children` union[] - … - `name` string, nullable - `email` string, nullable - `username` string, nullable - `image_url` string, nullable - `provider` string, nullable: Source system that issued `external_id`, e.g. `slack` - `external_id` string, nullable: The person's user id in the source system - `alt_names` string[], nullable - `is_bot` boolean, nullable - `is_app_user` boolean, nullable - `job_title` string, nullable - `department` string, nullable - `company` string, nullable - `lifecycle_stage` string, nullable - `lead_status` string, nullable - `employment_role` string, nullable - `employment_seniority` string, nullable - `employment_sub_role` string, nullable - `industry` string, nullable - `timezone` string, nullable - `persona` string, nullable - `buying_roles` string[], nullable - `website` string, nullable - `linkedin_url` string, nullable - `original_source` string, nullable - `marketing_contact_status` string, nullable - `last_sales_activity_at` string, nullable - `last_sales_activity_type` string, nullable - `emails` string[], nullable: All known email addresses; `email` holds the primary one - `phone_numbers` string[], nullable - `address` string, nullable - `tags` string[], nullable - `date_of_birth` string, date, nullable - `deal_ids` string[], nullable - `company_ids` string[], nullable - `link_urls` string[], nullable - `date` string, date-time, required - `title` string, nullable: The subject or title of the message - `upvotes` integer, nullable: The number of upvotes, likes, or reactions on the message - `replies` Message[], nullable: The replies or comments to the message - `channel` string, nullable: The channel or platform where the message was posted, if this Message is not explicitly part of a conversation - `external_id` string, nullable: Provider message id (e.g. Slack ts, Gmail message id) — merge-dedup key - `is_self` boolean, nullable - `updated_at` string, date-time, nullable - `num_replies` integer, nullable - `thread_id` string, nullable - `mentioned_users` Person[], nullable - `type` 'person' - `id` string - `metadata` Metadata: Optional annotations carried by a hyperdoc node. Includes the sources a node is grounded in, human edit attribution, and on a generated page the template block that wrote the node. Unset metadata is omitted from serialized responses. - … - `text` string, nullable - `children` union[] - … - `name` string, nullable - `email` string, nullable - `username` string, nullable - `image_url` string, nullable - `provider` string, nullable: Source system that issued `external_id`, e.g. `slack` - `external_id` string, nullable: The person's user id in the source system - `alt_names` string[], nullable - `is_bot` boolean, nullable - `is_app_user` boolean, nullable - `job_title` string, nullable - `department` string, nullable - `company` string, nullable - `lifecycle_stage` string, nullable - `lead_status` string, nullable - `employment_role` string, nullable - `employment_seniority` string, nullable - `employment_sub_role` string, nullable - `industry` string, nullable - `timezone` string, nullable - `persona` string, nullable - `buying_roles` string[], nullable - `website` string, nullable - `linkedin_url` string, nullable - `original_source` string, nullable - `marketing_contact_status` string, nullable - `last_sales_activity_at` string, nullable - `last_sales_activity_type` string, nullable - `emails` string[], nullable: All known email addresses; `email` holds the primary one - `phone_numbers` string[], nullable - `address` string, nullable - `tags` string[], nullable - `date_of_birth` string, date, nullable - `deal_ids` string[], nullable - `company_ids` string[], nullable - `link_urls` string[], nullable - `speaker_role` string, nullable - `channel` string, nullable - `title` string, nullable - `participants` Person[], nullable - `type` 'person' - `id` string - `metadata` Metadata: Optional annotations carried by a hyperdoc node. Includes the sources a node is grounded in, human edit attribution, and on a generated page the template block that wrote the node. Unset metadata is omitted from serialized responses. - `sources` SourceRef[], nullable - … - `edited_by` string, nullable - `template_block` string, nullable - `placeholder` string, nullable - `text` string, nullable - `children` union[] - union - … - `name` string, nullable - `email` string, nullable - `username` string, nullable - `image_url` string, nullable - `provider` string, nullable: Source system that issued `external_id`, e.g. `slack` - `external_id` string, nullable: The person's user id in the source system - `alt_names` string[], nullable - `is_bot` boolean, nullable - `is_app_user` boolean, nullable - `job_title` string, nullable - `department` string, nullable - `company` string, nullable - `lifecycle_stage` string, nullable - `lead_status` string, nullable - `employment_role` string, nullable - `employment_seniority` string, nullable - `employment_sub_role` string, nullable - `industry` string, nullable - `timezone` string, nullable - `persona` string, nullable - `buying_roles` string[], nullable - `website` string, nullable - `linkedin_url` string, nullable - `original_source` string, nullable - `marketing_contact_status` string, nullable - `last_sales_activity_at` string, nullable - `last_sales_activity_type` string, nullable - `emails` string[], nullable: All known email addresses; `email` holds the primary one - `phone_numbers` string[], nullable - `address` string, nullable - `tags` string[], nullable - `date_of_birth` string, date, nullable - `deal_ids` string[], nullable - `company_ids` string[], nullable - `link_urls` string[], nullable - Trace: An agent trace/transcript containing a sequence of steps. Steps can be TraceMessage (user/assistant messages or thinking), ToolCall (function calls), or ToolResult (tool responses). - `type` 'trace' - `id` string - `metadata` Metadata: Optional annotations carried by a hyperdoc node. Includes the sources a node is grounded in, human edit attribution, and on a generated page the template block that wrote the node. Unset metadata is omitted from serialized responses. - `sources` SourceRef[], nullable - `chunk_id` string, nullable - `resource_id` string, nullable - `source` string, nullable - `score` number, nullable - `edited_by` string, nullable - `template_block` string, nullable - `placeholder` string, nullable - `text` string, nullable - `children` union[] - union - TraceMessage: A message in an agent trace (user message, assistant message, or thinking). - … - ToolCall: A tool/function call made by the assistant. - … - ToolResult: The result of a tool call. - … - `title` string, nullable - Transcript: A time-anchored, speaker-attributed transcript for a meeting or call. Utterance timestamps are relative offsets from `started_at`, which is the absolute wall-clock anchor. - `type` 'transcript' - `id` string - `metadata` Metadata: Optional annotations carried by a hyperdoc node. Includes the sources a node is grounded in, human edit attribution, and on a generated page the template block that wrote the node. Unset metadata is omitted from serialized responses. - `sources` SourceRef[], nullable - `chunk_id` string, nullable - `resource_id` string, nullable - `source` string, nullable - `score` number, nullable - `edited_by` string, nullable - `template_block` string, nullable - `placeholder` string, nullable - `text` string, nullable - `children` Utterance[] - `type` 'utterance' - `id` string - `metadata` Metadata: Optional annotations carried by a hyperdoc node. Includes the sources a node is grounded in, human edit attribution, and on a generated page the template block that wrote the node. Unset metadata is omitted from serialized responses. - `sources` SourceRef[], nullable - … - `edited_by` string, nullable - `template_block` string, nullable - `placeholder` string, nullable - `text` string, required - `speaker` Person - `type` 'person' - `id` string - `metadata` Metadata: Optional annotations carried by a hyperdoc node. Includes the sources a node is grounded in, human edit attribution, and on a generated page the template block that wrote the node. Unset metadata is omitted from serialized responses. - … - `text` string, nullable - `children` union[] - … - `name` string, nullable - `email` string, nullable - `username` string, nullable - `image_url` string, nullable - `provider` string, nullable: Source system that issued `external_id`, e.g. `slack` - `external_id` string, nullable: The person's user id in the source system - `alt_names` string[], nullable - `is_bot` boolean, nullable - `is_app_user` boolean, nullable - `job_title` string, nullable - `department` string, nullable - `company` string, nullable - `lifecycle_stage` string, nullable - `lead_status` string, nullable - `employment_role` string, nullable - `employment_seniority` string, nullable - `employment_sub_role` string, nullable - `industry` string, nullable - `timezone` string, nullable - `persona` string, nullable - `buying_roles` string[], nullable - `website` string, nullable - `linkedin_url` string, nullable - `original_source` string, nullable - `marketing_contact_status` string, nullable - `last_sales_activity_at` string, nullable - `last_sales_activity_type` string, nullable - `emails` string[], nullable: All known email addresses; `email` holds the primary one - `phone_numbers` string[], nullable - `address` string, nullable - `tags` string[], nullable - `date_of_birth` string, date, nullable - `deal_ids` string[], nullable - `company_ids` string[], nullable - `link_urls` string[], nullable - `start` number, nullable - `end` number, nullable - `title` string, nullable - `started_at` string, date-time, nullable - `ended_at` string, date-time, nullable - `participants` Person[] - `type` 'person' - `id` string - `metadata` Metadata: Optional annotations carried by a hyperdoc node. Includes the sources a node is grounded in, human edit attribution, and on a generated page the template block that wrote the node. Unset metadata is omitted from serialized responses. - `sources` SourceRef[], nullable - … - `edited_by` string, nullable - `template_block` string, nullable - `placeholder` string, nullable - `text` string, nullable - `children` union[] - union - … - `name` string, nullable - `email` string, nullable - `username` string, nullable - `image_url` string, nullable - `provider` string, nullable: Source system that issued `external_id`, e.g. `slack` - `external_id` string, nullable: The person's user id in the source system - `alt_names` string[], nullable - `is_bot` boolean, nullable - `is_app_user` boolean, nullable - `job_title` string, nullable - `department` string, nullable - `company` string, nullable - `lifecycle_stage` string, nullable - `lead_status` string, nullable - `employment_role` string, nullable - `employment_seniority` string, nullable - `employment_sub_role` string, nullable - `industry` string, nullable - `timezone` string, nullable - `persona` string, nullable - `buying_roles` string[], nullable - `website` string, nullable - `linkedin_url` string, nullable - `original_source` string, nullable - `marketing_contact_status` string, nullable - `last_sales_activity_at` string, nullable - `last_sales_activity_type` string, nullable - `emails` string[], nullable: All known email addresses; `email` holds the primary one - `phone_numbers` string[], nullable - `address` string, nullable - `tags` string[], nullable - `date_of_birth` string, date, nullable - `deal_ids` string[], nullable - `company_ids` string[], nullable - `link_urls` string[], nullable - Company: A CRM company or account record. - `type` 'company' - `id` string - `metadata` Metadata: Optional annotations carried by a hyperdoc node. Includes the sources a node is grounded in, human edit attribution, and on a generated page the template block that wrote the node. Unset metadata is omitted from serialized responses. - `sources` SourceRef[], nullable - `chunk_id` string, nullable - `resource_id` string, nullable - `source` string, nullable - `score` number, nullable - `edited_by` string, nullable - `template_block` string, nullable - `placeholder` string, nullable - `text` string, nullable - `children` union[] - union - Person - … - Blob: Represents embedded binary data using data URI scheme. Format: data:[][;base64], Example: data:text/html;base64,PGh0bWw+... - … - Callout - … - Chunk - … - Code - … - Comment - … - Description: A document's standfirst: one or two sentences under the title. A distinct type rather than "the first paragraph", because position is not meaning — a renderer that styles children[0] differently breaks the moment a writer puts a heading first, and a reader extracting the summary would have to guess. One per document by convention; nothing enforces it. - … - Divider - … - Equation - … - Footnote - … - Heading - … - Image - … - Link - … - LineBreak - … - List - … - ListItem - … - Page - … - Paragraph - … - Quote - … - Reference: A pointer to another document in the brain. Carries the display title and the ``(provider, resource_id)`` pair that names the document — the same coordinates a ``SourceRef`` uses, so a reader can resolve it through the same grant-filtered lookup as a citation. Unlike a citation it is content: it stands on its own as a block rather than annotating one. - … - Table - … - TableCell - … - TableRow - … - TaskList: A block of tasks, rendered as one row per task. Children are ``Task`` documents and nothing else — a task list is the one place a task appears as a row inside another document rather than as the document itself, so the row renderer can rely on every child carrying status, due date and priority. The type is a separate container rather than a ``List`` of ``ToDo`` items because a to-do is a checkbox with text, while a task is a document with a lifecycle. - … - Text - … - ToDo - … - ToolCall: A tool/function call made by the assistant. - … - ToolResult: The result of a tool call. - … - TraceMessage: A message in an agent trace (user message, assistant message, or thinking). - … - Utterance: A speaker-attributed segment of a transcript. Start and end times are offsets in seconds from the beginning of the transcript. - … - `name` string, nullable - `description` string, nullable - `status_summary` string, nullable - `industry` string, nullable - `employees` integer, nullable - `last_activity_at` string, date-time, nullable - `websites` string[], nullable - `domains` string[], nullable - `link_urls` string[], nullable - `emails` string[], nullable - `phone_numbers` string[], nullable - `address` string, nullable - `image_url` string, nullable - `is_active` boolean, nullable - `tags` string[], nullable - `timezone` string, nullable - `deal_ids` string[], nullable - `contact_ids` string[], nullable - Deal: A CRM deal or opportunity record. - `type` 'deal' - `id` string - `metadata` Metadata: Optional annotations carried by a hyperdoc node. Includes the sources a node is grounded in, human edit attribution, and on a generated page the template block that wrote the node. Unset metadata is omitted from serialized responses. - `sources` SourceRef[], nullable - `chunk_id` string, nullable - `resource_id` string, nullable - `source` string, nullable - `score` number, nullable - `edited_by` string, nullable - `template_block` string, nullable - `placeholder` string, nullable - `text` string, nullable - `children` union[] - union - Person - … - Blob: Represents embedded binary data using data URI scheme. Format: data:[][;base64], Example: data:text/html;base64,PGh0bWw+... - … - Callout - … - Chunk - … - Code - … - Comment - … - Description: A document's standfirst: one or two sentences under the title. A distinct type rather than "the first paragraph", because position is not meaning — a renderer that styles children[0] differently breaks the moment a writer puts a heading first, and a reader extracting the summary would have to guess. One per document by convention; nothing enforces it. - … - Divider - … - Equation - … - Footnote - … - Heading - … - Image - … - Link - … - LineBreak - … - List - … - ListItem - … - Page - … - Paragraph - … - Quote - … - Reference: A pointer to another document in the brain. Carries the display title and the ``(provider, resource_id)`` pair that names the document — the same coordinates a ``SourceRef`` uses, so a reader can resolve it through the same grant-filtered lookup as a citation. Unlike a citation it is content: it stands on its own as a block rather than annotating one. - … - Table - … - TableCell - … - TableRow - … - TaskList: A block of tasks, rendered as one row per task. Children are ``Task`` documents and nothing else — a task list is the one place a task appears as a row inside another document rather than as the document itself, so the row renderer can rely on every child carrying status, due date and priority. The type is a separate container rather than a ``List`` of ``ToDo`` items because a to-do is a checkbox with text, while a task is a document with a lifecycle. - … - Text - … - ToDo - … - ToolCall: A tool/function call made by the assistant. - … - ToolResult: The result of a tool call. - … - TraceMessage: A message in an agent trace (user message, assistant message, or thinking). - … - Utterance: A speaker-attributed segment of a transcript. Start and end times are offsets in seconds from the beginning of the transcript. - … - `name` string, nullable - `amount` number, nullable - `currency` string, nullable - `stage` string, nullable - `pipeline` string, nullable - `probability` number, nullable - `closed_at` string, date-time, nullable - `expected_close_at` string, date-time, nullable - `won_reason` string, nullable - `lost_reason` string, nullable - `close_reason` string, nullable - `status_summary` string, nullable - `next_step` string, nullable - `last_activity_at` string, date-time, nullable - `deal_source` string, nullable - `tags` string[], nullable - `company_ids` string[], nullable - `contact_ids` string[], nullable - Invoice: A customer invoice, vendor bill, or credit memo. Line items are included in ``children``. - `type` 'invoice' - `id` string - `metadata` Metadata: Optional annotations carried by a hyperdoc node. Includes the sources a node is grounded in, human edit attribution, and on a generated page the template block that wrote the node. Unset metadata is omitted from serialized responses. - `sources` SourceRef[], nullable - `chunk_id` string, nullable - `resource_id` string, nullable - `source` string, nullable - `score` number, nullable - `edited_by` string, nullable - `template_block` string, nullable - `placeholder` string, nullable - `text` string, nullable - `children` union[] - union - Person - … - Blob: Represents embedded binary data using data URI scheme. Format: data:[][;base64], Example: data:text/html;base64,PGh0bWw+... - … - Callout - … - Chunk - … - Code - … - Comment - … - Description: A document's standfirst: one or two sentences under the title. A distinct type rather than "the first paragraph", because position is not meaning — a renderer that styles children[0] differently breaks the moment a writer puts a heading first, and a reader extracting the summary would have to guess. One per document by convention; nothing enforces it. - … - Divider - … - Equation - … - Footnote - … - Heading - … - Image - … - Link - … - LineBreak - … - List - … - ListItem - … - Page - … - Paragraph - … - Quote - … - Reference: A pointer to another document in the brain. Carries the display title and the ``(provider, resource_id)`` pair that names the document — the same coordinates a ``SourceRef`` uses, so a reader can resolve it through the same grant-filtered lookup as a citation. Unlike a citation it is content: it stands on its own as a block rather than annotating one. - … - Table - … - TableCell - … - TableRow - … - TaskList: A block of tasks, rendered as one row per task. Children are ``Task`` documents and nothing else — a task list is the one place a task appears as a row inside another document rather than as the document itself, so the row renderer can rely on every child carrying status, due date and priority. The type is a separate container rather than a ``List`` of ``ToDo`` items because a to-do is a checkbox with text, while a task is a document with a lifecycle. - … - Text - … - ToDo - … - ToolCall: A tool/function call made by the assistant. - … - ToolResult: The result of a tool call. - … - TraceMessage: A message in an agent trace (user message, assistant message, or thinking). - … - Utterance: A speaker-attributed segment of a transcript. Start and end times are offsets in seconds from the beginning of the transcript. - … - `title` string, nullable - `invoice_type` string, nullable - `number` string, nullable - `reference` string, nullable - `status` string, nullable - `currency` string, nullable - `contact_name` string, nullable - `total_amount` number, nullable - `paid_amount` number, nullable - `balance_amount` number, nullable - `tax_amount` number, nullable - `refund_amount` number, nullable - `posted_at` string, date-time, nullable - `due_at` string, date-time, nullable - `paid_at` string, date-time, nullable - `cancelled_at` string, date-time, nullable - `refunded_at` string, date-time, nullable - `notes` string, nullable - `refund_reason` string, nullable - `attachment_names` string[], nullable - `contact_id` string, nullable - `organization_id` string, nullable - `chunks` MemoryChunk[], nullable: Extracted memories (chunks with summaries) for this document, in document order. Present only when explicitly requested via `include_chunks`; omitted otherwise. - `chunk_id` string, required: Stable identifier of the chunk. - `summary` string, nullable: Generated summary of the chunk, when available within response limits. - `next_cursor` string, nullable, required - `notices` ResponseContentLimitedNotice[], nullable - `code` 'ResponseContentLimited' - `message` string, required - `returned_count` integer, required - `reduced_count` integer, required - `skipped_count` integer, required - `skipped_identities` SkippedDocumentIdentity[] - `source` string, required - `resource_id` string, required - `skipped_identity_omitted_count` integer ## Other responses - `422`: Validation Error ## Changes > 43 revisions in range; 2 not diffed. - **2026-10-22** `cdf64d80b832`: 1 info - endpoint added [Operation history](https://skmtc.dev/hyperspell/apis/hyperspell-api/changes/integrations/web_crawler/websites/pages/get.md) --- [API](https://skmtc.dev/hyperspell/apis/hyperspell-api.md) - [All operations](https://skmtc.dev/hyperspell/apis/hyperspell-api/llms.txt) - [OpenAPI document](https://skmtc.dev/hyperspell/apis/hyperspell-api/revisions/9bafd1215a0f?raw)