Upload a program bundle

curl --request POST \
  --url https://api.canary.effectiveai.app/api/v2/rsl/{id}/uploads \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/zip' \
  --data '<string>'

import requests

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

payload = "<string>"
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/zip"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/zip'},
  body: '<string>'
};

fetch('https://api.canary.effectiveai.app/api/v2/rsl/{id}/uploads', 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}/uploads",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "<string>",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/zip"
  ],
]);

$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}/uploads"

	payload := strings.NewReader("<string>")

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

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

	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}/uploads")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/zip")
  .body("<string>")
  .asString();

require 'uri'
require 'net/http'

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

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/zip'
request.body = "<string>"

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

{
  "programId": "<string>",
  "bundleId": "<string>",
  "programFingerprint": "<string>",
  "component": "rater",
  "uses": [
    {
      "alias": "<string>",
      "path": "<string>",
      "programFingerprint": "<string>"
    }
  ],
  "uploadedAt": "2023-11-07T05:31:56Z",
  "uploadedBy": "<string>",
  "alreadyUploaded": true,
  "latestReleaseVersion": 1
}

{
  "programId": "<string>",
  "bundleId": "<string>",
  "programFingerprint": "<string>",
  "component": "rater",
  "uses": [
    {
      "alias": "<string>",
      "path": "<string>",
      "programFingerprint": "<string>"
    }
  ],
  "uploadedAt": "2023-11-07T05:31:56Z",
  "uploadedBy": "<string>",
  "alreadyUploaded": true,
  "latestReleaseVersion": 1
}

{
  "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>"
}

{
  "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

Upload a program bundle

Upload a program bundle ZIP, as rslc export builds it from one entry file, as the request body. Effective checks the bundle, loads it once and stores it. Uploading changes nothing that serves: send the returned bundleId to Release an uploaded program bundle to serve it.

The response states the bundle’s component and, for a guideline, the raters it uses.

The first upload to a new ID creates the program with that ID. A program can grow: a later upload may be a guideline that uses the rater an earlier upload was, and each release serves what its own bundle contains. An archived program returns 404 program_not_found.

Send Content-Type: application/zip, at most 128 MiB. The bundle ID comes from the bundle’s content, so a rebuild usually gets a new ID.

Uploading the same content again is safe: it returns 200 with alreadyUploaded: true. A new upload returns 201.

Needs edit permission on the program. A new program needs permission to edit raters in your organization.

POST

rsl

{id}

uploads

Upload a program bundle

curl --request POST \
  --url https://api.canary.effectiveai.app/api/v2/rsl/{id}/uploads \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/zip' \
  --data '<string>'

import requests

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

payload = "<string>"
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/zip"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/zip'},
  body: '<string>'
};

fetch('https://api.canary.effectiveai.app/api/v2/rsl/{id}/uploads', 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}/uploads",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "<string>",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/zip"
  ],
]);

$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}/uploads"

	payload := strings.NewReader("<string>")

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

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

	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}/uploads")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/zip")
  .body("<string>")
  .asString();

require 'uri'
require 'net/http'

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

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/zip'
request.body = "<string>"

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

{
  "programId": "<string>",
  "bundleId": "<string>",
  "programFingerprint": "<string>",
  "component": "rater",
  "uses": [
    {
      "alias": "<string>",
      "path": "<string>",
      "programFingerprint": "<string>"
    }
  ],
  "uploadedAt": "2023-11-07T05:31:56Z",
  "uploadedBy": "<string>",
  "alreadyUploaded": true,
  "latestReleaseVersion": 1
}

{
  "programId": "<string>",
  "bundleId": "<string>",
  "programFingerprint": "<string>",
  "component": "rater",
  "uses": [
    {
      "alias": "<string>",
      "path": "<string>",
      "programFingerprint": "<string>"
    }
  ],
  "uploadedAt": "2023-11-07T05:31:56Z",
  "uploadedBy": "<string>",
  "alreadyUploaded": true,
  "latestReleaseVersion": 1
}

{
  "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>"
}

{
  "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/zip

The bundle ZIP.

Response

The program already had this content. 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}$

bundleId

string

required

SHA-256 identity of the uploaded bundle. Pass it to createProgramRelease to serve it.

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

programFingerprint

string

required

Fingerprint of the bundle’s entry program.

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. It is a fact of one bundle: a program’s releases may differ.

Available options:

rater,

guideline

uses

object[]

required

The raters the bundle’s guideline uses. Empty for a rater.

Show child attributes

uploadedAt

string<date-time>

required

When this content was first uploaded.

uploadedBy

string

required

Who first uploaded this content.

alreadyUploaded

boolean

required

True when this program already had this exact content. Nothing changed.

latestReleaseVersion

integer | null

required

The program’s latest release version (its highest ready release), or null before its first release. The next release needs a higher version to become the latest.

Required range: x > 0