Aaly API

openapi: 3.1.0
info:
  title: Aaly API
  version: '2026-10-31'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-31: 12 operation(s) read from 11 public documentation page(s) (each
    operation names its page in x-source). This is not the provider''s published contract; Aaly has published no machine-readable contract that
    the pipeline could find. Engine: oss.'
  x-evidence-tiers:
    code-example: 3
    documentation: 9
    pages-with-code: 2
    pages-read: 11
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-31'
  x-generator: generate-contract-from-docs.py
  x-engine: oss
  x-sources:
  - https://aaly.io/docs/rest-api
  - https://aaly.io/docs/functions
  - https://aaly.io/docs/mcp-tools
  - https://aaly.io/docs/quickstart
  - https://aaly.io/docs/connect
  - https://aaly.io/docs/auth
  - https://aaly.io/docs/multi-tenancy
  - https://aaly.io/docs/files
  - https://aaly.io/docs/notifications
  - https://aaly.io/docs/limits
  - https://aaly.io/multi-tenant-backend
servers:
- url: https://api.aaly.io
paths:
  /{yourSlug}/{project}/tasks:
    get:
      operationId: get_yourSlug_project_tasks
      tags:
      - Tasks
      summary: The moment the fields exist, POST /tasks , GET /tasks , GET /tasks/{id} , PATCH /tasks/{id} , and DELETE /tasks/{id} are live.
      x-source: https://aaly.io/docs/quickstart
      parameters:
      - name: yourSlug
        in: path
        required: true
        schema:
          type: string
      - name: project
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetYourslugProjectTasksResponse'
      x-evidence:
        kind: documentation
  /auth/change-password:
    post:
      operationId: post_auth_change_password
      tags:
      - Auth
      summary: Changes the user's password while signed in
      description: POST /auth/change-password with currentPassword and newPassword. It signs out the user's other sessions and returns a fresh
        session.
      x-source: https://aaly.io/docs/auth
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostAuthChangePasswordRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostAuthChangePasswordResponse'
      x-evidence:
        kind: documentation
  /auth/keys:
    post:
      operationId: post_auth_keys
      tags:
      - Auth
      summary: Create a new API key for authentication.
      description: POST /auth/keys generates an API key (aaly_<id>_<secret>)
      x-source: https://aaly.io/docs/rest-api
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostAuthKeysResponse'
      x-evidence:
        kind: documentation
  /auth/keys/{id}:
    delete:
      operationId: delete_auth_keys_id
      tags:
      - Auth
      summary: Revoke it with DELETE /auth/keys/{id} or from the dashboard.
      x-source: https://aaly.io/docs/connect
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /auth/logout:
    post:
      operationId: post_auth_logout
      tags:
      - Auth
      summary: Revokes a single session
      description: POST /auth/logout revokes one session.
      x-source: https://aaly.io/docs/auth
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /auth/refresh:
    post:
      operationId: post_auth_refresh
      tags:
      - Auth
      summary: Refreshes the JWT and returns a new refresh token
      description: Every call to POST /auth/refresh returns a fresh JWT and a new refresh token; the previously used refresh token stops working.
      x-source: https://aaly.io/docs/auth
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostAuthRefreshResponse'
      x-evidence:
        kind: documentation
  /auth/verify-send:
    post:
      operationId: post_auth_verify_send
      tags:
      - Auth
      summary: Resends the email verification code
      description: POST /auth/verify-send resends the verification email (once a minute, five times an hour).
      x-source: https://aaly.io/docs/auth
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /files/presigned-url:
    post:
      operationId: post_files_presigned_url
      tags:
      - Files
      summary: Mint a presigned upload URL
      x-source: https://aaly.io/docs/files
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostFilesPresignedUrlRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostFilesPresignedUrlResponse'
      x-evidence:
        kind: documentation
  /orders/summary:
    post:
      operationId: post_orders_summary
      tags:
      - Orders
      summary: Attach a function to a non-CRUD route such as POST /orders/summary
      x-source: https://aaly.io/docs/mcp-tools
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /{entity}/{id}:
    delete:
      operationId: delete_entity_id
      tags:
      - Api
      summary: Soft delete an entity record – cascades to nested children.
      description: DELETE /{entity}/{id} Soft delete — cascades to nested children
      x-source: https://aaly.io/docs/rest-api
      parameters:
      - name: entity
        in: path
        required: true
        schema:
          type: string
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    get:
      operationId: get_entity_id
      tags:
      - Api
      summary: Get one entity record – always immediately consistent.
      description: GET /{entity}/{id} Get one — always immediately consistent
      x-source: https://aaly.io/docs/rest-api
      parameters:
      - name: entity
        in: path
        required: true
        schema:
          type: string
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    patch:
      operationId: patch_entity_id
      tags:
      - Api
      summary: Partial update of an entity record.
      description: PATCH /{entity}/{id} Partial update
      x-source: https://aaly.io/docs/rest-api
      parameters:
      - name: entity
        in: path
        required: true
        schema:
          type: string
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
components:
  schemas:
    GetYourslugProjectTasksResponse:
      type: object
      properties:
        items:
          type: array
          description: Array of task objects
        count:
          type: integer
        total:
          type: integer
        limit:
          type: integer
        offset:
          type: integer
    PostAuthChangePasswordRequest:
      type: object
      properties:
        currentPassword:
          type: string
          description: Current password of the user
        newPassword:
          type: string
          description: New password to set
      required:
      - currentPassword
      - newPassword
    PostAuthChangePasswordResponse:
      type: object
      properties:
        jwt:
          type: string
          description: New JSON Web Token for the refreshed session
        refreshToken:
          type: string
          description: New refresh token for the refreshed session
    PostAuthKeysResponse:
      type: object
      properties:
        key:
          type: string
          description: Generated API key
    PostAuthRefreshResponse:
      type: object
      properties:
        jwt:
          type: string
          description: New JSON Web Token
        refreshToken:
          type: string
          description: New refresh token
    PostFilesPresignedUrlRequest:
      type: object
      properties:
        filename:
          type: string
        mimeType:
          type: string
        size:
          type: number
      required:
      - filename
      - mimeType
      - size
    PostFilesPresignedUrlResponse:
      type: object
      properties:
        files:
          type: array
          description: Array of presigned upload info
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
security:
- bearer: []
tags:
- name: Api
- name: Auth
- name: Files
- name: Orders
- name: Tasks