OpenAPI Documentation

The full Raisetalk API documentation is available in OpenAPI format at the following URL: https://api.raisetalk.com/docs.

It is generated automatically from the API source code and updated on every deployment, which ensures it always faithfully reflects the actual behavior of the exposed endpoints.

The raw specification file is also available at https://api.raisetalk.com/openapi.yaml.

Generate an SDK

From this OpenAPI specification, it is easy to generate a client SDK in virtually any language (PHP, Python, TypeScript, Java, Go, Ruby, C#, etc.) using the openapi-generator-cli tool.

Example to generate a PHP SDK:

docker run --rm \
  -v "${PWD}:/local" \
  openapitools/openapi-generator-cli generate \
  -i https://api.raisetalk.com/openapi.yaml \
  -g php \
  -o /local/sdk/php

To switch to a different target language, simply change the value of the -g parameter (for example -g python, -g typescript-axios, -g java, etc.).

The full list of available generators and the detailed tool documentation can be found on the official website: https://openapi-generator.tech/.