Aivyro API

openapi: 3.1.0
info:
  title: Aivyro API
  version: '2026-11-01'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-01: 3 operation(s) read from 40 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Aivyro has published no machine-readable contract that the pipeline
    could find. Engine: anthropic.'
  x-evidence-tiers:
    code-example: 3
    documentation: 0
    pages-with-code: 6
    pages-read: 40
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-01'
  x-generator: generate-contract-from-docs.py
  x-engine: anthropic
  x-sources:
  - https://knowledge.aivyro.io/reference
  - https://knowledge.aivyro.io/en/reference
  - https://knowledge.aivyro.io/reference/tags
  - https://knowledge.aivyro.io/reference/deals
  - https://knowledge.aivyro.io/reference/notes
  - https://knowledge.aivyro.io/reference/tasks
  - https://knowledge.aivyro.io/reference/stages
  - https://knowledge.aivyro.io/en/reference/tags
  - https://knowledge.aivyro.io/reference/members
  - https://knowledge.aivyro.io/en/reference/deals
  - https://knowledge.aivyro.io/en/reference/notes
  - https://knowledge.aivyro.io/en/reference/tasks
  - https://knowledge.aivyro.io/es/reference/deals
  - https://knowledge.aivyro.io/reference/contacts
  - https://knowledge.aivyro.io/reference/meetings
  - https://knowledge.aivyro.io/reference/whatsapp
  - https://knowledge.aivyro.io/en/reference/stages
  - https://knowledge.aivyro.io/es/reference/stages
  - https://knowledge.aivyro.io/reference/companies
  - https://knowledge.aivyro.io/reference/sequences
  - https://knowledge.aivyro.io/en/reference/members
  - https://knowledge.aivyro.io/en/reference/contacts
  - https://knowledge.aivyro.io/en/reference/meetings
  - https://knowledge.aivyro.io/en/reference/whatsapp
  - https://knowledge.aivyro.io/es/reference/contacts
  - https://knowledge.aivyro.io/en/reference/companies
  - https://knowledge.aivyro.io/en/reference/sequences
  - https://knowledge.aivyro.io/es/reference/companies
  - https://knowledge.aivyro.io/reference/conversations
  - https://knowledge.aivyro.io/en/reference/conversations
  - https://knowledge.aivyro.io/start/keys
  - https://knowledge.aivyro.io/en/webhooks
  - https://knowledge.aivyro.io/en/developers
  - https://knowledge.aivyro.io/en/start/keys
  - https://knowledge.aivyro.io/en/start/first-call
  - https://knowledge.aivyro.io/webhooks
  - https://knowledge.aivyro.io/webhooks/verify
  - https://knowledge.aivyro.io/en/webhooks/verify
  - https://knowledge.aivyro.io/developers
  - https://knowledge.aivyro.io/start/first-call
servers:
- url: https://api.aivyro.io
paths:
  /:
    get:
      operationId: get
      tags:
      - Api
      summary: GET /
      x-source: https://knowledge.aivyro.io/en/start/first-call
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -sS "$AIVYRO_API_BASE/api/v1/contacts"  -H "Authorization: Bearer $AIVYRO_API_KEY" An empty workspace returns { "data":
          [], "next_cursor": null, "has_more": false }. That is success. The created contact appears in Contacts for the same organization. Machine
          contract GET /api/v1/openapi.json is the contract for routes, pagination and errors. On some hosts the endpoint asks for the same Bearer '
  /aivyro/hooks:
    post:
      operationId: post_aivyro_hooks
      tags:
      - Aivyro
      summary: POST /aivyro/hooks
      x-source: https://knowledge.aivyro.io/en/webhooks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostAivyroHooksRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -sS -X POST "$AIVYRO_API_BASE/api/v1/webhooks"  -H "Authorization: Bearer $AIVYRO_API_KEY"  -H ''Content-Type: application/json''  -d
          ''{"url":"https://example.com/aivyro/hooks","events":["contact.created","deal.updated"]}'' Still need help? Tell us what happened, what
          you expected and which articles you tried. The right context shortens the path. Contact support Explore the platform AI revenue e'
  /api/v1/me:
    get:
      operationId: get_api_v1_me
      tags:
      - Api
      summary: GET /api/v1/me
      x-source: https://knowledge.aivyro.io/en/developers
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -sS "https://api.aivyro.io/api/v1/me"  -H "Authorization: Bearer $AIVYRO_API_KEY" Open the API reference → Build with AI
          (MCP) Connect Claude, Cursor or Codex Run the installer MCP Copy npx @aivyro/mcp setup Read the MCP guide → For developers API, MCP
          and webhooks. Connect your systems and build with Aivyro. Resolve Implement Operate 0 1 Resolve Understand responses, limits and failures
          with'
components:
  schemas:
    GetResponse:
      type: object
      properties:
        data:
          type: array
          items: {}
        next_cursor:
          type:
          - string
          - 'null'
        has_more:
          type: boolean
    PostAivyroHooksRequest:
      type: object
      properties:
        url:
          type: string
        events:
          type: array
          items:
            type: string
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
security:
- bearer: []
tags:
- name: Aivyro
- name: Api