Documentation Index
Fetch the complete documentation index at: https://developer.chessplay.io/llms.txt
Use this file to discover all available pages before exploring further.
All errors return JSON:
{
"error": "Error message",
"detail": "More details"
}
{
"field_name": ["Error message"],
"email": ["This field is required."]
}
Common Errors
400 Bad Request
Missing required fields:
{
"password": ["This field is required."]
}
{
"username": ["This username is already taken in your organization."]
}
401 Unauthorized
Missing token:
{
"detail": "Authentication credentials were not provided."
}
Authorization: Bearer YOUR_TOKEN header.
Expired token:
{
"detail": "Token is expired"
}
403 Forbidden
Insufficient permissions:
{
"detail": "You do not have permission to perform this action."
}
404 Not Found
Resource not found:
{
"detail": "Not found."
}
Example Error Handling
import requests
def create_student(token, data):
headers = {"Authorization": f"Bearer {token}"}
try:
response = requests.post(
"https://api.chessplay.io/api/v1/students/",
headers=headers,
json=data
)
response.raise_for_status()
return response.json()
except requests.exceptions.HTTPError as e:
if e.response.status_code == 400:
print(f"Validation error: {e.response.json()}")
elif e.response.status_code == 401:
print("Authentication failed. Login again.")
elif e.response.status_code == 403:
print("Need admin permissions.")
else:
print(f"Error: {e.response.status_code}")
return None
HTTP Status Codes
| Code | Meaning |
|---|
| 200 | Success |
| 201 | Created |
| 204 | Deleted |
| 400 | Bad request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not found |
| 500 | Server error |
