Fetch agent risk version

GET

/api/v1/agent_risk_version/{agent_risk_version_id}

const url = 'https://app.prefactorai.com/api/v1/agent_risk_version/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_risk_version/013xrzp12g3nqk8ns6jadrqmpgrjkeny \
  --header 'Authorization: Bearer <token>'

Authorizations

authorization

Parameters

Path Parameters

agent_risk_version_id

required

AgentRiskVersion_Id

A valid agent risk version ID

string

Example

013xrzp12g3nqk8ns6jadrqmpgrjkeny

Query Parameters

idempotency_key

One of:

string
Null

Optional idempotency key for ensuring request idempotency

string

Responses

200

Success

application/json

object

details

required

AgentRiskVersion_Details

object

account_id

required

Account_Id

A valid account ID

string

activity_data_risks

required

Map of activity span type name to data risk

object

key

additional properties

DataRisk

object

action_profile

required

ActionProfile

object

create_data

required

Creates data

string

Allowed values: unknown allowed disallowed

destroy_data

required

Destroys data

string

Allowed values: unknown allowed disallowed

external_communication

required

Sends external communications

string

Allowed values: unknown allowed disallowed

financial_transactions

required

Performs financial transactions

string

Allowed values: unknown allowed disallowed

read_data

required

Reads data

string

Allowed values: unknown allowed disallowed

update_data

required

Updates data

string

Allowed values: unknown allowed disallowed

params_data_categories

required

DataCategories

object

authentication_and_secrets

required

Authentication and secrets present

string

Allowed values: unknown included excluded

behavioural_and_inferred

required

Behavioural and inferred data present

string

Allowed values: unknown included excluded

classification

required

Classification level

string

Allowed values: unknown public internal confidential restricted secret

contact_information

required

Contact information present

string

Allowed values: unknown included excluded

criminal_justice

required

Criminal justice data present

string

Allowed values: unknown included excluded

financial_information

required

Financial information present

string

Allowed values: unknown included excluded

gdpr_biometric_for_identification

required

GDPR: biometric data for identification

string

Allowed values: unknown included excluded

gdpr_genetic_data

required

GDPR: genetic data

string

Allowed values: unknown included excluded

gdpr_political_opinions

required

GDPR: political opinions

string

Allowed values: unknown included excluded

gdpr_racial_or_ethnic_origin

required

GDPR: racial or ethnic origin

string

Allowed values: unknown included excluded

gdpr_religious_or_philosophical_beliefs

required

GDPR: religious or philosophical beliefs

string

Allowed values: unknown included excluded

gdpr_sex_life_or_sexual_orientation

required

GDPR: sex life or sexual orientation

string

Allowed values: unknown included excluded

gdpr_trade_union_membership

required

GDPR: trade union membership

string

Allowed values: unknown included excluded

health_and_medical

required

Health and medical data present

string

Allowed values: unknown included excluded

location_and_tracking

required

Location and tracking data present

string

Allowed values: unknown included excluded

minors_data

required

Minors data present

string

Allowed values: unknown included excluded

organisational_confidential

required

Organisational confidential data present

string

Allowed values: unknown included excluded

personal_identifiers

required

Personal identifiers present

string

Allowed values: unknown included excluded

result_data_categories

required

DataCategories

object

authentication_and_secrets

required

Authentication and secrets present

string

Allowed values: unknown included excluded

behavioural_and_inferred

required

Behavioural and inferred data present

string

Allowed values: unknown included excluded

classification

required

Classification level

string

Allowed values: unknown public internal confidential restricted secret

contact_information

required

Contact information present

string

Allowed values: unknown included excluded

criminal_justice

required

Criminal justice data present

string

Allowed values: unknown included excluded

financial_information

required

Financial information present

string

Allowed values: unknown included excluded

gdpr_biometric_for_identification

required

GDPR: biometric data for identification

string

Allowed values: unknown included excluded

gdpr_genetic_data

required

GDPR: genetic data

string

Allowed values: unknown included excluded

gdpr_political_opinions

required

GDPR: political opinions

string

Allowed values: unknown included excluded

gdpr_racial_or_ethnic_origin

required

GDPR: racial or ethnic origin

string

Allowed values: unknown included excluded

gdpr_religious_or_philosophical_beliefs

required

GDPR: religious or philosophical beliefs

string

Allowed values: unknown included excluded

gdpr_sex_life_or_sexual_orientation

required

GDPR: sex life or sexual orientation

string

Allowed values: unknown included excluded

gdpr_trade_union_membership

required

GDPR: trade union membership

string

Allowed values: unknown included excluded

health_and_medical

required

Health and medical data present

string

Allowed values: unknown included excluded

location_and_tracking

required

Location and tracking data present

string

Allowed values: unknown included excluded

minors_data

required

Minors data present

string

Allowed values: unknown included excluded

organisational_confidential

required

Organisational confidential data present

string

Allowed values: unknown included excluded

personal_identifiers

required

Personal identifiers present

string

Allowed values: unknown included excluded

agent_id

required

Agent_Id

A valid agent ID

string

required

AgentRiskVersion_Id

A valid agent risk version ID

string

inserted_at

required

When the agent risk version was created

string format: date-time

type

required

Type of resource (always ‘agent_risk_version’)

string

Allowed values: agent_risk_version

updated_at

required

When the agent risk version was last updated

string format: date-time

status

required

string

Allowed values: success

Example

{
  "details": {
    "account_id": "013xrzp12g3nqk8ns6jadrqmpgrjkeny",
    "activity_data_risks": {
      "llm": {
        "action_profile": {
          "read_data": "allowed"
        },
        "params_data_categories": {
          "classification": "internal"
        },
        "result_data_categories": {
          "classification": "internal"
        }
      }
    },
    "agent_id": "013xrzp12g3nqk8ns6jadrqmpgrjkeny",
    "id": "013xrzp12g3nqk8ns6jadrqmpgrjkeny",
    "inserted_at": "2024-01-01T00:00:00Z",
    "type": "agent_risk_version",
    "updated_at": "2024-01-01T00:00:00Z"
  },
  "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"
}