Edges

Upsert edges in bulk

Creates or updates up to 5,000 edges in one call, matching existing edges on (from_id, to_id, edge_type). The batch is atomic by default: one failed entry rolls it all back. Returns each entry's outcome.

POST
/edges/bulk

Authorization

bearerAuth
headerAuthorizationBearer <token>

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

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

The entries to write, at most 5,000. The items they join must already exist. An entry with a key this operation doesn't declare is refused as validation_error, and details.unknown_body_fields names each key.

mode?string

upsert (the default) merges an entry's properties into the edge it matches. create_only skips it, reporting skipped with reason duplicate_edge.

Value in"upsert""create_only"
atomic?boolean

Whether one failed entry rolls back the whole batch. Defaults to true. With false, that entry is errored and the rest are written.

enable_fanout?boolean

Whether each write also calls outbound webhooks. Defaults to false. Marfa logs the events either way.

Response body

About errors

Returns counts and a results entry for each edge, in order: created, updated, skipped or errored. Under create_only, an entry that matches an edge is skipped with reason duplicate_edge.

application/json
  1. response

What a bulk write did with each entry.

counts*

How many entries had each outcome.

results*array<>

One result per entry, in the order you sent them.

  • validation_error: the body is malformed, has an undeclared key or has over 5,000 entries.
  • missing_required_field: a required field is missing.
  • invalid_properties: an entry's properties hold a whole number a 64-bit float can't keep.
  • bulk_atomic_rollback: an atomic entry was refused and nothing was written (details.code, details.index). The status is the refusal's own.
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.

  • type_not_permitted: your credential reaches no type.
  • bulk_atomic_rollback: with atomic true, you don't have write on the type of the item an entry points from, or on its edge type. details.code is type_not_permitted or edge_type_not_permitted.
application/json
  1. response

An error response.

error*

What went wrong.

bulk_atomic_rollback: with atomic true, an entry names an item that doesn't exist, or whose type you can't read. details.code is item_not_found.

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.

bulk_atomic_rollback: with atomic true, an entry's edge has moved or its ID is taken. details.code is version_conflict or id_reused.

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/edges/bulk' \  -H 'Content-Type: application/json' \  -d '{  "edges": [    {      "from_id": "string",      "to_id": "string",      "edge_type": "string"    }  ]}'
About errors
{  "counts": {    "created": 1,    "updated": 0,    "skipped": 0,    "errored": 0  },  "results": [    {      "index": 0,      "outcome": "created",      "id": "01a1011e-8bc3-71cd-a077-c1167f68bd79"    }  ]}