Navigating our Resources

We designed our API in a way that is simple to navigate and is predictable. For starters, every API route starts with a resource name (see common terminology). We expose the following resources to consumers of our API:

• Agent
• Evaluations
• Hierarchy
• Media
• Metadata
• Interactions
• Roles
• User
• UserHierarchy
• Workflows

You will see that each of these resources has their own section in the API Reference page. And, within each resource you will see what routes exist and their associated methods.

Route Naming Conventions

To get all the records for a specific resource you will use the /All route and the GET method.

To get or update a single record for a specific resource you will use the /{Id} route and the GET or PUT method.

To create a record for a specific resource you will use the / route and the POST method.

You will see these naming conventions employed across most routes in the API Reference, however there are some exceptions which you can read more about there.