Agent Keys

Steps#

1. Go to dashboard.scalar.com/registry
2. Upload your OpenAPI document or connect via GitHub Actions for automatic sync
3. Navigate to your document
4. Create an Agent key

Configuration#

Add the key to your API reference configuration:

Scalar.createApiReference('#app', {
  sources: [
    {
      url: 'https://registry.scalar.com/@your-namespace/apis/your-api/latest?format=json',
      agent: {
        key: 'your-agent-scalar-key',
      },
    },
  ],
})

Keeping Documents in Sync#

For production, use GitHub Actions to automatically sync your OpenAPI document with the Registry. This ensures your Agent always has the latest API information.