API

Relay’s API is available in a searchable format at docs.relay.so/api and bundled with the extension stubs of PhpStorm.

Stubs

All builds include a relay.stub.php file, which outlines that build’s classes and their APIs. Fetching a specific stub without downloading a build can be done as well:

wget "https://builds.r2.relay.so/dev/relay.stub.php"
curl -O "https://builds.r2.relay.so/v0.21.0/relay.stub.php"

Attributes

All methods have PHP attributes to provide some metadata which can be inspected at runtime using the Reflection APIs.

• Local indicates the method does not communicate with Redis/Valkey
• Server indicates the method that may communicate with Redis/Valkey
• RedisCommand indicates the method represents a command
• ValkeyCommand indicates the method represents a command
• Cached indicates the method may use in-memory caching