Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Validate your API key and send your first message to a ReyGrid agent in a few minutes.
Set your API key
export REYGRID_API_KEY="your-api-key"
Check the API is up
GET /ping needs no authentication.curl https://reygrid.com/api/v1/ping
Validate your key
curl https://reygrid.com/api/v1/validate \
-H "Authorization: Bearer $REYGRID_API_KEY"
"valid": true with your usage.Send a message
curl -X POST https://reygrid.com/api/v1/agents/{AgentId}/chat \
-H "Authorization: Bearer $REYGRID_API_KEY" \
-H "Content-Type: application/json" \
-d '{"message": "Hello!", "userId": "user_42"}'
output.reply.content.Install
pip install reygrid
Run your first request
from reygrid import ReyGrid
client = ReyGrid(api_key="your-api-key")
print(client.ping().status) # UP
print(client.get_usage()) # Usage(total=..., quotaLimit=...)
reply = client.chat("{AgentId}", "Hello!", user_id="user_42")
print(reply.output.reply.content)
Install
npm install reygrid
Run your first request
import { ReyGrid } from "reygrid";
const client = new ReyGrid({ apiKey: "your-api-key" });
console.log((await client.ping()).status); // UP
console.log(await client.getUsage()); // { total, quotaLimit }
const res = await client.chat("{AgentId}", "Hello!", { userId: "user_42" });
console.log(res.output.reply.content);
userId gives that user a persistent conversation, so you don’t have to resend history. See Persistent conversations.