OverviewPlatformsAPI Reference

SDKs

Official TypeScript and Python clients for the Rumoro API, or generate one from the OpenAPI document.


Rumoro has official clients for TypeScript and Python. Both are generated from the OpenAPI document that the API reference is built from. Each endpoint is one call with the same name, and requests and responses are typed. You need an API key.

LanguagePackageInstall
TypeScript@rumoro-dev/sdknpm install @rumoro-dev/sdk
Pythonrumoropip install rumoro

The TypeScript and Python guides cover the first call, errors, paging and async use.

Other languages

For Go, Java, Ruby, PHP, .NET, Rust or anything else, you have three options.

  1. Use the CLI. Each endpoint is a rumoro command that prints JSON. Any language that can start a process can call it, for example rumoro mentions:search --relevant true | your-script.
  2. Call the API directly. It uses a Bearer key, JSON requests and responses, one error format and camelCase field names. Conventions explains it all on one page.
  3. Generate your own client. Run OpenAPI Generator or Kiota on https://api.rumoro.dev/v1/openapi.json. Each operation id becomes a method, and each tag a group.

Versions

When the API changes, both clients and the CLI are generated again from the OpenAPI document and released together. The changelog says what changed.

Was this page helpful?

On this page