Logo
banner image
Public

API Documentation

Welcome to the API documentation page.

API

URL

https://app.wordware.ai/api/released-app/fda1ba91-b363-4814-a4e3-a997afef7949/run

Request Body

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

Inputs

This WordApp doesn't take any inputs.

    Version

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

    {"version": "^1.0"}

    Complete Body

    The whole request body looks like this:

    { "inputs": {}, "version": "^1.0" }

    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/fda1ba91-b363-4814-a4e3-a997afef7949/run
    -H "Authorization: Bearer $WORDWARE_API_KEY"
    -d '{"inputs":{},"version":"^1.0"}'