Skip to main content
The /knowledge_status/{job_id} endpoint allows you to check the status of a knowledge upload job.

Base URL

Authentication

Path Parameters

job_id
string
required
The job ID for the knowledge upload, returned from the store_knowledge endpoint

Example Requests

Response

Success Response

status
string
required
Current status of the knowledge upload job, can be: completed, processing or failed
message
string
Human-readable status message
Example success response:

Error Response

detail
array
required
Array of validation errors
Example error response:

Status Codes

Best Practices

  1. Job ID Management
    • Store job IDs returned from store_knowledge endpoint
    • Implement retry logic for failed status checks
    • Consider implementing a timeout for long-running jobs
  2. Status Monitoring
    • Check status periodically for long-running jobs
    • Implement exponential backoff for status checks
    • Handle all possible status values appropriately
  3. Error Handling
    • Handle 404 errors for invalid job IDs
    • Implement proper retry logic
    • Log status check failures for debugging