Skip to content
PrefactorPrefactorPrefactor Docs

Create a new agent schema version

POST
/api/v1/agent_schema_version
curl --request POST \
  --url https://app.prefactorai.com/api/v1/agent_schema_version \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "agent_id": "013xrzp12g3nqk8ns6jadrqmpgrjkeny", "alert_schemas": null, "external_identifier": "example", "id": "013xrzp12g3nqk8ns6jadrqmpgrjkeny", "quality_schemas": null, "span_result_schemas": null, "span_schemas": null, "span_type_schemas": null }'

Authorizations

Section titled “Authorizations”

Request Body

Section titled “Request Body”
AgentSchemaVersion_DetailsForCreate
object
agent_id
Agent_Id

A valid agent ID

string
Example
013xrzp12g3nqk8ns6jadrqmpgrjkeny
alert_schemas
One of:

Array of alert schemas with name, schema and optional title, description, template and data_risk.

Array<object>
SchemaDetails_ForCreate

Named schema with schema and optional title, description, template and data_risk

object
data_risk
One of:
DataRisk
object
action_profile
required
ActionProfile
object
create_data
required

Creates data

string
Allowed values: unknown allowed disallowed
Example
unknown
destroy_data
required

Destroys data

string
Allowed values: unknown allowed disallowed
Example
unknown
external_communication
required

Sends external communications

string
Allowed values: unknown allowed disallowed
Example
unknown
financial_transactions
required

Performs financial transactions

string
Allowed values: unknown allowed disallowed
Example
unknown
read_data
required

Reads data

string
Allowed values: unknown allowed disallowed
Example
unknown
update_data
required

Updates data

string
Allowed values: unknown allowed disallowed
Example
unknown
params_data_categories
required
DataCategories
object
authentication_and_secrets
required

Authentication and secrets present

string
Allowed values: unknown included excluded
Example
unknown
behavioural_and_inferred
required

Behavioural and inferred data present

string
Allowed values: unknown included excluded
Example
unknown
classification
required

Classification level

string
Allowed values: unknown public internal confidential restricted secret
Example
unknown
contact_information
required

Contact information present

string
Allowed values: unknown included excluded
Example
unknown
criminal_justice
required

Criminal justice data present

string
Allowed values: unknown included excluded
Example
unknown
financial_information
required

Financial information present

string
Allowed values: unknown included excluded
Example
unknown
gdpr_biometric_for_identification
required

GDPR: biometric data for identification

string
Allowed values: unknown included excluded
Example
unknown
gdpr_genetic_data
required

GDPR: genetic data

string
Allowed values: unknown included excluded
Example
unknown
gdpr_political_opinions
required

GDPR: political opinions

string
Allowed values: unknown included excluded
Example
unknown
gdpr_racial_or_ethnic_origin
required

GDPR: racial or ethnic origin

string
Allowed values: unknown included excluded
Example
unknown
gdpr_religious_or_philosophical_beliefs
required

GDPR: religious or philosophical beliefs

string
Allowed values: unknown included excluded
Example
unknown
gdpr_sex_life_or_sexual_orientation
required

GDPR: sex life or sexual orientation

string
Allowed values: unknown included excluded
Example
unknown
gdpr_trade_union_membership
required

GDPR: trade union membership

string
Allowed values: unknown included excluded
Example
unknown
health_and_medical
required

Health and medical data present

string
Allowed values: unknown included excluded
Example
unknown
location_and_tracking
required

Location and tracking data present

string
Allowed values: unknown included excluded
Example
unknown
minors_data
required

Minors data present

string
Allowed values: unknown included excluded
Example
unknown
organisational_confidential
required

Organisational confidential data present

string
Allowed values: unknown included excluded
Example
unknown
personal_identifiers
required

Personal identifiers present

string
Allowed values: unknown included excluded
Example
unknown
result_data_categories
required
DataCategories
object
authentication_and_secrets
required

Authentication and secrets present

string
Allowed values: unknown included excluded
Example
unknown
behavioural_and_inferred
required

Behavioural and inferred data present

string
Allowed values: unknown included excluded
Example
unknown
classification
required

Classification level

string
Allowed values: unknown public internal confidential restricted secret
Example
unknown
contact_information
required

Contact information present

string
Allowed values: unknown included excluded
Example
unknown
criminal_justice
required

Criminal justice data present

string
Allowed values: unknown included excluded
Example
unknown
financial_information
required

Financial information present

