Search your own and shared documents

GET

/api/v1/documents/search

Titles and the first 50 KB of text. Case and accent insensitive; 3–6 letter words also match as prefixes; up to 8 words. Ranked by words matched, title matches, then most recently updated.

App integration: Build a library search, not a complete file-content search: the index covers titles and the first 50 KB of text. Show that results depend on current access and selected-token restrictions. Use match=all for every term, or any to broaden results.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

OAuth 2.0

Authorization Code

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Authorize URL: https://handwrites.io/oauth/authorize

Token URL: https://handwrites.io/api/oauth/token

Refresh URL: https://handwrites.io/api/oauth/token

Scopes:

documents:read-List, fetch and download documents, including ones shared with you

Query Params

Responses

🟢200

application/json

Ranked matches.

Headers

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠403Forbidden

🟠429TooManyRequests

🔴500ServerError

Request Example

Shell

JavaScript

Java

Swift

curl --location '/api/v1/documents/search?q=&match=&limit=&cursor=' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "documents": [
        {
            "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",
            "matchedTerms": 0,
            "score": 0
        }
    ],
    "cursor": "string"
}

Modified at 2026-10-26 12:58:15

Create a document

A document's metadata