Outline
Team knowledge base for documents, collections, comments, members, groups, and workspace content.
Supports team knowledge-base work across documents, collections, comments, members, groups, and workspace content.
Use Outline with Snow
Snow is a personal AI assistant that builds real apps for you, and they can put Outline to work.
What Snow can do with Outline
These are the Outline operations Snow and the apps you build with it can run. Sign in to choose which ones Snow may run without asking.
Reads46
Look at your data without changing it.
- Export Collection
Tool to export a collection in markdown, JSON, or HTML format. Triggers a bulk export that includes all documents and attachments. If documents are nested, they will be organized in folders within the zip file. Returns a fileOperation object to track progress.
- Export Document
Tool to export a document from Outline in Markdown, HTML, or PDF format. The response format is determined by the Accept header (text/markdown, text/html, or application/pdf). Use when you need to download or extract document content for external processing, archiving, or sharing.
- Get Collection Documents
Tool to retrieve a collection's document structure as a tree of navigation nodes. Use when you need to explore the document hierarchy within a collection.
- Get Collection Info
Tool to retrieve a collection by its unique identifier. Use when you need to fetch detailed information about a specific collection including its name, description, settings, and permissions.
- Get Document Info
Tool to retrieve a document from Outline by its UUID, urlId, or shareId. Returns complete document information including title, content, metadata, timestamps, and access policies. Use when you need to fetch document details or content.
- Get User Info
Tool to retrieve a user by their unique identifier. Returns user details including name, email, avatar, role, and status. Use when you need to fetch information about a specific user.
- List Collections
Tool to list all collections that the authenticated user has access to. Use when you need to retrieve all collections, optionally filtered by name or status, with pagination and sorting support.
- List Documents
Tool to list all documents in your Outline workspace. Returns published documents and draft documents belonging to the current user. Use filters to narrow results by collection, creator, status, or document relationships. Supports pagination for large document sets.
- List Groups
Tool to list all groups in the workspace. Groups organize users and manage permissions for collections. Use when you need to retrieve all groups, optionally filtered by name, with pagination and sorting support.
- List Templates
Tool to list all templates available to the current user. Use when you need to retrieve all templates, optionally filtered by collection or name, with pagination and sorting support. Templates not associated with a collection are workspace-wide.
Creates16
Add something new to your account.
- Create Collection
Tool to create a new collection in Outline. Use when you need to organize documents by creating a new collection with a specific name, description, icon, color, and permission settings.
- Create Document
Tool to create a new document in Outline. Use when you need to create a new document with specified title, content, and metadata. Documents can be created as drafts or immediately published to a collection. At least one of collectionId or parentDocumentId is required if publish is true.
- Create Group
Tool to create a new group in Outline. Use when you need to organize users into logical groups for easier permission management across collections.
- Create Template
Tool to create a new template in Outline. Use when you need to create a reusable template that can be used as a starting point for new documents. Templates can optionally be scoped to a specific collection.
- Add Document User
Tool to add a user membership to a document. Use when you need to grant a user access to a specific document.
- Add Group to Document
Tool to give all members in a group access to a document. Use when you need to grant document-level access permissions to an entire group at once, rather than adding individual users one by one.
- Add User to Group
Tool to add a user to a group. Use when you need to grant a user membership in a specific group.
- Create Attachment
Tool to create an attachment in Outline. This creates a database record and returns the inputs needed to generate a signed URL and upload the file from the client to cloud storage. Use when you need to prepare an attachment for upload to associate with a document.
- Create Comment
Tool to create a comment on an Outline document. Use when you need to add a comment or reply to a document. Either text or data field is required for the comment body.
- Create OAuth Client
Tool to create a new OAuth client in Outline. Use when you need to create an OAuth client application that can be used to authenticate users and access the API on their behalf.
Updates21
Change something that is already there.
- Move Document
Tool to move a document to a new location or collection in Outline. Use when you need to reorganize documents by moving them to a different collection or nesting them under a different parent document.
- Update Collection
Tool to update an existing collection's properties in Outline. Use when you need to modify collection settings such as name, description, icon, color, sharing settings, or permission level.
- Update Document
Tool to update a document in Outline. Use when you need to modify an existing document's title, content, or metadata. At least the document ID is required.
- Update Group
Tool to update an existing group's name in Outline. Use when you need to rename a group.
- Update User
Tool to update a user's name, avatar, or language preference in Outline. If no ID is provided, updates the authenticated user. Use when you need to modify user profile information.
- Update User Role
Tool to change a user's role in Outline workspace. Use when you need to promote a user to admin, demote an admin to member, or change a user to viewer role. Only available to admin users.
- Activate User
Tool to activate a previously suspended user in Outline. Activating a user allows them to sign in again and will cause billing totals to be re-calculated in the hosted version. Use when you need to restore access for a suspended user.
- Add Group to Collection
Tool to add a group to a collection in Outline. Use when you need to grant all members of a group access to a specific collection with read or write permissions.
- Add User to Collection
Tool to add a user to a collection with specified permissions. Use when you need to grant a user access to a specific collection.
- Archive Document
Tool to archive a document in Outline. Use when you need to move outdated information out of sight while retaining the ability to search and restore it later.
Deletes18
Remove something. This often cannot be undone.
- Delete Collection
Tool to delete a collection and all of its documents from Outline. Use when you need to permanently remove a collection. This action cannot be undone, so use with caution.
- Delete Attachment
Tool to delete an attachment from Outline. Deleting an attachment is permanent. It will not delete references or links to the attachment that may exist in your documents.
- Delete Comment
Tool to delete a comment in Outline. Use when you need to remove a comment from a document. If the comment is a top-level comment, all its children will be deleted as well.
- Delete Document
Tool to delete a document in Outline. Deleting a document moves it to the trash by default. If not restored within 30 days it is permanently deleted. Use permanent=true to destroy the document immediately with no way to recover.
- Delete File Operation
Tool to delete a file operation and its associated files from Outline. Use when you need to clean up completed or failed import/export operations.
- Delete Group
Tool to delete a group from Outline. Deleting a group will cause all of its members to lose access to any collections the group has previously been added to. This action cannot be undone, so use with caution.
- Delete OAuth Authentication
Tool to delete an OAuth authentication in Outline. Use when you need to revoke a third-party application's access to a user's account. This action removes the OAuth authentication connection between Outline and the third-party application.
- Delete OAuth Client
Tool to delete an OAuth client from Outline. Permanently delete an OAuth client and revoke all associated access tokens. This action cannot be undone, so use with caution.
- Delete Star
Tool to delete a star from a document in Outline. Use when you need to remove a star from a user's starred documents list.
- Delete Template
Tool to delete a template in Outline. This will soft-delete the template, it can be restored later. Use when you need to remove a template from the workspace.
Related integrations
Ready to put Outline to work?
Sign up free, build an app by chatting, and connect Outline in minutes. No credit card required.