Poll a sourcing brief

Returns the brief's status and progress while it runs, and the full result once it is complete or partial. partial means the whole brief did not run: a ceiling was hit (search calls or time budget), a batch held more ranked rows than the run could read (coverage.truncated), or evidence was still building. Report the regions actually covered rather than claiming exhaustive coverage. Debits 0 monthly credits; every call still passes the daily cap. Only the account that submitted the brief can read it; anyone else gets the same 404 as a brief that does not exist.

get/v1/briefs/{briefId}

Request

  • Base URL: https://api.githunt.ai
  • URL: https://api.githunt.ai/v1/briefs/{briefId}
  • Auth: one of:
    • HTTP bearer
    • API key in header X-Api-Key

Path parameters

briefIdstring uuid required

The brief_id returned by POST /v1/briefs

Response

Brief status. Carries result when status is complete or partial, and retry_after_seconds while it is still running.

successtrue

Example response

{
  "meta": {
    "quota": {
      "month": "2026-07",
      "cost": 1,
      "rollover": 340
    }
  }
}

Changes

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