Versioning

The ProteusAI Messaging API is versioned. The API version name is based on the date when the API version was released. For example, the API version 2024-07-01 was released on Mon, 1 July 2024.

Any breaking changes will be released in a new API version. Breaking changes are changes that can potentially break an integration. Breaking changes include:

• removing an entire operation
• removing or renaming a parameter
• removing or renaming a response field
• adding a new required parameter
• making a previously optional parameter required
• changing the type of a parameter or response field
• removing enum values
• adding a new validation rule to an existing parameter
• changing authentication or authorization requirements

Any additive (non-breaking) changes will be available in all supported API versions. Additive changes are changes that should not break an integration. Additive changes include:

• adding an operation
• adding an optional parameter
• adding an optional request header
• adding a response field
• adding a response header
• adding enum values

At this point, we don't make any claims about how long previous API versions will be supported. Just so you know, a specific support period may be communicated in the future.

Specifying an API version

Use the X-ProteusAI-Messaging-Api-Version header to specify an API version. For example:

curl --header "X-ProteusAI-Messaging-Api-Version:2024-07-01" https://messaging-api.useproteus.ai/conversations/77542a3587659db1a6ce5058/messages

This header is searched for in a case-insensitive manner; you may as well specify it as X-PROTEUSAI-MESSAGING-API-VERSION or x-proteusai-messaging-api-version.

Requests without the X-ProteusAI-Messaging-Api-Version header will default to use the latest version.

If you specify an API version that is no longer supported, you will receive a 400 error.

Supported API versions

Supported API versions will be listed here.