Overleaf API

openapi: 3.1.0
info:
  title: Overleaf API
  version: '2026-10-28'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-28: 8 operation(s) read from 36 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Overleaf has published no machine-readable contract that the
    pipeline could find. Engine: anthropic.'
  x-evidence-tiers:
    code-example: 0
    documentation: 8
    pages-with-code: 0
    pages-read: 36
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-28'
  x-generator: generate-contract-from-docs.py
  x-engine: anthropic
  x-sources:
  - https://docs.overleaf.com/citing-and-references/library.md
  - https://docs.overleaf.com/citing-and-references/available-bibtex-styles.md
  - https://docs.overleaf.com/citing-and-references/creating-a-bibliography.md
  - https://docs.overleaf.com/citing-and-references/working-with-.bib-files.md
  - https://docs.overleaf.com/citing-and-references/adding-citations-and-references.md
  - https://docs.overleaf.com/integrations-and-add-ons/reference-manager-integrations.md
  - https://docs.overleaf.com/integrations-and-add-ons/reference-manager-integrations/zotero.md
  - https://docs.overleaf.com/integrations-and-add-ons/reference-manager-integrations/mendeley.md
  - https://docs.overleaf.com/integrations-and-add-ons/reference-manager-integrations/readcube.md
  - https://docs.overleaf.com/citing-and-references/adding-citations-and-references/searching-for-references.md
  - https://docs.overleaf.com/citing-and-references/adding-citations-and-references/configuring-advanced-reference-search.md
  - https://docs.overleaf.com/getting-started/latex-tutorials.md
  - https://docs.overleaf.com/on-premises/configuration/overleaf-toolkit/password-restrictions.md
  - https://docs.overleaf.com/getting-started/your-first-project.md
  - https://docs.overleaf.com/getting-started/creating-an-account.md
  - https://docs.overleaf.com/getting-started/how-do-i-use-overleaf.md
  - https://docs.overleaf.com/getting-started/free-and-premium-plans.md
  - https://docs.overleaf.com/getting-started/recompiling-your-project.md
  - https://docs.overleaf.com/on-premises/getting-started/requirements.md
  - https://docs.overleaf.com/on-premises/getting-started/microservices.md
  - https://docs.overleaf.com/groups/getting-started/how-to-create-a-group.md
  - https://docs.overleaf.com/on-premises/getting-started/before-you-start.md
  - https://docs.overleaf.com/getting-started/free-and-premium-plans/plan-limits.md
  - https://docs.overleaf.com/groups/getting-started/accessing-your-admin-account.md
  - https://docs.overleaf.com/on-premises/getting-started/server-pro-infrastructure.md
  - https://docs.overleaf.com/on-premises/getting-started/requirements/skills-needed.md
  - https://docs.overleaf.com/getting-started/creating-an-account/getting-started-faq.md
  - https://docs.overleaf.com/getting-started/free-and-premium-plans/premium-features.md
  - https://docs.overleaf.com/on-premises/getting-started/what-is-the-overleaf-toolkit.md
  - https://docs.overleaf.com/getting-started/recompiling-your-project/the-main-document.md
  - https://docs.overleaf.com/groups/getting-started/sharing-permissions-within-your-group.md
  - https://docs.overleaf.com/on-premises/getting-started/requirements/hardware-requirements.md
  - https://docs.overleaf.com/on-premises/getting-started/requirements/software-requirements.md
  - https://docs.overleaf.com/getting-started/how-do-i-use-overleaf/redesigned-overleaf-editor.md
  - https://docs.overleaf.com/getting-started/how-do-i-use-overleaf/redesigned-overleaf-editor/contextual-menu.md
  - https://docs.overleaf.com/getting-started/recompiling-your-project/selecting-a-tex-live-version-and-latex-compiler.md
