AutoKitteh API

openapi: 3.1.0
info:
  title: AutoKitteh API
  version: '2026-10-19'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-19: 7 operation(s) read from 10 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; AutoKitteh has published no machine-readable contract that the
    pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 7
    documentation: 0
    pages-with-code: 9
    pages-read: 10
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-19'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://docs.autokitteh.com/develop/sync_webhooks
  - https://docs.autokitteh.com/get_started/quickstart
  - https://docs.autokitteh.com/develop/managing/cli
  - https://docs.autokitteh.com/develop/python
  - https://docs.autokitteh.com/get_started/install
  - https://docs.autokitteh.com/develop/managing/vscode
  - https://docs.autokitteh.com/get_started/install?os=linux
  - https://docs.autokitteh.com/get_started/install?os=macos
  - https://docs.autokitteh.com/integrations/google/config
  - https://docs.autokitteh.com/integrations/http/events
paths:
  /:
    get:
      operationId: get
      tags:
      - Api
      summary: GET /
      x-source: https://docs.autokitteh.com/get_started/install
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -fsSL https://get.autokitteh.sh | bash This script downloads, verifies, and extracts the latest release of

          AutoKitteh. The destination directory is ~/.local/bin , if it exists in the user''s'
  /google/cel-spec/blob/master/doc/langdef.md:
    get:
      operationId: get_google_cel_spec_blob_master_doc_langdef_md
      tags:
      - Google
      summary: GET /google/cel-spec/blob/master/doc/langdef.md
      x-source: https://docs.autokitteh.com/integrations/http/events
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl/x.y.z\" , ] , \"body\" : { \"bytes\" : b\"...\" , # None if there is no body \"form\" : { . . . } , # None if the body\
          \ is not a URL-encoded form \"json\" : { . . . } , # None if the body is not a JSON object } } \n Note that the fields in data are accessible\
          \ as dictionary keys as well\nas object attributes . For example: event.data.method is the same as\n event.data[\"method\"] and event.data.get(\"\
          method\") ."
  /http/quickstart/trigger_path:
    get:
      operationId: get_http_quickstart_trigger_path
      tags:
      - Http
      summary: GET /http/quickstart/trigger_path
      x-source: https://docs.autokitteh.com/develop/managing/cli
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X GET http://localhost:9980/http/quickstart/trigger_path \n Managing Sessions ​ \n A session is a single execution of\
          \ an automation upon its initiation, either by scheduler or webhook.\nWhen the Trigger is received the code begins execution from the\
          \ defined entry point and continues running until the termination of the code. \n To manage sessions use the various forms of the command:\n\
          \ ak session"
  /webhooks:
    get:
      operationId: get_webhooks
      tags:
      - Webhooks
      summary: GET /webhooks
      x-source: https://docs.autokitteh.com/get_started/quickstart
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -i \"http://localhost:9980/webhooks/...\" \n Explanation The curl flag -i shows you the server's response. localhost:9980\
          \ is the address of the local AutoKitteh server that you\nstarted (with the default port number ). /webhooks/... is the URL path of\
          \ the project's trigger, which is\ndefined in the\n YAML manifest file ,\nand was assigned when you deployed the project for the first\
          \ time. \n Run this "
  /webhooks/:
    get:
      operationId: get_webhooks
      tags:
      - Webhooks
      summary: Trigger the Deployment
      x-source: https://docs.autokitteh.com/get_started/quickstart
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /webhooks/{webhookid}:
    get:
      operationId: get_webhooks_webhookid
      tags:
      - Webhooks
      summary: GET /webhooks/{webhookId}
      x-source: https://docs.autokitteh.com/develop/python
      parameters:
      - name: webhookid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -d hello http://localhost:9980/webhooks/<webhook_id> \n You can view the print output using the ak session prints command.\
          \ \n Every time you change the handler code, you need to re-deploy the workflow. \n Limitations ​ \n danger We try to lift these limitations\
          \ as we progress, but currently your workflow will fail if you don't follow them. \n Function Return Value Must Be Pickleable ​ \n We\
          \ use pic"
    post:
      operationId: post_webhooks_webhookid
      tags:
      - Webhooks
      summary: POST /webhooks/01jv3wxp10esctj7b0c085enfy
      x-source: https://docs.autokitteh.com/develop/python
      parameters:
      - name: webhookid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostWebhooksWebhookidRequest'
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostWebhooksWebhookidResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -i -X POST -d '{\"user\": \"joe\", \"event\": \"login\"}' http://localhost:9980/webhooks/01jv3wxp10esctj7b0c085enfy \n\
          \ AutoKitteh captures print statements from Python and stores them in the session logs. \n Use the session prints command to view: \n\
          \ ak session prints py_simple \n Overview ​ \n The Python runtime can receive events from configured connection triggers .\nIt cannot\
          \ use the connection for out"
        collapsed_from: 2 example path(s) differing only at webhookId
components:
  schemas:
    PostWebhooksWebhookidRequest:
      type: object
      properties:
        user:
          type: string
        event:
          type: string
    PostWebhooksWebhookidResponse:
      type: object
      properties:
        name:
          type: string
  securitySchemes:
    Personal_API_Key:
      type: apiKey
      in: header
      name: Authorization
      x-source: https://docs.autokitteh.com/integrations/linear/api_key
tags:
- name: Api
- name: Google
- name: Http
- name: Webhooks
security:
- Personal_API_Key: []