Airia

Airia Artifact API

The Artifact API from Airia — 6 operation(s) for artifact.

GitHub OpenAPI

Operations 9

GET /v1/Artifact Artifact get artifacts #
POST /v1/Artifact Artifact create artifact #
GET /v1/Artifact/{artifactId}/conversation/{conversationId}/message/{messageId} Artifact get artifact by id #
DELETE /v1/Artifact/{artifactId}/conversation/{conversationId}/message/{messageId} Artifact delete artifact #
GET /v1/Artifact/conversation/{conversationId} Artifact get artifacts by conversation id #
POST /v1/Artifact/conversation/{conversationId}/recover Artifact recover artifacts for conversation #
PUT /v1/Artifact/{artifactId} Artifact update artifact #
POST /v1/Artifact/{artifactId}/conversation/{conversationId}/message/{messageId}/bookmark Artifact bookmark artifact #
DELETE /v1/Artifact/{artifactId}/conversation/{conversationId}/message/{messageId}/bookmark Artifact remove artifact bookmark #

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-artifact-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-artifact-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-artifact-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Airia Web Artifact API
  version: 1.0.0
servers:
- url: https://api.airia.ai
tags:
- name: Artifact
paths:
  /v1/Artifact:
    get:
      tags:
      - Artifact
      operationId: Artifact_GetArtifacts
      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: x-correlation-id
        in: header
        schema:
          type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedResultOfArtifactModel'
        401:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Artifact get artifacts
      x-summary-source: derived
    post:
      tags:
      - Artifact
      operationId: Artifact_CreateArtifact
      parameters:
      - name: x-correlation-id
        in: header
        schema:
          type: string
      requestBody:
        x-name: createArtifactRequest
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ArtifactModel'
        required: true
        x-position: 1
      responses:
        201:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ArtifactModel'
        401:
          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: Artifact create artifact
      x-summary-source: derived
  /v1/Artifact/{artifactId}/conversation/{conversationId}/message/{messageId}:
    get:
      tags:
      - Artifact
      operationId: Artifact_GetArtifactById
      parameters:
      - name: artifactId
        in: path
        required: true
        schema:
          type: string
          format: guid
        x-position: 1
      - name: conversationId
        in: path
        required: true
        schema:
          type: string
          format: guid
        x-position: 2
      - name: messageId
        in: path
        required: true
        schema:
          type: string
          format: guid
        x-position: 3
      - name: x-correlation-id
        in: header
        schema:
          type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ArtifactModel'
        404:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        401:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Artifact get artifact by id
      x-summary-source: derived
    delete:
      tags:
      - Artifact
      operationId: Artifact_DeleteArtifact
      parameters:
      - name: artifactId
        in: path
        required: true
        schema:
          type: string
          format: guid
        x-position: 1
      - name: conversationId
        in: path
        required: true
        schema:
          type: string
          format: guid
        x-position: 2
      - name: messageId
        in: path
        required: true
        schema:
          type: string
          format: guid
        x-position: 3
      - name: x-correlation-id
        in: header
        schema:
          type: string
      responses:
        204:
          description: ''
        401:
          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: Artifact delete artifact
      x-summary-source: derived
  /v1/Artifact/conversation/{conversationId}:
    get:
      tags:
      - Artifact
      operationId: Artifact_GetArtifactsByConversationId
      parameters:
      - name: conversationId
        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:
                type: array
                items:
                  $ref: '#/components/schemas/ArtifactModel'
        404:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        401:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Artifact get artifacts by conversation id
      x-summary-source: derived
  /v1/Artifact/conversation/{conversationId}/recover:
    post:
      tags:
      - Artifact
      operationId: Artifact_RecoverArtifactsForConversation
      parameters:
      - name: conversationId
        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:
                type: array
                items:
                  $ref: '#/components/schemas/ArtifactModel'
        404:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        401:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Artifact recover artifacts for conversation
      x-summary-source: derived
  /v1/Artifact/{artifactId}:
    put:
      tags:
      - Artifact
      operationId: Artifact_UpdateArtifact
      parameters:
      - name: artifactId
        in: path
        required: true
        schema:
          type: string
          format: guid
        x-position: 1
      - name: x-correlation-id
        in: header
        schema:
          type: string
      requestBody:
        x-name: updateArtifactRequest
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ArtifactModel'
        required: true
        x-position: 2
      responses:
        200:
          description: ''
        400:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        401:
          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: Artifact update artifact
      x-summary-source: derived
  /v1/Artifact/{artifactId}/conversation/{conversationId}/message/{messageId}/bookmark:
    post:
      tags:
      - Artifact
      operationId: Artifact_BookmarkArtifact
      parameters:
      - name: artifactId
        in: path
        required: true
        schema:
          type: string
          format: guid
        x-position: 1
      - name: conversationId
        in: path
        required: true
        schema:
          type: string
          format: guid
        x-position: 2
      - name: messageId
        in: path
        required: true
        schema:
          type: string
          format: guid
        x-position: 3
      - name: x-correlation-id
        in: header
        schema:
          type: string
      responses:
        204:
          description: ''
        401:
          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: Artifact bookmark artifact
      x-summary-source: derived
    delete:
      tags:
      - Artifact
      operationId: Artifact_RemoveArtifactBookmark
      parameters:
      - name: artifactId
        in: path
        required: true
        schema:
          type: string
          format: guid
        x-position: 1
      - name: conversationId
        in: path
        required: true
        schema:
          type: string
          format: guid
        x-position: 2
      - name: messageId
        in: path
        required: true
        schema:
          type: string
          format: guid
        x-position: 3
      - name: x-correlation-id
        in: header
        schema:
          type: string
      responses:
        204:
          description: ''
        401:
          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: Artifact remove artifact bookmark
      x-summary-source: derived
components:
  schemas:
    PagedResultOfArtifactModel:
      type: object
      additionalProperties: false
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/ArtifactModel'
        totalCount:
          type: integer
          format: int32
    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'
    ArtifactModel:
      type: object
      additionalProperties: false
      required:
      - id
      - messageId
      - conversationId
      - assistantId
      properties:
        id:
          type: string
          format: guid
        updatedAt:
          type: string
          format: date-time
        createdAt:
          type: string
          format: date-time
        messageId:
          type: string
          format: guid
        conversationId:
          type: string
          format: guid
        assistantId:
          type: string
          format: guid
        name:
          type: string
        content:
          type: string
        isBookmarked:
          type: boolean
  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))