Logo
banner image
Public

API Documentation

Welcome to the API documentation page.

API

URL

https://app.wordware.ai/api/released-app/bbdf0d52-f332-435a-8067-53311e285ee4/run

Request Body

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

Inputs

These are the inputs for this WordApp:

  • company_url (<string>)
  • competitor_url (<string>)
  • template_url (<string>)
  • content_length (<string>)
  • keywords_csv (<string>)
  • specific_page (<string>)

Version

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

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: ^4.0. We recommend you use this syntax when you build your APIs. Example:

{"version": "^4.0"}

Complete Body

The whole request body looks like this:

{ "inputs": { "company_url": "<string>", "competitor_url": "<string>", "template_url": "<string>", "content_length": "<string>", "keywords_csv": "<string>", "specific_page": "<string>" }, "version": "^4.0" }

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/bbdf0d52-f332-435a-8067-53311e285ee4/run
-H "Authorization: Bearer $WORDWARE_API_KEY"
-d '{"inputs":{"company_url":"<string>","competitor_url":"<string>","template_url":"<string>","content_length":"<string>","keywords_csv":"<string>","specific_page":"<string>"},"version":"^4.0"}'