openapi: 3.2.0
info:
  title: Tabnine Main API
  version: '2026-10-04'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-04: 20 operation(s) read from 16 public documentation page(s) (each operation names its page in x-source). This is not the provider''s published contract; Tabnine has published no machine-readable contract that the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 0
    documentation: 20
    pages-with-code: 0
    pages-read: 16
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-04'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://docs.tabnine.com/main/getting-started/tabnine-cli/features/hooks/event-reference.md
  - https://docs.tabnine.com/main/getting-started/tabnine-cli/features/settings/settings-reference.md
  - https://docs.tabnine.com/main/getting-started/quickstart.md
  - https://docs.tabnine.com/main/getting-started/tabnine-cli.md
  - https://docs.tabnine.com/main/getting-started/tabnine-cli/examples.md
  - https://docs.tabnine.com/main/administering-tabnine/managing-your-team/tabnine-apis.md
  - https://docs.tabnine.com/main/getting-started/tabnine-cli/getting-started/quickstart.md
  - https://docs.tabnine.com/main/getting-started/install/client-setup-private-installation.md
  - https://docs.tabnine.com/main/getting-started/tabnine-cli/features/agent-guidelines-cli.md
  - https://docs.tabnine.com/main/welcome/readme/protection/provenance-and-attribution-in-tabnine-cli.md
  - https://docs.tabnine.com/main/getting-started/tabnine-cli/features/hooks/examples-and-best-practices.md
  - https://docs.tabnine.com/main/getting-started/tabnine-plugin-for-opencode/migrating-from-tabnine-cli.md
  - https://docs.tabnine.com/main/welcome/readme/system-requirements/tabnine-client-and-deployment-requirements.md
  - https://docs.tabnine.com/main/getting-started/install/client-setup-private-installation/eclipse-private-installation.md
  - https://docs.tabnine.com/main/getting-started/tabnine-cli/git-integrations/github-actions/tabnine-cli-gha-trust-guidance.md
  - https://docs.tabnine.com/main/administering-tabnine/managing-your-team/settings/general-settings/idp-sync/tabnine-scim-api.md
