Create ai releases rollout

POST

api

ai-releases

{releaseId}

rollout

Create ai releases rollout

curl --request POST \
  --url https://evalgate.com/api/ai-releases/{releaseId}/rollout \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "idempotencyKey": "<string>",
  "action": "shadow",
  "expectedStateVersion": 123,
  "expectedRolloutRevision": 123,
  "authorizationId": "<string>"
}
'

import requests

url = "https://evalgate.com/api/ai-releases/{releaseId}/rollout"

payload = {
    "idempotencyKey": "<string>",
    "action": "shadow",
    "expectedStateVersion": 123,
    "expectedRolloutRevision": 123,
    "authorizationId": "<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({
    idempotencyKey: '<string>',
    action: 'shadow',
    expectedStateVersion: 123,
    expectedRolloutRevision: 123,
    authorizationId: '<string>'
  })
};

fetch('https://evalgate.com/api/ai-releases/{releaseId}/rollout', 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://evalgate.com/api/ai-releases/{releaseId}/rollout",
  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([
    'idempotencyKey' => '<string>',
    'action' => 'shadow',
    'expectedStateVersion' => 123,
    'expectedRolloutRevision' => 123,
    'authorizationId' => '<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://evalgate.com/api/ai-releases/{releaseId}/rollout"

	payload := strings.NewReader("{\n  \"idempotencyKey\": \"<string>\",\n  \"action\": \"shadow\",\n  \"expectedStateVersion\": 123,\n  \"expectedRolloutRevision\": 123,\n  \"authorizationId\": \"<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://evalgate.com/api/ai-releases/{releaseId}/rollout")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"idempotencyKey\": \"<string>\",\n  \"action\": \"shadow\",\n  \"expectedStateVersion\": 123,\n  \"expectedRolloutRevision\": 123,\n  \"authorizationId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://evalgate.com/api/ai-releases/{releaseId}/rollout")

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  \"idempotencyKey\": \"<string>\",\n  \"action\": \"shadow\",\n  \"expectedStateVersion\": 123,\n  \"expectedRolloutRevision\": 123,\n  \"authorizationId\": \"<string>\"\n}"

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

{
  "release": {
    "status": "<string>",
    "id": "<string>",
    "name": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "description": "<string>",
    "createdBy": "<string>",
    "releaseKey": "<string>",
    "riskTier": "<string>",
    "aiSystemId": 123,
    "environment": "<string>",
    "stateVersion": 123,
    "releasePolicyId": "<string>",
    "latestManifestId": "<string>",
    "baseReleaseId": "<string>"
  },
  "binding": {
    "id": "<string>",
    "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "releaseId": "<string>",
    "manifestId": "<string>",
    "manifestHash": "<string>",
    "environment": "<string>",
    "deploymentIds": [
      "<string>"
    ],
    "activeVersions": [
      {
        "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "schemaVersion": 1,
        "kind": "prompt",
        "artifactId": "<string>",
        "versionId": "<string>",
        "contentHash": "<string>",
        "environment": "local",
        "sourceControl": {
          "repositoryId": "<string>",
          "provider": "github",
          "commitSha": "<string>",
          "path": "<string>"
        },
        "dependencySnapshotHash": "<string>"
      }
    ],
    "shadowVersions": [
      {
        "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "schemaVersion": 1,
        "kind": "prompt",
        "artifactId": "<string>",
        "versionId": "<string>",
        "contentHash": "<string>",
        "environment": "local",
        "sourceControl": {
          "repositoryId": "<string>",
          "provider": "github",
          "commitSha": "<string>",
          "path": "<string>"
        },
        "dependencySnapshotHash": "<string>"
      }
    ],
    "canaryVersions": [
      {
        "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "schemaVersion": 1,
        "kind": "prompt",
        "artifactId": "<string>",
        "versionId": "<string>",
        "contentHash": "<string>",
        "environment": "local",
        "sourceControl": {
          "repositoryId": "<string>",
          "provider": "github",
          "commitSha": "<string>",
          "path": "<string>"
        },
        "dependencySnapshotHash": "<string>"
      }
    ],
    "cohortAssignmentPolicy": {},
    "healthPolicyHash": "<string>",
    "automaticRollbackPolicy": {
      "enabled": true,
      "conditions": [
        {
          "metric": "<string>",
          "comparator": "<string>",
          "threshold": 123,
          "reasonCode": "<string>"
        }
      ],
      "minimumObservations": 123
    },
    "rolloutRevision": 123,
    "status": "<string>",
    "createdBy": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "providerEventsObserved": true,
  "replayed": true
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "<string>",
    "details": "<unknown>",
    "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "redaction": {
      "applied": true,
      "fieldCount": 1,
      "secretCount": 1
    }
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "<string>",
    "details": "<unknown>",
    "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "redaction": {
      "applied": true,
      "fieldCount": 1,
      "secretCount": 1
    }
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "<string>",
    "details": "<unknown>",
    "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "redaction": {
      "applied": true,
      "fieldCount": 1,
      "secretCount": 1
    }
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "<string>",
    "details": "<unknown>",
    "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "redaction": {
      "applied": true,
      "fieldCount": 1,
      "secretCount": 1
    }
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "<string>",
    "details": "<unknown>",
    "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "redaction": {
      "applied": true,
      "fieldCount": 1,
      "secretCount": 1
    }
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "<string>",
    "details": "<unknown>",
    "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "redaction": {
      "applied": true,
      "fieldCount": 1,
      "secretCount": 1
    }
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "<string>",
    "details": "<unknown>",
    "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "redaction": {
      "applied": true,
      "fieldCount": 1,
      "secretCount": 1
    }
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "<string>",
    "details": "<unknown>",
    "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "redaction": {
      "applied": true,
      "fieldCount": 1,
      "secretCount": 1
    }
  }
}

