Run a Spark on a conversation

post

https://public-api.production.liveswitch.com/v1/conversations/{conversationId}/sparks

Required scope: sparks.write

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

This endpoint creates a Spark run on a Conversation.
If media is not available, the Spark run waits in the queue.
The Spark run starts automatically when media arrives.
The initial status is always "queued".

If the Spark template has user inputs (requiresUserInput: true), first validate them with POST /v1/spark-templates/{sparkTemplateId}/validate-inputs.
Then send the validation token from validationToken in that response.
Do not send tasks with the validation token.

If the Spark template has no user inputs, a validation token is not necessary.

Path Params

conversationId

uuid

required

Body Params

sparkTemplateId

string | null

The ID of the Spark template to run. Obtain available IDs from GET /v1/spark-templates.

tasks

array of objects | null

Input values for tasks in the Spark template, sent only with skipInputValidation: true. Normally, validate
the inputs first with POST /v1/spark-templates/{id}/validate-inputs and send its validationToken instead.
The Spark runs with the template's default task selection, matching Contact Admin.
Identify each task with tasks[].codeName from GET /v1/spark-templates.

tasks

validationToken

string | null

The token returned by POST /v1/spark-templates/{id}/validate-inputs. The Spark runs with the inputs that were
validated, without validating them again. Required when the Spark template has user inputs, unless
skipInputValidation is true; not needed for a template with no user inputs. Do not send tasks with
it. Valid for 24 hours, and only until the Spark template's tasks or inputs change.

skipInputValidation

boolean

Set to true to run with tasks as sent, without validating them (no validation token needed).
Default false: send a validationToken from POST /v1/spark-templates/{id}/validate-inputs.

shareWith

array of strings | null

Optional sharing targets for the completed Spark.
Accepted values: ["anyone"] to generate a public share URL.
Omit or pass an empty array for no public sharing.

shareWith

Response

202Accepted