Troubleshooting
This section addresses common issues developers may encounter when integrating with the Joinable RAG API.
Authentication & Authorization
401 Unauthorized
Missing or invalid X-API-Key header
Ensure you’ve included a valid API key in the request headers.
403 Forbidden
Accessing a collection you don’t have permissions for
Make sure your API key has access to the specific collection.
Request Formatting
400 Bad Request
Malformed JSON, missing message field
Ensure the request body is valid JSON and includes at least the message parameter.
Missing or incorrect trailing slash
Endpoint URL does not end with /
All endpoints must end with a slash (e.g., /chat/, not /chat).
Chat & Message Flow
chat_id is null or missing
Error during chat creation
Check the response from the Create Chat endpoint for errors.
Invalid or expired chat_id
Reusing an old or malformed ID
Always use the chat_id returned from a successful Create Chat call.
No response from AI
Insufficient or unclear context
Refine your input query and make sure relevant documents are uploaded.
Source Citations
No sources returned
The model didn’t find relevant content in your collection
Upload more representative documents or reformulate the question.
Sources appear in response body, not root
Looking for sources at the top level
Extract sources from each assistant message, not the root response.
Debugging Tips
Log both the HTTP status code and the full JSON response.
Use the Python or JS code examples provided to validate your requests.
Always verify
status === "success"in the response body before proceeding.Test your API key and endpoints with cURL or Postman if issues persist.
Last updated