Skip to main content

About This Documentation

This site is the developer reference for the Digital.ai Agility API: the endpoints, the query syntax they share, and the behaviour you can rely on when building an integration.

Its content is validated against Agility's implementation and its executable test suites. Where a behaviour is not covered by a test, or varies with an instance's configuration, the page says so and recommends verifying against your own instance.

Two boundaries keep this site focused:

  • It documents the API, not the product. Product concepts, tutorials and end-user workflows live in the Digital.ai Agility documentation.
  • It documents the supported surface. A small number of api/* routes exist for internal or infrastructure purposes. They are deliberately not documented here, and integrations should not be built against them.

Feedback​

Spotted an error, a gap, or behaviour that does not match your instance? There are two ways to reach the maintainers, depending on who you are:

  • Digital.ai team members — open an issue or propose a change in digital-ai/docs-agility-api. The repository is internal, so this link requires Digital.ai enterprise access and returns a 404 for everyone else.
  • Everyone else — contact Digital.ai Support. Include the page URL and, where possible, the request and response that surprised you — that is usually enough to reproduce and fix a documentation error quickly.