ReDesk
NewProposals drafted by ReDesk AI in under four minutesSee what's new
Case studySunfield EPC cut feasibility turnaround from 3.4 days to 6 hoursRead the story
Pricing
Sign inSchedule a demo
API reference

The ReDesk API reference

Every endpoint, object and error the platform exposes. Pick the platform you are integrating with — the whole reference follows.

Platform
ReDesk AI › Errors

Errors

Every endpoint fails the same way: an HTTP status, a stable machine-readable type, a human message, and the offending field where there is one. Match on type, never on the message — messages get clearer over time, types do not change.

HTTPTypeWhen
400invalid_requestA field is missing, malformed, or the wrong type. The body names the field.
401unauthenticatedNo key, a revoked key, or a key from the other environment.
403forbiddenThe key is valid but its role cannot touch this record.
404not_foundNo such id — or one your organisation cannot see, which is reported the same way on purpose.
409conflictThe write contradicts the record's current state, such as accepting a proposal twice.
422unprocessableWell formed and permitted, but rejected by a business rule. The body names the rule.
429rate_limitedOver the ceiling. Retry-After gives the seconds to wait.
500server_errorOur fault. Safe to retry with the same idempotency key.
Error envelope
{
  "error": {
    "type": "invalid_request",
    "message": "capacity_kw must be greater than 0",
    "param": "capacity_kw",
    "request_id": "req_8Q2Xk4ma"
  }
}