Ingest a document or file

curl --request POST \
  --url https://app.skimming.ai/back/source/v1/api/document \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form source='@example-file' \
  --form saveToServer=true

import requests

url = "https://app.skimming.ai/back/source/v1/api/document"

files = { "source": ("example-file", open("example-file", "rb")) }
payload = { "saveToServer": "true" }
headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('source', '[binary file data]');
form.append('saveToServer', 'true');

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

options.body = form;

fetch('https://app.skimming.ai/back/source/v1/api/document', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.skimming.ai/back/source/v1/api/document",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"source\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n[binary file data]\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"saveToServer\"\r\n\r\ntrue\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: multipart/form-data"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.skimming.ai/back/source/v1/api/document"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"source\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n[binary file data]\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"saveToServer\"\r\n\r\ntrue\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.skimming.ai/back/source/v1/api/document")
  .header("Authorization", "Bearer <token>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"source\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n[binary file data]\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"saveToServer\"\r\n\r\ntrue\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.skimming.ai/back/source/v1/api/document")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"source\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n[binary file data]\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"saveToServer\"\r\n\r\ntrue\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

{
  "success": {
    "file_id": "abc123-def456-ghi789",
    "file_name": "document.pdf",
    "user_id": "user123",
    "createAt": "2024-01-20T10:30:00.000Z"
  },
  "error": null,
  "message": {
    "content": null,
    "displayContent": true
  }
}

{
  "success": false,
  "error": {},
  "message": {
    "content": "Question limit exceeded!",
    "displayContent": true
  }
}

{
  "success": false,
  "error": {},
  "message": {
    "content": "Invalid API key",
    "displayContent": true
  }
}

{
  "success": false,
  "error": {},
  "message": {
    "content": "Question limit exceeded!",
    "displayContent": true
  }
}

Ingest

Ingest a document or file

Upload a file (PDF, , CSV, EPUB, PPTX, TXT) or provide a URL to get a file_id. The file_id returned from this endpoint is required for all chat operations.

URL Format:

/source/v1/api/document — upload any supported document
/source/v1/api/document/{type} — optionally specify a type suffix (e.g., pdf, “, xlsx, csv, epub, pptx, txt)

Examples:

POST /source/v1/api/document
POST /source/v1/api/document/pdf
POST /source/v1/api/document/xlsx
POST /source/v1/api/document/csv
POST /source/v1/api/document/epub
POST /source/v1/api/document/pptx
POST /source/v1/api/document/txt

Supported file types:

PDF (.pdf)
Excel/CSV (.xlsx, .xls, .csv)
EPUB (.epub)
PowerPoint (.pptx, .ppt)
Text files (.txt, .rtf)

Required Headers:

Authorization: Bearer YOUR_API_KEY

Notes:

Do not send platform, userid, useremail for API calls. The backend derives the user from your API key.
Choose the correct {type} in the route (e.g., pdf, xlsx, pptx, txt, epub) for document chat endpoints.

Example Workflow:

Upload file or provide URL → Get file_id
Use file_id in appropriate /chat/v1/api/document/:type endpoint to ask questions

POST

source

api

document

Ingest a document or file

curl --request POST \
  --url https://app.skimming.ai/back/source/v1/api/document \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form source='@example-file' \
  --form saveToServer=true

import requests

url = "https://app.skimming.ai/back/source/v1/api/document"

files = { "source": ("example-file", open("example-file", "rb")) }
payload = { "saveToServer": "true" }
headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('source', '[binary file data]');
form.append('saveToServer', 'true');

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

options.body = form;

fetch('https://app.skimming.ai/back/source/v1/api/document', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.skimming.ai/back/source/v1/api/document",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"source\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n[binary file data]\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"saveToServer\"\r\n\r\ntrue\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: multipart/form-data"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.skimming.ai/back/source/v1/api/document"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"source\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n[binary file data]\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"saveToServer\"\r\n\r\ntrue\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.skimming.ai/back/source/v1/api/document")
  .header("Authorization", "Bearer <token>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"source\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n[binary file data]\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"saveToServer\"\r\n\r\ntrue\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.skimming.ai/back/source/v1/api/document")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"source\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n[binary file data]\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"saveToServer\"\r\n\r\ntrue\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

{
  "success": {
    "file_id": "abc123-def456-ghi789",
    "file_name": "document.pdf",
    "user_id": "user123",
    "createAt": "2024-01-20T10:30:00.000Z"
  },
  "error": null,
  "message": {
    "content": null,
    "displayContent": true
  }
}

{
  "success": false,
  "error": {},
  "message": {
    "content": "Question limit exceeded!",
    "displayContent": true
  }
}

{
  "success": false,
  "error": {},
  "message": {
    "content": "Invalid API key",
    "displayContent": true
  }
}

{
  "success": false,
  "error": {},
  "message": {
    "content": "Question limit exceeded!",
    "displayContent": true
  }
}

Authorizations

Authorization

string

header

required

Bearer token authentication using an API key

Body

source

file

File to upload

saveToServer

boolean

default:true

Whether to save the file to server

Response

File ingested successfully

Overview

Ingest

Document

Image

Video

Audio

Source

Parse

Extract

Ingest a document or file

Authorizations

Body

Response