Welcome to the API documentation page.
https://app.wordware.ai/api/released-app/0714f82b-c171-4bed-84ec-51e77d7156f0/runYou have to pass two parameters to the request body: inputs and version.
These are the inputs for this WordApp:
We use a simplified semantic versioning. All versions follow the format <major>.<minor>, for example 3.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: ^3.0. We recommend you use this syntax when you build your APIs. Example:
{"version": "^3.0"}The whole request body looks like this:
{ "inputs": { "document": { "type": "file", "file_type": "application/pdf", "file_url": "<file_url>", "file_name": "<string>" }, "party": "<string>" }, "version": "^3.0" }
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>Use this cURL command to send your request:
curl -X POST https://app.wordware.ai/api/released-app/0714f82b-c171-4bed-84ec-51e77d7156f0/run-H "Authorization: Bearer $WORDWARE_API_KEY"-d '{"inputs":{"document":{"type":"file","file_type":"application/pdf","file_url":"<file_url>","file_name":"<string>"},"party":"<string>"},"version":"^3.0"}'