Release an uploaded program bundle

curl --request POST \
  --url https://api.canary.effectiveai.app/api/v2/rsl/{id}/releases \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "releaseVersion": 1073741823,
  "bundleId": "<string>",
  "notes": "<string>"
}
'

import requests

url = "https://api.canary.effectiveai.app/api/v2/rsl/{id}/releases"

payload = {
    "releaseVersion": 1073741823,
    "bundleId": "<string>",
    "notes": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({releaseVersion: 1073741823, bundleId: '<string>', notes: '<string>'})
};

fetch('https://api.canary.effectiveai.app/api/v2/rsl/{id}/releases', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.canary.effectiveai.app/api/v2/rsl/{id}/releases",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'releaseVersion' => 1073741823,
    'bundleId' => '<string>',
    'notes' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.canary.effectiveai.app/api/v2/rsl/{id}/releases"

	payload := strings.NewReader("{\n  \"releaseVersion\": 1073741823,\n  \"bundleId\": \"<string>\",\n  \"notes\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.canary.effectiveai.app/api/v2/rsl/{id}/releases")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"releaseVersion\": 1073741823,\n  \"bundleId\": \"<string>\",\n  \"notes\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.canary.effectiveai.app/api/v2/rsl/{id}/releases")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"releaseVersion\": 1073741823,\n  \"bundleId\": \"<string>\",\n  \"notes\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "programId": "<string>",
  "releaseVersion": 1,
  "bundleId": "<string>",
  "component": "rater",
  "uses": [
    {
      "alias": "<string>",
      "path": "<string>",
      "programFingerprint": "<string>"
    }
  ],
  "endpoints": [
    {
      "operationId": "<string>",
      "method": "GET",
      "path": "<string>"
    }
  ],
  "latest": true,
  "state": "provisioning",
  "metadata": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z",
  "updatedBy": "<string>",
  "failure": "<string>"
}

{
  "programId": "<string>",
  "releaseVersion": 1,
  "bundleId": "<string>",
  "component": "rater",
  "uses": [
    {
      "alias": "<string>",
      "path": "<string>",
      "programFingerprint": "<string>"
    }
  ],
  "endpoints": [
    {
      "operationId": "<string>",
      "method": "GET",
      "path": "<string>"
    }
  ],
  "latest": true,
  "state": "provisioning",
  "metadata": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z",
  "updatedBy": "<string>",
  "failure": "<string>"
}

