Skip to content
SocialMate
Knowledge base Developer API & automation

The OpenAPI spec & live docs

Every endpoint, request, and response — documented live on your own machine.

1 min read Updated July 14, 2026

You don’t have to guess at the API. SocialMate serves a full OpenAPI spec and human-readable docs locally.

Where to find them

  • Machine-readable: http://localhost:3456/docs/openapi.json — import it into Postman, Insomnia, or a code generator.
  • Human docs: http://localhost:3456/docs — browse every endpoint, parameter, and example.
The in-app Docs tab — every endpoint, parameter, and example, always matching the version you're running.
The in-app Docs tab — every endpoint, parameter, and example, always matching the version you're running.

Tip. Point your favourite API client at the OpenAPI URL to generate a typed client in minutes. Because it’s local, the spec always matches the exact version you’re running.

All requests are validated against JSON schemas (Fastify), so malformed input is rejected with a clear error instead of doing something surprising.

Was this helpful?

Still stuck — open a ticket · Back to all articles

Free forever · no card Download free