Properties
| Name | Type | Description |
|---|---|---|
| success | boolean | |
| data | object | |
| meta | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/githunt-ai/json-schema/githunt-ai-brief-status-response-schema.json",
"title": "BriefStatusResponse",
"x-generated": "2026-10-30",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/githunt-ai-openapi.yaml#/components/schemas/BriefStatusResponse",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"const": true
},
"data": {
"type": "object",
"properties": {
"brief_id": {
"type": "string",
"format": "uuid"
},
"status": {
"type": "string",
"enum": [
"queued",
"running",
"complete",
"partial",
"failed"
]
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"progress": {
"type": "object",
"description": "Live counters while the run is in flight.",
"properties": {
"phase": {
"type": "string",
"enum": [
"queued",
"search",
"evidence",
"done",
"failed"
]
},
"searches_done": {
"type": "integer"
},
"searches_planned": {
"type": "integer"
},
"candidates": {
"type": "integer"
},
"shortlisted": {
"type": "integer"
},
"evidence_ready": {
"type": "integer"
},
"evidence_pending": {
"type": "integer"
}
}
},
"retry_after_seconds": {
"type": "integer",
"description": "Present while the brief is still running."
},
"error": {
"type": "string",
"description": "Present when `status` is `failed`."
},
"result": {
"$ref": "#/$defs/BriefResult"
}
}
},
"meta": {
"$ref": "#/$defs/Meta"
}
},
"$defs": {
"BriefCard": {
"type": "object",
"description": "One evidence-backed profile. Identity, verified skill evidence, public commercial signals, domain evidence, and a screening question for every unknown. Every status and reason comes from the same criterion rules `GET /v1/users/{login}/evidence` applies.",
"properties": {
"login": {
"type": "string"
},
"name": {
"type": [
"string",
"null"
]
},
"location": {
"type": [
"string",
"null"
]
},
"location_resolution": {
"type": [
"object",
"null"
],
"description": "How the stated base resolved at the run timestamp. Only `resolved` can be delivered; `ambiguous` and `unresolved` are screening leads.",
"properties": {
"status": {
"type": "string",
"enum": [
"resolved",
"ambiguous",
"unresolved"
]
},
"country": {
"type": [
"string",
"null"
]
},
"utc_offset": {
"type": [
"object",
"null"
]
},
"basis": {
"type": [
"string",
"null"
]
},
"screening_reason": {
"type": [
"string",
"null"
]
},
"observed_at": {
"type": "string"
}
}
},
"company": {
"type": [
"string",
"null"
]
},
"bio": {
"type": [
"string",
"null"
]
},
"hireable": {
"nullable": true
},
"profile_url": {
"type": "string"
},
"score": {
"type": [
"number",
"null"
]
},
"rank_breakdown": {
"type": [
"object",
"null"
],
"description": "Why the ranker placed this row where it did. Present when the brief named languages, skills, sectors, organizations or domains.",
"properties": {
"base": {
"type": "number",
"description": "Score before the evidence multipliers."
},
"recency": {
"type": "number"
},
"org": {
"type": "number"
},
"domain": {
"type": "number"
},
"final": {
"type": "number",
"description": "The value the ordering actually used."
}
}
},
"discovered_by": {
"type": "array",
"items": {
"type": "string"
},
"description": "Which location batches surfaced this candidate."
},
"evidence_status": {
"type": "string",
"enum": [
"cached",
"built",
"pending",
"skipped"
]
},
"evaluated_at": {
"type": [
"string",
"null"
]
},
"window": {
"type": [
"object",
"null"
]
},
"coverage": {
"type": [
"object",
"null"
],
"description": "The evidence scan's own coverage, as on the evidence endpoint."
},
"criteria": {
"type": [
"object",
"null"
],
"description": "The evidence report's criterion assessments, verbatim."
},
"skill_evidence": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"reason": {
"type": [
"string",
"null"
]
},
"inspected_in_window": {
"type": "integer",
"description": "Inspected candidate-authored in-window commits in a requested skill. One or more is what makes a card deliverable."
},
"last_commit": {
"type": [
"string",
"null"
]
},
"repos": {
"type": "array",
"items": {
"type": "object",
"properties": {
"repository": {
"type": "string"
},
"url": {
"type": "string"
},
"owner_type": {
"type": [
"string",
"null"
]
},
"commits_seen": {
"type": "integer"
},
"commits_in_window": {
"type": "integer"
},
"inspected": {
"type": "integer"
},
"last_commit": {
"type": [
"string",
"null"
]
}
}
}
},
"commits": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": [
"string",
"null"
]
},
"date": {
"type": [
"string",
"null"
]
},
"message": {
"type": [
"string",
"null"
]
},
"repository": {
"type": [
"string",
"null"
]
},
"files_changed": {
"type": [
"integer",
"null"
]
},
"code_languages": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
},
"commercial_signals": {
"type": "object",
"description": "Public context for paid work, never a tenure claim. `tenure_status` is `unknown` unless a dated, corroborated interval exists.",
"properties": {
"public_signals_only": {
"type": "boolean",
"const": true
},
"tenure_status": {
"type": "string"
},
"tenure_reason": {
"type": [
"string",
"null"
]
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"public_org_contribution",
"self_reported_employment",
"commit_email_domain"
]
},
"value": {
"type": "string"
},
"url": {
"type": [
"string",
"null"
]
},
"organization": {
"type": [
"string",
"null"
]
},
"company": {
"type": [
"string",
"null"
]
},
"interval": {
"type": [
"object",
"null"
]
},
"commits": {
"type": [
"integer",
"null"
]
},
"active_years": {
"type": "array",
"items": {
"type": "integer"
}
},
"languages": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
},
"domain_evidence": {
"type": "object",
"properties": {
"tier": {
"type": "string",
"enum": [
"core",
"adjacent",
"generic",
"none"
],
"description": "`core` only when the evidence report's `core_domain_recent` criterion is supported. A core term in a README or a commit subject is context and lands as `adjacent` at best."
},
"status": {
"type": "string"
},
"reason": {
"type": [
"string",
"null"
]
},
"subsystems": {
"type": "array",
"items": {
"type": "string"
}
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": [
"string",
"null"
]
},
"date": {
"type": [
"string",
"null"
]
},
"term": {
"type": "string"
},
"pack": {
"type": "string"
},
"subsystem": {
"type": [
"string",
"null"
]
},
"context": {
"type": [
"string",
"null"
]
},
"kind": {
"type": "string"
},
"repository": {
"type": [
"string",
"null"
]
}
}
}
}
}
},
"screening_questions": {
"type": "array",
"items": {
"type": "string"
}
},
"links": {
"type": "object",
"properties": {
"profile": {
"type": "string"
},
"blog": {
"type": "string"
},
"twitter": {
"type": "string"
}
}
}
}
},
"BriefResult": {
"type": "object",
"description": "Present once the brief is `complete` or `partial`.",
"properties": {
"cover": {
"type": "object",
"description": "The brief as run, plus the assumptions every claim below rests on.",
"properties": {
"brief_id": {
"type": "string"
},
"prepared_at": {
"type": "string",
"format": "date-time"
},
"criteria": {
"type": "object"
},
"geography": {
"type": "object"
},
"assumptions": {
"type": "array",
"items": {
"type": "string"
}
},
"delivered": {
"type": "integer"
},
"screening_leads": {
"type": "integer"
},
"requested_profiles": {
"type": "integer"
}
}
},
"summary": {
"type": "array",
"description": "One row per delivered profile, in delivery order.",
"items": {
"type": "object",
"properties": {
"rank": {
"type": "integer"
},
"login": {
"type": "string"
},
"name": {
"type": [
"string",
"null"
]
},
"location": {
"type": [
"string",
"null"
]
},
"utc_offset": {
"type": [
"object",
"null"
]
},
"last_skill_commit": {
"type": [
"string",
"null"
]
},
"inspected_in_window": {
"type": "integer"
},
"domain_tier": {
"type": "string",
"enum": [
"core",
"adjacent",
"generic",
"none"
]
},
"tenure_status": {
"type": "string"
},
"screening_questions": {
"type": "integer"
},
"recency": {
"type": [
"number",
"null"
],
"description": "The recency multiplier from `rank_breakdown`."
},
"org": {
"type": [
"number",
"null"
]
},
"domain": {
"type": [
"number",
"null"
]
}
}
}
},
"profiles": {
"type": "array",
"items": {
"$ref": "#/$defs/BriefCard"
}
},
"screening_leads": {
"type": "array",
"description": "Cards that did not meet a delivery rule, each with a `reason`. Overflow beyond `maxProfiles` appears here too.",
"items": {
"allOf": [
{
"$ref": "#/$defs/BriefCard"
},
{
"type": "object",
"properties": {
"reason": {
"type": "string"
}
}
}
]
}
},
"coverage": {
"type": "object",
"description": "What was actually searched. Never a claim of worldwide coverage.",
"properties": {
"regions_requested": {
"type": "array",
"items": {
"type": "string"
}
},
"countries_searched": {
"type": "array",
"items": {
"type": "string"
}
},
"countries_skipped": {
"type": "array",
"description": "Countries the region expansion produced that the brief would have discarded anyway, so no search was spent on them.",
"items": {
"type": "object",
"properties": {
"country": {
"type": "string"
},
"reason": {
"type": "string",
"enum": [
"excluded_location",
"utc_offset_band"
],
"description": "`excluded_location` - named in `excludeLocations`. `utc_offset_band` - the country's whole UTC range sits inside `excludeUtcOffsets` at the run timestamp. A country only partly inside the band is still searched."
}
}
}
},
"batches_planned": {
"type": "integer"
},
"batches_run": {
"type": "integer"
},
"search_calls": {
"type": "integer"
},
"candidate_rows": {
"type": "integer",
"description": "Rows returned before dedup, the denominator for a duplicate rate."
},
"unique_candidates": {
"type": "integer"
},
"shortlisted": {
"type": "integer"
},
"evidence": {
"type": "object",
"properties": {
"cached": {
"type": "integer"
},
"built": {
"type": "integer"
},
"pending": {
"type": "integer"
},
"skipped": {
"type": "integer"
}
}
},
"truncated": {
"type": "boolean",
"description": "A batch's ranking held more rows than the run could read, so some ranked candidates were never seen."
},
"retrieval_capped": {
"type": "boolean",
"description": "True when the ranker's per-location retrieval ceiling was reached for at least one country: more candidates may exist there than this run could read. A capped read is not an incomplete run - absence under a cap is not evidence of absence - and it does not by itself make `status` `partial`."
},
"partial": {
"type": "boolean",
"description": "True when a ceiling was hit, a batch was truncated, or evidence was still building. `status` is `partial` exactly when this is. A per-location retrieval cap is reported separately as `retrieval_capped`."
},
"stopped_reason": {
"type": [
"string",
"null"
],
"enum": [
"search_call_ceiling",
"time_budget",
null
]
},
"batches": {
"type": "array",
"items": {
"type": "object"
}
},
"note": {
"type": "string"
}
}
},
"manifest": {
"type": "object",
"description": "Everything needed to reproduce or compare two runs.",
"properties": {
"brief_id": {
"type": "string"
},
"run_started_at": {
"type": "string",
"format": "date-time"
},
"run_completed_at": {
"type": "string",
"format": "date-time"
},
"skills": {
"type": "array",
"items": {
"type": "string"
}
},
"domains": {
"type": "array",
"items": {
"type": "string"
}
},
"evidence_requested": {
"type": "boolean"
},
"evidence_cache_key": {
"type": [
"string",
"null"
]
},
"evidence_schema_version": {
"type": "integer"
},
"inspection_rules_version": {
"type": "integer"
},
"ceilings": {
"type": "object"
}
}
}
}
},
"Meta": {
"type": "object",
"description": "Envelope metadata. `quota.cost` is 0 on endpoints that debit no credits.",
"properties": {
"requestId": {
"type": "string"
},
"quota": {
"$ref": "#/$defs/Quota"
}
}
},
"Quota": {
"type": "object",
"properties": {
"used": {
"type": "integer"
},
"limit": {
"type": "integer",
"description": "-1 means unlimited"
},
"month": {
"type": "string"
},
"cost": {
"type": "integer",
"description": "Credits this request debited (search: 1, get user: 1, evidence report: 3 when a report is returned and 0 while pending, analyze profile: 3, list operations: 0). `used` already reflects this charge."
},
"rollover": {
"type": "integer",
"description": "Unused credits banked from the previous month and available on top of `limit` this month (`remaining` = limit + rollover - used). Only present on the Team plan, capped at one extra month's allowance (so at most 2x the allowance is usable in a month)."
}
}
}
}
}Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/githunt-ai-brief-status-response"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.