Authorizations

Authorization

string

header

required

Organization-scoped EvalGate API key. Discover the supported agent scopes at /.well-known/oauth-protected-resource. Per-operation grants are listed in x-evalgate-required-scopes; OpenAPI bearer security requirement arrays remain empty as required for non-OAuth schemes.

Path Parameters

releaseId

string

required

Body

application/json

idempotencyKey

string

required

action

required

Available options:

shadow

expectedStateVersion

number

required

expectedRolloutRevision

number

required

authorizationId

string

Response

Successful response

Option 1
Option 2

release

object

required

Show child attributes

binding

object

required

Show child attributes

providerEventsObserved

boolean

required

replayed

boolean

required

Create ai releases rollout

curl --request POST \
  --url https://evalgate.com/api/ai-releases/{releaseId}/rollout \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "idempotencyKey": "<string>",
  "action": "shadow",
  "expectedStateVersion": 123,
  "expectedRolloutRevision": 123,
  "authorizationId": "<string>"
}
'

import requests

url = "https://evalgate.com/api/ai-releases/{releaseId}/rollout"

payload = {
    "idempotencyKey": "<string>",
    "action": "shadow",
    "expectedStateVersion": 123,
    "expectedRolloutRevision": 123,
    "authorizationId": "<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({
    idempotencyKey: '<string>',
    action: 'shadow',
    expectedStateVersion: 123,
    expectedRolloutRevision: 123,
    authorizationId: '<string>'
  })
};

