Create a new app job

POST

https://api.promptmate.io/v1/app-jobs

Create a new job for an app with specific configuration. Rate limit is 50 requests per minute.

Request

Authorization

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Header Params

Body Params application/json

Example

{
    "appId": "string",
    "callBackUrl": "string",
    "noMailOnFinish": true,
    "config": {
        "language": "string",
        "country": "string"
    },
    "data": [
        {
            "property1": "string",
            "property2": "string"
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.promptmate.io/v1/app-jobs' \
--header 'Content-Type: application/json' \
--header 'x-api-key;' \
--data-raw '{
    "appId": "string",
    "callBackUrl": "string",
    "noMailOnFinish": true,
    "config": {
        "language": "string",
        "country": "string"
    },
    "data": [
        {
            "property1": "string",
            "property2": "string"
        }
    ]
}'

Responses

🟢201Created

application/json

Job created

Body

Example

{
    "jobId": "string",
    "jobStatus": "queued"
}

🟠400Bad Request

🔴500Server Error

Modified at 2025-05-17 10:21:41

Get app

Get job status and result