Assistant

Chat with catalog assistant

post

Streaming AI assistant that answers questions about the API catalog using tools to query services and their details.

Authorizations

projectApiKeypersonalAccessToken

AuthorizationstringRequired

Project API key authentication. Use your project API key as a Bearer token in the Authorization header.

Path parameters

versionIdstring · min: 30 · max: 30Required

Catalog version identifier

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

Body

application/json

AI-sdk structured conversation payload for the AI assistant

Responses

200

Server-sent events stream of AI assistant response

text/event-stream

Responseany

AI-sdk protocol streaming response

400

Invalid request

application/json

500

Internal Server Error

application/json

post

/v2/catalog/versions/{versionId}/assistant

HTTPcURLJavaScriptPython

POST /v2/catalog/versions/{versionId}/assistant HTTP/1.1
Host: api.appear.sh
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 212

{
  "messages": [
    {
      "id": "text",
      "role": "system",
      "parts": [
        {
          "type": "text",
          "text": "text",
          "state": "streaming",
          "providerMetadata": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          }
        }
      ],
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ]
}

No content

Chat with catalog assistant

post

Streaming AI assistant that answers questions about the API catalog using tools to query services and their details.

Authorizations

projectApiKeypersonalAccessToken

AuthorizationstringRequired

Project API key authentication. Use your project API key as a Bearer token in the Authorization header.

Path parameters

projectRefany ofRequired

Project slug or project id (proj_*)

string · min: 31 · max: 31Optional

Object ID with prefix "proj_"

Example: proj_c4x6k3w8j7n9b1z5s2t4m8q0ve

or

string · min: 1Optional

versionTypestring · enumRequired

Version type, can be either 'branch' or 'environment'

Example: branchPossible values:

versionSlugstring · min: 1Required

Version slug

Example: main

Body

application/json

AI-sdk structured conversation payload for the AI assistant

Responses

200

Server-sent events stream of AI assistant response

text/event-stream

Responseany

AI-sdk protocol streaming response

400

Invalid request

application/json

500

Internal Server Error

application/json

post

/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/assistant

HTTPcURLJavaScriptPython

POST /v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/assistant HTTP/1.1
Host: api.appear.sh
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 212

{
  "messages": [
    {
      "id": "text",
      "role": "system",
      "parts": [
        {
          "type": "text",
          "text": "text",
          "state": "streaming",
          "providerMetadata": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          }
        }
      ],
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ]
}

No content