API Reference

Run template

post
https://api.jasper.ai/v1/templates//run

Run a default template or custom template by ID to generate an AI output. See our guide on Using Templates for tips on getting started.

Path Params
string
required

The template's unique ID

Body Params
inputs
object
required

A template's inputs. The required inputs for the given template should match it's inputKey values, which are available in the response from a GET request to templates. In addition, a tone can be optionally applied to any template.

options
object

The schema of a template's allowed inputs.

Responses

400

Bad Request. May need to check that the request body corresponds with the input schema for the template you are trying to complete.

404

Not found. May be due to an incorrect URL path.

500

Internal server error. Unable to generate outputs for specified template.

Updated 6 months ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago