Ask a Question

POST https://app.resemble.ai/api/v2/detects/{uuid}/intelligence

Submit a natural-language question about a completed detection report. The API responds immediately with a question UUID while the answer is generated in the background.

Path Parameters

Request Body

Example

$
curl --request POST 'https://app.resemble.ai/api/v2/detects/DETECTION_UUID/intelligence' \
>
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
>
  -H 'Content-Type: application/json' \
>
  --data '{"query": "Summarize the detection results in plain language."}'

Response (202 Accepted)

1
{
2
  "success": true,
3
  "item": {
4
    "uuid": "QUESTION_UUID",
5
    "detect_uuid": "DETECTION_UUID",
6
    "query": "Summarize the detection results in plain language.",
7
    "answer": null,
8
    "status": "pending",
9
    "error_message": null,
10
    "created_at": "2024-01-15T10:35:00Z",
11
    "updated_at": "2024-01-15T10:35:00Z"
12
  }
13
}

Use the returned uuid to poll the Get Answer endpoint until the answer is ready.

Error Responses