Matchai Docs

Get a listing creation runComing soon

Returns where an AI listing creation run stands, and the draft listing once it is done.

Coming soon. This is documented ahead of launch so you can plan your integration; it is not available yet.
GET
/listing-generations/{generation_id}

Coming soon. Returns where an AI listing creation run stands, and the draft listing once it is done.

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

Path Parameters

generation_id*string

Listing creation run id.

Length1 <= length <= 64

Response Body

The run.

application/json
  1. response

An AI listing creation run. It produces a draft listing; nothing is published.

id*string

Run id.

Length1 <= length <= 64
status*string
Value in"queued""running""succeeded""failed"
source*string
Value in"photos""web_page"
listing_id?|

The draft listing, once the run has created it.

Length1 <= length <= 64
step?|

What the run is doing now, in plain words, for example "Writing the description".

error?|null
created_at*string

Started.

Formatdate-time
completed_at?|

Finished.

Formatdate-time
Example Request
curl -X GET 'https://api.matchai.co/v1/listing-generations/string'
Example Response
{  "id": "string",  "status": "queued",  "source": "photos",  "listing_id": "string",  "step": "string",  "error": {    "code": "string",    "message": "string"  },  "created_at": "2019-08-24T14:15:22Z",  "completed_at": "2019-08-24T14:15:22Z"}