Skip to content

API Reference ​

This section provides a complete, interactive reference for the realay.io API.


To get started, you would create a Vue component that uses Scalar, and then you can embed that component directly into this Markdown file.

Example of what the integration could look like:

vue
<!-- .vitepress/theme/components/ApiReference.vue -->
<template>
  <ApiReference :configuration="configuration" />
</template>

<script setup>
import { ApiReference } from '@scalar/api-reference'

const configuration = {
  spec: {
    // This assumes your openapi.yaml is in the public folder
    // You might need to adjust the path
    url: '/docs/api/openapi.yaml',
  },
}
</script>

And then in this file (api/reference.md), you would use it like this:

_This is a placeholder. You would replace this with the actual component after setting it up._

<ApiReference />