Logo
banner image
Public

API Documentation

Welcome to the API documentation page.

API

URL

https://app.wordware.ai/api/released-app/2436ad08-5374-4750-a0f9-105080ff97ea/run

Request Body

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

Inputs

These are the inputs for this WordApp:

  • tweets (longtext)
  • profilePicture (image)
  • profileInfo (longtext)

Version

We use a simplified semantic versioning. All versions follow the format <major>.<minor>, for example 2.1.

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: ^2.1. We recommend you use this syntax when you build your APIs. Example:

{"version": "^2.1"}

Complete Body

The whole request body looks like this:

{ "inputs": { "tweets": "<longtext_value>", "profilePicture": { "type": "\"image\"", "image_url": "<string>" }, "profileInfo": "<longtext_value>" }, "version": "^2.1" }

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/2436ad08-5374-4750-a0f9-105080ff97ea/run
-H "Authorization: Bearer $WORDWARE_API_KEY"
-d '{"inputs":{"tweets":"<longtext_value>","profilePicture":{"type":"\"image\"","image_url":"<string>"},"profileInfo":"<longtext_value>"},"version":"^2.1"}'