discovery

Cancel a running discovery job.

Stops a running discovery, releasing its concurrency slot so a new execute can start. Credits are refunded on the server side (see credits_refunded) only when the run had delivered zero prospects at cancel time; if prospects were already delivered you keep them and are not refunded. Those already-delivered prospects remain retrievable after cancellation via GET /mcp/jobs/{jobId}/result and GET /api/v1/discoveries/{jobId} (cancelled is a terminal state that carries its delivered results). Only the job's owner may cancel it. Cancelling an already-terminal job is a no-op that returns the job's current state.

post/mcp/jobs/{jobId}/cancel

Request

  • Base URL: https://api.prosp.cc
  • URL: https://api.prosp.cc/mcp/jobs/{jobId}/cancel
  • Auth: OAuth 2 (client credentials, token URL https://prosp-mcp-641053169627.auth.eu-central-1.amazoncognito.com/oauth2/token, scopes: mcp/execute)

Response

The job's post-cancel state (and any refund applied).

jobIdstring required

Id of the cancelled discovery.

status'queued' | 'running' | 'processing' | 'completed' | 'failed' | 'exhausted' | 'cancelled' required

Discovery lifecycle state. queued = accepted, not yet started; running and processing = discovery in progress; completed = finished and reached its target; failed = ended with an error; exhausted = finished but ran out of candidates before hitting the target; cancelled = stopped by the caller via POST /mcp/jobs/{jobId}/cancel. The last four are terminal.

credits_refundedinteger nullable

Credits returned to the caller's balance for the cancelled run. Null/0 when nothing was refundable.

credits_refund_reasonstring nullable

Human-readable reason the refund was (or was not) applied.

Changes

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