Objects
In the PagePeek API, data is represented through structured objects. These objects encapsulate various pieces of information related to documents, analyses, summaries, and user accounts. Below is an overview of the main objects you will interact with while using the PagePeek API.
Document Object
The Document object represents a document uploaded to the PagePeek platform.
documentId
string
The unique identifier of the document.
title
string
The title of the document.
size
number
The size of the document in bytes.
status
string
The processing status of the document.
createdAt
string
The timestamp when the document was uploaded.
updatedAt
string
The timestamp when the document was updated.
Summary Object
The Summary object contains a summarized version of a document.
summaryId
string
The unique identifier of the summary.
documentId
string
The ID of the related document.
content
string
The textual summary of the document.
keywords
array
An array of keywords extracted from the document.
createdAt
string
The timestamp when the summary was created.
updatedAt
string
The timestamp when the summary was updated.
User Object
The User object represents a user account on the PagePeek platform.
userId
string
The unique identifier of the user.
email
string
The email address associated with the user.
name
string
The name of the user.
createdAt
string
The timestamp when the user account was created.
updatedAt
string
The timestamp when the user account was updated.
Error Object
The Error object represents an error response from the API.
code
number
The HTTP status code.
message
string
A human-readable error message.
description
string
A more detailed description of the error.
These objects form the core structure of data within the PagePeek API, and understanding them is crucial for effective interaction with the API endpoints. Each endpoint in the API documentation specifies the object or objects associated with it, along with the structure of those objects.
Last updated