@avallon-labs/sdk 0.0.0-0ca09b5e

package/openapi.yaml

@@ -0,0 +1,986 @@
+openapi: 3.1.0
+info:
+  title: Avallon API
+  version: 1.0.0
+servers:
+  - url: https://api.avallon.ai
+    description: US Region (Virginia)
+  - url: https://api.eu.avallon.ai
+    description: EU Region (Frankfurt)
+security:
+  - ApiKeyAuth: []
+paths:
+  /v1/agents:
+    get:
+      summary: List agents
+      description: |-
+        List all agents for your tenant.
+
+        **Filtering:**
+
+        Filter agents by name using the `agent_name` query parameter (exact match).
+
+        **Response:**
+
+        Returns an array of all agents with their configurations and a total count.
+      operationId: listAgents
+      tags:
+        - Agents
+      parameters:
+        - in: query
+          name: agent_name
+          schema:
+            description: Filter by exact agent name
+            example: customer-support-agent
+            type: string
+          description: Filter by exact agent name
+      responses:
+        "200":
+          description: List of agents
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/AgentList"
+        "400":
+          description: Bad request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "401":
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "409":
+          description: Conflict
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "500":
+          description: Internal server error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+    post:
+      summary: Create agent
+      description: |-
+        Create a new voice agent with the specified configuration.
+
+        **Required fields:**
+
+        All fields in the request body are required except `phone_number_id` and `transfer_phone_number`.
+
+        **Response:**
+
+        Returns the created agent with its ID and configuration.
+      operationId: createAgent
+      tags:
+        - Agents
+      requestBody:
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                agent_name:
+                  type: string
+                  minLength: 1
+                  description: Name for the agent
+                  example: customer-support-agent
+                direction:
+                  type: string
+                  enum:
+                    - OUTBOUND
+                    - INBOUND
+                  description: Call direction the agent handles
+                  example: INBOUND
+                llm_model:
+                  type: string
+                  enum:
+                    - GPT4.1
+                    - AZURE-GPT4o
+                    - AZURE-GPT4.1
+                    - GPT-5
+                    - GPT-5-low
+                    - GPT-5-high
+                    - GPT-5.1-chat-latest
+                    - GPT-5.1-no-reasoning
+                    - GEMINI-1.5-flash
+                    - GEMINI-2.5-flash
+                    - GEMINI-2.5-flash-lite
+                    - GEMINI-3-flash
+                  description: LLM model for conversation
+                  example: GPT-5
+                tts_provider:
+                  type: string
+                  enum:
+                    - elevenlabs
+                    - cartesia
+                    - google
+                  description: Text-to-speech provider
+                  example: elevenlabs
+                tts_model:
+                  type: string
+                  enum:
+                    - eleven_flash_v2_5
+                    - eleven_turbo_v2_5
+                    - sonic-multilingual
+                    - sonic-3
+                    - chirp_3
+                  description: Text-to-speech model
+                  example: eleven_flash_v2_5
+                tts_voice_id:
+                  anyOf:
+                    - anyOf:
+                        - type: string
+                          enum:
+                            - Achernar
+                            - Achird
+                        - type: string
+                          enum:
+                            - v3V1d2rk6528UrLKRuy8
+                    - type: string
+                      enum:
+                        - 5c42302c-194b-4d0c-ba1a-8cb485c84ab9
+                        - e8e5fffb-252c-436d-b842-8879b84445b6
+                        - f786b574-daa5-4673-aa0c-cbe3e8534c02
+                        - 8d8ce8c9-44a4-46c4-b10f-9a927b99a853
+                        - 5ee9feff-1265-424a-9d7f-8e4d431a12c7
+                        - b9de4a89-2257-424b-94c2-db18ba68c81a
+                  description: Voice ID from the TTS provider
+                  example: 21m00Tcm4TlvDq8ikWAM
+                stt_model:
+                  type: string
+                  enum:
+                    - DEEPGRAM-NOVA-2-GENERAL
+                    - DEEPGRAM-NOVA-3-GENERAL
+                    - AWS-TRANSCRIBE
+                  description: Speech-to-text model
+                  example: DEEPGRAM-NOVA-3-GENERAL
+                transfer_phone_number:
+                  anyOf:
+                    - type: string
+                    - type: "null"
+                  description: Phone number to transfer calls to
+                  example: null
+                phone_number_id:
+                  description: ID of phone number to assign to agent
+                  example: pn_123456
+                  type: string
+                language:
+                  type: string
+                  enum:
+                    - en-US
+                    - de-DE
+                  description: Language for the agent
+                  example: en-US
+                dial_pad:
+                  description: Whether the agent supports DTMF dial pad input
+                  example: false
+                  type: boolean
+                end_call:
+                  description: Whether the agent can end the call
+                  example: false
+                  type: boolean
+              required:
+                - agent_name
+                - direction
+                - llm_model
+                - tts_provider
+                - tts_model
+                - tts_voice_id
+                - stt_model
+                - transfer_phone_number
+                - language
+      responses:
+        "201":
+          description: Created agent
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/CreateAgentResponse"
+        "400":
+          description: Bad request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "401":
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "409":
+          description: Conflict
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "500":
+          description: Internal server error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+  /v1/agents/{id}:
+    get:
+      summary: Get agent
+      description: Retrieve a single agent by ID.
+      operationId: getAgent
+      tags:
+        - Agents
+      parameters:
+        - in: path
+          name: id
+          schema:
+            type: string
+            minLength: 1
+            description: Agent ID
+            example: 550e8400-e29b-41d4-a716-446655440000
+          required: true
+          description: Agent ID
+      responses:
+        "200":
+          description: Agent details
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/GetAgentResponse"
+        "400":
+          description: Bad request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "401":
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "404":
+          description: Not found
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "409":
+          description: Conflict
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "500":
+          description: Internal server error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+  /platform/api-keys:
+    get:
+      summary: List API keys
+      description: |-
+        List all API keys for your tenant.
+
+        By default, revoked keys are excluded. Set `include_revoked=true` to include them.
+
+        **Note:** The full API key value is never returned — only the key prefix is shown.
+      operationId: listApiKeys
+      tags:
+        - API Keys
+      parameters:
+        - in: query
+          name: include_revoked
+          schema:
+            description: Include revoked keys in the response
+            type: string
+            enum:
+              - "true"
+              - "false"
+          description: Include revoked keys in the response
+      responses:
+        "200":
+          description: List of API keys
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ApiKeyList"
+        "400":
+          description: Bad request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "401":
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "409":
+          description: Conflict
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "500":
+          description: Internal server error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+    post:
+      summary: Create an API key
+      description: >-
+        Create a new API key for authenticating with the Avallon API.
+
+
+        **Important:** The full API key is only returned once in the response. Store it securely — it cannot be
+        retrieved again.
+
+
+        Keys are scoped to an environment (`test` or `live`) and optionally accept an expiration date.
+      operationId: createApiKey
+      tags:
+        - API Keys
+      requestBody:
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                name:
+                  type: string
+                  minLength: 1
+                  maxLength: 100
+                  description: Human-readable name for the API key
+                expires_at:
+                  description: Optional expiration date (ISO 8601)
+                  type: string
+                  format: date-time
+                environment:
+                  default: live
+                  description: Target environment for the key
+                  type: string
+                  enum:
+                    - test
+                    - live
+              required:
+                - name
+      responses:
+        "201":
+          description: The created API key (includes the full key — only shown once)
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ApiKeyCreated"
+        "400":
+          description: Bad request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "401":
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "409":
+          description: Conflict
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "500":
+          description: Internal server error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+  /platform/api-keys/{id}/revoke:
+    post:
+      summary: Revoke an API key
+      description: |-
+        Revoke an existing API key. Once revoked, the key can no longer be used for authentication.
+
+        This operation is irreversible — revoked keys cannot be re-enabled. Create a new key if needed.
+
+        Returns 409 if the key is already revoked, 404 if the key does not exist.
+      operationId: revokeApiKey
+      tags:
+        - API Keys
+      parameters:
+        - in: path
+          name: id
+          schema:
+            type: string
+            format: uuid
+            pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
+            description: The API key ID to revoke
+          required: true
+          description: The API key ID to revoke
+      responses:
+        "200":
+          description: Revocation confirmation
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ConfirmationResponse"
+        "400":
+          description: Bad request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "401":
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "404":
+          description: Not found
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "409":
+          description: Conflict
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "500":
+          description: Internal server error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+  /v1/auth/sign-up:
+    post:
+      tags:
+        - Auth
+      security: []
+      requestBody:
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                email:
+                  type: string
+                  format: email
+                  pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
+                password:
+                  type: string
+              required:
+                - email
+                - password
+      responses:
+        "200":
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/EmptyResponse"
+        "400":
+          description: Bad request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "401":
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "409":
+          description: Conflict
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "500":
+          description: Internal server error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+  /v1/auth/sign-in:
+    post:
+      tags:
+        - Auth
+      security: []
+      requestBody:
+        content:
+          application/json:
+            schema:
+              oneOf:
+                - type: object
+                  properties:
+                    type:
+                      type: string
+                      const: password
+                    email:
+                      type: string
+                    password:
+                      type: string
+                  required:
+                    - type
+                    - email
+                    - password
+                - type: object
+                  properties:
+                    type:
+                      type: string
+                      const: oauth
+                    code:
+                      type: string
+                    verifier:
+                      type: string
+                  required:
+                    - type
+                    - code
+                    - verifier
+                - type: object
+                  properties:
+                    type:
+                      type: string
+                      const: email_otp
+                    email:
+                      type: string
+                      format: email
+                      pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
+                    token:
+                      type: string
+                      minLength: 1
+                  required:
+                    - type
+                    - email
+                    - token
+              type: object
+      responses:
+        "200":
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/AuthTokens"
+        "400":
+          description: Bad request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "401":
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "409":
+          description: Conflict
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "500":
+          description: Internal server error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+  /v1/auth/refresh-token:
+    post:
+      tags:
+        - Auth
+      security: []
+      requestBody:
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                access_token:
+                  type: string
+                refresh_token:
+                  type: string
+              required:
+                - access_token
+                - refresh_token
+      responses:
+        "200":
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/AuthTokens"
+        "400":
+          description: Bad request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "401":
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "409":
+          description: Conflict
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "500":
+          description: Internal server error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+  /v1/auth/oauth-url:
+    get:
+      tags:
+        - Auth
+      security: []
+      parameters:
+        - in: query
+          name: provider
+          schema:
+            type: string
+            enum:
+              - google
+              - microsoft
+          required: true
+        - in: query
+          name: redirect_uri
+          schema:
+            type: string
+            format: uri
+          required: true
+        - in: query
+          name: code_challenge_method
+          schema:
+            type: string
+            enum:
+              - plain
+              - s256
+          required: true
+        - in: query
+          name: code_challenge
+          schema:
+            type: string
+            minLength: 1
+          required: true
+      responses:
+        "200":
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/OAuthUrl"
+        "400":
+          description: Bad request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "401":
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "409":
+          description: Conflict
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "500":
+          description: Internal server error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+components:
+  schemas:
+    AgentList:
+      type: object
+      properties:
+        agents:
+          type: array
+          items:
+            $ref: "#/components/schemas/Agent"
+        total:
+          type: integer
+          minimum: -9007199254740991
+          maximum: 9007199254740991
+          description: Total number of agents
+          example: 2
+      required:
+        - agents
+        - total
+      additionalProperties: false
+    Agent:
+      type: object
+      properties:
+        id:
+          type: string
+        tenant_id:
+          type: string
+        agent_name:
+          type: string
+        direction:
+          type: string
+          enum:
+            - INBOUND
+            - OUTBOUND
+        llm_model:
+          type: string
+          enum:
+            - GPT4.1
+            - AZURE-GPT4o
+            - AZURE-GPT4.1
+            - GPT-5
+            - GPT-5-low
+            - GPT-5-high
+            - GPT-5.1-chat-latest
+            - GPT-5.1-no-reasoning
+            - GEMINI-1.5-flash
+            - GEMINI-2.5-flash
+            - GEMINI-2.5-flash-lite
+            - GEMINI-3-flash
+        tts_provider:
+          type: string
+          enum:
+            - elevenlabs
+            - cartesia
+            - google
+        tts_model:
+          type: string
+          enum:
+            - eleven_flash_v2_5
+            - eleven_turbo_v2_5
+            - sonic-multilingual
+            - sonic-3
+            - chirp_3
+        language:
+          type: string
+          enum:
+            - en-US
+            - de-DE
+        tts_voice_id:
+          type: string
+        stt_model:
+          type: string
+          enum:
+            - DEEPGRAM-NOVA-2-GENERAL
+            - DEEPGRAM-NOVA-3-GENERAL
+            - AWS-TRANSCRIBE
+        transfer_phone_number:
+          anyOf:
+            - type: string
+            - type: "null"
+        background_sounds:
+          type: string
+          enum:
+            - enabled
+            - disabled
+        created_at:
+          type: string
+          format: date-time
+        updated_at:
+          type: string
+          format: date-time
+        phone_number:
+          anyOf:
+            - type: string
+            - type: "null"
+        dial_pad:
+          type: boolean
+        end_call:
+          type: boolean
+      required:
+        - id
+        - tenant_id
+        - agent_name
+        - direction
+        - llm_model
+        - tts_provider
+        - tts_model
+        - language
+        - tts_voice_id
+        - stt_model
+        - transfer_phone_number
+        - background_sounds
+        - created_at
+        - updated_at
+        - phone_number
+        - dial_pad
+        - end_call
+      additionalProperties: false
+    ErrorResponse:
+      type: object
+      properties:
+        data:
+          type: object
+          properties: {}
+          additionalProperties: false
+        message:
+          type: string
+          description: Human-readable error message
+      required:
+        - data
+        - message
+      additionalProperties: false
+    CreateAgentResponse:
+      type: object
+      properties:
+        agent:
+          $ref: "#/components/schemas/Agent"
+      required:
+        - agent
+      additionalProperties: false
+    GetAgentResponse:
+      type: object
+      properties:
+        agent:
+          $ref: "#/components/schemas/Agent"
+      required:
+        - agent
+      additionalProperties: false
+    ApiKeyList:
+      type: object
+      properties:
+        data:
+          type: array
+          items:
+            $ref: "#/components/schemas/ApiKey"
+        count:
+          type: number
+          description: Total number of keys returned
+      required:
+        - data
+        - count
+      additionalProperties: false
+    ApiKey:
+      type: object
+      properties:
+        id:
+          type: string
+          description: Unique identifier for the API key
+        name:
+          type: string
+          description: Human-readable name for the API key
+        key_prefix:
+          type: string
+          description: First 12 characters of the key (e.g. ak_live_abc1)
+        last_used_at:
+          description: Last usage timestamp, if ever used
+          type: string
+          format: date-time
+        expires_at:
+          description: Expiration date, if set
+          type: string
+          format: date-time
+        revoked_at:
+          description: Revocation timestamp, if revoked
+          type: string
+          format: date-time
+        created_at:
+          type: string
+          format: date-time
+          description: Creation timestamp
+        updated_at:
+          type: string
+          format: date-time
+          description: Last update timestamp
+      required:
+        - id
+        - name
+        - key_prefix
+        - created_at
+        - updated_at
+      additionalProperties: false
+    ApiKeyCreated:
+      type: object
+      properties:
+        id:
+          type: string
+          description: Unique identifier for the API key
+        name:
+          type: string
+          description: Human-readable name for the API key
+        key_prefix:
+          type: string
+          description: First 12 characters of the key (e.g. ak_live_abc1)
+        expires_at:
+          description: Expiration date, if set
+          type: string
+          format: date-time
+        created_at:
+          type: string
+          format: date-time
+          description: Creation timestamp
+        api_key:
+          type: string
+          description: The full API key — only returned once at creation
+      required:
+        - id
+        - name
+        - key_prefix
+        - created_at
+        - api_key
+      additionalProperties: false
+    ConfirmationResponse:
+      type: object
+      properties:
+        message:
+          type: string
+          description: Confirmation message
+      required:
+        - message
+      additionalProperties: false
+    EmptyResponse:
+      type: object
+      properties: {}
+      additionalProperties: false
+    AuthTokens:
+      type: object
+      properties:
+        access_token:
+          type: string
+        refresh_token:
+          type: string
+        expires_at:
+          type: string
+          format: date-time
+      required:
+        - access_token
+        - refresh_token
+        - expires_at
+      additionalProperties: false
+    OAuthUrl:
+      type: object
+      properties:
+        url:
+          type: string
+          format: uri
+      required:
+        - url
+      additionalProperties: false
+  securitySchemes:
+    ApiKeyAuth:
+      type: apiKey
+      in: header
+      name: x-api-key
+      description: API key for authentication