Kordiam API v2: Ready for AI, Easier to Build On
Version 2 of the Kordiam REST API works reliably with the AI tools and agents your team is starting to rely on. It also gives the developers behind your integrations a clearer, more direct interface – with documentation and interactive testing in Swagger UI, generated from an OpenAPI 3.1 specification.
v2 is a meaningful upgrade to the bridge that connects your own tools, systems, and workflows to Kordiam. Your existing v1 integrations keep running, so v2 is where new development should start.
What is special about the v2 upgrade?
AI assistants and agents are only as good as the interfaces they're given. The API ships with an OpenAPI 3.1 specification, the standard machine-readable format that AI coding tools and agent frameworks use to read an API and generate working clients. Swagger UI is generated from that same specification, so what your developers read and what an AI tool consumes come from a single source, kept in sync.
Three changes matter most for automated and AI-driven clients:
- Explicit reference fields. Fields that point to other resources now carry clear names like platformId or categoryId, so an AI tool or a developer can map your data correctly without guessing.
- Structured errors. Every error follows the RFC 9457 Problem Details format, so a client knows precisely what failed and why, rather than parsing free text.
- Documented write behavior. POST, PUT, PATCH, and DELETE now have clearly defined, documented semantics, so an automated client can act on your content knowing exactly what each call will do.
How does this API upgrade affect developers?
The v2 upgrade gives a clearer API for the developers behind your integrations. The same qualities that make v2 work for AI tools make it more direct for the people maintaining your integrations.
For example:
- Versioned addresses. Every endpoint lives under a clearly versioned path. Future breaking changes land under a new major version, so what you've built against v2 keeps working.
- Modern authentication. Access uses OAuth2 client credentials and bearer tokens, a current and well-understood standard for system-to-system access.
- Consistent pagination. Requests that return multiple items use one shared response shape, with both offset and cursor modes.
- Richer responses. Responses can now include full embedded objects rather than bare ID values, cutting the number of calls your systems need to make to assemble a complete picture.
- Documented workflow contracts. The rules governing how tasks link to publications, and when content is scheduled to go live, are now documented – including explicit task references and a dedicated operation for publishing.
How do we migrate from v1?
Your existing v1 integrations continue to run, so your team can plan the move on its own timeline rather than all at once. Resource-by-resource notes for elements, tasks, publications, task-publication linking, custom fields, configuration, people, and scheduling are available for your team.
You can explore the full specification, browse the interactive Swagger documentation, and start your migration from the developer docs here. If questions come up along the way, our team is reachable at support@kordiam.io.

