Logo
banner image
Public

API Documentation

Welcome to the API documentation page.

API

URL

https://app.wordware.ai/api/released-app/4d32b258-f032-4da9-a574-a3ac1e79c19e/run

Request Body

You have to pass two parameters to the request body: inputs and version.

Inputs

These are the inputs for this WordApp:

  • image ({ "type": "file", "file_type": "<string>", "file_url": "<string>", "file_name": "<string>" })

Version

We use a simplified semantic versioning. All versions follow the format <major>.<minor>, for example 1.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: ^1.2. We recommend you use this syntax when you build your APIs. Example:

{"version": "^1.2"}

Complete Body

The whole request body looks like this:

{ "inputs": { "image": { "type": "image", "image_url": "<image_url>" } }, "version": "^1.2" }

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/4d32b258-f032-4da9-a574-a3ac1e79c19e/run
-H "Authorization: Bearer $WORDWARE_API_KEY"
-d '{"inputs":{"image":{"type":"image","image_url":"<image_url>"}},"version":"^1.2"}'