Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-GitHits-Client-Name
string

Optional client attribution: trimmed printable ASCII, at most 80 bytes. Invalid optional values are dropped.

X-GitHits-Client-Version
string

Optional client-version attribution: trimmed printable ASCII, at most 80 bytes. Invalid optional values are dropped.

X-GitHits-Agent
string

Optional agent attribution: trimmed printable ASCII, at most 160 bytes. Invalid optional values are dropped.

X-GitHits-Session-ID
string

Optional session attribution: trimmed printable ASCII, at most 128 bytes. Invalid optional values are dropped; no session is created.

Body

application/json

Start a thread or ask a follow-up question.

question
string
required

Nonblank question after trimming, at most 8192 Unicode scalar values.

Minimum string length: 1
target
object
required

Package, GitHub repository, or documentation site.

Response

Generated Markdown, ordered source URLs, and execution and thread identifiers

Generated answer, cited source URLs, and identifiers for diagnostics and follow-up questions.

answer_markdown
string
required

Generated Markdown; citations and source order are preserved.

sources
object[]
required

Source URLs in their original order. Citation numbers are not array indices; entries without URLs are omitted.

thread_id
string<uuid>
required

Thread identifier (UUIDv7) to reuse for follow-up questions.

tool_call_id
string<uuid>
required

Execution identifier (UUIDv7) for diagnostics.