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:

1. Upload image → Get file_id
2. Use file_id with /chat/v1/api/image/:type endpoint

POST /ingest/v1/api/image

Ingest an image file

cURL

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

200

{
  "success": {
    "file_id": "abc123-def456-ghi789",
    "file_name": "document.pdf",
    "user_id": "<string>",
    "createAt": "2023-11-07T05:31:56Z"
  },
  "error": {},
  "message": {
    "content": "<string>",
    "displayContent": true
  }
}

Authorizations

Authorization · string · header · required

Bearer token authentication using an API key

Body

multipart/form-data

file · file

Image file to upload

saveToServer · boolean · default: true

Response

200

application/json

Image ingested successfully

success · object

Show child attributes

error · object

message · object

Show child attributes