Logo
banner image
Public

API Documentation

Welcome to the API documentation page.

API

URL

https://app.wordware.ai/api/released-app/d246e436-a40d-49a2-bcf1-6508b7be29c2/run

Request Body

You have to pass two parameters to the request body: inputs and version.

Inputs

These are the inputs for this WordApp:

  • Topic (<string>)
  • Count of Words (<string>)
  • English Level (<string>)

Version

We use a simplified semantic versioning. All versions follow the format <major>.<minor>, for example 3.5.

You have to pass the version number you want to use. You can use the caret syntax like this to get the latest non-breaking version: ^3.5. We recommend you use this syntax when you build your APIs. Example:

{"version": "^3.5"}

Complete Body

The whole request body looks like this:

{ "inputs": { "Topic": "<string>", "Count of Words": "<string>", "English Level": "<string>" }, "version": "^3.5" }

Testing

Setup

To get started, export your API key in your terminal. You can generate a key here.

You can then export it from your terminal:

export WORDWARE_API_KEY=<your_api_key>

cURL

Use this cURL command to send your request:

curl -X POST https://app.wordware.ai/api/released-app/d246e436-a40d-49a2-bcf1-6508b7be29c2/run
-H "Authorization: Bearer $WORDWARE_API_KEY"
-d '{"inputs":{"Topic":"<string>","Count of Words":"<string>","English Level":"<string>"},"version":"^3.5"}'