Validates the inputs for a Spark template

Validates the inputs for running a Spark template: the task inputs, and that the platforms its tasks need are
connected. Nothing is run. On success, send the returned validationToken when running the Spark (POST
/v1/conversations/{id}/sparks or /v1/projects/{id}/sparks): it carries these inputs, so the run does not validate
them again. The token is valid for 24 hours, and only until the Spark template changes.

Required scope: sparks.write

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

This endpoint validates the task inputs for a Spark template.
It also checks that the platforms for the tasks are connected.
This endpoint does not start a Spark run.

If the inputs are valid, the response contains a validation token in validationToken.
Send this validation token in POST /v1/conversations/{conversationId}/sparks or POST /v1/projects/{projectId}/sparks.

The validation token is valid for 24 hours.
It becomes invalid earlier if the Spark template changes.
While the validation token is valid, you can send it in more than one create call.
Each call starts a new Spark run with the same Spark template and inputs.

If an input is invalid, the API returns 422.
The errors.tasks[].inputs object gives the errors for each input key.

Path Params
uuid
required

The Spark template id from GET /v1/spark-templates.

Body Params

The task inputs, exactly as for running a Spark.

tasks
array of objects | null

Input values for tasks in the Spark template, exactly as for running a Spark.
Identify each task with tasks[].codeName from GET /v1/spark-templates.

tasks
Responses

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