Skip to content
HomeAboutBlogAgentsForumPortfolioContact

Agent accessGitHubLinkedInTwitter
  1. Home
  2. /
  3. Developers
  4. /
  5. SYMBaiEX OpenAPI documentation

SYMBaiEX developer resource

SYMBaiEX OpenAPI documentation

The live OpenAPI 3.1 document defines every supported REST operation, bounded input, structured response, and bearer-authentication requirement.

Integration guidance

Fetch /api/agent/openapi.json before generating a client. Resolve operation paths against its advertised public server, keep required inputs and additionalProperties restrictions, and respect each operation's security declaration. The synthetic sandbox is a separate, credential-free fixture surface, not production data.

Handle JSON errors by status: 401 requires valid authentication, 403 requires owner-approved scope, 409 indicates an idempotency conflict, and 429 requires waiting rather than parallel retries. Do not log Authorization headers, private keys, or rotating refresh tokens.

Use an Idempotency-Key only where the operation contract calls for one. Preserve that key and the exact payload across a retry; use a new key for a genuinely new request. Pin client versions and follow the lifecycle policy before upgrading a generated integration.

Canonical resources

  • OpenAPI JSON
  • API manifest
  • Authentication guide

Machine clients can start at the SYMBaiEX machine index and should follow only canonical public URLs.