Plugins

Answer a mapping preview

Keeps the connector's answer to a pending preview as it sends it: the rendered item as result, or error. Marfa never renders a field itself. Only the connector's own key, or local authority, can do this.

POST
/plugins/{name}/connector/previews/{id}

Authorization

bearerAuth
headerAuthorizationBearer <token>

Authenticate with an API key (marfa_k1_…) or an OAuth access token (marfa_at_…).

Path parameters

name*string

The plugin's name.

id*string

The ID of the mapping preview.

Header parameters

X-Marfa-Instance-Id?string

The ID of the instance you expect, as GET / returns it. If another instance answers at this address, Marfa returns 409 instance_changed and doesn't write. Leave it out to send the request to whichever instance answers.

Match^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Request body

application/json
  1. body

The connector's answer to a mapping preview: result or error, not both.

result?

The item the connector rendered, at most 65,536 bytes written as JSON. Send this or error.

error?string

Why the connector could not render the preview. Send this or result.

Length1 <= length <= 500

Response body

About errors

Returns the preview, answered.

application/json
  1. response

A mapping preview is how one kind of a connector would land, which the connector renders on one of its items.

id*string

Unique identifier for the mapping preview.

kind*string

The kind of the connector the preview renders.

item_id*|

The ID of the item the connector renders the preview from, or null to let the connector choose a recent one.

mapping*|

The draft of the kind's mapping to render with, or null for the mapping in force.

status*string

pending until the connector answers, then ready with result or failed with error.

Value in"pending""ready""failed"
result*|

The item the connector rendered, as it sent it, once status is ready.

error*|

Why the connector could not render the preview, once status is failed.

created_at*string

When the preview was asked for, in UTC.

Formatdate-time
expires_at*string

When Marfa stops returning the preview, in UTC: 10 minutes after created_at.

Formatdate-time
answered_at*|

When the connector answered, in UTC, or null.

Formatdate-time

validation_error: the body holds neither or both of result and error, a result that is over 65,536 bytes or isn't an item of the kind's target type with properties, an optional title and an optional source_item, an error that is not 1 to 500 characters, or another member. details.errors names each.

application/json
  1. response

An error response.

error*

What went wrong.

unauthorized: the request has no credential, or its credential is not valid. For a key that has expired, details.expired_at says when it expired.

application/json
  1. response

An error response.

error*

What went wrong.

forbidden: only the connector's own key, or local authority, can do this.

application/json
  1. response

An error response.

error*

What went wrong.

  • plugin_not_found: no plugin of this name is installed.
  • plugin_connector_not_found: the plugin has no connector.
  • connector_preview_not_found: the plugin holds no preview with this ID, or it has expired.
application/json
  1. response

An error response.

error*

What went wrong.

request_timeout: the request body didn't arrive whole within 180 seconds. Nothing changed, and Marfa closed the connection. Send the request again. A body larger than about 21 MiB can't arrive in that time over a 1 Mbit/s link, so send it in smaller requests.

application/json
  1. response

An error response.

error*

What went wrong.

  • connector_preview_answered: the connector already answered this preview.
  • instance_changed: another instance answers at this address.
application/json
  1. response

An error response.

error*

What went wrong.

contract_mismatch: X-Marfa-Contract names another contract version than this instance speaks, or is not a whole number. Nothing was done.

application/json
  1. response

An error response.

error*

What went wrong.

request_too_large: the request body is larger than this instance accepts.

application/json
  1. response

An error response.

error*

What went wrong.

rate_limited: you sent too many requests. Wait for the number of seconds in Retry-After, then try again.

application/json
  1. response

An error response.

error*

What went wrong.

internal_error: Marfa failed in a way it didn't expect, and the request may not have completed. Read what you changed before you repeat a write.

application/json
  1. response

An error response.

error*

What went wrong.

write_contention: the database was busy, and Marfa couldn't complete the request in time. Nothing changed. Try the request again. While a restore runs, details.reason is restore_running.

application/json
  1. response

An error response.

error*

What went wrong.

insufficient_storage: the disk that holds the instance's data has no room for the request, or the request would leave less free than the instance keeps in reserve. Nothing changed, unless details.write_outcome is unknown, which means the write may have landed: read what you changed before you repeat it. Free space on the disk, then try the request again.

application/json
  1. response

An error response.

error*

What went wrong.

curl -X POST 'http://localhost:8600/plugins/string/connector/previews/01a1fa40-3b2c-7d11-8e90-5a6b7c8d9e0f' \  -H 'Content-Type: application/json' \  -d '{  "result": {    "type": "rss.entry",    "title": "A post",    "properties": {      "title": "A post",      "url": "https://example.com/a-post"    },    "source_item": "01a1fa41-9d8e-7f10-b2c3-4d5e6f708192"  }}'
About errors
{  "id": "01a1fa40-3b2c-7d11-8e90-5a6b7c8d9e0f",  "kind": "entry",  "item_id": "01a1fa41-9d8e-7f10-b2c3-4d5e6f708192",  "mapping": null,  "status": "ready",  "result": {    "type": "rss.entry",    "title": "A post",    "properties": {      "title": "A post",      "url": "https://example.com/a-post"    },    "source_item": "01a1fa41-9d8e-7f10-b2c3-4d5e6f708192"  },  "error": null,  "created_at": "2026-10-03T09:30:00.000Z",  "expires_at": "2026-10-03T09:40:00.000Z",  "answered_at": "2026-10-03T09:30:04.000Z"}