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:

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

POST /source/v1/api/document

Ingest a document or file

cURL

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

200

{
  "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

multipart/form-dataapplication/json

source · file

File to upload

saveToServer · boolean · default: true

Whether to save the file to server

Response

200

application/json

File ingested successfully