> ## 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.

# Hello world



## OpenAPI

````yaml /openapi.json get /v1/companies/{companyId}/hello
openapi: 3.1.0
info:
  title: Rima Partner API
  version: 0.0.1
  description: >-
    Use `https://partner-api.rhythm.tryrima.com` for the Rima Partner API.


    Send requests from your backend with `Authorization: Bearer <key>`. Keep the
    key in a secrets manager and out of email, support requests, and shared
    documents. Keys are scoped to approved operations and companies.


    Responses include `x-request-id`. Include that ID and the request timestamp
    when reporting a failed request; never include the key.
servers:
  - url: https://partner-api.rhythm.tryrima.com
    description: Rima
security: []
paths:
  /v1/companies/{companyId}/hello:
    get:
      summary: Hello world
      operationId: hello:read
      parameters:
        - name: companyId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Greeting
          content:
            application/json:
              schema:
                type: object
                required:
                  - message
                properties:
                  message:
                    type: string
                    example: Hello, world!
        '400':
          description: Invalid company ID
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: string
                    enum:
                      - invalid_company_id
        '401':
          description: Invalid API key
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: string
                    enum:
                      - invalid_api_key
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: string
                    enum:
                      - forbidden
        '429':
          description: Rate limited
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: string
                    enum:
                      - rate_limited
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````

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