← Back

API Documentation

This API allows you to generate random release names. You can specify an adjective, a noun, a separator, and the casing.

Endpoint

GET https://www.releasename.dev/api/generate

Query Parameters

  • adjective (string, optional): The adjective to use, or random if empty
  • noun (string, optional): The noun to use, or random if empty
  • separator (string, optional): Separator between words. Default is -
  • adjective_casing (string, optional): Casing for the adjective. One of lowercase, uppercase, capitalized. Default is capitalized
  • noun_casing (string, optional): Casing for the noun. One of lowercase, uppercase, capitalized. Default is capitalized

Example

/api/generate?adjective=release&noun=name&separator=%2B&adjective_casing=uppercase&noun_casing=lowercase

Response

{"name": "RELEASE+name"}