Skip to main content
POST
/
ingest
/
v1
/
api
/
document
Ingest a document or file
curl --request POST \
  --url https://api.skimming.ai/ingest/v1/api/document \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form file='@example-file' \
  --form saveToServer=true
{
  "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
  }
}

Authorizations

​
Authorization
string
header
required

Bearer token authentication using an API key

Body

​
file
file

File to upload

​
saveToServer
boolean
default:true

Whether to save the file to server

Response

File ingested successfully

​
success
object
​
error
object
​
message
object