Matchai Docs

Put an edited photo on the listingComing soon

Adds the edited photo next to the original (add), or replaces the original with it (replace). A replaced original can be restored later.

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

Coming soon. Adds the edited photo next to the original (add), or replaces the original with it (replace). A replaced original can be restored later.

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

Path Parameters

listing_id*string

Listing id, or its slug.

Length1 <= length <= 200
edit_id*string

Photo edit id.

Length1 <= length <= 64

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
mode*string

add puts the edit next to the original. replace swaps the original for it; the original can be restored later.

Value in"add""replace"

Response Body

The edit, now applied.

application/json
  1. response

An edited version of a photo. It is not on the listing until you apply it.

id*string

Edit id.

Length1 <= length <= 64
listing_id*string

Listing id.

Length1 <= length <= 64
media_id*string

The photo it was made from.

Length1 <= length <= 64
kind*string

The edit kind requested.

status*string
Value in"queued""running""succeeded""failed""applied"
preview_url?|

The edited photo, once it succeeded.

Formaturi
applied_media_id?|

The media created or replaced when it was applied.

Length1 <= length <= 64
error?|null
created_at*string

Requested.

Formatdate-time
completed_at?|

Finished.

Formatdate-time
Example Request
curl -X POST 'https://api.matchai.co/v1/listings/string/photo-edits/string/apply' \  -H 'Idempotency-Key: 6f1d3c2a-0b7e-4f5a-9c8d-1e2f3a4b5c6d' \  -H 'Content-Type: application/json' \  -d '{  "mode": "add"}'
Example Response
{  "id": "string",  "listing_id": "string",  "media_id": "string",  "kind": "string",  "status": "queued",  "preview_url": "http://example.com",  "applied_media_id": "string",  "error": {    "code": "string",    "message": "string"  },  "created_at": "2019-08-24T14:15:22Z",  "completed_at": "2019-08-24T14:15:22Z"}