Matchai Docs

Upload a documentComing soon

Uploads a file to Matchai Cloud, private, and optionally files it in one place. Matchai reads its text so it can be searched and summarised.

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

Coming soon. Uploads a file to Matchai Cloud, private, and optionally files it in one place. Matchai reads its text so it can be searched and summarised.

Scopes: documents:write

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:write

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

multipart/form-data
  1. body
file*string

The file.

name?string

File name, if different from the uploaded one.

Lengthlength <= 255
place_type?string

File it somewhere straight away.

Value in"listing""conversation""project""team"
place_id?string

Id of that place.

Length1 <= length <= 64

Response Body

The document.

application/json
  1. response

A file in Matchai Cloud. One file can be in several places at once.

id*string

Document id.

Length1 <= length <= 64
name*string

File name.

mime_type?|

File type.

size_bytes?|

Size.

Range0 <= value
visibility*string

private: only people with access to one of its places. public: shown on the listing page to anyone. More levels may be added.

Value in"private""public"
tags*array<>

Tags.

places*array<>

Where it is filed.

summary?|

A short summary, once Matchai has read it.

reading_status*string

Whether Matchai has read the file’s text.

Value in"not_read""reading""done""failed"
download_url?|

A short-lived link to the file. Returned by GET /documents/{document_id} only.

Formaturi
uploaded_at*string

Added.

Formatdate-time
updated_at?|

Last changed.

Formatdate-time
archived_at?|

Moved to the trash. Restorable for 30 days.

Formatdate-time
Example Request
curl -X POST 'https://api.matchai.co/v1/documents' \  -H 'Idempotency-Key: 6f1d3c2a-0b7e-4f5a-9c8d-1e2f3a4b5c6d' \  -F 'file=string'
Example Response
{  "id": "string",  "name": "string",  "mime_type": "string",  "size_bytes": 0,  "visibility": "private",  "tags": [    {      "facet": "kind",      "value": "string"    }  ],  "places": [    {      "type": "listing",      "id": "string",      "name": "string"    }  ],  "summary": "string",  "reading_status": "not_read",  "download_url": "http://example.com",  "uploaded_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "archived_at": "2019-08-24T14:15:22Z"}