# Thaw API

> Your documents, the people & things they are about, and the Checkup, as JSON. Every call carries a bearer token and answers as JSON; every refusal is application/problem+json.

Base URL: https://api.thawed.app/v1
Reference: https://developer.thawed.app/openapi.yaml
Tokens: https://go.thawed.app/settings/developers

## Guides

- [Getting started](https://developer.thawed.app/guides/getting-started/): A token, one call, and what comes back.
- [The two ways in](https://developer.thawed.app/guides/ways-in/): A personal token, or an assistant connection.
- [Scopes, roles and plans](https://developer.thawed.app/guides/scopes/): Three walls, and the narrowest wins.
- [Changing things](https://developer.thawed.app/guides/changing-things/): The same press the page makes, through another door.
- [Idempotency](https://developer.thawed.app/guides/idempotency/): Making a change once, however many times it is sent.
- [Paging](https://developer.thawed.app/guides/paging/): Cursors that stay right while documents arrive.
- [Errors](https://developer.thawed.app/guides/errors/): Every refusal is a problem you can read out loud.
- [Adding documents](https://developer.thawed.app/guides/uploads/): One request for a small file, parts for a big one.
- [MCP](https://developer.thawed.app/guides/mcp/): An assistant reaching the documents over the same door.

## Reference

### You

- GET /identity (scope read): Who holds this token. https://developer.thawed.app/reference/you/#identity
- GET /account (scope read): Where this call landed. https://developer.thawed.app/reference/you/#account
- GET /overview (scope read): What is on file, in numbers. https://developer.thawed.app/reference/you/#overview

### Documents

- GET /search (scope read): Search. https://developer.thawed.app/reference/documents/#search
- GET /documents (scope read): The documents. https://developer.thawed.app/reference/documents/#listDocuments
- POST /documents (scope add): A document in. https://developer.thawed.app/reference/documents/#addDocument
- GET /documents/{document} (scope read): One document. https://developer.thawed.app/reference/documents/#getDocument
- PATCH /documents/{document} (scope write): Correct a document. https://developer.thawed.app/reference/documents/#updateDocument
- GET /documents/{document}/files/{file} (scope files): The file itself. https://developer.thawed.app/reference/documents/#documentFile
- GET /documents/{document}/files/{file}/pages/{page} (scope files): One page as a picture. https://developer.thawed.app/reference/documents/#documentPage
- POST /documents/note (scope add): Save a note as a document. https://developer.thawed.app/reference/documents/#saveNote
- POST /documents/{document}/type (scope write): File a document as something else. https://developer.thawed.app/reference/documents/#fileDocumentAs
- POST /documents/{document}/entities (scope write): Link a person or thing. https://developer.thawed.app/reference/documents/#linkPersonOrThing
- DELETE /documents/{document}/entities/{entity} (scope write): Unlink a person or thing. https://developer.thawed.app/reference/documents/#unlinkPersonOrThing
- POST /documents/{document}/reviewed (scope write): Looks right. https://developer.thawed.app/reference/documents/#markReviewed
- POST /documents/{document}/read-again (scope write): Read it again. https://developer.thawed.app/reference/documents/#readAgain
- POST /documents/{document}/links (scope write): Share a document by link. https://developer.thawed.app/reference/documents/#shareDocument
- DELETE /documents/{document}/links/{link} (scope write): Take a link back. https://developer.thawed.app/reference/documents/#revokeShareLink

### Facts

- GET /documents/{document}/facts (scope read): A document's facts. https://developer.thawed.app/reference/facts/#documentFacts
- GET /facts (scope read): Facts across documents. https://developer.thawed.app/reference/facts/#listFacts
- PATCH /documents/{document}/facts/{fact} (scope write): Correct a fact. https://developer.thawed.app/reference/facts/#correctFact

### People & things

- GET /people-and-things (scope read): Everyone and everything. https://developer.thawed.app/reference/people-and-things/#listPeopleAndThings
- GET /people-and-things/{entity} (scope read): One person or thing. https://developer.thawed.app/reference/people-and-things/#getPersonOrThing
- PATCH /people-and-things/{entity} (scope write): Correct a person or thing. https://developer.thawed.app/reference/people-and-things/#updatePersonOrThing

### Checkup

- GET /checkup (scope read): The Checkup. https://developer.thawed.app/reference/checkup/#checkup
- GET /calendar.ics (scope read): Up next as a calendar. https://developer.thawed.app/reference/checkup/#calendar
- POST /checkup/obligations/{obligation} (scope write): Act on a dated item. https://developer.thawed.app/reference/checkup/#actOnObligation
- PATCH /checkup/obligations/{obligation}/lead-days (scope write): How far ahead to raise it. https://developer.thawed.app/reference/checkup/#setLeadDays
- POST /checkup/{gap}/dismiss (scope write): It's fine. https://developer.thawed.app/reference/checkup/#dismissGap
- POST /checkup/{gap}/reopen (scope write): Ask again. https://developer.thawed.app/reference/checkup/#reopenGap
- POST /reminders (scope write): Remind me. https://developer.thawed.app/reference/checkup/#makeReminder

### Bundles

- GET /bundles (scope read): The bundles. https://developer.thawed.app/reference/bundles/#listBundles
- GET /bundles/{bundle} (scope read): One bundle. https://developer.thawed.app/reference/bundles/#getBundle

### Imports

- GET /imports (scope read): The imports. https://developer.thawed.app/reference/imports/#listImports
- GET /imports/{import} (scope read): One import. https://developer.thawed.app/reference/imports/#getImport

### Uploads

- POST /uploads (scope add): Start an upload in parts. https://developer.thawed.app/reference/uploads/#startUpload
- POST /uploads/urls (scope add): URLs for the next parts. https://developer.thawed.app/reference/uploads/#uploadPartUrls
- POST /uploads/complete (scope add): Finish an upload. https://developer.thawed.app/reference/uploads/#completeUpload
- POST /uploads/abort (scope add): Abandon an upload. https://developer.thawed.app/reference/uploads/#abortUpload

### Ask

- POST /ask (scope ask): Ask a question. https://developer.thawed.app/reference/ask/#ask
- POST /documents/{document}/ask (scope ask): Ask about one document. https://developer.thawed.app/reference/ask/#askDocument
- POST /checkup/obligations/{obligation}/draft (scope ask): Draft the email for a dated item. https://developer.thawed.app/reference/ask/#draftForObligation
- POST /checkup/{gap}/draft (scope ask): Draft the email for something missing. https://developer.thawed.app/reference/ask/#draftForGap

## Shapes

- Problem: https://developer.thawed.app/reference/shapes/#problem
- Scope: https://developer.thawed.app/reference/shapes/#scope
- Named: https://developer.thawed.app/reference/shapes/#named
- Status: https://developer.thawed.app/reference/shapes/#status
- DocumentRow: https://developer.thawed.app/reference/shapes/#documentrow
- Document: https://developer.thawed.app/reference/shapes/#document
- Fact: https://developer.thawed.app/reference/shapes/#fact
- UpNext: https://developer.thawed.app/reference/shapes/#upnext
- CheckupItem: https://developer.thawed.app/reference/shapes/#checkupitem
- PersonOrThing: https://developer.thawed.app/reference/shapes/#personorthing
- ShareLink: https://developer.thawed.app/reference/shapes/#sharelink