Conventions and authentication
Authentication, response envelopes, and error formats by endpoint.
Check each endpoint’s authentication and response shape before integrating.
Prop
Type
Prop
Type
Parse success responses per endpoint: catalog queries, /me, and sync status use data; publishing, whoami, and deletion use result; title matching directly returns version, decision, and candidates. Anime preview returns a top-level previewUrl.
Application JSON errors contain ok: false and error.code, error.message, and error.requestId. reason, retryable, retryAfterMs, and details are optional. A missing retryable flag does not authorize retries. Public RSS errors are usually plain text. Torznab protocol errors are XML and may have HTTP 200. Edge blocks may be HTML. Check status and Content-Type before parsing.
Before publishing, GET the same endpoint and check groupSlug and scopes. A publish receipt guarantees releaseId and revision, with an optional torrentObjectId; it does not include group identity or fileSize. Use rel_* or orel_* as required. Group filters usually take a slug; other-category RSS groupId takes an organization ID.