Matchai Docs

Translate a listingComing soon

Translates the listing’s title, description, highlights and neighbourhood text into the languages you name.

Coming soon. This is documented ahead of launch so you can plan your integration; it is not available yet.
POST
/listings/{listing_id}/translations

Coming soon. Translates the listing’s title, description, highlights and neighbourhood text into the languages you name. Fields written by hand are left alone. Read the result with GET /listings/{listing_id}/translations/{locale}.

Spends Matchai Energy. Returns 402 without doing anything when the account does not have enough Energy, or when this connection reached the Energy limit the account holder set for it.

Scopes: listings:write

Pricing: Included with the connection, and spends Matchai Energy.

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

Path Parameters

listing_id*string

Listing id, or its slug.

Length1 <= length <= 200

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
locales*array<>

Languages to translate into. Hand-edited fields are left alone.

Items1 <= items <= 3

Response Body

The translation has started.

application/json
  1. response
id*string

Run id.

Length1 <= length <= 64
listing_id*string

Listing id.

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

Languages being translated.

status*string
Value in"queued""running""succeeded""failed"
created_at*string

Requested.

Formatdate-time
Example Request
curl -X POST 'https://api.matchai.co/v1/listings/string/translations' \  -H 'Idempotency-Key: 6f1d3c2a-0b7e-4f5a-9c8d-1e2f3a4b5c6d' \  -H 'Content-Type: application/json' \  -d '{  "locales": [    "en-US"  ]}'
Example Response
{  "id": "string",  "listing_id": "string",  "locales": [    "en-US"  ],  "status": "queued",  "created_at": "2019-08-24T14:15:22Z"}