Reserve Media ID

matrix.create_media_id
ActionChat & messagingconnection required

Calls the Matrix API with the connection's credentials.

Reserve an mxc:// URI now and upload its bytes later with matrix.upload_to_media_id.

Connection

Required
Yes — the node will not save without one
Auth type
Bearer token
Providers
Matrix
Secret shape
the account access token, or {"access_token": "…"}
Config it needs
base_url, user_id, default_room_id
Resolved by
config.connection_id, else node.connection_id

Configuration

This node takes no configuration beyond its connection.

Output

One shape.

result

FieldTypeExample
content_uri
The reserved mxc:// URI, still holding no bytes.
string—
unused_expires_at
When the reservation lapses if nothing is uploaded, in milliseconds since the epoch; absent when the server sets no deadline.
number—
uploaded
Always false — the bytes are not there yet.
boolean—
{
  "content_uri": "",
  "unused_expires_at": 0,
  "uploaded": false
}

Notes

  • The connection's base_url is the homeserver (e.g. https://matrix.example.org), not the account's server name; the two differ whenever .well-known delegation is in use.
  • Rooms are addressed by room id (!abc:server). Resolve a #alias:server with matrix.resolve_room_alias first, or set a default room on the connection.
  • This is the asynchronous half of an upload: the URI can be sent in an event before the file exists, and clients will wait for it.
  • The reserve-then-upload pair is Matrix 1.7 and later; an older homeserver answers 404 for it — use matrix.upload_media instead.

See Reserve Media ID run in a workflow.

In a technical demo we add the Matrix connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.