- Handwrite Regular Accounts
- Start here — Handwrite for outside developers
- API specification notes
- Socket specification notes
- Account
- README — GET /api/v1/me
- README — DELETE /api/v1/me
- README — GET /api/v1/me/policy
- README — GET /api/v1/me/usage
- Account API — README
- Who this credential acts for
- Delete the account (after a 30-day grace period)
- What your teams' and classes' policies allow
- Your own usage, and what your teams and classes counted
- Documents
- README — GET /api/v1/documents
- README — POST /api/v1/documents
- README — GET /api/v1/documents/search
- README — GET /api/v1/documents/{id}
- README — PATCH /api/v1/documents/{id}
- README — DELETE /api/v1/documents/{id}
- README — GET /api/v1/documents/{id}/content
- README — PUT /api/v1/documents/{id}/content
- README — POST /api/v1/documents/{id}/live
- README — GET /api/v1/export
- Documents API — README
- List your documents (or shared, or changes since)
- Create a document
- Search your own and shared documents
- A document's metadata
- Change title, text, content type or language
- Delete a document (owner)
- The document's text
- Replace the text
- Join the document's live co-editing room
- Every document you own, with its text
- Files
- README — GET /api/v1/documents/{id}/file
- README — POST /api/v1/documents/{id}/file
- README — POST /api/v1/documents/{id}/file/commit
- README — POST /api/v1/documents/{id}/extract
- Files API — README
- Download the original file
- Start uploading the original file
- Make an uploaded file the document's file
- Replace the text with the file's text
- Audio
- README — GET /api/v1/documents/{id}/audio
- README — POST /api/v1/audio/stream
- README — POST /api/v1/audio/speech
- README — GET /api/v1/voices
- README — GET /api/v1/quota
- Audio API — README
- The whole document as one audio file
- Stream speech as it's made
- Speech with word timings (read-along)
- Voices you can use
- Characters left, limit, plan and reset time
- Sharing
- README — GET /api/v1/documents/{id}/permissions
- README — POST /api/v1/documents/{id}/permissions
- README — PATCH /api/v1/documents/{id}/permissions/{principal}
- README — DELETE /api/v1/documents/{id}/permissions/{principal}
- README — DELETE /api/v1/documents/{id}/invitations/{inviteId}
- README — GET /api/v1/invitations
- README — POST /api/v1/invitations/{id}/accept
- README — POST /api/v1/invitations/{id}/decline
- Sharing API — README
- Who a document is shared with
- Share by principal, or invite by email (owner)
- Change someone's role (owner)
- Remove access (owner, or leave yourself)
- Cancel a pending invitation (owner)
- Document invitations to your verified email
- Accept a document invitation
- Decline a document invitation
- Settings
- Webhooks
- Meta
- OAuth
- Live socket
- A document or sharing event
- Schemas
- Error
- Principal
- Role
- Access
- ContentType
- Language
- FileRef
- Document
- Tombstone
- DocumentPage
- CreateDocument
- UpdateDocument
- FileInfo
- CommitUpload
- Upload
- DownloadLink
- Extracted
- ExtractionFailed
- CommittedDocument
- ExtractedDocument
- SearchHit
- SearchPage
- Export
- Permission
- Share
- ChangeRole
- Invitation
- Permissions
- ReceivedInvitation
- AcceptedInvitation
- Me
- WebhookEventType
- Webhook
- CreateWebhook
- CreatedWebhook
- WebhookDelivery
- AudioFormat
- Speech
- WordTiming
- SpeechMarks
- AudioLink
- Voice
- Quota
- SettingEntry
- Settings
- SettingsPatch
- PatchedSettings
- OAuthToken
- OAuthError
- Handwrite Team
- Handwrite Classroom
CommittedDocument
{
"id": "doc_Ab3dEf6hIj9kLm0n",
"title": "string",
"language": "en",
"revision": 0,
"contentType": "text/plain",
"contentLength": 0,
"contentSha256": "string",
"file": {
"name": "string",
"type": "application/pdf",
"length": 0
},
"owner": "user:3f2b…",
"access": "owner",
"source": "api",
"createdAt": "2019-08-24T14:15:22.123Z",
"updatedAt": "2019-08-24T14:15:22.123Z",
"extracted": {
"characters": 0,
"method": "text"
}
}