IngestIQ
Getting StartedCore ConceptsData ConnectorsAI & ProcessingIntegrationsAPI ReferenceSelf-Hosting

API Introduction

IngestIQ REST API overview

Overview#

The IngestIQ API is a RESTful API that allows you to programmatically manage Knowledge Bases, Pipelines, Documents, and perform semantic search.

Base URL#

http://localhost:3000/api/v2

For production deployments, use your configured domain.

Authentication#

All API endpoints (except health check) require JWT authentication.

Getting a Token#

# Register
curl -X POST http://localhost:3000/api/v2/auth/register \
  -H "Content-Type: application/json" \
  -d '{
    "email": "user@example.com",
    "password": "securepassword",
    "name": "Your Name"
  }'

# Login
curl -X POST http://localhost:3000/api/v2/auth/login \
  -H "Content-Type: application/json" \
  -d '{
    "email": "user@example.com",
    "password": "securepassword"
  }'

Using the Token#

Include the JWT token in the Authorization header:

curl http://localhost:3000/api/v2/knowledgebases \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

Response Format#

Successful Response#

{
  "data": { ... },
  "message": "Operation successful"
}

Error Response#

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters",
    "details": [...]
  }
}

HTTP Status Codes#

CodeMeaning
200Success
201Created
400Bad Request
401Unauthorized
403Forbidden
404Not Found
429Rate Limited
500Server Error

Common Error Codes#

CodeDescription
VALIDATION_ERRORRequest validation failed
UNAUTHORIZEDMissing or invalid token
NOT_FOUNDResource not found
DUPLICATE_ENTRYResource already exists
RATE_LIMITEDToo many requests

Pagination#

List endpoints support pagination:

curl "http://localhost:3000/api/v2/knowledgebases/{kbId}/documents?page=1&limit=20" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

Response includes pagination metadata:

{
  "data": [...],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 150,
    "totalPages": 8
  }
}

Rate Limiting#

Default rate limits:

  • 100 requests/minute per IP for unauthenticated
  • 1000 requests/minute per user for authenticated

Rate limit headers:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 998
X-RateLimit-Reset: 1706450400

API Reference#

Authentication
Register, login, refresh tokens
Knowledge Bases
CRUD operations
Pipelines
Pipeline management
Documents
Document operations
Search
Semantic search

OpenAPI Specification#

Interactive API documentation is available at:

Swagger UI
http://localhost:3000/api/docs
Documentation