Skip to main content

​
API Reference

The Nedzo API is organized around REST. It uses standard HTTP methods, returns JSON responses, and uses standard HTTP status codes.

​
Base URL

https://api.nedzo.ai/v1

​
Authentication

All API requests require a Bearer token in the Authorization header: 
Authorization: Bearer YOUR_API_KEY
See Authentication for more details.

​
Request Format

For POST, PUT, and PATCH requests, send JSON in the request body: 
curl -X POST https://api.nedzo.ai/v1/agents \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "My Agent", "workspaceId": "..."}'

​
Response Format

All responses are JSON. Successful responses return the requested data: 
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "My Agent",
  "createdAt": "2024-01-15T10:30:00Z"
}

​
Errors

Errors follow the RFC 7807 Problem Details format: 
{
  "type": "https://api.nedzo.ai/errors/not-found",
  "title": "Not Found",
  "status": 404,
  "detail": "Agent not found"
}

​
HTTP Status Codes

CodeDescription
200Success
201Created
400Bad Request - Invalid parameters
401Unauthorized - Invalid or missing API key
404Not Found - Resource doesn’t exist
422Validation Error - Request failed validation
429Too Many Requests - Rate limited
500Internal Server Error
502Bad Gateway - Upstream service error

​
Pagination

List endpoints support pagination via query parameters:
ParameterDescriptionDefault
limitNumber of items per page20
offsetNumber of items to skip0
GET /v1/contacts?limit=50&offset=100

​
Rate Limiting

API requests are rate-limited. When you exceed the limit, you’ll receive a 429 response with a Retry-After header indicating when you can retry.