string
Allowed values: unknown included excluded
Example
unknown
gdpr_biometric_for_identification
required

GDPR: biometric data for identification

string
Allowed values: unknown included excluded
Example
unknown
gdpr_genetic_data
required

GDPR: genetic data

string
Allowed values: unknown included excluded
Example
unknown
gdpr_political_opinions
required

GDPR: political opinions

string
Allowed values: unknown included excluded
Example
unknown
gdpr_racial_or_ethnic_origin
required

GDPR: racial or ethnic origin

string
Allowed values: unknown included excluded
Example
unknown
gdpr_religious_or_philosophical_beliefs
required

GDPR: religious or philosophical beliefs

string
Allowed values: unknown included excluded
Example
unknown
gdpr_sex_life_or_sexual_orientation
required

GDPR: sex life or sexual orientation

string
Allowed values: unknown included excluded
Example
unknown
gdpr_trade_union_membership
required

GDPR: trade union membership

string
Allowed values: unknown included excluded
Example
unknown
health_and_medical
required

Health and medical data present

string
Allowed values: unknown included excluded
Example
unknown
location_and_tracking
required

Location and tracking data present

string
Allowed values: unknown included excluded
Example
unknown
minors_data
required

Minors data present

string
Allowed values: unknown included excluded
Example
unknown
organisational_confidential
required

Organisational confidential data present

string
Allowed values: unknown included excluded
Example
unknown
personal_identifiers
required

Personal identifiers present

string
Allowed values: unknown included excluded
Example
unknown
description
One of:

Optional description

string
name
required

Schema name (key)

string
schema
required

JSON schema for the payload

object
key
additional properties
any
template
One of:

Display template. Use {{field}} to interpolate payload fields.

string
title
One of:

Human-readable title. Defaults to name when omitted.

string
external_identifier
string
id
One of:
AgentSchemaVersion_Id

A valid agent schema version ID

string
Example
013xrzp12g3nqk8ns6jadrqmpgrjkeny
quality_schemas
One of:

Array of quality schemas with name, schema and optional title, description, template and data_risk.

Array<object>
SchemaDetails_ForCreate

Named schema with schema and optional title, description, template and data_risk

object
data_risk
One of:
DataRisk
object
action_profile
required
ActionProfile
object
create_data
required

Creates data

string
Allowed values: unknown allowed disallowed
Example
unknown
destroy_data
required

Destroys data

string
Allowed values: unknown allowed disallowed
Example
unknown
external_communication
required

Sends external communications

string
Allowed values: unknown allowed disallowed
Example
unknown
financial_transactions
required

Performs financial transactions

string
Allowed values: unknown allowed disallowed
Example
unknown
read_data
required

Reads data

string
Allowed values: unknown allowed disallowed
Example
unknown
update_data
required

Updates data

string
Allowed values: unknown allowed disallowed
Example
unknown
params_data_categories
required
DataCategories
object
authentication_and_secrets
required

Authentication and secrets present

string
Allowed values: unknown included excluded
Example
unknown
behavioural_and_inferred
required

Behavioural and inferred data present

string
Allowed values: unknown included excluded
Example
unknown
classification
required

Classification level

string
Allowed values: unknown public internal confidential restricted secret
Example
unknown
contact_information
required

Contact information present

string
Allowed values: unknown included excluded
Example
unknown
criminal_justice
required

Criminal justice data present

string
Allowed values: unknown included excluded
Example
unknown
financial_information
required

Financial information present

string
Allowed values: unknown included excluded
Example
unknown
gdpr_biometric_for_identification
required

GDPR: biometric data for identification

string
Allowed values: unknown included excluded
Example
unknown
gdpr_genetic_data
required

GDPR: genetic data

string
Allowed values: unknown included excluded
Example
unknown
gdpr_political_opinions
required

GDPR: political opinions

string
Allowed values: unknown included excluded
Example
unknown
gdpr_racial_or_ethnic_origin
required

GDPR: racial or ethnic origin

string
Allowed values: unknown included excluded
Example
unknown
gdpr_religious_or_philosophical_beliefs
required

GDPR: religious or philosophical beliefs

string
Allowed values: unknown included excluded
Example
unknown
gdpr_sex_life_or_sexual_orientation
required

GDPR: sex life or sexual orientation

string
Allowed values: unknown included excluded
Example
unknown
gdpr_trade_union_membership
required

GDPR: trade union membership

string
Allowed values: unknown included excluded
Example
unknown
health_and_medical
required

