JAjasper
Templates

Retrieve template by ID

Retrieve an individual default or custom template available in your workspace by ID

get/v1/templates/{templateId}

Request

  • Base URL
    https://api.jasper.ai
  • URL
    https://api.jasper.ai/v1/templates/{templateId}
  • Auth
    • API key in header X-API-Key
    • or OAuth 2
      Authorization code: https://api.jasper.ai/oauth2/authorize
      Token URL: https://api.jasper.ai/oauth2/token scopes: user

Path parameters

templateIdstring required

Response

Retrieve template by ID

requestIdstring
resourcestring

Example response

{
  "requestId": "bce766ea-a4ef-48e5-9da1-d9602bfecf2d",
  "resource": "template",
  "data": {
    "id": "skl_03a2b34578094db09dd806e49f2e15d1",
    "name": "Product Descriptions",
    "description": "Create compelling product descriptions to be used on websites, emails and social media.",
    "responseFormats": [
      "text",
      "json"
    ],
    "inputSchema": [
      {
        "inputKey": "productName",
        "type": "string",
        "required": true,
        "label": "Product Name",
        "placeholder": "Sherlock Holmes Adventure Escape Room",
        "tooltip": "This should match the product name found in our company catalog.",
        "options": [
          {
            "label": "First Option",
            "value": "option1"
          }
        ]
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.