Airia

Airia Prompts API

The Prompts API from Airia — 3 operation(s) for prompts.

GitHub OpenAPI

Operations 6

GET /v1/Prompts Prompts get prompts2 #
POST /v1/Prompts Prompts post prompt2 #
GET /v1/Prompts/{id} Prompts get active prompt version2 #
PUT /v1/Prompts/{id} Prompts put prompt2 #
DELETE /v1/Prompts/{id} Prompts delete prompt2 #
GET /v1/Prompts/{id}/references Prompts get prompt references2 #

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-prompts-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-prompts-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-prompts-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Airia Web Prompts API
  version: 1.0.0
servers:
- url: https://api.airia.ai
tags:
- name: Prompts
paths:
  /v1/Prompts:
    get:
      tags:
      - Prompts
      operationId: Prompts_GetPrompts2
      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
        style: form
        explode: true
        schema:
          type:
          - array
          - 'null'
          items:
            type: string
            format: guid
        x-position: 6
      - name: includeGlobal
        in: query
        schema:
          type: boolean
          default: false
        x-position: 7
      - name: pipelineVersionId
        in: query
        schema:
          type:
          - string
          - 'null'
          format: guid
        x-position: 8
      - name: x-correlation-id
        in: header
        schema:
          type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedResultOfPromptDto'
        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: Prompts get prompts2
      x-summary-source: derived
    post:
      tags:
      - Prompts
      operationId: Prompts_PostPrompt2
      parameters:
      - name: x-correlation-id
        in: header
        schema:
          type: string
      requestBody:
        x-name: promptDto
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePromptRequest'
        required: true
        x-position: 1
      responses:
        201:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PromptDto'
        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'
        409:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        500:
          description: ''
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Prompts post prompt2
      x-summary-source: derived
  /v1/Prompts/{id}:
    get:
      tags:
      - Prompts
      operationId: Prompts_GetActivePromptVersion2
      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/GetPromptDto'
        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'
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Prompts get active prompt version2
      x-summary-source: derived
    put:
      tags:
      - Prompts
      operationId: Prompts_PutPrompt2
      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: prompt
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePromptRequest'
        required: true
        x-position: 2
      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'
        409:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        500:
          description: ''
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Prompts put prompt2
      x-summary-source: derived
    delete:
      tags:
      - Prompts
      operationId: Prompts_DeletePrompt2
      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: ''
        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'
        422:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PromptUsageInfo'
        500:
          description: ''
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Prompts delete prompt2
      x-summary-source: derived
  /v1/Prompts/{id}/references:
    get:
      tags:
      - Prompts
      operationId: Prompts_GetPromptReferences2
      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/PromptUsageInfo'
        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'
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Prompts get prompt references2
      x-summary-source: derived
components:
  schemas:
    GetPromptDto:
      type: object
      additionalProperties: false
      properties:
        id:
          type: string
          format: guid
        name:
          type:
          - string
          - 'null'
        activeVersionId:
          type: string
          format: guid
        activeVersion:
          oneOf:
          - $ref: '#/components/schemas/PromptVersionDto'
        versions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/PromptVersionDto'
        createdAt:
          type:
          - string
          - 'null'
          format: date-time
        updatedAt:
          type:
          - string
          - 'null'
          format: date-time
        projectId:
          type:
          - string
          - 'null'
          format: guid
        isAgentSpecific:
          type: boolean
        usageInfo:
          oneOf:
          - $ref: '#/components/schemas/PromptUsageInfo'
    PipelineUsageInfo:
      type: object
      additionalProperties: false
      properties:
        pipelineId:
          type: string
          format: guid
        pipelineName:
          type: string
        pipelineVersionId:
          type: string
          format: guid
        versionNumber:
          type: string
        isLatest:
          type: boolean
        projectId:
          type:
          - string
          - 'null'
          format: guid
    PromptDto:
      type: object
      additionalProperties: false
      properties:
        id:
          type: string
          format: guid
        name:
          type:
          - string
          - 'null'
        activeVersionId:
          type: string
          format: guid
        activeVersion:
          oneOf:
          - $ref: '#/components/schemas/PromptVersionDto'
        createdAt:
          type:
          - string
          - 'null'
          format: date-time
        updatedAt:
          type:
          - string
          - 'null'
          format: date-time
        projectId:
          type:
          - string
          - 'null'
          format: guid
        projectName:
          type:
          - string
          - 'null'
        project:
          oneOf:
          - $ref: '#/components/schemas/ProjectModelBase'
        latestVersionNumber:
          type:
          - integer
          - 'null'
          format: int32
        isAgentSpecific:
          type: boolean
    PagedResultOfPromptDto:
      type: object
      additionalProperties: false
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/PromptDto'
        totalCount:
          type: integer
          format: int32
    ModelUsageInfo:
      type: object
      additionalProperties: false
      properties:
        modelId:
          type: string
          format: guid
        modelName:
          type: string
        projectId:
          type:
          - string
          - 'null'
          format: guid
    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'
    CreatePromptRequest:
      type: object
      additionalProperties: false
      properties:
        name:
          type:
          - string
          - 'null'
        projectId:
          type:
          - string
          - 'null'
          format: guid
        versionChangeDescription:
          type: string
        messages:
          type: array
          deprecated: true
          x-deprecatedMessage: Use Message instead. This property will be removed in a future version.
          items:
            $ref: '#/components/schemas/PromptMessageDto'
        message:
          type: string
        isAgentSpecific:
          type: boolean
    UpdatePromptRequest:
      type: object
      additionalProperties: false
      properties:
        id:
          type: string
          format: guid
        name:
          type: string
        description:
          type:
          - string
          - 'null'
        projectId:
          type:
          - string
          - 'null'
          format: guid
        activeVersionId:
          type: string
          format: guid
    PromptUsageInfo:
      type: object
      additionalProperties: false
      properties:
        pipelines:
          type: array
          items:
            $ref: '#/components/schemas/PipelineUsageInfo'
        models:
          type: array
          items:
            $ref: '#/components/schemas/ModelUsageInfo'
        segments:
          type: array
          items:
            $ref: '#/components/schemas/SegmentUsageInfo'
        usedInOtherProjects:
          type: boolean
        isInUse:
          type: boolean
        isInUseByLatestVersion:
          type: boolean
    ProjectModelBase:
      type: object
      additionalProperties: false
      properties:
        id:
          type: string
          format: guid
        name:
          type: string
    PromptVersionDto:
      type: object
      additionalProperties: false
      properties:
        id:
          type: string
          format: guid
        versionNumber:
          type: integer
          format: int32
        versionChangeDescription:
          type: string
        message:
          type:
          - string
          - 'null'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/PromptMessageDto'
        isLatest:
          type: boolean
        createdAt:
          type:
          - string
          - 'null'
          format: date-time
        updatedAt:
          type:
          - string
          - 'null'
          format: date-time
    SegmentUsageInfo:
      type: object
      additionalProperties: false
      properties:
        segmentId:
          type: string
          format: guid
        pipelineId:
          type: string
          format: guid
        pipelineName:
          type: string
        pipelineVersionId:
          type: string
          format: guid
        versionNumber:
          type: string
        isLatest:
          type: boolean
        projectId:
          type:
          - string
          - 'null'
          format: guid
    PromptMessageDto:
      type: object
      additionalProperties: false
      properties:
        text:
          type: string
        order:
          type: integer
          format: int32
  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))