Create a new app job

POST

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

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

x-api-key

string

required

Example:

YOUR_API_KEY

User-Agent

string

optional

Example:

promptmate.io

Body Params application/json

Represents a request to create a new job for an app.

appId

string

optional

Application identifier for the job.

callBackUrl

string

optional

URL to which the result of the job will be sent.

noMailOnFinish

boolean

optional

Send an email to the user when the job has finished.

Default:

true

config

object

optional

Configuration settings for the job.

language

string

optional

Language setting for the job.

country

string

optional

Country setting for the job.

data

array[object (DataObject) {1}]

optional

Array of Objects. Each Object represents a request to process by the app. The Object must contain the required data fields for the app. It can also contain additional data fields that are not required by the app (e.g. for reference), all fields will be returned in the result.

Additional properties

string

optional

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

jobId

string

optional

Unique identifier for the job.

jobStatus

enum<string>

optional

Current status of the job.

Allowed values:

queuederror

Example

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

🟠400Bad Request

🔴500Server Error

Get app

Get job status and result