Electrik API

openapi: 3.1.0
info:
  title: Electrik API
  version: '2026-11-06'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-06: 9 operation(s) read from 9 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Electrik has published no machine-readable contract that the
    pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 2
    documentation: 7
    pages-with-code: 3
    pages-read: 9
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-06'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://electrik.dev/docs/reference/routes-middleware
  - https://electrik.dev/docs/guides/api-tokens
  - https://docs.electrik.dev/getting-started/installation
  - https://docs.electrik.dev/getting-started/introduction
  - https://docs.electrik.dev/getting-started/directory-structure
  - https://docs.electrik.dev/getting-started/how-does-electrik-works
  - https://electrik.dev/docs/reference/routes-middleware.md
  - https://electrik.dev/docs/guides/api-tokens.md
  - https://electrik.dev/docs/core-concepts/billing
paths:
  /1.x/getting-started/directory-structure.md:
    get:
      operationId: get_1_x_getting_started_directory_structure_md
      tags:
      - '1'
      summary: Page Not Found
      description: Perform an HTTP GET request on the URL with the `ask` and `goal` query parameters to retrieve a direct answer and relevant
        excerpts from the documentation.
      x-source: https://docs.electrik.dev/getting-started/directory-structure
      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: The user’s ultimate goal, describing the outcome they want rather than restating the question.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /1.x/getting-started/how-does-electrik-works.md:
    get:
      operationId: get_1_x_getting_started_how_does_electrik_works_md
      tags:
      - '1'
      summary: Page Not Found
      description: Perform an HTTP GET request on the URL with the `ask` and `goal` query parameters to retrieve a direct answer and relevant
        excerpts from the documentation.
      x-source: https://docs.electrik.dev/getting-started/how-does-electrik-works
      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: The user’s ultimate goal, describing the outcome they want rather than restating the question.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /1.x/getting-started/installation.md:
    get:
      operationId: get_1_x_getting_started_installation_md
      tags:
      - '1'
      summary: Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters
      description: The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
      x-source: https://docs.electrik.dev/getting-started/installation
      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: The user’s ultimate goal, describing the outcome they want to achieve.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Get1XGettingStartedInstallationMdResponse'
      x-evidence:
        kind: documentation
  /1.x/getting-started/introduction.md:
    get:
      operationId: get_1_x_getting_started_introduction_md
      tags:
      - '1'
      summary: Page Not Found
      description: Perform an HTTP GET request on the URL with the `ask` and `goal` query parameters to retrieve a direct answer and relevant
        excerpts from the documentation.
      x-source: https://docs.electrik.dev/getting-started/introduction
      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: The user’s ultimate goal, helping GitBook tailor the answer.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/electrik/me:
    get:
      operationId: get_api_electrik_me
      tags:
      - Api
      summary: GET /api/electrik/me
      x-source: https://electrik.dev/docs/guides/api-tokens
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -H "Authorization: Bearer <token>" https://your-app.test/api/electrik/me

          ```'
  /api/electrik/members:
    get:
      operationId: get_api_electrik_members
      tags:
      - Api
      summary: Built‑in API route to list team members.
      x-source: https://electrik.dev/docs/guides/api-tokens
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/electrik/team:
    get:
      operationId: get_api_electrik_team
      tags:
      - Api
      summary: Built‑in API route to get the current team.
      x-source: https://electrik.dev/docs/guides/api-tokens
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/electrik/usage:
    post:
      operationId: post_api_electrik_usage
      tags:
      - Api
      summary: POST /api/electrik/usage
      x-source: https://electrik.dev/docs/guides/api-tokens
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiElectrikUsageRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -X POST https://your-app.test/api/electrik/usage  -H "Authorization: Bearer <token>"  -H "Content-Type: application/json"  -d
          ''{"stripe_price_id":"price_xxx","quantity":5}''

          ```'
  /usage:
    post:
      operationId: post_usage
      tags:
      - Usage
      summary: POST /usage
      x-source: https://electrik.dev/docs/reference/routes-middleware
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
components:
  schemas:
    Get1XGettingStartedInstallationMdResponse:
      type: object
      properties:
        answer:
          type: string
          description: A direct answer to the question, including relevant excerpts and sources from the documentation.
    PostApiElectrikUsageRequest:
      type: object
      properties:
        stripe_price_id:
          type: string
        quantity:
          type: integer
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
security:
- bearer: []
tags:
- name: '1'
- name: Api
- name: Usage