ai

Retrieve AI answer

Polls for the result of a search request. Returns the generated answer and metadata once ready.

get/ai/answer

Request

  • Base URL
    https://public.stonly.com/api/v3
  • Auth
    HTTP basic

Query parameters

teamIdinteger

ID of the team to manage. Optional if the API key is associated with a single team.

questionAnswerIdstring uuid required
Example:048a3878-18cb-4aac-a821-6bcef12ac014

Unique UUID of the specific question/answer interaction.

Response

Answer successfully generated.

questionAnswerIdstring uuid required

Unique identifier for the generated AI answer

conversationIdstring uuid required

Unique identifier for the current conversation

querystring required

Original query submitted by the user

answerstring required
status'NEW' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED' required

Current processing status of the answer

Example response

{
  "questionAnswerId": "92c3c11c-5a2b-4814-a97d-cf2e0e5256a9",
  "conversationId": "928b59ad-f24d-44b2-933f-4c88fbcc75c7",
  "query": "What is Stonly?",
  "queryMetadata": {
    "language": "en",
    "aiAgentId": 736,
    "userEmail": "user@example.com",
    "webhookUrl": "https://example.com/webhook",
    "kbBaseUrl": "https://example.com"
  },
  "answer": "<p>Stonly is an AI-powered knowledge management platform...</p>",
  "answerMetadata": {
    "links": [
      {
        "url": "https://example.com/"
      }
    ],
    "language": "en"
  },
  "status": "IN_PROGRESS"
}

Changes

No recorded changes to this operation across all 1 revision of this API.