Sign in

v1

latestOpenAPI 3.0.3MIT OR Apache-2.02026-07-17203670.3 KB
ingestion

Ingest from URL

Enqueue content from a URL for background ingestion. Supports web pages, YouTube videos (with transcription), and other online resources.

Returns a job_id. Poll GET /v1/jobs/{job_id} for status and the resulting document ID.

post/v1/tables/{table_name}/ingest/url

Path parameters

table_namestring required
Example:legal_contracts

Table name or slug

Request body

urlstring uri required

URL to ingest (web page, YouTube video, etc.)

generate_summariesboolean

Whether to generate LLM summaries (default: true)

Example request

{
  "url": "https://en.wikipedia.org/wiki/Machine_learning"
}

Response

Ingestion job queued

job_idstring

Unique job ID

status'queued' | 'processing' | 'completed' | 'failed'

Current job status

progressstring

Progress message (only present when status is 'processing')

errorstring

Error message (only present when status is 'failed')

created_atstring date-time

Job creation timestamp

updated_atstring date-time

Last status update timestamp

Example response

{
  "job_id": "job_abc123",
  "status": "queued",
  "progress": "Building document tree...",
  "result": {
    "document_id": "doc_abc123",
    "title": "Machine Learning Fundamentals",
    "total_nodes": 42,
    "max_depth": 4,
    "stats": {
      "chars_extracted": 50000,
      "chunks_created": 25,
      "nodes_created": 42,
      "summaries_generated": 42,
      "total_time_ms": 5230
    }
  },
  "error": "Failed to parse document",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:05Z"
}