Developers Log in Sign up

Succo AI Public API reference

The Succo AI Public API is a REST API over surveys, forms and their responses, served from https://succo.ai/api/public/v1. Authenticate with a bearer API key (succo_sk_…) created in Succo AI account settings, pin a contract with the Succo-Version header, and read every endpoint, schema and example in the interactive reference below.

How the API works

  • Base URL: https://succo.ai/api/public/v1
  • Authentication: Authorization: Bearer succo_sk_…. Each key carries a fixed set of scopes (read, read:pii, write, write:runs, write:delete) and never exceeds what its owner can do in the app.
  • Versioning: date-based, sent in the Succo-Version header. Supported versions: 2026-07-21 (default 2026-07-21).
  • Errors: RFC 7807 application/problem+json with a stable machine-readable code.
  • Pagination: keyset, with an opaque cursor; every list returns the envelope {data, next_cursor, limit_left}.
  • Sparse fieldsets: append ?fields=a,b to any endpoint to trim the returned keys.
  • Personal data: redacted by default. It is returned only when the key holds read:pii and the request sets include_pii=true.

What the API covers

Machine-readable contract