Skip to main content
POST
/
api
/
ingest
Start Ingestion
curl --request POST \
  --url https://api.example.com/api/ingest \
  --header 'Content-Type: application/json' \
  --data '
{
  "content": "<string>",
  "content_type": "youtube",
  "destination": {
    "project_id": "<string>",
    "type": "library"
  },
  "force": false,
  "namespace": "global",
  "taxonomy_labels": [
    "<string>"
  ]
}
'
{
  "content_type": "youtube",
  "created_at": "2023-11-07T05:31:56Z",
  "job_id": "<string>",
  "status": "queued",
  "chunks_created": 1,
  "completed_at": "2023-11-07T05:31:56Z",
  "current_step": "<string>",
  "destination_project_id": "<string>",
  "destination_type": "library",
  "error": "<string>",
  "progress": 0,
  "title": "<string>"
}

Body

application/json

Request to ingest content.

​
content
string
required
Required string length: 1 - 1000000
​
content_type
enum<string> | null

Type of content being ingested.

Available options:
youtube,
article,
pdf,
markdown,
text
​
destination
IngestDestination · object

Where ingested content should be routed.

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

Response

Successful Response

Status of an ingestion job.

​
content_type
enum<string>
required

Type of content being ingested.

Available options:
youtube,
article,
pdf,
markdown,
text
​
created_at
string<date-time>
required
​
job_id
string
required
​
status
enum<string>
required

Status of an ingestion job.

Available options:
queued,
processing,
completed,
failed
​
chunks_created
integer | null
Required range: x >= 0
​
completed_at
string<date-time> | null
​
current_step
string | null
​
destination_project_id
string | null
​
destination_type
enum<string>
default:library
Available options:
library,
project
​
error
string | null
​
progress
integer
default:0
Required range: 0 <= x <= 100
​
title
string | null