> ## Documentation Index
> Fetch the complete documentation index at: https://docs.partner-api.tryrima.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Make your first request to the 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:

```bash theme={null}
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](/authentication) for key and company scope, or [errors and rate limits](/errors-and-limits) if the request fails.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.