Developers / Quickstart

First call in about a minute.

You keep your provider, your key and your billing. R-Sym sits in front of the call and hands you back something smaller to send.

01

Get a key

Access is granted by request while the platform is in preview. You will receive a key beginning rsk_live_. It is shown once and stored hashed, so keep it somewhere you control.

02

Check you can reach the service

No credential needed for this one. If it answers, the platform is up.

# service state, no auth required
curl https://api.r-sym.com/status
03

Send your first payload

Your key goes in the Authorization header. Your provider key does not go anywhere — it stays with you.

curl https://api.r-sym.com/v1/submit \
  -H "Authorization: Bearer $RSYM_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "tool": "optimize_payload",
    "payload": "...your context..."
  }'
04

Read the envelope

Every response has the same shape. deliverable is what you send on to your provider. dollarsSaved is what it saved you, settled against their invoice rather than our estimate.

{
  "status": "ok",
  "requestId": "2325138bcba040e1af6e8441e4dad1c6",
  "outcome": 0,
  "deliverable": "...send this instead...",
  "dollarsSaved": 0.0000,
  "latencyMs": 0
}
05

Dispatch to your provider

Send deliverable where you were going to send your original context. Same endpoint, same model, same account, same key. Nothing about your provider setup changes.

Responses

What you will get back.

Errors carry a code and the matching HTTP status. A caller reading only the status line and one reading only the body reach the same conclusion.

CodeHTTPMeaningWhat to do
200Accepted and processed.Use the deliverable.
RS-401401Missing, unknown or revoked key.Check the header, then the key.
RS-402402Account on hold.Settle the balance.
RS-403403Usage cap reached, or payload too large.Split the payload or raise the cap.
RS-429429Rate limited.Back off and retry.
RS-500500Fault on our side.Retry. Quote the requestId if it persists.
Unknown and revoked keys return the same code. That is deliberate.
Get started

Request a key.

Access is granted by request while the platform is in preview.