Sign in
v1

Get Niche Dive status

Retrieves the current status of a Niche Dive analysis. Returns different response schemas based on the Dive state: in_progress (with estimated completion time), success (with nicheId and token usage), or error (with error details). Poll this endpoint to track the progress of a Dive until completion.

get/v1/niches/dives/{diveId}

Path parameters

diveIdstring required

The unique identifier of the Dive

Response

OR
OR

Example response

{
  "diveId": "xxxxxxxxxxxxxxxxxxxxxxxxxx",
  "status": "in_progress",
  "nicheId": "HdNCcryRCs",
  "tokensUsed": 30,
  "tokensLeft": 1000
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.