promptmate.io API
  1. apps
promptmate.io API
  • apps
    • Lists apps
      GET
    • Get app
      GET
  • app-jobs
    • Create a new app job
      POST
    • Get job status and result
      GET
  • templates
    • Lists templates
      GET
    • Use a specific template
      POST
  • reference
    • Lists available languages
      GET
    • Lists available countries
      GET
  • projects
    • Lists projects
      GET
  • webhooks
    • Lists webhooks
      GET
    • Creates a webhook
      POST
    • Deletes a webhook
      DELETE
  • app-results
    • Get last result rows of an app (e.g. as examples)
      GET
  • userInfo
    • get user information
      GET
  1. apps

Get app

GET
https://api.promptmate.io/v1/app
apps
Delivers information and structure of the app. Rate limit is 500 requests per minute.

Request

Authorization
Add parameter in header
x-api-key
Example:
x-api-key: ********************
Query Params
appId
string 
required
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
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.promptmate.io/v1/app?appId' \
--header 'x-api-key;'

Responses

🟢200OK
application/json
App information
Body
Represents an app with its basic details.
appId
string 
optional
Unique identifier for the app.
appName
string 
optional
Name of the app.
creditEstimate
integer 
optional
Estimated credit usage for the app per row.
dataFields
array[string]
optional
List of data fields required by the app.
responseFields
array [object] 
optional
List of data fields returned by the app.
Example
{
    "appId": "string",
    "appName": "string",
    "creditEstimate": 0,
    "dataFields": [
        "string"
    ],
    "responseFields": [
        {}
    ]
}
🟠404Record Not Found
🔴500Server Error
Previous
Lists apps
Next
Create a new app job
Built with