Quickstart - Rima Partner API

Get access

Obtain a partner API key and a company ID allowed by that key from your Rima integration contact.

Call the hello endpoint

Set RIMA_PARTNER_API_KEY and COMPANY_ID in your shell, then send a request from your backend or terminal:

curl -i \
  -H "Authorization: Bearer $RIMA_PARTNER_API_KEY" \
  "https://partner-api.tryrima.com/v1/companies/$COMPANY_ID/hello"

A successful request returns HTTP 200 and {"message":"Hello, world!"}. The response also includes x-request-id for troubleshooting. See authentication and access for key and company scope, or errors and rate limits if the request fails.