Lists templates

GET

https://api.promptmate.io/v1/templates

templates

Returns a list of available templates with an optional filter for public templates. Rate limit is 500 requests per minute.

Request

Authorization

Add parameter in header

x-api-key

Example:

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

Query Params

showPublicTemplates

boolean

optional

Return Public templates

Default:

true

showPrivateTemplates

boolean

optional

Return Private templates

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

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

A list of templates

Body

array of:

string

optional

Unique identifier for the template.

templateCategory

string

optional

Category of the template, indicating its general use case.

templateName

string

optional

Name of the template.

dataFields

array[string]

optional

List of data fields required by the template.

templateDescription

string

optional

Description of the template, which may include HTML content.

templateVideo_url

string

optional

URL of a video associated with the template, if any.

templateType

string

optional

Type of the template, e.g., 'private' or 'public'.

Example

[
    {
        "id": "string",
        "templateCategory": "string",
        "templateName": "string",
        "dataFields": [
            "string"
        ],
        "templateDescription": "string",
        "templateVideo_url": "string",
        "templateType": "string"
    }
]

🔴500Server Error

Get job status and result

Use a specific template