Relayers

Creates a new relayer.

post/api/v1/relayers

Request

The document declares no server URL.
Auth
HTTP bearer
TypeScript
https://skmtc.dev/openzeppelin/apis/openzeppelin-relayer-api/docs/api/v1/relayers/post.ts
A function with typed inputs. Its response is checked against the schema.

idstring

namestring required

networkstring required

network_type'evm' | 'solana' | 'stellar' required

Network type enum for relayers

notification_idstring

pausedboolean required

signer_idstring required

{
  "custom_rpc_urls": [
    {
      "url": "https://rpc.example.com",
      "weight": 100
    }
  ]
}

Relayer created successfully

errorstring

successboolean required

Jul 28, 2026e6e7514284f5 Revision changes
- info
  added the new optional request property /////
- info
  added the optional property ////// to the response with the status
Jan 12, 202641cbb68dc72d Revision changes
- warning
  the // request property's max was set to 100.00
- info
  the request property // with a default value became required
- info
  the request property default value 100 was added
- info
  the response property /// became required for the status