Apicat Docs
  1. Dynamic values Modules
Apicat Docs
  • What is Apicat?
  • Send requests
    • Create requests
      • Request basics
      • Parameters and body
      • Request headers
      • Request settings
      • Dynamic values
      • HTTP/2
      • SOAP/WebService
    • Authentication and authorization
      • Overview
      • CA and client certificates
      • Authorization types supported by Apidog
      • Digest Auth
      • OAuth 1.0
      • OAuth 2.0
      • Hawk Authentication
      • Kerberos
      • NTLM
      • Akamai EdgeGrid
    • Response and cookies
      • Overview
      • API response in Apidog
      • Create and send cookies
      • Debug requests
    • Dynamic values Modules
      • Airline
      • Animal
      • Color
      • Commerce
      • Company
      • Database
      • Datatype
      • Date
      • Finance
      • Food
      • Git
      • Hacker
      • Helpers
      • Image
      • Internet
      • Location
      • Lorem
      • Music
      • Number
      • Person
      • Phone
      • Science
      • String
      • System
      • Vehicle
      • Word
  • Environments & variables
    • Overview
    • Using variables
    • Environments & services
  • Pre/Post processors
    • Overview
    • Assertion
    • Extract variable
    • Wait
    • Database operations
      • Overview
      • MySQL
      • MongoDB
      • Redis
      • Oracle Client
    • Using scripts
      • Overview
      • Pre processor scripts
      • Post processor scripts
      • Public scripts
      • Postman scripts reference
      • Calling other programming languages
      • Using JS libraries
      • Visualizing responses
      • Script examples
        • Assertion scripts
        • Using variables in scripts
        • Using scripts to modify request messages
        • Other examples
  • Best practices
    • How to handle API signatures
    • How to access OAuth 2.0 protected APIs
    • Apidog collaboration workflow
    • Managing authentication state in Apidog
  • Account & preferences
    • Account settings
    • Generate OpenAPI access token
    • Language settings
    • Hot keys
    • Network proxy configuration
    • Data backup
    • Updating Apidog
    • Deleting account
    • Experimental Features
  • References
    • API-Design First Approach
    • Apidog OpenAPI/Swagger Specificaiton Extensions
    • JSONPath
    • XPath
    • Regular Expressions
    • JSON Schema
    • CSV File Format
    • Install Java Environment
    • Runner deployment environment
    • Apidog flavored Markdown
  1. Dynamic values Modules

Word

Module to return various types of words.

adjective#

Returns a random adjective.
Parameters
NameTypeDefaultDescription
lengthnumberThe expected length of the word.
minnumberThe minimum length of the word.
maxnumberThe maximum length of the word.
strategy'fail' | 'closest' | 'shortest' | 'longest' | 'any-length''any-length'The strategy to apply when no words with a matching length are found. Available error handling strategies:- fail: Throws an error if no words with the given length are found.- shortest: Returns any of the shortest words.- closest: Returns any of the words closest to the given length.- longest: Returns any of the longest words.- any-length: Returns a word with any length.
Returns: string
Examples

adverb#

Returns a random adverb.
Parameters
NameTypeDefaultDescription
lengthnumberThe expected length of the word.
minnumberThe minimum length of the word.
maxnumberThe maximum length of the word.
strategy'fail' | 'closest' | 'shortest' | 'longest' | 'any-length''any-length'The strategy to apply when no words with a matching length are found. Available error handling strategies:- fail: Throws an error if no words with the given length are found.- shortest: Returns any of the shortest words.- closest: Returns any of the words closest to the given length.- longest: Returns any of the longest words.- any-length: Returns a word with any length.
Returns: string
Examples

conjunction#

Returns a random conjunction.
Parameters
NameTypeDefaultDescription
lengthnumberThe expected length of the word.
minnumberThe minimum length of the word.
maxnumberThe maximum length of the word.
strategy'fail' | 'closest' | 'shortest' | 'longest' | 'any-length''any-length'The strategy to apply when no words with a matching length are found. Available error handling strategies:- fail: Throws an error if no words with the given length are found.- shortest: Returns any of the shortest words.- closest: Returns any of the words closest to the given length.- longest: Returns any of the longest words.- any-length: Returns a word with any length.
Returns: string
Examples

interjection#

Returns a random interjection.
Parameters
NameTypeDefaultDescription
lengthnumberThe expected length of the word.
minnumberThe minimum length of the word.
maxnumberThe maximum length of the word.
strategy'fail' | 'closest' | 'shortest' | 'longest' | 'any-length''any-length'The strategy to apply when no words with a matching length are found. Available error handling strategies:- fail: Throws an error if no words with the given length are found.- shortest: Returns any of the shortest words.- closest: Returns any of the words closest to the given length.- longest: Returns any of the longest words.- any-length: Returns a word with any length.
Returns: string
Examples

preposition#

Returns a random preposition.
Parameters
NameTypeDefaultDescription
lengthnumberThe expected length of the word.
minnumberThe minimum length of the word.
maxnumberThe maximum length of the word.
strategy'fail' | 'closest' | 'shortest' | 'longest' | 'any-length''any-length'The strategy to apply when no words with a matching length are found. Available error handling strategies:- fail: Throws an error if no words with the given length are found.- shortest: Returns any of the shortest words.- closest: Returns any of the words closest to the given length.- longest: Returns any of the longest words.- any-length: Returns a word with any length.
Returns: string
Examples

sample#

Returns a random word, that can be an adjective, adverb, conjunction, interjection, noun, preposition, or verb.
Parameters
NameTypeDefaultDescription
lengthnumberThe expected length of the word.
minnumberThe minimum length of the word.
maxnumberThe maximum length of the word.
strategy'fail' | 'closest' | 'shortest' | 'longest' | 'any-length''any-length'The strategy to apply when no words with a matching length are found. Available error handling strategies:- fail: Throws an error if no words with the given length are found.- shortest: Returns any of the shortest words.- closest: Returns any of the words closest to the given length.- longest: Returns any of the longest words.- any-length: Returns a word with any length.
Returns: string
Examples

verb#

Returns a random verb.
Parameters
NameTypeDefaultDescription
lengthnumberThe expected length of the word.
minnumberThe minimum length of the word.
maxnumberThe maximum length of the word.
strategy'fail' | 'closest' | 'shortest' | 'longest' | 'any-length''any-length'The strategy to apply when no words with a matching length are found. Available error handling strategies:- fail: Throws an error if no words with the given length are found.- shortest: Returns any of the shortest words.- closest: Returns any of the words closest to the given length.- longest: Returns any of the longest words.- any-length: Returns a word with any length.
Returns: string
Examples

words#

Returns a random string containing some words separated by spaces.
Parameters
NameTypeDefaultDescription
countnumber{ min: 1, max: 3 }The number of words to return.
minnumberThe minimum length of the word.
maxnumberThe maximum length of the word.
Returns: string
Examples

Modified at 2025-06-25 07:57:16
Previous
Vehicle
Next
Overview
Built with