API versioning | Coris API

/api/v0_2 is the stable production API, in use since 2023. The name is historical, so v0_2 does not mean beta.

Your workspace also holds a dated version that sets response details.

Base path/api/v0_2
Workspace version2024-08-23
SendsYour request
ReturnsResponse

The workspace version also sets the Coris-Api-Version webhook header.

Prepare your integration

Keep the base URL in one setting, so that every request uses the same path.

export CORIS_BASE_URL="https://sandbox-api.coris.ai/api/v0_2"
export CORIS_API_KEY="YOUR_API_KEY"

import requests

BASE_URL = "https://sandbox-api.coris.ai/api/v0_2"
HEADERS = {"Authorization": "Token YOUR_API_KEY"}

const BASE_URL = "https://sandbox-api.coris.ai/api/v0_2";
const HEADERS = {
  Authorization: "Token YOUR_API_KEY",
  "Content-Type": "application/json",
};

Log the workspace version from webhook deliveries, so that you can branch on it.

# HEADERS_FILE holds the headers of a stored delivery.
grep -i '^coris-api-version' "$HEADERS_FILE"

def handle_delivery(headers, raw_body):
    print("Coris API version:", headers.get("Coris-Api-Version"))

function handleDelivery(headers, rawBody) {
  console.log("Coris API version:", headers["coris-api-version"]);
}

Ignore fields you do not recognize, so that your code keeps working as responses grow.

Version layers

Layer	Value	Where you see it
Path version	`v0_2`	Every request URL
Workspace version	`2024-08-23` by default	`Coris-Api-Version` on webhook deliveries

There is no request header that selects a version.

Deprecation policy

Coris gives at least 90 days' notice before it removes or changes anything in a way that breaks a working integration.

Step	What happens
Notice	Coris posts the change in the changelog and emails your technical contacts.
Notice period	At least 90 days, from the notice to the change.
During the period	The current behavior keeps working, so you can test and switch.

These changes are not breaking, and they can ship without notice: new endpoints, new optional request fields, new response fields and new enum values. Build your integration to ignore fields and values it does not know.

What to do next

Change	Your action
Coris announces a breaking change	Follow the notice before its date.
You want to see recent changes	Read the changelog.
You see an unexpected response	Send the `Correlation-ID` to Coris support.

FAQ

How will I hear about breaking changes?

Coris posts them in the changelog and emails your technical contacts at least 90 days ahead. Keep your technical contacts with Coris current.

Why is the path `v0_2` if the API is stable?

The name comes from an early version label. Every live integration calls that path, so it stays.

Does the sandbox run the same version as production?

Both use the /api/v0_2 path. Test against the sandbox before each change you make.

Can I change my workspace version?

Not through the API. Ask Coris support.

Next: File formats for portfolio uploads