Outline
Outline is an open-source team knowledge base and wiki with a fully featured RPC-style REST API for programmatically managing documents, collections, teams, users, groups, comments, shares, attachments, and importing or exporting organizational knowledge. The main application itself is built on the same API it exposes publicly.
Real signal across most facets with visible, nameable gaps — the contract exists but is thin, or the portal is good while governance and commercial terms are absent.
API Evangelist profiles Outline the way a machine reads it — 178 machine-readable artifacts across 18 APIs, pulled from the provider's own public surface and indexed so a developer, an analyst, or an AI agent can evaluate it against every other provider on the network.
Every provider in the network is reduced to the same set of machine-readable artifacts — OpenAPI contracts, event specifications, GraphQL schemas, runnable collections, pricing and rate-limit signals, security posture, OAuth scopes, and the agent surfaces (MCP servers and skills) that let software drive the API on its own. We profile them because the interface is the part of a company you can actually inspect: it is a truer signal of what a provider does than any marketing page. From those artifacts we compute the Kin Score — Outline scores 53.9/100 (developing), with a separate agent-readiness read of 54/100 (agent ready). The full breakdown is below, followed by every artifact we hold — each card links through to its machine-readable definition on apis.io.
Kin Score
This is the API Evangelist rating — a single, repeatable read computed from the artifacts on this page. Green fill is points earned; the red track is points possible, so every bar shows earned-versus-possible at a glance.
How we profile Outline
Each block below is one kind of artifact we hold for Outline. For each we say what it is and why it earns a place in the profile, then list every one we've indexed — capped at two rows, scroll within the panel for the rest.
APIs 18
Each API is captured as its own OpenAPI definition — every operation, parameter, and response. This is the single most useful machine-readable description of what an API does, and it's what lets us score, lint, mock, and generate against it without asking the provider for anything.
Individual APIs this provider publishes, each with its own machine-readable definition.
Outline AccessRequests API
`AccessRequests` represent a request by a user for access to a document they do not currently have permission to view. The request can be approved or dismissed by a user with pe...
Outline Attachments API
`Attachments` represent a file uploaded to cloud storage. They are created before the upload happens from the client and store all the meta information such as file type, size, ...
Outline Auth API
`Auth` represents the current API Keys authentication details. It can be used to check that a token is still valid and load the IDs for the current user and workspace.
Outline Collections API
`Collections` represent grouping of documents in the knowledge base, they offer a way to structure information in a nested hierarchy and a level at which read and write permissi...
Outline Comments API
`Comments` represent a comment either on a selection of text in a document or on the document itself.
Outline DataAttributes API
`DataAttributes` represent custom metadata fields that can be attached to documents. They allow workspaces to add structured data like status, priority, or any other custom prop...
Outline Documents API
`Documents` are what everything else revolves around. A document represents a single page of information and always returns the latest version of the content. Documents are stor...
Outline Events API
`Events` represent an artifact of an action. Whether it is creating a user, editing a document, changing permissions, or any other action – an event is created that can be used ...
Outline FileOperations API
`FileOperations` represent background jobs for importing or exporting files. You can query the file operation to find the state of progress and any resulting output.
Outline Groups API
`Groups` represent a list of users that logically belong together, for example there might be groups for each department in your organization. Groups can be granted access to co...
Outline OAuthAuthentications API
`OAuthAuthentications` represent individual scoped authentications between Outline and an `OAuthClient`.
Outline OAuthClients API
`OAuthClients` represent OAuth clients that can be used to authenticate users with third-party services.
Outline Revisions API
`Revisions` represent a snapshot of a document at a point in time. They are used to keep track of editing and collaboration history – a document can also be restored to a previo...
Outline Shares API
`Shares` represent authorization to view a document without being a member of the workspace. Shares are created in order to give access to documents publicly. Each user that sha...
Outline Stars API
`Stars` represent a favorited document or collection in the application sidebar. Each user has their own collection of starred items.
Outline Templates API
`Templates` represent reusable document templates that can be used as a starting point when creating new documents. Templates can be scoped to a specific collection or available...
Outline Users API
`Users` represent an individual with access to the knowledge base. Users can be created automatically when signing in with SSO or when a user is invited via email.
Outline Views API
`Views` represent a compressed record of an individual users views of a document. Individual views are not recorded but a first, last and total is kept per user.
Scroll within the panel for all 18 ·
Pricing Plans 1
Pricing is part of the interface. Machine-readable plans tell you what a tier costs and includes before you commit — one of the six things the Kin Score reads for commercial clarity.
Published pricing tiers and plan structures.
Rate Limits 1
Rate limits are the difference between a demo that works and a production integration that doesn't fall over. Publishing them is an operational-transparency signal — and a hard requirement for any agent that plans its own throughput.
Documented rate limits and quota policies.
Outline Rate Limits
RATE LIMITSFinOps 1
Cost, billing, and metering signals let a buyer model the financial operations of an API before it's live. We profile them for the same reason we profile pricing: the money is part of the contract.
Cost, billing, and metering signals for API financial operations.
Outline Finops
FINOPSSemantic Vocabularies 2
JSON-LD contexts give the data shared meaning across APIs. We profile them because semantics are what let a machine reconcile 'customer' here with 'customer' somewhere else.
JSON-LD contexts and semantic vocabularies used across these APIs.
Outline Api Context
JSON-LDOutline Context
JSON-LDSpectral Rules 1
Governance rulesets we run against this provider's specs — the automated checks behind parts of the score. Profiling them makes the quality bar explicit and re-runnable, not a matter of opinion.
Outline API Rules
SPECTRALJSON Schema 38
Standalone JSON Schema definitions describe the data models behind the API. We profile them so the shapes are validatable on their own — useful long after a single request is forgotten.
Standalone JSON Schema definitions for this provider's data models.
Ability
JSON SCHEMAAccessRequest
JSON SCHEMAAttachment
JSON SCHEMAAuth
JSON SCHEMACollection
JSON SCHEMACollectionGroupMembership
JSON SCHEMACollectionStatus
JSON SCHEMAComment
JSON SCHEMADataAttribute
JSON SCHEMADataAttributeDataType
JSON SCHEMADataAttributeOptions
JSON SCHEMADocument
JSON SCHEMADocumentDataAttribute
JSON SCHEMADocumentInsight
JSON SCHEMAError
JSON SCHEMAEvent
JSON SCHEMAFileOperation
JSON SCHEMAGroup
JSON SCHEMAGroupMembership
JSON SCHEMAInvite
JSON SCHEMAMembership
JSON SCHEMANavigationNode
JSON SCHEMAOAuthAuthentication
JSON SCHEMAOAuthClient
JSON SCHEMAPagination
JSON SCHEMAPermission
JSON SCHEMAPolicy
JSON SCHEMARevision
JSON SCHEMASearchResult
JSON SCHEMAShare
JSON SCHEMASorting
JSON SCHEMAStar
JSON SCHEMATeam
JSON SCHEMATemplate
JSON SCHEMATextEditMode
JSON SCHEMAUser
JSON SCHEMAUserRole
JSON SCHEMAView
JSON SCHEMAScroll within the panel for all 38 ·
Examples 112
Real request and response payloads are what turn a spec from abstract into obvious — and they're one of the twelve things an agent needs to call an API correctly on the first try.
Example request and response payloads for these APIs.
Accessrequestsapprove
EXAMPLEAccessrequestscreate
EXAMPLEAccessrequestsdismiss
EXAMPLEAccessrequestsinfo
EXAMPLEAttachmentscreate
EXAMPLEAttachmentsdelete
EXAMPLEAttachmentsredirect
EXAMPLEAuthconfig
EXAMPLEAuthinfo
EXAMPLECollectionsaddgroup
EXAMPLECollectionsadduser
EXAMPLECollectionscreate
EXAMPLECollectionsdelete
EXAMPLECollectionsdocuments
EXAMPLECollectionsexport
EXAMPLECollectionsexportall
EXAMPLECollectionsgroupmemberships
EXAMPLECollectionsinfo
EXAMPLECollectionslist
EXAMPLECollectionsmemberships
EXAMPLECollectionsremovegroup
EXAMPLECollectionsremoveuser
EXAMPLECollectionsupdate
EXAMPLECommentscreate
EXAMPLECommentsdelete
EXAMPLECommentsinfo
EXAMPLECommentslist
EXAMPLECommentsupdate
EXAMPLEDataattributescreate
EXAMPLEDataattributesdelete
EXAMPLEDataattributesinfo
EXAMPLEDataattributeslist
EXAMPLEDataattributesupdate
EXAMPLEDocumentsaddgroup
EXAMPLEDocumentsadduser
EXAMPLEDocumentsanswerquestion
EXAMPLEDocumentsarchive
EXAMPLEDocumentsarchived
EXAMPLEDocumentscreate
EXAMPLEDocumentsdelete
EXAMPLEDocumentsdeleted
EXAMPLEDocumentsdocuments
EXAMPLEDocumentsdrafts
EXAMPLEDocumentsduplicate
EXAMPLEDocumentsemptytrash
EXAMPLEDocumentsexport
EXAMPLEDocumentsgroupmemberships
EXAMPLEDocumentsimport
EXAMPLEDocumentsinfo
EXAMPLEDocumentsinsights
EXAMPLEDocumentslist
EXAMPLEDocumentsmemberships
EXAMPLEDocumentsmove
EXAMPLEDocumentsremovegroup
EXAMPLEDocumentsremoveuser
EXAMPLEDocumentsrestore
EXAMPLEDocumentssearch
EXAMPLEDocumentssearchtitles
EXAMPLEDocumentstemplatize
EXAMPLEDocumentsunpublish
EXAMPLEDocumentsupdate
EXAMPLEDocumentsusers
EXAMPLEDocumentsviewed
EXAMPLEEventslist
EXAMPLEFileoperationsdelete
EXAMPLEFileoperationsinfo
EXAMPLEFileoperationslist
EXAMPLEFileoperationsredirect
EXAMPLEGroupsadduser
EXAMPLEGroupscreate
EXAMPLEGroupsdelete
EXAMPLEGroupsinfo
EXAMPLEGroupslist
EXAMPLEGroupsmemberships
EXAMPLEGroupsremoveuser
EXAMPLEGroupsupdate
EXAMPLEOauthauthenticationsdelete
EXAMPLEOauthauthenticationslist
EXAMPLEOauthclientscreate
EXAMPLEOauthclientsdelete
EXAMPLEOauthclientsinfo
EXAMPLEOauthclientslist
EXAMPLEOauthclientsrotatesecret
EXAMPLEOauthclientsupdate
EXAMPLERevisionsinfo
EXAMPLERevisionslist
EXAMPLESharescreate
EXAMPLESharesinfo
EXAMPLEShareslist
EXAMPLESharesrevoke
EXAMPLESharesupdate
EXAMPLEStarscreate
EXAMPLEStarsdelete
EXAMPLEStarslist
EXAMPLEStarsupdate
EXAMPLETemplatescreate
EXAMPLETemplatesdelete
EXAMPLETemplatesduplicate
EXAMPLETemplatesinfo
EXAMPLETemplateslist
EXAMPLETemplatesrestore
EXAMPLETemplatesupdate
EXAMPLEUsersactivate
EXAMPLEUsersdelete
EXAMPLEUsersinfo
EXAMPLEUsersinvite
EXAMPLEUserslist
EXAMPLEUserssuspend
EXAMPLEUsersupdate
EXAMPLEUsersupdaterole
EXAMPLEViewscreate
EXAMPLEViewslist
EXAMPLEScroll within the panel for all 112 ·
Security Posture 2
Authentication, domain security, vulnerability disclosure, and trust-center signals — the evidence that a provider takes security seriously enough to document it. We profile it because you can't govern what you can't see.
Authentication, domain security, vulnerability disclosure, and trust-center signals.
Scopes 1
OAuth scopes are the vocabulary of least-privilege access. Profiling them shows exactly what an integration — or an agent acting on a user's behalf — is allowed to do.
OAuth scopes governing access to this provider's APIs.
Agentic Access 1
An x-agentic-access contract marks which operations are safe for an agent to run on its own and which need a human in the loop. It is the difference between an API an agent can use and one it can use safely.
Recommended x-agentic-access execution contracts for AI agents.
Resources
Every other property we hold for Outline — documentation, portals, status pages, policies, and corporate surface — grouped by the job it does, following the integrator's arc from getting started to running in production.
Documentation 2
Reference material describing how the API behaves
Agent Surfaces 1
MCP servers, agent skills, and machine-readable catalogs
Design & Contract 1
Pagination, idempotency, versioning, errors, and events
Build 2
SDKs, sample code, and the tooling you integrate with
Access & Security 3
Authentication, authorization, and security posture
Operate 3
Status, limits, changes, and where to get help
Commercial 3
Pricing, plans, and the legal terms of use
Company 1
The organization behind the API
← All providers · Data indexed from github.com/api-evangelist/outline · machine-readable index on apis.io