Operation Index
Browse every Developer OpenAPI operation by purpose. Each interface page includes parameters, request and response examples, returned fields, error codes, and suggested next steps.
| Operation | Method | Path | Group |
|---|---|---|---|
| Health | GET | /openapi/v2/health | Metadata |
| OpenAPI contract | GET | /openapi/v2/openapi.json | Metadata |
| Version | GET | /openapi/v2/version | Metadata |
| List knowledge bases | GET | /openapi/v2/knowledge-bases | Knowledge Bases |
| Create knowledge base | POST | /openapi/v2/knowledge-bases | Knowledge Bases |
| Delete knowledge base | DELETE | /openapi/v2/knowledge-bases/{knowledgeBaseId} | Knowledge Bases |
| Get knowledge base | GET | /openapi/v2/knowledge-bases/{knowledgeBaseId} | Knowledge Bases |
| Update knowledge base | PATCH | /openapi/v2/knowledge-bases/{knowledgeBaseId} | Knowledge Bases |
| Create upload session | POST | /openapi/v2/knowledge-bases/{knowledgeBaseId}/upload-sessions | Upload Sessions |
| Cancel upload session | DELETE | /openapi/v2/knowledge-bases/{knowledgeBaseId}/upload-sessions/{uploadSessionId} | Upload Sessions |
| Get upload session | GET | /openapi/v2/knowledge-bases/{knowledgeBaseId}/upload-sessions/{uploadSessionId} | Upload Sessions |
| Add files to upload session | POST | /openapi/v2/knowledge-bases/{knowledgeBaseId}/upload-sessions/{uploadSessionId}/entries | Upload Sessions |
| Upload one Markdown file | PUT | /openapi/v2/knowledge-bases/{knowledgeBaseId}/upload-sessions/{uploadSessionId}/entries/{entryId}/content | Upload Sessions |
| Complete upload session | POST | /openapi/v2/knowledge-bases/{knowledgeBaseId}/upload-sessions/{uploadSessionId}/finalize | Upload Sessions |
| Refresh upload conflicts | POST | /openapi/v2/knowledge-bases/{knowledgeBaseId}/upload-sessions/{uploadSessionId}/reconcile | Upload Sessions |
| Confirm upload file list | POST | /openapi/v2/knowledge-bases/{knowledgeBaseId}/upload-sessions/{uploadSessionId}/seal | Upload Sessions |
| List uploaded directories | GET | /openapi/v2/knowledge-bases/{knowledgeBaseId}/source-directories | Uploaded Directories |
| Delete uploaded directory | DELETE | /openapi/v2/knowledge-bases/{knowledgeBaseId}/source-directories/{directoryId} | Uploaded Directories |
| Get uploaded directory | GET | /openapi/v2/knowledge-bases/{knowledgeBaseId}/source-directories/{directoryId} | Uploaded Directories |
| Move uploaded directory | PATCH | /openapi/v2/knowledge-bases/{knowledgeBaseId}/source-directories/{directoryId} | Uploaded Directories |
| List uploaded files | GET | /openapi/v2/knowledge-bases/{knowledgeBaseId}/source-files | Uploaded Files |
| Delete uploaded file | DELETE | /openapi/v2/knowledge-bases/{knowledgeBaseId}/source-files/{sourceFileId} | Uploaded Files |
| Get uploaded file | GET | /openapi/v2/knowledge-bases/{knowledgeBaseId}/source-files/{sourceFileId} | Uploaded Files |
| Move uploaded file | PATCH | /openapi/v2/knowledge-bases/{knowledgeBaseId}/source-files/{sourceFileId} | Uploaded Files |
| Get uploaded file content | GET | /openapi/v2/knowledge-bases/{knowledgeBaseId}/source-files/{sourceFileId}/content | Uploaded Files |
| Replace uploaded file content | PUT | /openapi/v2/knowledge-bases/{knowledgeBaseId}/source-files/{sourceFileId}/content | Uploaded Files |
| Retry uploaded file | POST | /openapi/v2/knowledge-bases/{knowledgeBaseId}/source-files/{sourceFileId}/retry | Uploaded Files |
| List document indexing and resource changes | GET | /openapi/v2/knowledge-bases/{knowledgeBaseId}/operations | File and Directory Changes |
| Get document indexing or resource change | GET | /openapi/v2/knowledge-bases/{knowledgeBaseId}/operations/{operationId} | File and Directory Changes |
| Get file | GET | /openapi/v2/knowledge-bases/{knowledgeBaseId}/files/{fileId} | Files |
| Get file content by ID | GET | /openapi/v2/knowledge-bases/{knowledgeBaseId}/files/{fileId}/content | Files |
| List related files | GET | /openapi/v2/knowledge-bases/{knowledgeBaseId}/files/{fileId}/related | Files |
| Get file content by path | GET | /openapi/v2/knowledge-bases/{knowledgeBaseId}/files/content | Files |
| Search readable files | GET | /openapi/v2/knowledge-bases/{knowledgeBaseId}/files/search | Files |
| Explore related files | GET | /openapi/v2/knowledge-bases/{knowledgeBaseId}/graph/expand | Files |
| Get relationship overview | GET | /openapi/v2/knowledge-bases/{knowledgeBaseId}/graph/overview | Files |
| List file tree | GET | /openapi/v2/knowledge-bases/{knowledgeBaseId}/tree | Files |
| List webhook deliveries | GET | /openapi/v2/webhook-deliveries | Webhooks |
| Redeliver webhook | POST | /openapi/v2/webhook-deliveries/{deliveryId}/redeliver | Webhooks |
| List webhooks | GET | /openapi/v2/webhooks | Webhooks |
| Create webhook | POST | /openapi/v2/webhooks | Webhooks |
| Delete webhook | DELETE | /openapi/v2/webhooks/{webhookId} | Webhooks |