Skip to main content
POST
/
api
/
ingest
/
url
Ingest Url
curl --request POST \
  --url https://api.example.com/api/ingest/url \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "destination": {
    "project_id": "<string>",
    "type": "library"
  },
  "force": false,
  "namespace": "global",
  "taxonomy_labels": [
    "<string>"
  ]
}
'
{
  "status": "ok",
  "chunks_created": 1,
  "error": "<string>",
  "source_id": "<string>",
  "title": "<string>"
}

Body

application/json

Request to ingest a URL directly (for Add to Library button).

url
string
required
Minimum string length: 1
destination
IngestDestination · object

Where ingested content should be routed.

force
boolean
default:false
namespace
string
default:global
taxonomy_labels
string[] | null

Response

Successful Response

Response from URL ingestion.

status
enum<string>
required
Available options:
ok,
error
chunks_created
integer | null
Required range: x >= 0
error
string | null
source_id
string | null
title
string | null