Missing API Documentation

[caosinf777]

I am currently using this repository for integrating a chatbot based on Bedrock and Claude. However, I have noticed that the project lacks comprehensive documentation for the API, especially regarding the following:

Endpoints: The specific API endpoints available, including details about their expected request formats and response structures.
Authentication: Clear instructions on how to authenticate API requests, particularly for integrating with Bedrock or other AWS services.
Error Handling: Information on common API errors and suggested handling practices.
Rate Limits: Details on any rate limits that might apply when making API calls.

These details are essential for users who want to effectively integrate this solution into their own projects.

Request:

Could you please provide a more detailed API reference or point me to where I might find this information? I believe that additional documentation would be highly beneficial for users looking to implement this solution in production environments.

Thank you in advance for your assistance.

[statefb]

• Is this regarding the backend API for this app? The documentation is available here.
• Or is it about the published API? You can find the information here.

[caosinf777]

I apologize for my delayed response regarding the request for more detailed API documentation. I truly appreciate your patience.

I have encountered an issue that I wanted to bring to your attention. After initiating a conversation through the API and subsequently trying to retrieve messages, I received the following error:

{
"errors": [
"No conversation found with id: 01JD5WTTW5TGR4GPCXK1F20ARF"
]
}

This occurs when attempting to access a conversation that was just created, and I am uncertain as to why this happens. Any guidance on this matter, or any pointers to additional documentation that might address this issue, would be greatly appreciated.

Thank you once again for your assistance and for the work you have done to support this project.

Best regards,

[statefb]

Due to the time required to generate the conversation, you may initially receive a 404 error. Please try accessing again after a short while.

[caosinf777]

Thank you for your previous response regarding the API issue I raised. I appreciate the guidance provided about the potential delay in accessing a conversation.

However, I am still encountering the same issue even after waiting for some time. Specifically, when I initiate a conversation and subsequently try to retrieve it using the conversationId provided by the API, I receive the following error:

{
"errors": [
"No conversation found with id: 01JD8OW752WR76CQ6SRGX8Y3Q5"
]
}

To help illustrate the issue, I have attached screenshots showing both the successful creation of the conversation and the subsequent attempt to retrieve it, which results in the "conversation not found" error. The problem persists despite following the suggestion to retry after waiting.

It would be really helpful if you could provide further insights into what might be causing this. I wonder if there could be an issue with how the conversation is being indexed or a potential timeout beyond the waiting period I have tried.

Any additional documentation or suggestions would be greatly appreciated.

Thank you again for your assistance.

Best regards,

[github-actions]

This issue has been labeled as "stale" due to no response by the reporter within 1 month (and 14 days after last commented by someone). And it will be closed automatically 14 days later if not responded.