API Documentation
Welcome to the API documentation page.
API
URL
https://app.wordware.ai/api/released-app/b47cd8ee-3dfe-4c10-8b1e-f7647d7bb13f/runRequest Body
You have to pass two parameters to the request body: inputs and version.
Inputs
These are the inputs for this WordApp:
- Name (<string>)
- Host (<string>)
Version
We use a simplified semantic versioning. All versions follow the format <major>.<minor>, for example 1.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: ^1.5. We recommend you use this syntax when you build your APIs. Example:
{"version": "^1.5"}Complete Body
The whole request body looks like this:
{ "inputs": { "Name": "<string>", "Host": "<string>" }, "version": "^1.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/b47cd8ee-3dfe-4c10-8b1e-f7647d7bb13f/run-H "Authorization: Bearer $WORDWARE_API_KEY"-d '{"inputs":{"Name":"<string>","Host":"<string>"},"version":"^1.5"}'
