Skip to main content

​
First API call

Use this page when you are not using the TypeScript SDK yet. For typed helpers, see First SDK call.
Fetch the documentation index before exploring: llms.txt

​
Base URL

https://api.auvy.ai

​
Authentication

Every request needs your API key: 
Authorization: Bearer ak_live_...
Create a key in cortex.auvy.ai → Admin → API keys.

​
Health check

curl -s https://api.auvy.ai/v1/health \
  -H "Authorization: Bearer $AUVY_API_KEY"

​
Invoke a receptor

Replace support-bot with your receptor slug and set X-Brain-Id when the receptor is brain-scoped: 
curl -s -X POST "https://api.auvy.ai/v1/receptors/{receptor_id}/fire" \
  -H "Authorization: Bearer $AUVY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "X-Brain-Id: YOUR_BRAIN_ID" \
  -d '{"message":"Hello from curl"}'
Long-running invokes return a job_id. Poll GET /v1/jobs/{job_id} or stream tokens — see Jobs and streaming.

​
When to use HTTP vs SDK

SituationRecommendation
TypeScript / Node / BunTypeScript SDK
Python, Go, Ruby, etc.HTTP + OpenAPI JSON
Shell scriptsCLI or curl

​
Next steps