Airia

Airia Experiences API

The Experiences API from Airia — 8 operation(s) for experiences.

GitHub OpenAPI

Operations 11

GET /v1/Experiences Experiences get experiences apps2 #
POST /v1/Experiences Experiences create experiences app2 #
GET /v1/Experiences/{id} Experiences get experiences app by id2 #
PUT /v1/Experiences/{id} Experiences update experiences app2 #
DELETE /v1/Experiences/{id} Experiences delete experiences app2 #
POST /v1/Experiences/generate Experiences generate experiences app2 #
POST /v1/Experiences/generate-async Experiences generate experiences app4 #
GET /v1/Experiences/seed Experiences seed experiences2 #
GET /v1/Experiences/examples Experiences get examples2 #
GET /v1/Experiences/templates Experiences get templates2 #
GET /v1/Experiences/example/{id} Experiences get example or template by id2 #

Documentation

📖
APIReference
https://api.airia.ai/docs/
📖
Documentation
https://airia.ai/docs/build/interface-options/api-deployment
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/airia/refs/heads/main/authentication/airia-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/airia/refs/heads/main/openapi/airia-experiences-api-openapi.yml

Other Resources

🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/airia/refs/heads/main/errors/airia-problem-types.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/airia/refs/heads/main/conventions/airia-conventions.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/airia/refs/heads/main/data-model/airia-data-model.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/airia/refs/heads/main/asyncapi/airia-webhooks.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/airia:airia-experiences-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

airia-experiences-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Airia Web Experiences API
  version: 1.0.0
servers:
- url: https://api.airia.ai
tags:
- name: Experiences
paths:
  /v1/Experiences:
    get:
      tags:
      - Experiences
      operationId: Experiences_GetExperiencesApps2
      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: status
        in: query
        schema:
          oneOf:
          - oneOf:
            - $ref: '#/components/schemas/ExperiencesAppStatus'
        x-position: 6
      - name: x-correlation-id
        in: header
        schema:
          type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedResultOfExperiencesApp'
        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'
        500:
          description: ''
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Experiences get experiences apps2
      x-summary-source: derived
    post:
      tags:
      - Experiences
      operationId: Experiences_CreateExperiencesApp2
      parameters:
      - name: x-correlation-id
        in: header
        schema:
          type: string
      requestBody:
        x-name: experiencesApp
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExperiencesApp'
        required: true
        x-position: 1
      responses:
        201:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExperiencesApp'
        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'
        500:
          description: ''
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Experiences create experiences app2
      x-summary-source: derived
  /v1/Experiences/{id}:
    get:
      tags:
      - Experiences
      operationId: Experiences_GetExperiencesAppById2
      parameters:
      - name: id
        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/ExperiencesApp'
        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'
        404:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        500:
          description: ''
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Experiences get experiences app by id2
      x-summary-source: derived
    put:
      tags:
      - Experiences
      operationId: Experiences_UpdateExperiencesApp2
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: guid
        x-position: 1
      - name: x-correlation-id
        in: header
        schema:
          type: string
      requestBody:
        x-name: experiencesApp
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExperiencesApp'
        required: true
        x-position: 2
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExperiencesApp'
        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'
        404:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        500:
          description: ''
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Experiences update experiences app2
      x-summary-source: derived
    delete:
      tags:
      - Experiences
      operationId: Experiences_DeleteExperiencesApp2
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: guid
        x-position: 1
      - name: x-correlation-id
        in: header
        schema:
          type: string
      responses:
        204:
          description: ''
        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'
        404:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        500:
          description: ''
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Experiences delete experiences app2
      x-summary-source: derived
  /v1/Experiences/generate:
    post:
      tags:
      - Experiences
      operationId: Experiences_GenerateExperiencesApp2
      parameters:
      - name: x-correlation-id
        in: header
        schema:
          type: string
      requestBody:
        x-name: request
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenerateExperiencesAppRequest'
        required: true
        x-position: 1
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExperiencesApp'
        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'
        500:
          description: ''
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Experiences generate experiences app2
      x-summary-source: derived
  /v1/Experiences/generate-async:
    post:
      tags:
      - Experiences
      operationId: Experiences_GenerateExperiencesApp4
      parameters:
      - name: x-correlation-id
        in: header
        schema:
          type: string
      requestBody:
        x-name: request
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenerateExperiencesAppRequest'
        required: true
        x-position: 1
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: string
                format: guid
        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'
        500:
          description: ''
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Experiences generate experiences app4
      x-summary-source: derived
  /v1/Experiences/seed:
    get:
      tags:
      - Experiences
      operationId: Experiences_SeedExperiences2
      parameters:
      - name: x-correlation-id
        in: header
        schema:
          type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExperiencesSeedResult'
        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'
        500:
          description: ''
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Experiences seed experiences2
      x-summary-source: derived
  /v1/Experiences/examples:
    get:
      tags:
      - Experiences
      operationId: Experiences_GetExamples2
      parameters:
      - name: x-correlation-id
        in: header
        schema:
          type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ExperiencesAppSummary'
        401:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        500:
          description: ''
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Experiences get examples2
      x-summary-source: derived
  /v1/Experiences/templates:
    get:
      tags:
      - Experiences
      operationId: Experiences_GetTemplates2
      parameters:
      - name: x-correlation-id
        in: header
        schema:
          type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ExperiencesAppSummary'
        401:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        500:
          description: ''
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Experiences get templates2
      x-summary-source: derived
  /v1/Experiences/example/{id}:
    get:
      tags:
      - Experiences
      operationId: Experiences_GetExampleOrTemplateById2
      parameters:
      - name: id
        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/ExperiencesAppDetail'
        401:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        404:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        500:
          description: ''
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Experiences get example or template by id2
      x-summary-source: derived
