Discover website pages for review before ingest

POST/v1/ai/agents/{agentID}/knowledge/discover

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Path parameters

agentIDstringrequired

Request body

requiredapplication/json

exclude_prefixesstring[] | null

include_prefixesstring[] | null

max_pagesinteger<int64>

seed_urlstringrequired

Responses

200OK

default_urlsstring[] | nullrequired

discoverystringrequired

max_pagesinteger<int64>required

pagesKnowledgeDiscoverPage[] | nullrequired

Show properties

Array of KnowledgeDiscoverPage

classstringrequired

pathstringrequired

selectedbooleanrequired

urlstringrequired

pathsstring[] | nullrequired

recommended_countinteger<int64>required

seed_urlstringrequired

total_foundinteger<int64>required

urlsstring[] | nullrequired

400Bad Request

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

401Unauthorized

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

403Forbidden

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

404Not Found

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

422Unprocessable Entity

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

500Internal Server Error

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X POST "/v1/ai/agents/string/knowledge/discover" \
  -H "Content-Type: application/json" \
  -d '{
  "exclude_prefixes": [
    "string"
  ],
  "include_prefixes": [
    "string"
  ],
  "max_pages": 0,
  "seed_url": "string"
}'

const response = await fetch("/v1/ai/agents/string/knowledge/discover", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "exclude_prefixes": [
    "string"
  ],
  "include_prefixes": [
    "string"
  ],
  "max_pages": 0,
  "seed_url": "string"
})
});

import requests

response = requests.post(
    "/v1/ai/agents/string/knowledge/discover",
    headers={
        "Content-Type": "application/json"
    },
    json={
  "exclude_prefixes": [
    "string"
  ],
  "include_prefixes": [
    "string"
  ],
  "max_pages": 0,
  "seed_url": "string"
},
)

Response

{
  "default_urls": [
    "string"
  ],
  "discovery": "string",
  "max_pages": 0,
  "pages": [
    {
      "class": "string",
      "path": "string",
      "selected": true,
      "url": "string"
    }
  ],
  "paths": [
    "string"
  ],
  "recommended_count": 0,
  "seed_url": "string",
  "total_found": 0,
  "urls": [
    "string"
  ]
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}