{
  "programId": "<string>",
  "releaseVersion": 1,
  "bundleId": "<string>",
  "component": "rater",
  "uses": [
    {
      "alias": "<string>",
      "path": "<string>",
      "programFingerprint": "<string>"
    }
  ],
  "endpoints": [
    {
      "operationId": "<string>",
      "method": "GET",
      "path": "<string>"
    }
  ],
  "latest": true,
  "state": "provisioning",
  "metadata": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z",
  "updatedBy": "<string>",
  "failure": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "details": [
    {
      "location": "path",
      "path": [
        "<string>"
      ],
      "code": "required",
      "message": "<string>"
    }
  ],
  "requestId": "<string>",
  "dataset": "naic",
  "businessCode": "<string>",
  "violations": [
    {
      "code": "<string>",
      "message": "<string>",
      "path": "<string>",
      "value": "<unknown>",
      "constraint": "<string>",
      "cite": "<string>"
    }
  ],
  "violationsTruncated": true,
  "executionId": "<string>",
  "accessUrl": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "details": [
    {
      "location": "path",
      "path": [
        "<string>"
      ],
      "code": "required",
      "message": "<string>"
    }
  ],
  "requestId": "<string>",
  "dataset": "naic",
  "businessCode": "<string>",
  "violations": [
    {
      "code": "<string>",
      "message": "<string>",
      "path": "<string>",
      "value": "<unknown>",
      "constraint": "<string>",
      "cite": "<string>"
    }
  ],
  "violationsTruncated": true,
  "executionId": "<string>",
  "accessUrl": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "details": [
    {
      "location": "path",
      "path": [
        "<string>"
      ],
      "code": "required",
      "message": "<string>"
    }
  ],
  "requestId": "<string>",
  "dataset": "naic",
  "businessCode": "<string>",
  "violations": [
    {
      "code": "<string>",
      "message": "<string>",
      "path": "<string>",
      "value": "<unknown>",
      "constraint": "<string>",
      "cite": "<string>"
    }
  ],
  "violationsTruncated": true,
  "executionId": "<string>",
  "accessUrl": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "details": [
    {
      "location": "path",
      "path": [
        "<string>"
      ],
      "code": "required",
      "message": "<string>"
    }
  ],
  "requestId": "<string>",
  "dataset": "naic",
  "businessCode": "<string>",
  "violations": [
    {
      "code": "<string>",
      "message": "<string>",
      "path": "<string>",
      "value": "<unknown>",
      "constraint": "<string>",
      "cite": "<string>"
    }
  ],
  "violationsTruncated": true,
  "executionId": "<string>",
  "accessUrl": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "details": [
    {
      "location": "path",
      "path": [
        "<string>"
      ],
      "code": "required",
      "message": "<string>"
    }
  ],
  "requestId": "<string>",
  "dataset": "naic",
  "businessCode": "<string>",
  "violations": [
    {
      "code": "<string>",
      "message": "<string>",
      "path": "<string>",
      "value": "<unknown>",
      "constraint": "<string>",
      "cite": "<string>"
    }
  ],
  "violationsTruncated": true,
  "executionId": "<string>",
  "accessUrl": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "details": [
    {
      "location": "path",
      "path": [
        "<string>"
      ],
      "code": "required",
      "message": "<string>"
    }
  ],
  "requestId": "<string>",
  "dataset": "naic",
  "businessCode": "<string>",
  "violations": [
    {
      "code": "<string>",
      "message": "<string>",
      "path": "<string>",
      "value": "<unknown>",
      "constraint": "<string>",
      "cite": "<string>"
    }
  ],
  "violationsTruncated": true,
  "executionId": "<string>",
  "accessUrl": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "details": [
    {
      "location": "path",
      "path": [
        "<string>"
      ],
      "code": "required",
      "message": "<string>"
    }
  ],
  "requestId": "<string>",
  "dataset": "naic",
  "businessCode": "<string>",
  "violations": [
    {
      "code": "<string>",
      "message": "<string>",
      "path": "<string>",
      "value": "<unknown>",
      "constraint": "<string>",
      "cite": "<string>"
    }
  ],
  "violationsTruncated": true,
  "executionId": "<string>",
  "accessUrl": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "details": [
    {
      "location": "path",
      "path": [
        "<string>"
      ],
      "code": "required",
      "message": "<string>"
    }
  ],
  "requestId": "<string>",
  "dataset": "naic",
  "businessCode": "<string>",
  "violations": [
    {
      "code": "<string>",
      "message": "<string>",
      "path": "<string>",
      "value": "<unknown>",
      "constraint": "<string>",
      "cite": "<string>"
    }
  ],
  "violationsTruncated": true,
  "executionId": "<string>",
  "accessUrl": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "details": [
    {
      "location": "path",
      "path": [
        "<string>"
      ],
      "code": "required",
      "message": "<string>"
    }
  ],
  "requestId": "<string>",
  "dataset": "naic",
  "businessCode": "<string>",
  "violations": [
    {
      "code": "<string>",
      "message": "<string>",
      "path": "<string>",
      "value": "<unknown>",
      "constraint": "<string>",
      "cite": "<string>"
    }
  ],
  "violationsTruncated": true,
  "executionId": "<string>",
  "accessUrl": "<string>"
}

Your programs

Release an uploaded program bundle

Create a release: a version number that names one uploaded bundle. The response’s endpoints lists the operations the release serves, derived from what the bundle contains.

Send releaseVersion and the bundleId that Upload a program bundle returned. To make the release the latest, use a version above the program’s latestReleaseVersion.

A release is permanent. A version that names another bundle or other notes returns 409 release_exists; choose a higher version. Repeating an identical request is safe: it returns 200 with the release.

A new release that serves at once returns 201 with state ready. A release Effective still prepares to serve returns 202 with state provisioning. Poll Get a program release at Location until it returns 200. Until then the release is not the latest.

Needs edit permission on the program.

POST

rsl

{id}

releases

Release an uploaded program bundle

curl --request POST \
  --url https://api.canary.effectiveai.app/api/v2/rsl/{id}/releases \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "releaseVersion": 1073741823,
  "bundleId": "<string>",
  "notes": "<string>"
}
'

import requests

url = "https://api.canary.effectiveai.app/api/v2/rsl/{id}/releases"

payload = {
    "releaseVersion": 1073741823,
    "bundleId": "<string>",
    "notes": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({releaseVersion: 1073741823, bundleId: '<string>', notes: '<string>'})
};