components:
  schemas:
    ChatMessage:
      type: object
      additionalProperties: false
      properties:
        id:
          type: string
        message:
          type: string
        timestamp:
          type: string
        role:
          type: string
        responseTime:
          type:
          - integer
          - 'null'
          format: int32
        toolResponses:
          type: array
          items:
            $ref: '#/components/schemas/ToolResponse'
        toolRequests:
          type: array
          items:
            $ref: '#/components/schemas/ToolRequest'
    ExperiencesAppStatus:
      type: string
      description: ''
      x-enumNames:
      - InProgress
      - InGeneration
      - Finished
      - Fail
      - Example
      - Template
      enum:
      - InProgress
      - InGeneration
      - Finished
      - Fail
      - Example
      - Template
    PagedResultOfExperiencesApp:
      type: object
      additionalProperties: false
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/ExperiencesApp'
        totalCount:
          type: integer
          format: int32
    JsonNode:
      type: object
      x-abstract: true
      additionalProperties: false
      properties:
        underlyingElement: {}
        options:
          oneOf:
          - $ref: '#/components/schemas/JsonNodeOptions'
        parent:
          oneOf:
          - $ref: '#/components/schemas/JsonNode'
        root:
          $ref: '#/components/schemas/JsonNode'
    ExperiencesAppDetail:
      type: object
      additionalProperties: false
      properties:
        id:
          type: string
          format: guid
        name:
          type: string
        description:
          type:
          - string
          - 'null'
        reactCode:
          type:
          - string
          - 'null'
    GenerateExperiencesAppRequest:
      type: object
      additionalProperties: false
      properties:
        prompt:
          type: string
        experiencesAppId:
          type:
          - string
          - 'null'
          format: guid
        inMemoryMessages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ChatMessage'
    ExperiencesAppSummary:
      type: object
      additionalProperties: false
      properties:
        id:
          type: string
          format: guid
        name:
          type: string
        description:
          type:
          - string
          - 'null'
    ToolResponse:
      type: object
      additionalProperties: false
      properties:
        toolCallId:
          type: string
        toolName:
          type: string
        response:
          type:
          - string
          - 'null'
    ToolRequest:
      allOf:
      - $ref: '#/components/schemas/BaseAssistantMessagePart'
      - type: object
        additionalProperties: false
        properties:
          toolCallId:
            type: string
          toolName:
            type: string
          parameters:
            type: array
            items:
              $ref: '#/components/schemas/KeyValuePairOfStringAndJsonNode'
          thoughtSignature:
            type:
            - string
            - 'null'
    KeyValuePairOfStringAndJsonNode:
      type: object
      additionalProperties: false
      properties:
        key:
          type:
          - string
          - 'null'
        value:
          oneOf:
          - $ref: '#/components/schemas/JsonNode'
    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'
    BaseAssistantMessagePart:
      type: object
      x-abstract: true
      additionalProperties: false
      properties:
        index:
          type: integer
          format: int32
    BaseAuditEntity:
      type: object
      x-abstract: true
      additionalProperties: false
      properties:
        createdAt:
          type:
          - string
          - 'null'
          format: date-time
        updatedAt:
          type:
          - string
          - 'null'
          format: date-time
        userId:
          type:
          - string
          - 'null'
          format: guid
    JsonNodeOptions:
      type: object
      additionalProperties: false
      properties:
        propertyNameCaseInsensitive:
          type: boolean
    ExperiencesApp:
      allOf:
      - $ref: '#/components/schemas/BaseAuditEntity'
      - type: object
        additionalProperties: false
        required:
        - name
        properties:
          id:
            type: string
            format: guid
          tenantId:
            type: string
            format: guid
          name:
            type: string
            maxLength: 255
            minLength: 1
          description:
            type:
            - string
            - 'null'
            maxLength: 1000
          reactCode:
            type:
            - string
            - 'null'
          reactContext:
            type:
            - string
            - 'null'
          status:
            $ref: '#/components/schemas/ExperiencesAppStatus'
    ExperiencesSeedResult:
      type: object
      additionalProperties: false
      properties:
        projectId:
          type: string
          format: guid
        pipelineId:
          type: string
          format: guid
  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))