API Reference

Create a new SparkAI engagement

post deprecated
https://app.spark.ai/v1/engagement

This endpoint has been retired. Use /v2.

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

A correctly formatted image URL

string
enum

Optional content type. Defaults to image

Allowed:
string
required
length between 3 and 128

The associated program name with this engagement

uuid

Original engagement id, needed when re-submitting engagements

string
length between 3 and 1024

Optional instructions

uri

An optional well-formatted URL. The SparkAI service will POST status changes and results to this address.

metadata
object

A set of key-value pairs that can provide additional context to the request

priors
object

An optional set of properties to assist in the engagement request

Response

Updated about 2 months ago

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

Updated about 2 months ago