List agent deployment promotions

GET

/api/v1/agent_deployment/promotions

const url = 'https://app.prefactorai.com/api/v1/agent_deployment/promotions?agent_id=013xrzp12g3nqk8ns6jadrqmpgrjkeny';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://app.prefactorai.com/api/v1/agent_deployment/promotions?agent_id=013xrzp12g3nqk8ns6jadrqmpgrjkeny' \
  --header 'Authorization: Bearer <token>'

Authorizations

authorization

Parameters

Query Parameters

agent_id

Agent_Id

A valid agent ID

string

Example

013xrzp12g3nqk8ns6jadrqmpgrjkeny

idempotency_key

One of:

string
Null

Optional idempotency key for ensuring request idempotency

string

Responses

200

Success

application/json

object

promotions

required

Deployments of this agent that can be promoted

Array<object>

AgentDeployment_Promotion

Source_agent_deployment_id is the deployment whose current version can be promoted. source_environment_id is the environment of that deployment. agent_version_id is the version that would be pinned on the target environment. target_environment_id is the environment the version would be promoted to. target_agent_deployment_id is the deployment in the target environment, or null when that environment has no deployment yet.

object

agent_version_id

required

AgentVersion_Id

A valid agent version ID

string

source_agent_deployment_id

required

AgentDeployment_Id

A valid agent deployment ID

string

source_environment_id

required

Environment_Id

A valid environment ID

string

target_agent_deployment_id

required

One of:

AgentDeployment_Id
Null

AgentDeployment_Id

A valid agent deployment ID

string

target_environment_id

required

Environment_Id

A valid environment ID

string

status

required

string

Allowed values: success

Example

{
  "promotions": [
    {
      "agent_version_id": "013xrzp12g3nqk8ns6jadrqmpgrjkeny",
      "source_agent_deployment_id": "013xrzp12g3nqk8ns6jadrqmpgrjkeny",
      "source_environment_id": "013xrzp12g3nqk8ns6jadrqmpgrjkeny",
      "target_agent_deployment_id": "013xrzp12g3nqk8ns6jadrqmpgrjkeny",
      "target_environment_id": "013xrzp12g3nqk8ns6jadrqmpgrjkeny"
    }
  ],
  "status": "success"
}

default

Error

application/json

One of:

object

code

required

string

Allowed values: bad_request bad_authtoken not_authenticated not_permitted not_implemented unknown not_found unexpected_ref_type unexpected invalid_action invalid_state alert_unknown alert_already_cleared invalid_value required_value idempotency_key_already_used temporarily_unavailable conflict

message

required

string

status

required

string

Allowed values: error

Example

{
  "code": "bad_request",
  "status": "error"
}