Matchai Docs

Show a file on your pageComing soon

Shows a Matchai Cloud document on your page, where anyone who opens the page can download it.

Coming soon. This is documented ahead of launch so you can plan your integration; it is not available yet.
POST
/page/files

Coming soon. Shows a Matchai Cloud document on your page, where anyone who opens the page can download it.

Final action. When the connection is set to Ask me, this call returns 202 with an approval_url and does nothing until the account holder approves it in Matchai; Matchai then performs it exactly as sent and sends approval.resolved. When the connection is set to Allowed, it runs straight away.

Scopes: page:write and 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: page:write, documents:read

Header Parameters

Idempotency-Key?string

A unique string (a UUID works). Retrying with the same key within 24 hours returns the first response instead of acting twice. Reusing a key with a different body returns 409 idempotency_key_reused.

Length1 <= length <= 255

Request Body

application/json
  1. body
document_id*string

A document in your Matchai Cloud. It becomes downloadable by anyone who opens the page.

Length1 <= length <= 64

Response Body

The file on the page.

application/json
  1. response
document_id*string

The Matchai Cloud document.

Length1 <= length <= 64
name*string

File name.

mime_type?|

File type.

size_bytes?|

Size.

Range0 <= value
position*integer

Order on the page.

Range0 <= value
Example Request
curl -X POST 'https://api.matchai.co/v1/page/files' \  -H 'Idempotency-Key: 6f1d3c2a-0b7e-4f5a-9c8d-1e2f3a4b5c6d' \  -H 'Content-Type: application/json' \  -d '{  "document_id": "string"}'
Example Response
{  "document_id": "string",  "name": "string",  "mime_type": "string",  "size_bytes": 0,  "position": 0}