Health and medical data present

string
Allowed values: unknown included excluded
Example
unknown
location_and_tracking
required

Location and tracking data present

string
Allowed values: unknown included excluded
Example
unknown
minors_data
required

Minors data present

string
Allowed values: unknown included excluded
Example
unknown
organisational_confidential
required

Organisational confidential data present

string
Allowed values: unknown included excluded
Example
unknown
personal_identifiers
required

Personal identifiers present

string
Allowed values: unknown included excluded
Example
unknown
result_data_categories
required
DataCategories
object
authentication_and_secrets
required

Authentication and secrets present

string
Allowed values: unknown included excluded
Example
unknown
behavioural_and_inferred
required

Behavioural and inferred data present

string
Allowed values: unknown included excluded
Example
unknown
classification
required

Classification level

string
Allowed values: unknown public internal confidential restricted secret
Example
unknown
contact_information
required

Contact information present

string
Allowed values: unknown included excluded
Example
unknown
criminal_justice
required

Criminal justice data present

string
Allowed values: unknown included excluded
Example
unknown
financial_information
required

Financial information present

string
Allowed values: unknown included excluded
Example
unknown
gdpr_biometric_for_identification
required

GDPR: biometric data for identification

string
Allowed values: unknown included excluded
Example
unknown
gdpr_genetic_data
required

GDPR: genetic data

string
Allowed values: unknown included excluded
Example
unknown
gdpr_political_opinions
required

GDPR: political opinions

string
Allowed values: unknown included excluded
Example
unknown
gdpr_racial_or_ethnic_origin
required

GDPR: racial or ethnic origin

string
Allowed values: unknown included excluded
Example
unknown
gdpr_religious_or_philosophical_beliefs
required

GDPR: religious or philosophical beliefs

string
Allowed values: unknown included excluded
Example
unknown
gdpr_sex_life_or_sexual_orientation
required

GDPR: sex life or sexual orientation

string
Allowed values: unknown included excluded
Example
unknown
gdpr_trade_union_membership
required

GDPR: trade union membership

string
Allowed values: unknown included excluded
Example
unknown
health_and_medical
required

Health and medical data present

string
Allowed values: unknown included excluded
Example
unknown
location_and_tracking
required

Location and tracking data present

string
Allowed values: unknown included excluded
Example
unknown
minors_data
required

Minors data present

string
Allowed values: unknown included excluded
Example
unknown
organisational_confidential
required

Organisational confidential data present

string
Allowed values: unknown included excluded
Example
unknown
personal_identifiers
required

Personal identifiers present

string
Allowed values: unknown included excluded
Example
unknown
description
One of:

Optional description

string
name
required

Schema name (key)

string
schema
required

JSON schema for the payload

object
key
additional properties
any
template
One of:

Display template. Use {{field}} to interpolate payload fields.

string
title
One of:

Human-readable title. Defaults to name when omitted.

string
span_result_schemas
One of:
object
key
additional properties
object
key
additional properties
any
span_schemas
One of:
object
key
additional properties
object
key
additional properties
any
span_type_schemas
One of:

Array of span types with name, params_schema and optional result_schema.

Array<object>
SpanTypeSchemaDetails_ForCreate

One span type with name, params_schema and optional result_schema

object
data_risk
One of:
DataRisk
object
action_profile
required
ActionProfile
object
create_data
required

Creates data

string
Allowed values: unknown allowed disallowed
Example
unknown
destroy_data
required

Destroys data

string
Allowed values: unknown allowed disallowed
Example
unknown
external_communication
required

Sends external communications

string
Allowed values: unknown allowed disallowed
Example
unknown
financial_transactions
required

Performs financial transactions

string
Allowed values: unknown allowed disallowed
Example
unknown
read_data
required

Reads data

string
Allowed values: unknown allowed disallowed
Example
unknown
update_data
required

Updates data

string
Allowed values: unknown allowed disallowed
Example
unknown
params_data_categories
required
DataCategories
object
authentication_and_secrets
required

Authentication and secrets present

string
Allowed values: unknown included excluded
Example
unknown
behavioural_and_inferred
required

Behavioural and inferred data present

string
Allowed values: unknown included excluded
Example
unknown
classification
required

Classification level

string
Allowed values: unknown public internal confidential restricted secret
Example
unknown
contact_information
required

Contact information present

string
Allowed values: unknown included excluded
Example
unknown
criminal_justice
required

