The FlatPeak API is RESTful and resource-driven, using:
  • Standard HTTP methods (GET, POST, etc.)
  • JSON for writes and reads
  • Bearer token authenticaiton
  • Sandbox mode (test API keys start with sk_test_; live keys with sk_live_)
  • Consistent status codes across operations

​
Connect endpoints

The Connect API operates differently:
FeatureDetails
EndpointSingle endpoint, used like a JSON‑structured conversation
Session IDA one-time-use connect_token authorises each session
Flow ControlYour app must handle every step of Connect session
UsageFollow the Connect guide to implement this flow

​
Developer tips

  1. Use REST best practices for non-Connect endpoints
  2. Ensure Authorization keys match environment (sk_test_ vs sk_live_)
  3. For Connect, follow session flow and handle all required pages
  4. Test in sandbox mode before going live