API Documentation
Welcome to the API documentation page.
API
URL
https://app.wordware.ai/api/released-app/63e0d602-4404-46b3-a8ad-96e11f5efc7a/runRequest Body
You have to pass two parameters to the request body: inputs and version.
Inputs
These are the inputs for this WordApp:
- Contract (<string>)
- Listing (<string>)
Version
We use a simplified semantic versioning. All versions follow the format <major>.<minor>, for example 3.9.
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.9. We recommend you use this syntax when you build your APIs. Example:
{"version": "^3.9"}Complete Body
The whole request body looks like this:
{ "inputs": { "Contract": "<string>", "Listing": "<string>" }, "version": "^3.9" }
Testing
Setup
To get started, export your API key in your terminal. When logged in you can find it in your .
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/63e0d602-4404-46b3-a8ad-96e11f5efc7a/run-H "Authorization: Bearer $WORDWARE_API_KEY"-d '{"inputs":{"Contract":"<string>","Listing":"<string>"},"version":"^3.9"}'
