Errors

In this guide provides information on handling errors while working with the API. 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 debugging.

Status codes

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

  • Name
    2xx
    Type
    Description

    A 2xx status code indicates a successful response.

  • Name
    4xx
    Type
    Description

    A 4xx status code indicates a client error — usually indicates that the provided input does not match the expected format.

  • Name
    5xx
    Type
    Description
    A 5xx status code indicates a server error.

Error types

Whenever a request is unsuccessful, the Embed Notion Pages API will return an error response with an error message.

Here is a list of the two error types supported by the Embed Notion Pages API — use these to understand what you have done wrong.

  • Name
    BadRequestError
    Type
    Description

    This means that the provided input does not match the expected format.

  • Name
    UnauthorizedError
    Type
    Description

    This means that the request lacks valid authentication credentials.

  • Name
    NotFoundError
    Type
    Description

    This means that the requested resource could not be found.

  • Name
    TooManyRequestsError
    Type
    Description

    This means that the user has sent too many requests in a given amount of time.

  • Name
    InternalServerError
    Type
    Description

    This means that the server encountered an unexpected condition that prevented it from fulfilling the request.

Error response

{
  "error": "Required",
  "path": "notion_url",
  "embed": null
}