API Reference

Get status of a SparkAI engagement

get
https://app.spark.ai/v1/engagement

This API call can be used to poll for the status of any ongoing or completed SparkAI engagement requested by the user.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
number
1 to 50

Limit the number of responses, up to 50

boolean

Return the total count of the query, instead of results

number

Obtain results beginning at the cursor

string

Query by program name

string

Query by system ID

string

Query by metadata values (uses AND logical operator) [keys]

string

Query by metadata (uses AND logical operator) [values]

string
enum

State of engagement

Allowed:
string

Return engagements created after date. Extended ISO 8601 date format.

string

Return engagements created before date. Extended ISO 8601 date format.

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