Fetchply Docs
API reference
PATCH
/api/v1/agents/{id}/qa-pairs/{pairId}

Change the question, answer, or enabled state of a Q&A pair. Changes are re-indexed in the background. Requires the write:qa permission.

Authorization

BearerAuth write:qa
AuthorizationBearer <token>

In: header

Scope: write:qa

Path Parameters

id*string
pairId*integer

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/api/v1/agents/string/qa-pairs/1" \  -H "Content-Type: application/json" \  -d '{    "enabled": false  }'
{
  "id": 7,
  "agentId": "a1b2c3d4e5",
  "kind": "qa",
  "question": "Do you ship internationally?",
  "answer": "Yes, we ship to over 40 countries. Delivery takes 5-10 days.",
  "enabled": true,
  "attachmentCount": 0,
  "createdAt": "2026-08-01T10:00:00.000Z",
  "updatedAt": null
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}

Create a Q&A pair POST

Add a curated question and answer the agent should serve verbatim. The pair is indexed in the background and starts matching shortly after. Requires the `write:qa` permission.

Delete a Q&A pair DELETE

Delete a Q&A pair and stop it from matching. This cannot be undone. Requires the `write:qa` permission.