Skip to content

Product Contract · reference

One descriptor. Generated clients.

crates/sylphx-bots-tools/idl/capability-idl.v2.json is the authoring SSOT for the public Product Contract. capabilities.v1.json, @sylphx-bots/capability-sdk, and the product CLI capability/SDK surfaces are projections of that contract. Handwritten SDK or CLI authority is not dest.

Published locators

Product site: https://bots.sylphx.com

Public API: https://api.bots.sylphx.com. Leftover bots.api.sylphx.com is never a product API.

Authoring SSOT: crates/sylphx-bots-tools/idl/capability-idl.v2.json

Generated pin: CAPABILITY_IDL_V2_CONTENT_DIGEST = sha256:4032fb1d9d4e9ad653dedfe23e23724a94d02d8d45dfa94cc49b14cc0f76e15a

Envelope: Bots is a Platform customer. Callers take api_base from the current Binding when dest. Bots does not mint Binding. Platform sylphx-sdk / sylphx-cli is not this product's client.

What is not the public schema

  • A handwritten OpenAPI, Swagger, GraphQL, or second proto as product authority.
  • Transport Connect files under proto/bots/v1 as a competing customer schema.
  • Author-facing invoke, tool_invoke, broker.call, or (name, arguments) envelopes.
  • Platform sylphx-sdk compiling this product as a mega-client.

Generated projections

SDK package @sylphx-bots/capability-sdk exports createSylphxBotsClient. CLI product dogfood is sylphx-bots capabilities and sylphx-bots sdk. Both bind to the same IDL. Field lists stay in the descriptor; this page does not re-author them.

Continue on SDK and CLI.