Skip to main content

Documentation Index

Fetch the complete documentation index at: https://apidoc.cufinder.io/llms.txt

Use this file to discover all available pages before exploring further.

You can tell if your request was successful by checking the status code when receiving an API response. If a response comes back unsuccessful, you can use the error type and error message to figure out what has gone wrong and do some rudimentary debugging (before contacting support).

Before reaching out to support with an error, please be aware that 99% of all reported errors are, in fact, user errors. Therefore, please carefully check your code before contacting CUFinder support.

​
Error types

Whenever a request is unsuccessful, the CUFinder API will return an error response with an error type and message. You can use this information to understand better what has gone wrong and how to fix it. Most of the error messages are pretty helpful and actionable.Here is a list of the two error types supported by the CUFinder API — use these to understand what you have done wrong.
{
  "type": "api_error",
  "message": "API key is wrong!"
}
​
api_error
string
required
This means that we made an error, which is highly speculative and unlikely.
​
invalid_request
string
required
This means that you made an error, which is much more likely.