PRprimitive
Interactions

Start an interaction

Send the first step of a protocol from one of your addresses: a carrier email with the step's interaction.json part. The step is validated against the protocol before anything is sent. An Idempotency-Key makes a retry return the same interaction without sending again.

post/interactions

Request

  • Base URL
    https://api.primitive.dev/v1
  • URL
    https://api.primitive.dev/v1/interactions
  • Auth
    HTTP bearer

Headers

Idempotency-Keystring

Optional client-supplied idempotency key. Retrying a request with the same key returns the original result instead of performing the action a second time; if omitted the server derives one from the canonical payload hash. Safe to retry network failures without duplicating side effects.

Request body

protocolstring required
protocol_versioninteger
stepstring required
fromstring required
tostring required
payloadunknown
expires_atstring date-time nullable
subjectstring
body_textstring

Response

Start an interaction

successtrue required

Changes

No operation changes recorded.