Ingest an image file
curl --request POST \
--url https://app.skimming.ai/back/source/v1/api/image \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form source='@example-file' \
--form saveToServer=trueimport requests
url = "https://app.skimming.ai/back/source/v1/api/image"
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 image 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/image', 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/image",
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 image 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/image"
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 image 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/image")
.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 image 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/image")
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 image 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": false,
"error": {},
"message": {
"content": "Invalid request parameters",
"displayContent": true
}
}{
"success": false,
"error": {},
"message": {
"content": "Invalid API key",
"displayContent": true
}
}{
"success": false,
"error": {},
"message": {
"content": "Question limit exceeded!",
"displayContent": true
}
}Ingest
Ingest an image file
Upload an image file to get a file_id for chat operations.
Supported formats: JPG, JPEG, PNG, GIF, WebP, BMP, TIFF, SVG, HEIC, ICO
Required Headers:
Authorization: Bearer YOUR_API_KEY
Workflow:
- Upload image → Get
file_id - Use
file_idwith/chat/v1/api/image/:typeendpoint
POST
/
source
/
v1
/
api
/
image
Ingest an image file
curl --request POST \
--url https://app.skimming.ai/back/source/v1/api/image \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form source='@example-file' \
--form saveToServer=trueimport requests
url = "https://app.skimming.ai/back/source/v1/api/image"
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 image 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/image', 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/image",
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 image 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/image"
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 image 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/image")
.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 image 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/image")
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 image 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": false,
"error": {},
"message": {
"content": "Invalid request parameters",
"displayContent": true
}
}{
"success": false,
"error": {},
"message": {
"content": "Invalid API key",
"displayContent": true
}
}{
"success": false,
"error": {},
"message": {
"content": "Question limit exceeded!",
"displayContent": true
}
}⌘I