fetch('https://api.canary.effectiveai.app/api/v2/rsl/{id}/releases', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.canary.effectiveai.app/api/v2/rsl/{id}/releases",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'releaseVersion' => 1073741823,
    'bundleId' => '<string>',
    'notes' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.canary.effectiveai.app/api/v2/rsl/{id}/releases"

	payload := strings.NewReader("{\n  \"releaseVersion\": 1073741823,\n  \"bundleId\": \"<string>\",\n  \"notes\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.canary.effectiveai.app/api/v2/rsl/{id}/releases")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"releaseVersion\": 1073741823,\n  \"bundleId\": \"<string>\",\n  \"notes\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.canary.effectiveai.app/api/v2/rsl/{id}/releases")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"releaseVersion\": 1073741823,\n  \"bundleId\": \"<string>\",\n  \"notes\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "programId": "<string>",
  "releaseVersion": 1,
  "bundleId": "<string>",
  "component": "rater",
  "uses": [
    {
      "alias": "<string>",
      "path": "<string>",
      "programFingerprint": "<string>"
    }
  ],
  "endpoints": [
    {
      "operationId": "<string>",
      "method": "GET",
      "path": "<string>"
    }
  ],
  "latest": true,
  "state": "provisioning",
  "metadata": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z",
  "updatedBy": "<string>",
  "failure": "<string>"
}

{
  "programId": "<string>",
  "releaseVersion": 1,
  "bundleId": "<string>",
  "component": "rater",
  "uses": [
    {
      "alias": "<string>",
      "path": "<string>",
      "programFingerprint": "<string>"
    }
  ],
  "endpoints": [
    {
      "operationId": "<string>",
      "method": "GET",
      "path": "<string>"
    }
  ],
  "latest": true,
  "state": "provisioning",
  "metadata": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z",
  "updatedBy": "<string>",
  "failure": "<string>"
}

{
  "programId": "<string>",
  "releaseVersion": 1,
  "bundleId": "<string>",
  "component": "rater",
  "uses": [
    {
      "alias": "<string>",
      "path": "<string>",
      "programFingerprint": "<string>"
    }
  ],
  "endpoints": [
    {
      "operationId": "<string>",
      "method": "GET",
      "path": "<string>"
    }
  ],
  "latest": true,
  "state": "provisioning",
  "metadata": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z",
  "updatedBy": "<string>",
  "failure": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "details": [
    {
      "location": "path",
      "path": [
        "<string>"
      ],
      "code": "required",
      "message": "<string>"
    }
  ],
  "requestId": "<string>",
  "dataset": "naic",
  "businessCode": "<string>",
  "violations": [
    {
      "code": "<string>",
      "message": "<string>",
      "path": "<string>",
      "value": "<unknown>",
      "constraint": "<string>",
      "cite": "<string>"
    }
  ],
  "violationsTruncated": true,
  "executionId": "<string>",
  "accessUrl": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "details": [
    {
      "location": "path",
      "path": [
        "<string>"
      ],
      "code": "required",
      "message": "<string>"
    }
  ],
  "requestId": "<string>",
  "dataset": "naic",
  "businessCode": "<string>",
  "violations": [
    {
      "code": "<string>",
      "message": "<string>",
      "path": "<string>",
      "value": "<unknown>",
      "constraint": "<string>",
      "cite": "<string>"
    }
  ],
  "violationsTruncated": true,
  "executionId": "<string>",
  "accessUrl": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "details": [
    {
      "location": "path",
      "path": [
        "<string>"
      ],
      "code": "required",
      "message": "<string>"
    }
  ],
  "requestId": "<string>",
  "dataset": "naic",
  "businessCode": "<string>",
  "violations": [
    {
      "code": "<string>",
      "message": "<string>",
      "path": "<string>",
      "value": "<unknown>",
      "constraint": "<string>",
      "cite": "<string>"
    }
  ],
  "violationsTruncated": true,
  "executionId": "<string>",
  "accessUrl": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "details": [
    {
      "location": "path",
      "path": [
        "<string>"
      ],
      "code": "required",
      "message": "<string>"
    }
  ],
  "requestId": "<string>",
  "dataset": "naic",
  "businessCode": "<string>",
  "violations": [
    {
      "code": "<string>",
      "message": "<string>",
      "path": "<string>",
      "value": "<unknown>",
      "constraint": "<string>",
      "cite": "<string>"
    }
  ],
  "violationsTruncated": true,
  "executionId": "<string>",
  "accessUrl": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "details": [
    {
      "location": "path",
      "path": [
        "<string>"
      ],
      "code": "required",
      "message": "<string>"
    }
  ],
  "requestId": "<string>",
  "dataset": "naic",
  "businessCode": "<string>",
  "violations": [
    {
      "code": "<string>",
      "message": "<string>",
      "path": "<string>",
      "value": "<unknown>",
      "constraint": "<string>",
      "cite": "<string>"
    }
  ],
  "violationsTruncated": true,
  "executionId": "<string>",
  "accessUrl": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "details": [
    {
      "location": "path",
      "path": [
        "<string>"
      ],
      "code": "required",
      "message": "<string>"
    }
  ],
  "requestId": "<string>",
  "dataset": "naic",
  "businessCode": "<string>",
  "violations": [
    {
      "code": "<string>",
      "message": "<string>",
      "path": "<string>",
      "value": "<unknown>",
      "constraint": "<string>",
      "cite": "<string>"
    }
  ],
  "violationsTruncated": true,
  "executionId": "<string>",
  "accessUrl": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "details": [
    {
      "location": "path",
      "path": [
        "<string>"
      ],
      "code": "required",
      "message": "<string>"
    }
  ],
  "requestId": "<string>",
  "dataset": "naic",
  "businessCode": "<string>",
  "violations": [
    {
      "code": "<string>",
      "message": "<string>",
      "path": "<string>",
      "value": "<unknown>",
      "constraint": "<string>",
      "cite": "<string>"
    }
  ],
  "violationsTruncated": true,
  "executionId": "<string>",
  "accessUrl": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "details": [
    {
      "location": "path",
      "path": [
        "<string>"
      ],
      "code": "required",
      "message": "<string>"
    }
  ],
  "requestId": "<string>",
  "dataset": "naic",
  "businessCode": "<string>",
  "violations": [
    {
      "code": "<string>",
      "message": "<string>",
      "path": "<string>",
      "value": "<unknown>",
      "constraint": "<string>",
      "cite": "<string>"
    }
  ],
  "violationsTruncated": true,
  "executionId": "<string>",
  "accessUrl": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "details": [
    {
      "location": "path",
      "path": [
        "<string>"
      ],
      "code": "required",
      "message": "<string>"
    }
  ],
  "requestId": "<string>",
  "dataset": "naic",
  "businessCode": "<string>",
  "violations": [
    {
      "code": "<string>",
      "message": "<string>",
      "path": "<string>",
      "value": "<unknown>",
      "constraint": "<string>",
      "cite": "<string>"
    }
  ],
  "violationsTruncated": true,
  "executionId": "<string>",
  "accessUrl": "<string>"
}

