DealerAI
API Reference

Execute a predefined assistant task

Runs the predefined assistant task identified by taskKey using the parameters supplied in the request body, and returns the task result. Use the predefined-tasks list endpoint to discover valid task keys and their expected parameters.

POST
/api/v1/assistant/predefined-tasks/{taskKey}/execute

Authorization

basic
AuthorizationBasic <token>

Basic Authorization header

In: header

Path Parameters

taskKey*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://api.dealerai.com/api/v1/assistant/predefined-tasks/string/execute" \  -H "Content-Type: application/json" \  -d '{}'
{
  "task_key": "string",
  "dealer_id": "string",
  "status": "string",
  "completed_date": "2019-08-24T14:15:22Z",
  "output": "string"
}
{
  "message": "string",
  "details": null
}
{
  "message": "string",
  "details": null
}
{
  "message": "string",
  "details": null
}

List predefined assistant tasks

Returns the catalog of predefined assistant tasks available to your account, including each task key and the parameters it accepts. Use a task key with the execute endpoint to run it.

Get assistant capabilities

Returns the capabilities the AI assistant currently supports for your account, such as available tools, data sources, and predefined task categories. Use this to discover what the assistant can do before starting a thread.