fetch('https://evalgate.com/api/ai-releases/{releaseId}/rollout', 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://evalgate.com/api/ai-releases/{releaseId}/rollout",
  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([
    'idempotencyKey' => '<string>',
    'action' => 'shadow',
    'expectedStateVersion' => 123,
    'expectedRolloutRevision' => 123,
    'authorizationId' => '<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://evalgate.com/api/ai-releases/{releaseId}/rollout"

	payload := strings.NewReader("{\n  \"idempotencyKey\": \"<string>\",\n  \"action\": \"shadow\",\n  \"expectedStateVersion\": 123,\n  \"expectedRolloutRevision\": 123,\n  \"authorizationId\": \"<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://evalgate.com/api/ai-releases/{releaseId}/rollout")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"idempotencyKey\": \"<string>\",\n  \"action\": \"shadow\",\n  \"expectedStateVersion\": 123,\n  \"expectedRolloutRevision\": 123,\n  \"authorizationId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://evalgate.com/api/ai-releases/{releaseId}/rollout")

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  \"idempotencyKey\": \"<string>\",\n  \"action\": \"shadow\",\n  \"expectedStateVersion\": 123,\n  \"expectedRolloutRevision\": 123,\n  \"authorizationId\": \"<string>\"\n}"

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

{
  "release": {
    "status": "<string>",
    "id": "<string>",
    "name": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "description": "<string>",
    "createdBy": "<string>",
    "releaseKey": "<string>",
    "riskTier": "<string>",
    "aiSystemId": 123,
    "environment": "<string>",
    "stateVersion": 123,
    "releasePolicyId": "<string>",
    "latestManifestId": "<string>",
    "baseReleaseId": "<string>"
  },
  "binding": {
    "id": "<string>",
    "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "releaseId": "<string>",
    "manifestId": "<string>",
    "manifestHash": "<string>",
    "environment": "<string>",
    "deploymentIds": [
      "<string>"
    ],
    "activeVersions": [
      {
        "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "schemaVersion": 1,
        "kind": "prompt",
        "artifactId": "<string>",
        "versionId": "<string>",
        "contentHash": "<string>",
        "environment": "local",
        "sourceControl": {
          "repositoryId": "<string>",
          "provider": "github",
          "commitSha": "<string>",
          "path": "<string>"
        },
        "dependencySnapshotHash": "<string>"
      }
    ],
    "shadowVersions": [
      {
        "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "schemaVersion": 1,
        "kind": "prompt",
        "artifactId": "<string>",
        "versionId": "<string>",
        "contentHash": "<string>",
        "environment": "local",
        "sourceControl": {
          "repositoryId": "<string>",
          "provider": "github",
          "commitSha": "<string>",
          "path": "<string>"
        },
        "dependencySnapshotHash": "<string>"
      }
    ],
    "canaryVersions": [
      {
        "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "schemaVersion": 1,
        "kind": "prompt",
        "artifactId": "<string>",
        "versionId": "<string>",
        "contentHash": "<string>",
        "environment": "local",
        "sourceControl": {
          "repositoryId": "<string>",
          "provider": "github",
          "commitSha": "<string>",
          "path": "<string>"
        },
        "dependencySnapshotHash": "<string>"
      }
    ],
    "cohortAssignmentPolicy": {},
    "healthPolicyHash": "<string>",
    "automaticRollbackPolicy": {
      "enabled": true,
      "conditions": [
        {
          "metric": "<string>",
          "comparator": "<string>",
          "threshold": 123,
          "reasonCode": "<string>"
        }
      ],
      "minimumObservations": 123
    },
    "rolloutRevision": 123,
    "status": "<string>",
    "createdBy": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "providerEventsObserved": true,
  "replayed": true
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "<string>",
    "details": "<unknown>",
    "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "redaction": {
      "applied": true,
      "fieldCount": 1,
      "secretCount": 1
    }
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "<string>",
    "details": "<unknown>",
    "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "redaction": {
      "applied": true,
      "fieldCount": 1,
      "secretCount": 1
    }
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "<string>",
    "details": "<unknown>",
    "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "redaction": {
      "applied": true,
      "fieldCount": 1,
      "secretCount": 1
    }
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "<string>",
    "details": "<unknown>",
    "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "redaction": {
      "applied": true,
      "fieldCount": 1,
      "secretCount": 1
    }
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "<string>",
    "details": "<unknown>",
    "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "redaction": {
      "applied": true,
      "fieldCount": 1,
      "secretCount": 1
    }
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "<string>",
    "details": "<unknown>",
    "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "redaction": {
      "applied": true,
      "fieldCount": 1,
      "secretCount": 1
    }
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "<string>",
    "details": "<unknown>",
    "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "redaction": {
      "applied": true,
      "fieldCount": 1,
      "secretCount": 1
    }
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "<string>",
    "details": "<unknown>",
    "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "redaction": {
      "applied": true,
      "fieldCount": 1,
      "secretCount": 1
    }
  }
}

Overview

Endpoints

Create ai releases rollout

Authorizations

Path Parameters

Body

Response