openapi: 3.2.0
info:
  title: Airia Web Agent Card API
  version: 1.0.0
servers:
- url: https://api.airia.ai
tags:
- name: AgentCard
paths:
  /v1/AgentCard:
    get:
      tags:
      - AgentCard
      operationId: AgentCard_GetAll
      parameters:
      - name: PageNumber
        in: query
        schema:
          type: integer
          format: int32
        x-position: 1
      - name: PageSize
        in: query
        schema:
          type: integer
          format: int32
        x-position: 2
      - name: SortBy
        in: query
        schema:
          type:
          - string
          - 'null'
        x-position: 3
      - name: SortDirection
        in: query
        schema:
          type: string
        x-position: 4
      - name: filter
        in: query
        schema:
          type:
          - string
          - 'null'
        x-position: 5
      - name: projectId
        in: query
        schema:
          type:
          - string
          - 'null'
        x-position: 6
      - name: x-correlation-id
        in: header
        schema:
          type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AgentCardModelList'
        400:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        401:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        403:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Agent card get all
      x-summary-source: derived
    post:
      tags:
      - AgentCard
      operationId: AgentCard_Create
      parameters:
      - name: x-correlation-id
        in: header
        schema:
          type: string
      requestBody:
        x-name: agentCardModels
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/AgentCardModel'
        required: true
        x-position: 1
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AgentCardCreationResponse'
        401:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        403:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Agent card create
      x-summary-source: derived
  /v1/AgentCard/{agentCardId}:
    get:
      tags:
      - AgentCard
      operationId: AgentCard_Get
      parameters:
      - name: agentCardId
        in: path
        required: true
        schema:
          type: string
          format: guid
        x-position: 1
      - name: x-correlation-id
        in: header
        schema:
          type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentCardModel'
        404:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        401:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        403:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Agent card get
      x-summary-source: derived
components:
  schemas:
    AgentProvider:
      type: object
      additionalProperties: false
      properties:
        organization:
          type: string
        url:
          type: string
    AgentCardSignature:
      type: object
      additionalProperties: false
      properties:
        protected:
          type: string
        signature:
          type: string
        header:
          type:
          - object
          - 'null'
          additionalProperties: {}
    AgentCapabilities:
      type: object
      additionalProperties: false
      properties:
        streaming:
          type:
          - boolean
          - 'null'
        pushNotifications:
          type:
          - boolean
          - 'null'
        extendedAgentCard:
          type:
          - boolean
          - 'null'
        extensions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AgentExtension'
    SecurityScheme:
      type: object
      discriminator:
        propertyName: type
        mapping:
          apiKey: '#/components/schemas/ApiKeySecurityScheme'
          http: '#/components/schemas/HttpSecurityScheme'
          oauth2: '#/components/schemas/OAuth2SecurityScheme'
          openIdConnect: '#/components/schemas/OpenIdConnectSecurityScheme'
          mutualTLS: '#/components/schemas/MutualTlsSecurityScheme'
      x-abstract: true
      additionalProperties: false
      required:
      - type
      properties:
        description:
          type:
          - string
          - 'null'
        type:
          type: string
    ProblemDetails:
      type: object
      additionalProperties: {}
      properties:
        type:
          type:
          - string
          - 'null'
        title:
          type:
          - string
          - 'null'
        status:
          type:
          - integer
          - 'null'
          format: int32
        detail:
          type:
          - string
          - 'null'
        instance:
          type:
          - string
          - 'null'
    AgentCardModelList:
      allOf:
      - $ref: '#/components/schemas/AgentCardModel'
      - type: object
        additionalProperties: false
        properties:
          agentCardId:
            type: string
            format: guid
    AgentInterface:
      type: object
      additionalProperties: false
      properties:
        url:
          type: string
        protocolBinding:
          type: string
        protocolVersion:
          type: string
        tenant:
          type:
          - string
          - 'null'
    AgentSkill:
      type: object
      additionalProperties: false
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type: string
        tags:
          type: array
          items:
            type: string
        examples:
          type:
          - array
          - 'null'
          items:
            type: string
        inputModes:
          type:
          - array
          - 'null'
          items:
            type: string
        outputModes:
          type:
          - array
          - 'null'
          items:
            type: string
        securityRequirements:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SecurityRequirement'
    AgentExtension:
      type: object
      additionalProperties: false
      properties:
        uri:
          type: string
        description:
          type:
          - string
          - 'null'
        required:
          type:
          - boolean
          - 'null'
        params:
          type:
          - object
          - 'null'
          additionalProperties: {}
    SecurityRequirement:
      type: object
      additionalProperties: false
      properties:
        schemes:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
    AgentCardCreationResponse:
      type: object
      additionalProperties: false
      properties:
        success:
          type: boolean
        requestedName:
          type: string
        createdId:
          type:
          - string
          - 'null'
          format: guid
        createdUrl:
          type:
          - string
          - 'null'
        errorMessage:
          type:
          - string
          - 'null'
        createdAgentId:
          type:
          - string
          - 'null'
          format: guid
    AgentCardModel:
      type: object
      additionalProperties: false
      required:
      - projectId
      properties:
        projectId:
          type: string
          format: guid
        name:
          type: string
        description:
          type: string
        supportedInterfaces:
          type: array
          items:
            $ref: '#/components/schemas/AgentInterface'
        provider:
          oneOf:
          - $ref: '#/components/schemas/AgentProvider'
        version:
          type: string
        documentationUrl:
          type:
          - string
          - 'null'
        iconUrl:
          type:
          - string
          - 'null'
        capabilities:
          $ref: '#/components/schemas/AgentCapabilities'
        securitySchemes:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/SecurityScheme'
        securityRequirements:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SecurityRequirement'
        signatures:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AgentCardSignature'
        defaultInputModes:
          type:
          - array
          - 'null'
          items:
            type: string
        defaultOutputModes:
          type:
          - array
          - 'null'
          items:
            type: string
        skills:
          type: array
          items:
            $ref: '#/components/schemas/AgentSkill'
  securitySchemes:
    ApiKey:
      type: apiKey
      description: API Key Authentication
      name: X-API-Key
      in: header
    Cookies:
      type: apiKey
      description: Cookie based Authentication
      name: Cookie
      in: header
x-generator: NSwag v14.7.1.0 (NJsonSchema v11.6.1.0 (Newtonsoft.Json v13.0.0.0))