security:
- Personal_Access_Token: []
tags:
- name: Main
paths:
  /main/getting-started/install/client-setup-private-installation.md:
    get:
      operationId: get_main_getting_started_install_client_setup_private_installation_md
      tags:
      - Main
      summary: Client Setup (Private/Enterprise-SaaS)
      description: Perform an HTTP GET request on the current page URL with the `ask` query parameter, and optionally `goal`, to retrieve a direct answer from the documentation.
      x-source: https://docs.tabnine.com/main/getting-started/install/client-setup-private-installation.md
      parameters:
      - name: ask
        in: query
        required: true
        schema:
          type: string
        description: The immediate question; specific, self‑contained, natural language.
      - name: goal
        in: query
        required: false
        schema:
          type: string
        description: Optional broader end goal to tailor the answer.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetMainGettingStartedInstallClientSetupPrivateInstallationMd'
      x-evidence:
        kind: documentation
  /main/getting-started/install/client-setup-private-installation/eclipse-private-installation.md:
    get:
      operationId: get_main_getting_started_install_client_setup_private_installation_eclipse_priva
      tags:
      - Main
      summary: Eclipse (Private/Enterprise‑SaaS)
      x-source: https://docs.tabnine.com/main/getting-started/install/client-setup-private-installation/eclipse-private-installation.md
      parameters:
      - name: ask
        in: query
        required: true
        schema:
          type: string
        description: The immediate question; specific, self‑contained, natural‑language query.
      - name: goal
        in: query
        required: false
        schema:
          type: string
        description: Optional broader end‑goal describing what the user ultimately wants to achieve.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /main/getting-started/tabnine-cli/examples.md:
    get:
      operationId: get_main_getting_started_tabnine_cli_examples_md
      tags:
      - Main
      summary: Examples
      x-source: https://docs.tabnine.com/main/getting-started/tabnine-cli/examples.md
      parameters:
      - name: ask
        in: query
        required: true
        schema:
          type: string
        description: The immediate question, specific and self‑contained, written in natural language.
      - name: goal
        in: query
        required: false
        schema:
          type: string
        description: An optional broader end goal to help tailor the answer.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /main/getting-started/tabnine-cli/features/agent-guidelines-cli.md:
    get:
      operationId: get_main_getting_started_tabnine_cli_features_agent_guidelines_cli_md
      tags:
      - Main
      summary: Agent Guidelines (CLI)
      description: Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter to retrieve a direct answer and relevant excerpts from the documentation.
      x-source: https://docs.tabnine.com/main/getting-started/tabnine-cli/features/agent-guidelines-cli.md
      parameters:
      - name: ask
        in: query
        required: true
        schema:
          type: string
        description: The immediate question; specific, self‑contained, natural language.
      - name: goal
        in: query
        required: false
        schema:
          type: string
        description: Optional broader end goal for tailoring the answer.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /main/getting-started/tabnine-cli/features/hooks/{hookid}:
    get:
      operationId: get_main_getting_started_tabnine_cli_features_hooks_hookid
      tags:
      - Main
      summary: Event Reference
      description: Performs an HTTP GET request on the current page URL with the `ask` query parameter (and optional `goal`) to retrieve a documentation answer.
      x-source: https://docs.tabnine.com/main/getting-started/tabnine-cli/features/hooks/event-reference.md
      parameters:
      - name: hookid
        in: path
        required: true
        schema:
          type: string
      - name: ask
        in: query
        required: true
        schema:
          type: string
        description: The immediate question to ask the documentation, specific and self‑contained, written in natural language.
      - name: goal
        in: query
        required: false
        schema:
          type: string
        description: Optional broader end‑goal description to help tailor the answer.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetMainGettingStartedTabnineCliFeaturesHooksHookidResponse'
      x-evidence:
        kind: documentation
        collapsed_from: 2 example path(s) differing only at hookId
  /main/getting-started/tabnine-cli/features/settings/settings-reference.md:
    get:
      operationId: get_main_getting_started_tabnine_cli_features_settings_settings_reference_md
      tags:
      - Main
      summary: Settings Reference
      x-source: https://docs.tabnine.com/main/getting-started/tabnine-cli/features/settings/settings-reference.md
      parameters:
      - name: ask
        in: query
        required: true
        schema:
          type: string
        description: The immediate question to ask the documentation.
      - name: goal
        in: query
        required: false
        schema:
          type: string
        description: Optional broader end goal for tailoring the answer.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /main/getting-started/tabnine-cli/getting-started/quickstart.md:
    get:
      operationId: get_main_getting_started_tabnine_cli_getting_started_quickstart_md
      tags:
      - Main
      summary: Quickstart
      x-source: https://docs.tabnine.com/main/getting-started/tabnine-cli/getting-started/quickstart.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /main/getting-started/tabnine-cli/git-integrations/github-actions/tabnine-cli-gha-trust-guidance.md:
    get:
      operationId: get_main_getting_started_tabnine_cli_git_integrations_github_actions_tabnine_cli
      tags:
      - Main
      summary: Tabnine CLI GHA Trust Guidance
      x-source: https://docs.tabnine.com/main/getting-started/tabnine-cli/git-integrations/github-actions/tabnine-cli-gha-trust-guidance.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /main/getting-started/tabnine-plugin-for-opencode/migrating-from-tabnine-cli.md:
    get:
      operationId: get_main_getting_started_tabnine_plugin_for_opencode_migrating_from_tabnine_cli_
      tags:
      - Main
      summary: Migrating from Tabnine CLI
      x-source: https://docs.tabnine.com/main/getting-started/tabnine-plugin-for-opencode/migrating-from-tabnine-cli.md
      parameters:
      - name: ask
        in: query
        required: true
        schema:
          type: string
        description: The immediate question to ask, specific and self‑contained, written in natural language.
      - name: goal
        in: query
        required: false
        schema:
          type: string
        description: Optional broader end goal to help tailor the answer.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetMainGettingStartedTabninePluginForOpencodeMigratingFromTa'
      x-evidence:
        kind: documentation
  /main/getting-started/{gettingstartedid}:
    get:
      operationId: get_main_getting_started_gettingstartedid
      tags:
      - Main
      summary: Quickstart Guide
      description: Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter.
      x-source: https://docs.tabnine.com/main/getting-started/quickstart.md
      parameters:
      - name: gettingstartedid
        in: path
        required: true
        schema:
          type: string
      - name: ask
        in: query
        required: true
        schema:
          type: string
        description: The immediate question, specific and self‑contained, written in natural language.
      - name: goal
        in: query
        required: false
        schema:
          type: string
        description: Optional broader end goal to tailor the answer.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
        collapsed_from: 2 example path(s) differing only at gettingstartedId
  /main/welcome/readme/protection/provenance-and-attribution-in-tabnine-cli.md:
    get:
      operationId: get_main_welcome_readme_protection_provenance_and_attribution_in_tabnine_cli_md
      tags:
      - Main
      summary: Provenance & Attribution in Tabnine CLI
      x-source: https://docs.tabnine.com/main/welcome/readme/protection/provenance-and-attribution-in-tabnine-cli.md
      parameters:
      - name: ask
        in: query
        required: false
        schema:
          type: string
        description: 'The immediate question: it should be specific, self‑contained, and written in natural language.'
      - name: goal
        in: query
        required: false
        schema:
          type: string
        description: Optional broader end goal describing what the user ultimately wants to accomplish.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /main/welcome/readme/system-requirements/tabnine-client-and-deployment-requirements.md:
    get:
      operationId: get_main_welcome_readme_system_requirements_tabnine_client_and_deployment_requir
      tags:
      - Main
      summary: Tabnine Client & Deployment Requirements
      description: Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter to retrieve a direct answer from the documentation.
      x-source: https://docs.tabnine.com/main/welcome/readme/system-requirements/tabnine-client-and-deployment-requirements.md
      parameters:
      - name: ask
        in: query
        required: true
        schema:
          type: string
        description: 'The immediate question: it should be specific, self-contained, and written in natural language.'
      - name: goal
        in: query
        required: false
        schema:
          type: string
        description: Optional broader end goal for tailoring the answer.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
components:
  schemas:
    GetMainGettingStartedTabninePluginForOpencodeMigratingFromTa:
      type: object
      properties:
        '200':
          type: string
          description: Successful response containing a direct answer to the question and relevant excerpts from the documentation.
    GetMainGettingStartedTabnineCliFeaturesHooksHookidResponse:
      type: object
      properties:
        answer:
          type: string
          description: Direct answer to the question, including relevant excerpts and sources from the documentation.
    GetMainGettingStartedInstallClientSetupPrivateInstallationMd:
      type: object
      properties:
        answer:
          type: string
          description: Direct answer to the question with relevant excerpts and sources.
  securitySchemes:
    Personal_Access_Token:
      type: http
      scheme: bearer
      x-source: https://docs.tabnine.com/main/getting-started/install/client-setup-private-installation/sign-in-using-authentication-token.md