OpenAPI contract | Raims Documentation

The raimshq/openapi repository publishes the OpenAPI contract for the Raims API version available to integrations. Use this contract to inspect endpoint structures, import the reference into a compatible tool or generate a client for your project.

The latest directory tracks the API version that is actually published. It does not include changes that exist only in source code.

Available files

JSON
YAML

Both files describe the same contract. Choose the format accepted by your tool.

Download or import

To download the JSON file:

Shell

curl --fail --location --output openapi.spec3.json https://raw.githubusercontent.com/raimshq/openapi/main/latest/openapi.spec3.json

In Postman, Insomnia or another OpenAPI 3 compatible tool, choose the option to import from a URL and enter the JSON or YAML address. If the tool accepts only local files, download either format and import it from disk.

The contract describes Bearer authentication but contains no credentials. Configure your key in the tool's secure environment and do not save it in an exported collection.

Generate a client

Use the downloaded file as input for an OpenAPI 3 compatible generator. For example, with the OpenAPI Generator CLI:

Shell

openapi-generator-cli generate \
  -i openapi.spec3.json \
  -g YOUR_GENERATOR \
  -o ./generated/raims

Choose the generator for the language and library used by your project. Review the generated code, keep the generator configuration under version control and run your integration tests before updating your application. This client belongs to your project and is not an official Raims SDK.

Keep the contract up to date

Use the main/latest addresses on this page to download the current contract, including for code generation and CI. Download the file again before generating the client to follow the published API version.

Review the contract diff, regenerate the client and run your integration tests before updating your application. Downloading a new contract does not automatically change code already generated in your project.