> ## Documentation Index > Fetch the complete documentation index at: https://docs.githits.com/llms.txt > Use this file to discover all available pages before exploring further. # Generate an example from open-source references > Generate a code example for a programming task using open-source references. The response contains Markdown with source references, license attribution, and a link to the saved example. Use this endpoint when you want an example tailored to your task. To find existing documentation or code instead, use `POST /v1/searches`. You can rate a saved example with `POST /v1/feedback`. ## OpenAPI ````yaml https://api.githits.dev/v1/openapi.json post /v1/examples/search openapi: 3.1.0 info: description: >- Explore package metadata, security advisories, dependencies, documentation and source code with the GitHits API. ## Choose an operation | Task | Operations | | --- | --- | | Inspect a package | Release metadata, vulnerabilities and dependencies | | Review releases or upgrades | Changelog and batch upgrade reviews | | Read documentation | List package documentation, then read a page | | Navigate source code | List files, read a file or search text within a target | | Compare source trees | Compare files, line statistics and patches between package versions or repository refs | | Discover relevant content | Search across packages, repositories and documentation sites; retrieve a search's status and retained results | | Resolve a target name | Find ranked package, repository and documentation-site targets | | Ask a cited question | Generate an answer grounded in a package, repository or documentation site, or continue a conversation | | Generate an example | Generate and save a code example, then submit feedback | | Find a language identifier | Search supported programming languages | ## Authenticate and send requests The production API origin is `https://api.githits.dev`; development uses `https://api-dev.githits.dev`. Examples target production. Replace `` with your GitHits token. Send the token in `Authorization: Bearer `. JSON request bodies use `Content-Type: application/json`; public JSON field names use `snake_case`. Percent-encode a package name or opaque read target as one path segment, including any embedded slash. For query values, encode a literal plus sign as `%2B`; ordinary form decoding interprets `+` as a space. Each operation documents its accepted parameters and encoding rules. ## Select the data you need Where supported, `fields` is a comma-separated **query parameter**, including on POST requests. Omit it to use the operation's defaults. Supplying it replaces those defaults; required identity and information needed to interpret the result remain present. A **selector** names a supported **group** of response fields. Groups are atomic: their members are selected together. A **wildcard bundle**, such as `vulnerabilities.*`, selects only the groups listed for that bundle. A bare group does not automatically include nested groups. Arbitrary subfields and undeclared wildcards are not supported. Each operation lists its selectors, defaults, dependencies and the data they return. Selection can reduce transferred data without reducing the work needed to produce it; consult its parameter and response field documentation. Small fixed responses do not offer `fields`. ## Interpret responses and errors An omitted optional field can mean unselected or unavailable data, according to the operation's contract. Null has an operation-specific meaning: it can mark unavailable or inapplicable data, or an unselected search result. Empty arrays, zero and false are values, not substitutes for unavailable data. Always retain the result's completeness and freshness information when displaying or processing it. **Requested** identity records caller intent; **resolved** identity records what that intent resolved to; **served** identity identifies the artifact that produced the response. These can differ while indexing or refresh work continues. Use served identity when an exact follow-up read is required, preserving package-relative or repository-relative path scope. Errors normally use `application/problem+json`. Branch on the stable `code`, not the human-readable `detail`. Include `X-Request-ID` when reporting a problem; error `instance` matches that ID. Respect `Retry-After` when present. If request identity cannot be created, the response is an empty HTTP 500 without a request ID. Responses use `Cache-Control: no-store`. Timeouts do not guarantee that work stopped. Read the documented timeout responses, especially for Ask, generated examples and append-only feedback. Optional `X-GitHits-*` request headers attribute client, agent and session usage. The OpenAPI extension `x-githits-cost` is provisional operation metadata, not a price or a measure of computation. ## Contract status This API is pre-production. The external v1 contract is not yet frozen. license: name: Proprietary title: GitHits Public API version: 0.1.0 servers: - description: Production url: https://api.githits.dev security: [] tags: - description: >- Package metadata, release history, vulnerabilities, dependency graphs and upgrade comparisons. Each operation documents its registry, version and evidence scope. name: Packages - description: >- Discover existing documentation pages and read their content with exact source locators and availability information. name: Documentation - description: >- Enumerate files, read exact content and grep within a package or repository. Responses retain served identity, indexing state and completeness information. name: Code - description: >- Discover evidence across package, repository and documentation-site targets, then retrieve retained search results and progress. name: Search - description: >- Find supported programming-language names and aliases for example requests. name: Languages - description: >- Generate code examples for programming tasks, with source references and license attribution. name: Examples - description: Rate generated examples or sessions and provide written feedback. name: Feedback - description: >- Preview operations for target resolution, source comparison and cited questions. Routes use /v1/experimental and may later move to permanent v1 locations under a documented migration policy. name: Experimental paths: /v1/examples/search: post: tags: - Examples summary: Generate an example from open-source references description: >- Generate a code example for a programming task using open-source references. The response contains Markdown with source references, license attribution, and a link to the saved example. Use this endpoint when you want an example tailored to your task. To find existing documentation or code instead, use `POST /v1/searches`. You can rate a saved example with `POST /v1/feedback`. operationId: get_example parameters: - description: >- Optional client attribution: trimmed printable ASCII, at most 80 bytes. Invalid optional values are dropped. in: header name: X-GitHits-Client-Name required: false schema: type: string - description: >- Optional client-version attribution: trimmed printable ASCII, at most 80 bytes. Invalid optional values are dropped. in: header name: X-GitHits-Client-Version required: false schema: type: string - description: >- Optional agent attribution: trimmed printable ASCII, at most 160 bytes. Invalid optional values are dropped. in: header name: X-GitHits-Agent required: false schema: type: string - description: >- Optional session attribution: trimmed printable ASCII, at most 128 bytes. Invalid optional values are dropped; no session is created. in: header name: X-GitHits-Session-ID required: false schema: type: string requestBody: content: application/json: examples: custom: value: language: ts license_mode: custom query: Parse JSON default: value: query: Read a JSON file in Rust yolo: value: license_mode: yolo query: Parse JSON schema: $ref: '#/components/schemas/ExampleRequest' required: true responses: '200': content: application/json: examples: complete: value: result: > # Example ```rust let value = 1; ``` ### References - [Source 1](https://example.org/source) (MIT) --- [Open in GitHits Web App](https://app.githits.com/solutions/12345678-1234-4234-8234-123456789abc) search_status: complete solution_id: 12345678-1234-4234-8234-123456789abc degraded: value: result: > Source search may be incomplete. --- [Open in GitHits Web App](https://app.githits.com/solutions/12345678-1234-4234-8234-123456789abc) search_status: degraded solution_id: 12345678-1234-4234-8234-123456789abc no_example: value: result: > No suitable example was found. --- [Open in GitHits Web App](https://app.githits.com/solutions/12345678-1234-4234-8234-123456789abc) search_status: complete solution_id: 12345678-1234-4234-8234-123456789abc schema: $ref: '#/components/schemas/ExampleResponse' description: >- Full markdown with saved solution identity and source evidence completeness. headers: Cache-Control: schema: enum: - no-store type: string X-Request-ID: description: Request trace ID. schema: type: string '400': content: application/problem+json: example: code: VALIDATION_ERROR detail: The request is invalid. instance: 4bf92f3577b34da6a3ce929d0e0e4736 status: 400 title: Validation error type: about:blank schema: $ref: '#/components/schemas/ProblemResponse' description: >- VALIDATION_ERROR: invalid, missing, malformed, oversized or unsupported-media JSON; blank/overlong query, blank language, unknown/duplicate keys, nonempty query string or invalid license mode; backend semantic rejection. headers: Cache-Control: schema: enum: - no-store type: string X-Request-ID: description: Request trace ID. schema: type: string '401': content: application/problem+json: examples: authentication: value: code: AUTHENTICATION_REQUIRED detail: A bearer credential is required. instance: 4bf92f3577b34da6a3ce929d0e0e4736 status: 401 title: Authentication required type: about:blank reauthentication: value: code: REAUTH_REQUIRED detail: The caller must reconnect their source provider account. instance: 4bf92f3577b34da6a3ce929d0e0e4736 status: 401 title: Provider reauthentication required type: about:blank schema: $ref: '#/components/schemas/ProblemResponse' description: >- AUTHENTICATION_REQUIRED: missing, malformed or upstream-rejected credential (including waitlist denial); REAUTH_REQUIRED means reconnect the source provider account. headers: Cache-Control: schema: enum: - no-store type: string WWW-Authenticate: description: Bearer challenge. schema: type: string X-Request-ID: description: Request trace ID. schema: type: string '403': content: application/problem+json: examples: forbidden: value: code: FORBIDDEN detail: The caller is not allowed to access this resource. instance: 4bf92f3577b34da6a3ce929d0e0e4736 status: 403 title: Forbidden type: about:blank terms: value: code: TERMS_ACCEPTANCE_REQUIRED detail: The caller must accept the applicable terms. instance: 4bf92f3577b34da6a3ce929d0e0e4736 status: 403 terms_url: https://githits.com/terms title: Terms acceptance required type: about:blank schema: $ref: '#/components/schemas/ProblemResponse' description: >- FORBIDDEN or TERMS_ACCEPTANCE_REQUIRED; safe terms/acceptance links may be supplied. headers: Cache-Control: schema: enum: - no-store type: string X-Request-ID: description: Request trace ID. schema: type: string '405': content: application/problem+json: example: code: METHOD_NOT_ALLOWED detail: The requested method is not supported for this route. instance: 4bf92f3577b34da6a3ce929d0e0e4736 status: 405 title: Method not allowed type: about:blank schema: $ref: '#/components/schemas/ProblemResponse' description: 'METHOD_NOT_ALLOWED: the route does not support this HTTP method.' headers: Allow: description: 'Supported methods: POST.' schema: type: string Cache-Control: schema: enum: - no-store type: string X-Request-ID: description: >- Request trace ID for diagnostics; matches problem.instance on failures. schema: type: string '429': content: application/problem+json: example: code: RATE_LIMITED detail: The request was rate limited. instance: 4bf92f3577b34da6a3ce929d0e0e4736 status: 429 title: Rate limited type: about:blank schema: $ref: '#/components/schemas/ProblemResponse' description: 'RATE_LIMITED: example quota exceeded; honor Retry-After.' headers: Cache-Control: schema: enum: - no-store type: string Retry-After: description: Optional validated delay in seconds or HTTP-date from upstream. schema: type: string X-Request-ID: description: Request trace ID. schema: type: string '500': description: >- Request identity could not be created. Empty body without X-Request-ID; no problem object is available. headers: Cache-Control: schema: enum: - no-store type: string x-githits-empty-identity-failure: true '502': content: application/problem+json: example: code: UPSTREAM_ERROR detail: The upstream service failed to provide a response. instance: 4bf92f3577b34da6a3ce929d0e0e4736 status: 502 title: Upstream error type: about:blank schema: $ref: '#/components/schemas/ProblemResponse' description: >- UPSTREAM_ERROR: transport failure, unexpected status or malformed response; upstream details are suppressed. headers: Cache-Control: schema: enum: - no-store type: string X-Request-ID: description: Request trace ID. schema: type: string '503': content: application/problem+json: example: code: UPSTREAM_UNAVAILABLE detail: Source search is temporarily unavailable. instance: 4bf92f3577b34da6a3ce929d0e0e4736 status: 503 title: Upstream unavailable type: about:blank schema: $ref: '#/components/schemas/ProblemResponse' description: 'UPSTREAM_UNAVAILABLE: source-search capacity unavailable.' headers: Cache-Control: schema: enum: - no-store type: string X-Request-ID: description: Request trace ID. schema: type: string '504': content: application/problem+json: example: code: TIMEOUT detail: The upstream request did not complete in time. instance: 4bf92f3577b34da6a3ce929d0e0e4736 status: 504 title: Upstream timeout type: about:blank schema: $ref: '#/components/schemas/ProblemResponse' description: >- TIMEOUT: generation exceeded its deadline (240 seconds by default). Set a longer client timeout. The example may already have been saved; retrying can create another example and consume quota again. headers: Cache-Control: schema: enum: - no-store type: string X-Request-ID: description: Request trace ID. schema: type: string security: - bearer_auth: [] components: schemas: ExampleRequest: additionalProperties: false description: >- Generate one full markdown result; unknown or duplicate JSON keys are rejected. properties: language: description: >- Optional nonblank language name or alias; inferred upstream when omitted/null. example: rust minLength: 1 type: - string - 'null' license_mode: default: strict oneOf: - $ref: '#/components/schemas/LicenseMode' description: >- License policy for source examples: `strict` (default) applies the strict filter, `custom` uses your account policy, and `yolo` disables license filtering. query: description: >- Programming task to demonstrate, such as reading a JSON file in Rust. Must be nonblank and at most 8192 Unicode scalar values; text is preserved exactly. example: Read a JSON file in Rust maxLength: 8192 minLength: 1 type: string required: - query type: object ExampleResponse: description: >- Unaltered markdown with its saved solution and source-evidence completeness. properties: result: description: >- Full generated Markdown, including source references, license attribution and the saved-solution link. type: string search_status: $ref: '#/components/schemas/SearchStatus' description: >- Whether the source search was complete or degraded. A degraded search means some source information was unavailable; generation still succeeded. solution_id: description: >- Identifier of the saved example linked in the Markdown footer. Use this as `solution_id` with `POST /v1/feedback` to rate the example. format: uuid type: string required: - result - solution_id - search_status type: object ProblemResponse: description: >- The stable problem document returned for an unsuccessful public API request. properties: acceptance_url: description: An optional acceptance URL supplied by the upstream allow-list. type: string code: description: The stable uppercase API error code. type: string detail: description: A stable, client-safe explanation of the failure. type: string instance: description: The active request trace ID. type: string status: description: The HTTP status returned with this problem. format: int32 minimum: 0 type: integer terms_url: description: An optional terms URL supplied by the upstream allow-list. type: string title: description: A short, stable title for the error. type: string type: description: The generic RFC 9457 problem type. type: string required: - type - title - status - detail - instance - code type: object LicenseMode: description: Backend-owned license filtering policy. enum: - strict - yolo - custom type: string SearchStatus: description: Completeness of source evidence, independent of generation success. enum: - complete - degraded type: string securitySchemes: bearer_auth: scheme: bearer type: http ````