Public API documentation
This page documents the buyer marketplace API, the OpenAI-compatible gateway, node lifecycle endpoints, and payout onboarding endpoints. Use the examples below or open the interactive explorer for the current schema.
Quickstart
Start with marketplace job submission, OpenAI-compatible inference, or direct server-side integration.
Marketplace job submission
curl -X POST https://ryvion-hub.fly.dev/api/v1/marketplace/jobs \\
-H "Content-Type: application/json" \\
-H "X-API-Key: BUYER_API_KEY" \\
-d '{
"kind": 1,
"budget": 500,
"max_price_per_unit": 1,
"currency": "CAD",
"strict_jurisdiction": "CA",
"region": "st. john's",
"estimated_tokens": 3200
}'
OpenAI-compatible chat
curl https://ryvion-hub.fly.dev/v1/chat/completions \\
-H "Content-Type: application/json" \\
-H "Authorization: Bearer BUYER_JWT_OR_API_GATEWAY_TOKEN" \\
-d '{
"model": "phi-4",
"messages": [
{"role": "user", "content": "How do I route work to Canada-only nodes?"}
]
}'
JavaScript / TypeScript
const response = await fetch("https://ryvion-hub.fly.dev/api/v1/marketplace/estimate", {
method: "POST",
headers: {
"Content-Type": "application/json",
"X-API-Key": process.env.RYVION_API_KEY,
},
body: JSON.stringify({
kind: 1,
strict_jurisdiction: "CA",
region: "st. john's",
estimated_tokens: 3200,
}),
});
const estimate = await response.json();
Python
import requests
resp = requests.post(
"https://ryvion-hub.fly.dev/v1/embeddings",
headers={
"Authorization": "Bearer BUYER_TOKEN",
"Content-Type": "application/json",
},
json={
"model": "nomic-embed-text",
"input": ["Ryvion developer portal"],
},
timeout=30,
)
resp.raise_for_status()
print(resp.json())
Public surfaces
The public API is organized by buyer, operator, and gateway endpoints.
Buyer API
Estimate workloads, submit marketplace jobs, inspect audit trails, export evidence, manage credits, and route inference near the required region.
/api/v1/marketplace/estimate/api/v1/marketplace/jobs/api/v1/marketplace/jobs/{job}/audit/api/v1/marketplace/sla
OpenAI-compatible gateway
Drop-in chat completion and embeddings endpoints for developer tools, copilots, and agentic products that already speak OpenAI semantics.
/v1/models/v1/chat/completions/v1/embeddings
Operator API
Register nodes, poll for work, submit receipts, and manage payout onboarding for operators contributing compute to the network.
/api/v1/node/register/api/v1/node/work/api/v1/node/receipt/api/v1/node/connect/status
Interactive API explorer
Use the built-in explorer to inspect schemas, authorize requests, and try the live endpoints directly against the current hub.