Matchai Docs

Read a document’s textComing soon

Returns the text Matchai read from the file, page by page. With find, only the pages containing those words.

Coming soon. This is documented ahead of launch so you can plan your integration; it is not available yet.
GET
/documents/{document_id}/content

Coming soon. Returns the text Matchai read from the file, page by page. With find, only the pages containing those words.

Scopes: documents:read

Pricing: Included with the connection.

Authorization

headerAuthorizationBearer <matchai_<base62>>

A personal API key, sent as Authorization: Bearer matchai_…. Create keys in Matchai under Settings → Connectors → Advanced (for developers). A key starts with matchai_ followed by letters and digits, carries the scopes chosen when it was created, and can be revoked at any time. Keys reach only the account that created them: to serve other professionals, use Connect with Matchai.

Scope: documents:read

Path Parameters

document_id*string

Document id.

Length1 <= length <= 64

Query Parameters

find?string

Words to find.

Lengthlength <= 120

Response Body

The text.

application/json
  1. response
document_id*string

Document id.

Length1 <= length <= 64
pages*array<>

Pages, or only those containing find when you passed it.

truncated*boolean

True when there was more text than one response holds.

Example Request
curl -X GET 'https://api.matchai.co/v1/documents/string/content'
Example Response
{  "document_id": "string",  "pages": [    {      "number": 1,      "text": "string"    }  ],  "truncated": true}