Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.notte.cc/llms.txt

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

The API uses standard HTTP status codes and returns structured error responses.

​
HTTP status codes

StatusDescription
200Success
401Authentication failed — invalid or missing API key
422Validation error — malformed request or invalid parameters
429Rate limit exceeded
500Internal server error
529Cluster overloaded - Too many sessions

​
Error response format

{
  "message": "Description of what went wrong",
  "detail": "Additional context about the error"
}

​
Common errors

​
Authentication (401)

{
  "message": "Authentication failed. Please check your credentials."
}

​
Validation (422)

{
  "message": "Validation error",
  "detail": [
    {
      "loc": ["body", "url"],
      "msg": "field required",
      "type": "value_error.missing"
    }
  ]
}

​
Execution errors

Returned when an operation fails. Includes the x-error-class: NotteApiExecutionError header. 
{
  "message": "Error executing the requested operation"
}