API Documentation
Welcome to the API documentation page.
API
URL
https://app.wordware.ai/api/released-app/c76b7a5e-d8f1-4a4b-8b76-884e1d5fb7d7/runRequest 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>)
Version
We use a simplified semantic versioning. All versions follow the format <major>.<minor>, for example 1.8.
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: ^1.8. We recommend you use this syntax when you build your APIs. Example:
{"version": "^1.8"}Complete Body
The whole request body looks like this:
{ "inputs": { "company url": "<string>" }, "version": "^1.8" }
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/c76b7a5e-d8f1-4a4b-8b76-884e1d5fb7d7/run-H "Authorization: Bearer $WORDWARE_API_KEY"-d '{"inputs":{"company url":"<string>"},"version":"^1.8"}'
