Plugins

Get a mapping preview

Returns a mapping preview: pending, or ready with the fields the connector rendered, or failed with its reason. Needs connectors.manage, or the connector's own key.

GET
/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.

Response body

About errors

Returns the preview.

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 query has a parameter this endpoint doesn't take.
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: you don't have connectors.manage and aren't the connector's own key (details.required_scope).

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.

instance_changed: X-Marfa-Instance-Id names another instance. Nothing is written. Rebuild the working copy from the instance 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.

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 GET 'http://localhost:8600/plugins/string/connector/previews/01a1fa40-3b2c-7d11-8e90-5a6b7c8d9e0f'
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"}