Criminal justice data present

string
Allowed values: unknown included excluded
Example
unknown
financial_information
required

Financial information present

string
Allowed values: unknown included excluded
Example
unknown
gdpr_biometric_for_identification
required

GDPR: biometric data for identification

string
Allowed values: unknown included excluded
Example
unknown
gdpr_genetic_data
required

GDPR: genetic data

string
Allowed values: unknown included excluded
Example
unknown
gdpr_political_opinions
required

GDPR: political opinions

string
Allowed values: unknown included excluded
Example
unknown
gdpr_racial_or_ethnic_origin
required

GDPR: racial or ethnic origin

string
Allowed values: unknown included excluded
Example
unknown
gdpr_religious_or_philosophical_beliefs
required

GDPR: religious or philosophical beliefs

string
Allowed values: unknown included excluded
Example
unknown
gdpr_sex_life_or_sexual_orientation
required

GDPR: sex life or sexual orientation

string
Allowed values: unknown included excluded
Example
unknown
gdpr_trade_union_membership
required

GDPR: trade union membership

string
Allowed values: unknown included excluded
Example
unknown
health_and_medical
required

Health and medical data present

string
Allowed values: unknown included excluded
Example
unknown
location_and_tracking
required

Location and tracking data present

string
Allowed values: unknown included excluded
Example
unknown
minors_data
required

Minors data present

string
Allowed values: unknown included excluded
Example
unknown
organisational_confidential
required

Organisational confidential data present

string
Allowed values: unknown included excluded
Example
unknown
personal_identifiers
required

Personal identifiers present

string
Allowed values: unknown included excluded
Example
unknown
result_data_categories
required
DataCategories
object
authentication_and_secrets
required

Authentication and secrets present

string
Allowed values: unknown included excluded
Example
unknown
behavioural_and_inferred
required

Behavioural and inferred data present

string
Allowed values: unknown included excluded
Example
unknown
classification
required

Classification level

string
Allowed values: unknown public internal confidential restricted secret
Example
unknown
contact_information
required

Contact information present

string
Allowed values: unknown included excluded
Example
unknown
criminal_justice
required

Criminal justice data present

string
Allowed values: unknown included excluded
Example
unknown
financial_information
required

Financial information present

string
Allowed values: unknown included excluded
Example
unknown
gdpr_biometric_for_identification
required

GDPR: biometric data for identification

string
Allowed values: unknown included excluded
Example
unknown
gdpr_genetic_data
required

GDPR: genetic data

string
Allowed values: unknown included excluded
Example
unknown
gdpr_political_opinions
required

GDPR: political opinions

string
Allowed values: unknown included excluded
Example
unknown
gdpr_racial_or_ethnic_origin
required

GDPR: racial or ethnic origin

string
Allowed values: unknown included excluded
Example
unknown
gdpr_religious_or_philosophical_beliefs
required

GDPR: religious or philosophical beliefs

string
Allowed values: unknown included excluded
Example
unknown
gdpr_sex_life_or_sexual_orientation
required

GDPR: sex life or sexual orientation

string
Allowed values: unknown included excluded
Example
unknown
gdpr_trade_union_membership
required

GDPR: trade union membership

string
Allowed values: unknown included excluded
Example
unknown
health_and_medical
required

Health and medical data present

string
Allowed values: unknown included excluded
Example
unknown
location_and_tracking
required

Location and tracking data present

string
Allowed values: unknown included excluded
Example
unknown
minors_data
required

Minors data present

string
Allowed values: unknown included excluded
Example
unknown
organisational_confidential
required

Organisational confidential data present

string
Allowed values: unknown included excluded
Example
unknown
personal_identifiers
required

Personal identifiers present

string
Allowed values: unknown included excluded
Example
unknown
description
One of:

Optional description

string
name
required

Span type name (e.g. llm, tool)

string
params_schema
required

JSON schema for the span payload

object
key
additional properties
any
result_schema
One of:

JSON schema for the span result payload. Defaults to empty object if omitted.

object
key
additional properties
any
template
One of:

Display template. Use {{field}} to interpolate params and result fields.

string
title
One of:

Human-readable title. Defaults to name when omitted.

string

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
details
AgentSchemaVersion_Details
object
account_id
Account_Id

A valid account ID

string
agent_id
Agent_Id

A valid agent ID

string
alert_schemas

Map of alert schema names to their schemas and optional title, description, template and data_risk

