Create knowledge website ingest job

POST/v1/ai/agents/{agentID}/knowledge/ingest-jobs

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Path parameters

agentIDstringrequired

Request body

requiredapplication/json

exclude_prefixesstring[] | null

max_pagesinteger<int64>

modestring

seed_urlstringrequired

source_idstring

titlestring

urlsstring[] | null

Responses

200OK

agent_idstringrequired

created_atstringrequired

errorstring

idstringrequired

max_pagesinteger<int64>required

metadataobject

modestringrequired

organization_idstring

pages_doneinteger<int64>required

pages_failedinteger<int64>required

pages_totalinteger<int64>required

seed_urlstringrequired

source_idstring

statusstringrequired

updated_atstringrequired

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/ingest-jobs" \
  -H "Content-Type: application/json" \
  -d '{
  "exclude_prefixes": [
    "string"
  ],
  "max_pages": 0,
  "mode": "string",
  "seed_url": "string",
  "source_id": "string",
  "title": "string",
  "urls": [
    "string"
  ]
}'

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

import requests

response = requests.post(
    "/v1/ai/agents/string/knowledge/ingest-jobs",
    headers={
        "Content-Type": "application/json"
    },
    json={
  "exclude_prefixes": [
    "string"
  ],
  "max_pages": 0,
  "mode": "string",
  "seed_url": "string",
  "source_id": "string",
  "title": "string",
  "urls": [
    "string"
  ]
},
)

Response

{
  "agent_id": "string",
  "created_at": "string",
  "error": "string",
  "id": "string",
  "max_pages": 0,
  "metadata": {},
  "mode": "string",
  "organization_id": "string",
  "pages_done": 0,
  "pages_failed": 0,
  "pages_total": 0,
  "seed_url": "string",
  "source_id": "string",
  "status": "string",
  "updated_at": "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"
  }
}