Errors

In this guide, we will talk about what happens when something goes wrong while you work with the API. Mistakes happen, and mostly they will be yours, not ours. Let's look at some status codes and error types you might encounter.

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).

Status codes

Here is a list of the different categories of status codes returned by the Composable Prompts API. Use these to understand if a request was successful.

Name
2xx
Description
A 2xx status code indicates a successful response.
Name
4xx
Description
A 4xx status code indicates a client error — this means it's a you problem.
Name
5xx
Description
A 5xx status code indicates a server error — you won't be seeing these.

Interactions Execution Errors

Whenever an execution is unsuccessful, the Composable Prompts 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.

After an execution error occurs, the Run status is set to failed and the execution is stopped. The error message is stored in the error field of the Run object.

Error response

{
  "code": "error",
  "message": "429 Rate limit reached for gpt-4 in organization on tokens per min.
  Limit: 10000 / min.
  Please try again in 6ms.
  Contact us through our help center at help.openai.com if you continue to have issues."
  }