Fetchply Docs
API reference
POST
/api/v1/agents/{id}/retrain

Queue a background refresh of the agent's knowledge: known pages are re-read and new site pages are discovered. Poll GET /agents/{id}/training-status for progress. Requires the write:sources permission.

Authorization

BearerAuth write:sources
AuthorizationBearer <token>

In: header

Scope: write:sources

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/agents/string/retrain"
{
  "status": "queued",
  "runId": "string",
  "urlCount": 0
}
{
  "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"
    }
  ]
}

Get training status GET

Live training state for an agent: whether a run is active, its phase, and page progress. Poll this after adding sources or triggering a retrain. Requires the `read:sources` permission.

List Q&A pairs GET

List an agent's curated Q&A pairs, newest first, paged with `limit`/`offset` and filterable by `kind`. Requires the `read:qa` permission.