Bevaya API

The Bevaya API is a RESTful service that follows a JSON API spec.

The API is designed with the following principles in mind:

JSON API-compliant: Standardized response structures for resources, relationships, and errors.
Authenticated: All operations require proper authentication via tokens provided by the Identity service.
Authorization: All requests must be authorized to operate on a given resource.

Hierarchy Levels

The Bevaya hierarchy is as follows:

Code
Organization
└── Workspace
    └── AI Agent
        ├── Flow
        └── Item

To start using the API, you will need:

These identifiers are typically found in the platform URL or provided by the system administrator.

Error Handling: Standard HTTP status codes are used.
- 400 Bad Request: The request was invalid or cannot be served.
- 401 Unauthorized: Authentication failed or user does not have permissions.
- 404 Not Found: The requested resource could not be found.
- 429 Too Many Requests: Rate limit exceeded.
- 500 Internal Server Error: An unexpected error occurred on the server.
Rate Limiting: Users are limited to 60 requests per minute. Exceeding this limit will result in a 429 Too Many Requests response. Useful headers: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.
Traceability: All responses include an X-Encore-Trace-Id header. Please provide this ID when reporting issues to support.

The Bevaya API is a RESTful service that follows a JSON API spec.

The API is designed with the following principles in mind:

JSON API-compliant: Standardized response structures for resources, relationships, and errors.
Authenticated: All operations require proper authentication via tokens provided by the Identity service.
Authorization: All requests must be authorized to operate on a given resource.

The Bevaya hierarchy is as follows:

Code
Organization
└── Workspace
    └── AI Agent
        ├── Flow
        └── Item

To start using the API, you will need:

These identifiers are typically found in the platform URL or provided by the system administrator.

Error Handling: Standard HTTP status codes are used.
- 400 Bad Request: The request was invalid or cannot be served.
- 401 Unauthorized: Authentication failed or user does not have permissions.
- 404 Not Found: The requested resource could not be found.
- 429 Too Many Requests: Rate limit exceeded.
- 500 Internal Server Error: An unexpected error occurred on the server.
Rate Limiting: Users are limited to 60 requests per minute. Exceeding this limit will result in a 429 Too Many Requests response. Useful headers: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.
Traceability: All responses include an X-Encore-Trace-Id header. Please provide this ID when reporting issues to support.