GET
/
knowledge_status
/
{job_id}
curl --request GET \
  --url https://osmosis.gulp.dev/knowledge_status/{job_id} \
  --header 'x-api-key: <api-key>'
{}

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

​
Base URL

GET https://osmosis.gulp.dev/knowledge_status/{job_id}

​
Authentication

​
Path Parameters

​
job_id
string
required

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

​
Example Requests

curl -X GET https://osmosis.gulp.dev/knowledge_status/abc123 \
  -H "x-api-key: your-api-key"

​
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:

{
  "status": "processing",
  "created_at": "2025-03-05T18:15:37.903173",
  "started_at": "2025-03-05T18:15:37.903942"
}

​
Error Response

​
detail
array
required

Array of validation errors

Example error response:

{
    "some_hash_key_123": {
        "status": "failed",
        "created_at": "2024-03-20T14:30:00.123456",
        "started_at": "2024-03-20T14:30:01.234567",
        "failed_at": "2024-03-20T14:30:05.345678",
        "error_message": "YWJjZGVmMTIzNDU2Nzg5MA==",
        "note": "Please provide the error_message to founders@gulp.ai alongside with the job_id"
    }
}

​
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

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
job_id
string
required

Response

200
application/json

Successful Response

The response is of type object.