Search documentation…
/
Support
API Reference
Read the extracted text of a FILE document.
Documentation
API Reference
MCP Reference
API Reference
Documentation
API Reference
MCP Reference
Introduction
Authentication
AI Chat
Role
AI Chat Plugin
Documents Plugin
POST
Inbound-email capture webhook (signed, per-organization token).
POST
Upload 1–10 FILE documents (multipart field `files`).
POST
Replace the stored file of a FILE document in place (multipart field `file`).
GET
Get a short-lived download URL for a FILE document.
GET
Stream the stored bytes of a FILE document.
POST
Reprocess a FILE document from the extract stage.
POST
Search the organization knowledge (hybrid lexical + vector, RRF).
POST
Bulk re-index the knowledge (model-drift or all).
GET
Knowledge capability status.
POST
Import a document into AI knowledge.
POST
Exclude a document from AI knowledge.
POST
Re-index one document into AI knowledge.
POST
Request a human review of a document.
POST
Approve a pending document review.
POST
Reject a pending document review.
POST
Regenerate the AI summary of a document.
GET
Read the extracted text of a FILE document.
PUT
Save a human-corrected extraction for a FILE document.
GET
Get org-global document stats for the hub tiles.
GET
Retrieve a paginated, filtered list of documents.
POST
Create a FOLDER or PAGE document.
GET
Get document count for a filter set.
GET
Get facet counts for the filter chips.
POST
Apply a bulk action to a set of documents.
GET
Get document by ID.
PUT
Update document metadata by ID.
DEL
Soft-delete an archived document.
PUT
Save PAGE content (optimistic concurrency + version snapshot).
GET
Get the breadcrumb path of a document (unreadable ancestors masked).
POST
Reorder sibling documents.
POST
Move a document in the tree (cycle-guarded).
POST
Duplicate a document (optionally deep).
POST
Archive a document subtree.
POST
Unarchive a document subtree.
POST
Recover a soft-deleted document.
GET
List PAGE version snapshots (newest first).
GET
Get one full version snapshot.
POST
Restore a version snapshot (non-destructive).
GET
List the document category catalog.
POST
Create a document category.
PUT
Update a document category.
DEL
Delete a document category.
POST
Merge one category into another.
GET
List the shares of one document.
POST
Share a PRIVATE document with an employee or a team.
PUT
Update the access level of a document share.
DEL
Revoke a document share.
GET
List links attached to one business record.
POST
Attach a document to a business record.
DEL
Detach a document link.
GET
List everything one document is linked to.
GET
Get the Documents org defaults and deployment capabilities.
PUT
Update the Documents org defaults.
GET
List the organization's inbound capture addresses.
POST
Register an inbound capture address on a tenant-owned domain.
GET
Show the DNS record required to verify a custom inbound domain.
POST
Check the DNS TXT record and verify the domain.
POST
Rotate the relay secret for an inbound address.
POST
Rotate a platform capture address to a new token.
PUT
Update an inbound capture address.
Feature
TenantSetting
Changelog
ActivePieces Integration
ActivePieces MCP Server Integration
IntegrationsEntitySetting
IntegrationTenant
IntegrationSetting
IntegrationEntitySettingTied
Tasks
User
Employee
CustomSmtp
EmailTemplate
Organization
UserOrganization
Tenant
Auth
EmailVerification
Auth0
Facebook
Github
Google
Linkedin
Twitter
Microsoft
OAuthAppController_
1
OrganizationTeam
OAuthClient
Terms
Email
Contact
OrganizationTeamEmployee
Timer Tracker
TimeLog
OrganizationProject
EmployeeRecentVisit
OrganizationContact
TimeSlot
Activity
TimesheetStatistic
OrganizationSprint
Task views
EmployeeNotification
EmployeeNotificationSetting
Tags
Integrations
GitHubAuthorizationController_
1
GitHub Integrations
GitHubIntegration
GitHubSync
GitHubRepository
Hubstaff Integrations
Screenshot
Make.com Integrations
Make.com OAuth
Make.com API
Hook
Upwork Integrations
ExpenseCategories
Expense
EmployeeStatistics
OrganizationRecurringExpense
EmployeeRecurringExpense
Income
OrganizationVendor
Proposal
Plane Integration
TenantAPIKeys
Ever Async Integration
Ever Async Connector
SIM Integration
Zapier OAuth2 Authorization
Zapier Integrations
ZapierWebhookController_
1
EmployeeProposalTemplate
EmployeeJobPost
JobSearchOccupation
JobSearchCategory
EmployeeJobPreset
JobSearchPreset
KnowledgeBase
KnowledgeBaseArticle
KnowledgeBaseArticleVersion
KnowledgeBaseAuthor
Video Plugin
Camshot Plugin
Soundshot Plugin
Plugins - User Assignment
Plugin Settings
Plugin Subscriptions
Plugin Subscription Access
Plugin Subscription Plans
Plugin Billing
Plugins - Tag Management
Plugins - Recommendations
Plugin Installation
Plugin Installation Management
Plugin Sources
Plugin Versions
Plugin Registry
Plugin Management
Plugin Security
Tags - Plugin Management
Plugin Tags
Plugin Categories
Users - Plugin Assignment
Plugins - User Assignment Management
Plugin Analytics
Plugin Subscription Analytics
Plugin Tenant Management
User Subscribed Plugins
App
Health
EmailCheck
EmployeeAward
Candidate
CandidateDocument
CandidateSource
CandidateEducation
CandidateExperience
CandidateSkill
CandidateFeedback
CandidateInterview
CandidateInterviewer
CandidatePersonalQuality
CandidateTechnology
CandidateCriterionRating
Download
Import
Import History
EmployeeSetting
EmployeeAppointment
AppointmentEmployee
OrganizationDepartment
OrganizationPositions
Project Modules
OrganizationAward
OrganizationLanguage
OrganizationTeamJoinRequest
Invite
OrganizationDocument
Country
Currency
OfficialHoliday
TimeOffBalance
TimeOffPolicy
TimeOffRequest
RequestApproval
EquipmentSharing
ApprovalPolicy
EquipmentSharingPolicy
Billing
TagTypes
Skills
Languages
Invoice
EstimateEmail
InvoiceItem
Payment
PayrollRun
Goals
GoalTimeFrame
GoalGeneralSetting
KeyResults
KeyResultsUpdate
EmployeeLevel
EventType
AvailabilitySlots
Pipeline
Deal
InvoiceEstimateHistory
Equipment
Task Priority
Task RelatedIssueTypes
Task Size
Task Status
Task Version
Daily Plan
Screening Tasks
OrganizationEmploymentType
Custom Tracking
TimeSheet
TimesheetProjectChangeRequest
Report Category
Report
ProductCategories
ProductTypes
Product
ProductVariantSetting
ProductVariantPrice
ProductOption
ProductVariant
ImageAsset
GoalKpi
GoalTemplates
keyResultTemplate
GoalKpiTemplate
Accounting Template
Warehouses
Merchants
GauzyCloud
PublicEmployee
PublicInvoice
PublicOrganization
PublicTeam
EmailReset
Issue Type
Task Metadata
Linked Issue
OrganizationTaskSetting
Task Estimation
Favorites
Stats
Reactions
Comments
Mention
EntitySubscriptions
ActivityLog
ApiCallLog
Resource Links
Dashboard
Dashboard Widget
SharedEntity
Broadcast
OrganizationStrategicInitiative
Models
Support
GitHub
Documents Plugin
Read the extracted text of a FILE document.
GET
http://localhost:3000
/
api
/
plugins
/
docs
/
documents
/
{id}
/
extracted-text
Try it
Parameters
id
string
required
path
Response
200
OK
Extracted text payload.
← Previous
Regenerate the AI summary of a document.
Next →
Save a human-corrected extraction for a FILE document.
Copyright © 2023-Present Ever Co. LTD.
Docs by Sourcey
Stack Overflow
Website
Demo