API Documentation
Welcome to the API documentation page.
API
URL
https://app.wordware.ai/api/released-app/2afc45cc-578b-4e27-ab2f-83c1b8b05a4b/runRequest Body
You have to pass two parameters to the request body: inputs and version.
Inputs
These are the inputs for this WordApp:
- Company Description (text)
- URL (text)
Version
We use a simplified semantic versioning. All versions follow the format <major>.<minor>, for example 4.2.
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.2. We recommend you use this syntax when you build your APIs. Example:
{"version": "^4.2"}Complete Body
The whole request body looks like this:
{ "inputs": { "Company Description": "<text_value>", "URL": "<text_value>" }, "version": "^4.2" }
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/2afc45cc-578b-4e27-ab2f-83c1b8b05a4b/run-H "Authorization: Bearer $WORDWARE_API_KEY"-d '{"inputs":{"Company Description":"<text_value>","URL":"<text_value>"},"version":"^4.2"}'
