Get job status and result - promptmate.io API

Request

Authorization

Add parameter in header

x-api-key

Example:

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

Query Params

appId

string

required

jobId

string

required

onlyDefaultResultFields

boolean

optional

Return only the default result fields (if set)

Default:

true

Header Params

x-api-key

string

required

Example:

YOUR_API_KEY

User-Agent

string

optional

Example:

promptmate.io

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200OK

application/json

Job status and result

Body

jobId

string

optional

Unique identifier for the job.

jobStatus

enum<string>

optional

Current status of the job.

Allowed values:

queuedrunningfinishederror

processedRowCount

integer

optional

The number of rows that have been processed.

requestedRowCount

integer

optional

The total number of rows requested to be processed.

stepCount

integer

optional

The total number of steps involved in the job (only available if one row is submitted)

executingStep

integer

optional

The current step being executed (only available if one row is submitted).

actualStep

string

optional

Description or identifier of the actual step being performed (only available if one row is submitted).

appId

string

optional

Application identifier associated with the job.

dataProcessType

string

optional

Type of query being executed, e.g., single (if one row is submitted) or bulk.

resultData

array [object {1}]

optional

Array of result objects with dynamic fields and values. This field is optional and is only returned after the job has finished.

Additional properties

string

optional

responseFields

array [object]

optional

List of data fields returned by the app.

Example

{
    "jobId": "string",
    "jobStatus": "queued",
    "processedRowCount": 0,
    "requestedRowCount": 0,
    "stepCount": 0,
    "executingStep": 0,
    "actualStep": "string",
    "appId": "string",
    "dataProcessType": "string",
    "resultData": [
        {
            "property1": "string",
            "property2": "string"
        }
    ],
    "responseFields": [
        {}
    ]
}

🟠404Record Not Found

🔴500Server Error