Skip to main content
Node.js
import { PeriskopeApi } from '@periskope/periskope-client';

const client = new PeriskopeApi({
  authToken: 'YOUR_API_KEY',
  phone: 'YOUR_PHONE_NUMBER', // e.g., '919876543210'
});

async function updateFaq() {
  const response = await client.knowledgeBase.updateFaq({
    context_id: 'ai-context-aaauajhjdgjnomr',
    question: 'How do I connect my WhatsApp account?',
    answer: 'You can connect your WhatsApp account by scanning the QR code in the Settings page.',
  });

  console.log(response);
}

updateFaq();
{
  "context_id": "ai-context-aaauajhjdgjnomr",
  "type": "faq",
  "question": "How do I connect my WhatsApp account?",
  "answer": "You can connect your WhatsApp account by scanning the QR code in the Settings page.",
  "embedding": [
    -0.020637017,
    -0.0148050785,
    0.02985098,
    0.023778915,
    "..."
  ],
  "updated_at": "2025-01-20T11:00:00Z"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

context_id
string
required

The context ID of the FAQ to update

Example:

"ai-context-aaauajhjdgjnomr"

Body

application/json · object[]
question
string

The updated question

Example:

"How do I connect my WhatsApp account?"

answer
string

The updated answer

Example:

"You can connect your WhatsApp account by scanning the QR code in the Settings page."

embedding
number[]

Optional array of embedding values

Example:
[
-0.020637017,
-0.0148050785,
0.02985098,
0.023778915,
"..."
]

Response

200 OK

success
boolean
message
string
faq
object

The updated FAQ object