object
key
additional properties
SchemaDetails
object
data_risk
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
description
One of:

Optional description

string
name

Schema name (key)

string
schema

JSON schema for the payload. Title and description are sibling fields on this object and are not present inside schema.

object
key
additional properties
any
schema_validation
SchemaValidationResult

Result of validating a JSON schema

object
message
One of:

Validation error message when status is ‘error’

string
status

Whether the schema is valid

string
Allowed values: success error
template
One of:

Display template. Use {{field}} to interpolate payload fields.

string
title

Human-readable title (defaults to name)

string
current_agent_deployment_refs

Agent deployments whose current version uses this schema version (empty if none).

Array<string>
external_identifier

External identifier for the agent schema version

string
external_identifier_repeats

Count of rows sharing this external identifier (helps distinguish duplicates).

integer
id
AgentSchemaVersion_Id

A valid agent schema version ID

string
inserted_at

When the agent schema version was created

string format: date-time
quality_schemas

Map of quality schema names to their schemas and optional title, description, template and data_risk

object
key
additional properties
SchemaDetails
object
data_risk
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
description
One of:

Optional description

string
name

Schema name (key)

string
schema

JSON schema for the payload. Title and description are sibling fields on this object and are not present inside schema.

object
key
additional properties
any
schema_validation
SchemaValidationResult

Result of validating a JSON schema

object
message
One of:

Validation error message when status is ‘error’

string
status

Whether the schema is valid

string
Allowed values: success error
template
One of:

Display template. Use {{field}} to interpolate payload fields.

string
title

Human-readable title (defaults to name)

string
span_type_schemas

Map of span type names to their params and result JSON schemas

object
key
additional properties
SpanTypeSchemaDetails
object
data_risk
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
description
One of:

Optional description

string
name

Span type name

string
params_schema

JSON schema for the span payload

object
key
additional properties
any
params_schema_validation
SchemaValidationResult

Result of validating a JSON schema

object
message
One of:

Validation error message when status is ‘error’

string
status

Whether the schema is valid

string
Allowed values: success error
result_schema

JSON schema for the span result payload (defaults to empty object if omitted when creating)

object
key
additional properties
any
result_schema_validation
SchemaValidationResult

Result of validating a JSON schema

object
message
One of:

Validation error message when status is ‘error’

string
status

Whether the schema is valid

string
Allowed values: success error
template
One of:

Display template describing what happened in the span. Use {{field}} to interpolate params and result fields. Use imperative/command tense for params (e.g. “Generate {{content}}”) and past tense for result (e.g. “completed with {{finish_reason}}”).

string
title

Human-readable title (defaults to name)

string
type

Type of resource (always ‘agent_schema_version’)

string
Allowed values: agent_schema_version
updated_at

When the agent schema version was last updated

