Get started

Velu REST API

Trigger deployments, search published docs, and embed Ask AI.

The Velu REST API lets you interact with your documentation programmatically: trigger a rebuild, search indexed pages, and send Ask AI messages from your own product.

Base URL: https://api.getvelu.com

Common use cases

CI/CD — Call Trigger deployment from a GitHub Action after merging to main, then poll Get deployment status until successful or failed.
In-app search — Power a custom search UI with Search documentation, then load the full page with Get page content.
Embedded assistant — Point useChat at Create assistant message. {domain} is the hosted hostname (veludocs.com, not veludocs.com/docs). No API key.

Authentication

Authenticate every request with a Velu API key as a Bearer token.

Create a key in the dashboard under Settings → API keys.

curl https://api.getvelu.com/v1/search \
  -H "Authorization: Bearer velu_••••" \
  -H "Content-Type: application/json" \
  -d '{"query": "custom domain"}'

Was this page helpful?

Trigger deployment