paths:
  /citing-and-references/creating-a-bibliography.md:
    get:
      operationId: get_citing_and_references_creating_a_bibliography_md
      tags:
      - Citing And References
      summary: Query the documentation to get answers about creating bibliographies by asking a specific question with context about your goal.
      x-source: https://docs.overleaf.com/citing-and-references/creating-a-bibliography.md
      parameters:
      - name: ask
        in: query
        required: false
        schema:
          type: string
        description: The immediate question about creating a bibliography
      - name: goal
        in: query
        required: false
        schema:
          type: string
        description: What the user is ultimately trying to achieve
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCitingAndReferencesCreatingABibliographyMdResponse'
      x-evidence:
        kind: documentation
  /getting-started/how-do-i-use-overleaf.md:
    get:
      operationId: get_getting_started_how_do_i_use_overleaf_md
      tags:
      - Getting Started
      summary: Query the documentation with a question and goal to retrieve additional information.
      x-source: https://docs.overleaf.com/getting-started/how-do-i-use-overleaf.md
      parameters:
      - name: ask
        in: query
        required: false
        schema:
          type: string
        description: The immediate question; should be specific, self-contained, and written in natural language.
      - name: goal
        in: query
        required: false
        schema:
          type: string
        description: What the user is ultimately trying to achieve, the reason they need the answer.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetGettingStartedHowDoIUseOverleafMdResponse'
      x-evidence:
        kind: documentation
  /groups/getting-started/how-to-create-a-group.md:
    get:
      operationId: get_groups_getting_started_how_to_create_a_group_md
      tags:
      - Groups
      summary: Query the Overleaf documentation with a question and goal to retrieve information about creating groups.
      x-source: https://docs.overleaf.com/groups/getting-started/how-to-create-a-group.md
      parameters:
      - name: ask
        in: query
        required: false
        schema:
          type: string
        description: The immediate question, specific and self-contained in natural language
      - name: goal
        in: query
        required: false
        schema:
          type: string
        description: The user's ultimate objective or reason for needing the answer
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetGroupsGettingStartedHowToCreateAGroupMdResponse'
      x-evidence:
        kind: documentation
  /on-premises/getting-started/before-you-start.md:
    get:
      operationId: get_on_premises_getting_started_before_you_start_md
      tags:
      - On Premises
      summary: Query the documentation with a question and goal to retrieve additional information.
      x-source: https://docs.overleaf.com/on-premises/getting-started/before-you-start.md
      parameters:
      - name: ask
        in: query
        required: false
        schema:
          type: string
        description: The immediate question; should be specific, self-contained, and written in natural language.
      - name: goal
        in: query
        required: false
        schema:
          type: string
        description: What the user is ultimately trying to achieve; helps GitBook give a better, more relevant answer.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetOnPremisesGettingStartedBeforeYouStartMdResponse'
      x-evidence:
        kind: documentation
  /on-premises/getting-started/microservices.md:
    get:
      operationId: get_on_premises_getting_started_microservices_md
      tags:
      - On Premises
      summary: Query documentation by asking a question about microservices configuration and architecture.
      x-source: https://docs.overleaf.com/on-premises/getting-started/microservices.md
      parameters:
      - name: ask
        in: query
        required: false
        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: What the user is ultimately trying to achieve; describes the outcome desired
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetOnPremisesGettingStartedMicroservicesMdResponse'
      x-evidence:
        kind: documentation
  /on-premises/getting-started/requirements.md:
    get:
      operationId: get_on_premises_getting_started_requirements_md
      tags:
      - On Premises
      summary: Get requirements documentation for installing Overleaf Server Pro and Community Edition.
      x-source: https://docs.overleaf.com/on-premises/getting-started/requirements.md
      parameters:
      - name: ask
        in: query
        required: false
        schema:
          type: string
        description: The immediate question to ask about the documentation page
      - name: goal
        in: query
        required: false
        schema:
          type: string
        description: The ultimate goal the user is trying to achieve
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetOnPremisesGettingStartedRequirementsMdResponse'
      x-evidence:
        kind: documentation
  /on-premises/getting-started/requirements/skills-needed.md:
    get:
      operationId: get_on_premises_getting_started_requirements_skills_needed_md
      tags:
      - On Premises
      summary: Query the skills-needed documentation page with optional ask and goal parameters.
      x-source: https://docs.overleaf.com/on-premises/getting-started/requirements/skills-needed.md
      parameters:
      - name: ask
        in: query
        required: false
        schema:
          type: string
        description: Immediate question about the documentation; should be specific, self-contained, and written in natural language
      - name: goal
        in: query
        required: false
        schema:
          type: string
        description: What the user is ultimately trying to achieve; helps provide more relevant answers
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetOnPremisesGettingStartedRequirementsSkillsNeededMdRespons'
      x-evidence:
        kind: documentation
  /on-premises/getting-started/requirements/software-requirements.md:
    get:
      operationId: get_on_premises_getting_started_requirements_software_requirements_md
      tags:
      - On Premises
      summary: Retrieve the Markdown version of the software requirements documentation page for Overleaf on-premises.
      x-source: https://docs.overleaf.com/on-premises/getting-started/requirements/software-requirements.md
      parameters:
      - name: ask
        in: query
        required: false
        schema:
          type: string
        description: An immediate question to query the documentation
      - name: goal
        in: query
        required: false
        schema:
          type: string
        description: The user's ultimate objective for querying the documentation
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetOnPremisesGettingStartedRequirementsSoftwareRequirementsM'
      x-evidence:
        kind: documentation
components:
  schemas:
    GetCitingAndReferencesCreatingABibliographyMdResponse:
      type: object
      properties:
        answer:
          type: string
          description: Direct answer to the question
        excerpts:
          type: array
          description: Relevant excerpts from the documentation
        sources:
          type: array
          description: Sources referenced in the answer
    GetGettingStartedHowDoIUseOverleafMdResponse:
      type: object
      properties:
        answer:
          type: string
          description: Direct answer to the question
        excerpts:
          type: array
          description: Relevant excerpts and sources from the documentation
    GetGroupsGettingStartedHowToCreateAGroupMdResponse:
      type: object
      properties:
        answer:
          type: string
          description: Direct answer to the question
        excerpts:
          type: array
          description: Relevant excerpts from the documentation
        sources:
          type: array
          description: Related documentation sections
    GetOnPremisesGettingStartedBeforeYouStartMdResponse:
      type: object
      properties:
        answer:
          type: string
          description: Direct answer to the question
        excerpts:
          type: array
          description: Relevant excerpts and sources from the documentation
    GetOnPremisesGettingStartedMicroservicesMdResponse:
      type: object
      properties:
        answer:
          type: string
          description: Direct answer to the question asked
        excerpts:
          type: array
          description: Relevant excerpts and sources from the documentation
    GetOnPremisesGettingStartedRequirementsMdResponse:
      type: object
      properties:
        answer:
          type: string
          description: Direct answer to the question
        excerpts:
          type: array
          description: Relevant excerpts from the documentation
        sources:
          type: array
          description: Related documentation sections
    GetOnPremisesGettingStartedRequirementsSkillsNeededMdRespons:
      type: object
      properties:
        answer:
          type: string
          description: Direct answer to the question asked
        excerpts:
          type: array
          description: Relevant excerpts and sources from the documentation
    GetOnPremisesGettingStartedRequirementsSoftwareRequirementsM:
      type: object
      properties:
        content:
          type: string
          description: The Markdown content of the software requirements page
tags:
- name: Citing And References
- name: Getting Started
- name: Groups
- name: On Premises