Authorizations

Authorization

string

header

required

Effective API key. Send Authorization: Bearer sk-eai-...

Path Parameters

string

required

Your organization’s ID for the program, chosen at its first upload: lowercase letters, digits, dots, underscores and hyphens. A rater’s program ID is its rater ID.

Required string length: 1 - 128

Pattern: ^[a-z0-9][a-z0-9._-]{0,127}$

Body

application/json

releaseVersion

integer

required

Version number for the new release. It must be unused for this program.

Required range: 0 < x <= 2147483647

bundleId

string

required

An uploaded bundle of this program, from uploadProgram.

Pattern: ^[a-f0-9]{64}$

notes

string

Markdown release notes, stored as metadata.notes.

Required string length: 1 - 20000

Response

The identical release already existed. Nothing changed.

programId

string

required

Your organization’s ID for the program, chosen at its first upload: lowercase letters, digits, dots, underscores and hyphens. A rater’s program ID is its rater ID.

Required string length: 1 - 128

Pattern: ^[a-z0-9][a-z0-9._-]{0,127}$

releaseVersion

integer

required

Required range: x > 0

bundleId

string

required

SHA-256 identity of the immutable program bundle.

Pattern: ^[a-f0-9]{64}$

component

enum<string>

required

What the program’s entry file is, as its spec states. A rater prices a risk. A guideline decides a submission step by step, and prices it with the raters it uses. The first upload fixes it: every bundle of one program has the same component.

Available options:

rater,

guideline

uses

object[]

required

The raters this release’s guideline uses. Empty for a rater.

Show child attributes

endpoints

object[]

required

The operations this release serves, derived from what its own bundle contains. A rater’s release serves its contract and rating. A guideline’s release lists none yet.

Show child attributes

latest

boolean

required

True for the latest release: the highest version whose state is ready.

state

enum<string>

required

provisioning while Effective prepares the release to serve; ready once it serves; failed if its bundle cannot be served. Only a ready release becomes the latest.

Available options:

provisioning,

ready,

failed

metadata

object

required

Release metadata, such as notes.

Show child attributes

createdAt

string<date-time>

required

createdBy

string

required

updatedAt

string<date-time>

required

updatedBy

string

required

failure

string

Why the release failed, when state is failed. Upload a fixed bundle and release it.