string format: date-time
status
string
Allowed values: success
Example
{
  "details": {
    "account_id": "013xrzp12g3nqk8ns6jadrqmpgrjkeny",
    "agent_id": "013xrzp12g3nqk8ns6jadrqmpgrjkeny",
    "alert_schemas": {
      "additionalProperty": {
        "data_risk": {
          "action_profile": {
            "create_data": "unknown",
            "destroy_data": "unknown",
            "external_communication": "unknown",
            "financial_transactions": "unknown",
            "read_data": "unknown",
            "update_data": "unknown"
          },
          "params_data_categories": {
            "authentication_and_secrets": "unknown",
            "behavioural_and_inferred": "unknown",
            "classification": "unknown",
            "contact_information": "unknown",
            "criminal_justice": "unknown",
            "financial_information": "unknown",
            "gdpr_biometric_for_identification": "unknown",
            "gdpr_genetic_data": "unknown",
            "gdpr_political_opinions": "unknown",
            "gdpr_racial_or_ethnic_origin": "unknown",
            "gdpr_religious_or_philosophical_beliefs": "unknown",
            "gdpr_sex_life_or_sexual_orientation": "unknown",
            "gdpr_trade_union_membership": "unknown",
            "health_and_medical": "unknown",
            "location_and_tracking": "unknown",
            "minors_data": "unknown",
            "organisational_confidential": "unknown",
            "personal_identifiers": "unknown"
          },
          "result_data_categories": {
            "authentication_and_secrets": "unknown",
            "behavioural_and_inferred": "unknown",
            "classification": "unknown",
            "contact_information": "unknown",
            "criminal_justice": "unknown",
            "financial_information": "unknown",
            "gdpr_biometric_for_identification": "unknown",
            "gdpr_genetic_data": "unknown",
            "gdpr_political_opinions": "unknown",
            "gdpr_racial_or_ethnic_origin": "unknown",
            "gdpr_religious_or_philosophical_beliefs": "unknown",
            "gdpr_sex_life_or_sexual_orientation": "unknown",
            "gdpr_trade_union_membership": "unknown",
            "health_and_medical": "unknown",
            "location_and_tracking": "unknown",
            "minors_data": "unknown",
            "organisational_confidential": "unknown",
            "personal_identifiers": "unknown"
          }
        },
        "description": null,
        "schema_validation": {
          "message": null,
          "status": "success"
        },
        "template": null
      }
    },
    "current_agent_deployment_refs": [
      "013xrzp12g3nqk8ns6jadrqmpgrjkeny"
    ],
    "external_identifier": "v0",
    "id": "013xrzp12g3nqk8ns6jadrqmpgrjkeny",
    "inserted_at": "2024-01-01T00:00:00Z",
    "quality_schemas": {
      "additionalProperty": {
        "data_risk": {
          "action_profile": {
            "create_data": "unknown",
            "destroy_data": "unknown",
            "external_communication": "unknown",
            "financial_transactions": "unknown",
            "read_data": "unknown",
            "update_data": "unknown"
          },
          "params_data_categories": {
            "authentication_and_secrets": "unknown",
            "behavioural_and_inferred": "unknown",
            "classification": "unknown",
            "contact_information": "unknown",
            "criminal_justice": "unknown",
            "financial_information": "unknown",
            "gdpr_biometric_for_identification": "unknown",
            "gdpr_genetic_data": "unknown",
            "gdpr_political_opinions": "unknown",
            "gdpr_racial_or_ethnic_origin": "unknown",
            "gdpr_religious_or_philosophical_beliefs": "unknown",
            "gdpr_sex_life_or_sexual_orientation": "unknown",
            "gdpr_trade_union_membership": "unknown",
            "health_and_medical": "unknown",
            "location_and_tracking": "unknown",
            "minors_data": "unknown",
            "organisational_confidential": "unknown",
            "personal_identifiers": "unknown"
          },
          "result_data_categories": {
            "authentication_and_secrets": "unknown",
            "behavioural_and_inferred": "unknown",
            "classification": "unknown",
            "contact_information": "unknown",
            "criminal_justice": "unknown",
            "financial_information": "unknown",
            "gdpr_biometric_for_identification": "unknown",
            "gdpr_genetic_data": "unknown",
            "gdpr_political_opinions": "unknown",
            "gdpr_racial_or_ethnic_origin": "unknown",
            "gdpr_religious_or_philosophical_beliefs": "unknown",
            "gdpr_sex_life_or_sexual_orientation": "unknown",
            "gdpr_trade_union_membership": "unknown",
            "health_and_medical": "unknown",
            "location_and_tracking": "unknown",
            "minors_data": "unknown",
            "organisational_confidential": "unknown",
            "personal_identifiers": "unknown"
          }
        },
        "description": null,
        "schema_validation": {
          "message": null,
          "status": "success"
        },
        "template": null
      }
    },
    "span_type_schemas": {
      "llm": {
        "name": "llm",
        "params_schema": {
          "properties": {
            "max_tokens": {
              "type": "integer"
            },
            "model": {
              "type": "string"
            },
            "temperature": {
              "type": "number"
            }
          },
          "type": "object"
        },
        "result_schema": {
          "properties": {
            "tokens": {
              "type": "integer"
            }
          },
          "type": "object"
        }
      },
      "tool": {
        "name": "tool",
        "params_schema": {
          "properties": {
            "input": {
              "type": "object"
            },
            "name": {
              "type": "string"
            }
          },
          "type": "object"
        },
        "result_schema": {
          "additionalProperties": false,
          "type": "object"
        }
      }
    },
    "type": "agent_schema_version",
    "updated_at": "2024-01-01T00:00:00Z"
  },
  "status": "success"
}

default

Section titled “default”

Error

Media typeapplication/json
One of:
object
code
string
Allowed values: bad_request bad_authtoken not_authenticated not_permitted not_implemented unknown not_found unexpected_ref_type unexpected invalid_action alert_unknown alert_already_cleared invalid_value required_value idempotency_key_already_used
message
string
status
string
Allowed values: error
Example
{
  "code": "bad_request",
  "status": "error"
}