Document
Classes
DocumentTasks
pydantic-model
Bases: pydantic.BaseModel
Tiny structure for storing the statistics of checklist points in document
Fields:
-
completed(int) -
total(int)
Document
pydantic-model
Bases: pydantic.BaseModel
Represents a document in the system, containing rich text content and metadata.
Documents are the primary content type, supporting Markdown formatting, collaboration features, and version history.
Fields:
-
id(uuid.UUID) -
collection_id(typing.Optional[uuid.UUID]) -
parent_document_id(typing.Optional[uuid.UUID]) -
title(str) -
full_width(bool) -
emoji(typing.Optional[str]) -
text(str) -
url(str) -
url_id(str) -
collaborators(typing.List[outline_wiki_api.models.user.User]) -
pinned(bool) -
template(bool) -
template_id(typing.Optional[uuid.UUID]) -
revision(int) -
created_at(datetime.datetime) -
created_by(outline_wiki_api.models.user.User) -
updated_at(datetime.datetime) -
updated_by(outline_wiki_api.models.user.User) -
published_at(typing.Optional[datetime.datetime]) -
archived_at(typing.Optional[datetime.datetime]) -
deleted_at(typing.Optional[datetime.datetime]) -
icon(typing.Optional[str]) -
color(typing.Optional[str]) -
tasks(typing.Optional[outline_wiki_api.models.document.DocumentTasks]) -
last_viewed_at(typing.Optional[datetime.datetime]) -
is_collection_deleted(typing.Optional[bool]) -
insights_enabled(typing.Optional[bool])
Attributes
archived_at = None
pydantic-field
The date and time that this object was archived
collaborators = []
pydantic-field
List of users who have collaborated on this document
color = None
pydantic-field
Document's icon color in hex format
created_at
pydantic-field
The date and time that this object was created
created_by
pydantic-field
User who created this document
deleted_at = None
pydantic-field
The date and time that this object was deleted
emoji = None
pydantic-field
An emoji associated with the document
full_width = False
pydantic-field
Whether this document should be displayed in a full-width view
last_viewed_at = None
pydantic-field
The date and time that this object was viewed for the last time
parent_document_id = None
pydantic-field
Identifier for the document this is a child of, if any
pinned = False
pydantic-field
Whether this document is pinned in the collection
published_at = None
pydantic-field
The date and time that this object was published
revision
pydantic-field
A number that is auto incrementing with every revision of the document that is saved
template = False
pydantic-field
Whether this document is a template
template_id = None
pydantic-field
Unique identifier for the template this document was created from, if any
text
pydantic-field
The text content of the document, contains markdown formatting
title
pydantic-field
The title of the document
updated_at
pydantic-field
The date and time that this object was last changed
updated_by
pydantic-field
User who last updated this document
url_id
pydantic-field
A short unique ID that can be used to identify the document as an alternative to the UUID
DocumentSearchResult
pydantic-model
DocumentAnswer
pydantic-model
Bases: pydantic.BaseModel
Represents a result of the LLM request containing answer and metadata
Fields:
-
id(uuid.UUID) -
query(str) -
answer(str) -
source(typing.Literal['api', 'app']) -
created_at(datetime.datetime)
Attributes
answer
pydantic-field
An answer to the query, if possible
created_at
pydantic-field
The date and time that this object was created
id
pydantic-field
Unique identifier for the search result
query
pydantic-field
The user-provided request (usually question)
source
pydantic-field
The source of the query
DocumentListResponse
pydantic-model
Bases: outline_wiki_api.models.response.Response
A Collection of the Document objects response
Fields:
-
status(int) -
ok(bool) -
pagination(typing.Optional[outline_wiki_api.models.response.Pagination]) -
policies(typing.Optional[typing.List[outline_wiki_api.models.response.Policy]]) -
data(typing.Optional[typing.List[outline_wiki_api.models.document.Document]])
DocumentSearchResultResponse
pydantic-model
Bases: outline_wiki_api.models.response.Response
Full-text search response data model
Fields:
-
status(int) -
ok(bool) -
pagination(typing.Optional[outline_wiki_api.models.response.Pagination]) -
policies(typing.Optional[typing.List[outline_wiki_api.models.response.Policy]]) -
data(typing.Optional[typing.List[outline_wiki_api.models.document.DocumentSearchResult]])
DocumentAnswerResponse
pydantic-model
Bases: outline_wiki_api.models.response.Response
Response from natural language query of documents
Fields:
-
status(int) -
ok(bool) -
data(typing.Optional[typing.Any]) -
pagination(typing.Optional[outline_wiki_api.models.response.Pagination]) -
policies(typing.Optional[typing.List[outline_wiki_api.models.response.Policy]]) -
documents(typing.List[outline_wiki_api.models.document.Document]) -
search(outline_wiki_api.models.document.DocumentAnswer)