Fetch agent version

GET

/api/v1/agent_version/{agent_version_id}

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

Authorizations

authorization

Parameters

Path Parameters

agent_version_id

required

AgentVersion_Id

A valid agent 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

AgentVersion_Details

object

account_id

required

Account_Id

A valid account ID

string

agent_id

required

Agent_Id

A valid agent ID

string

agent_schema_version_id

required

AgentSchemaVersion_Id

A valid agent schema version ID

string

current_agent_deployment_refs

required

Agent deployments that pin this version as their current version (empty if none).

Array<string>

external_identifier

required

External identifier for the agent version

string

external_identifier_repeats

required

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

integer

required

AgentVersion_Id

A valid agent version ID

string

inserted_at

required

When the agent version was created

string format: date-time

runtime_environment

required

One of:

AgentVersion_RuntimeEnvironment
Null

AgentVersion_RuntimeEnvironment

object

agent_sdk

One of:

Array<string>
Null

List of package name and version strings (e.g. “package@1.0.0”)

Array<string>

One of:

string
Null

Operating system (e.g. “linux”)

string

prefactor_sdk

One of:

Array<string>
Null

List of package name and version strings (e.g. “package@1.0.0”)

Array<string>

runtime

One of:

string
Null

Language runtime version (e.g. “python@3.12”)

string

type

required

Type of resource (always ‘agent_version’)

string

Allowed values: agent_version

updated_at

required

When the agent version was last updated

string format: date-time

status

required

string

Allowed values: success

Example

{
  "details": {
    "account_id": "013xrzp12g3nqk8ns6jadrqmpgrjkeny",
    "agent_id": "013xrzp12g3nqk8ns6jadrqmpgrjkeny",
    "agent_schema_version_id": "013xrzp12g3nqk8ns6jadrqmpgrjkeny",
    "current_agent_deployment_refs": [
      "013xrzp12g3nqk8ns6jadrqmpgrjkeny"
    ],
    "external_identifier": "v1.0.0",
    "id": "013xrzp12g3nqk8ns6jadrqmpgrjkeny",
    "inserted_at": "2024-01-01T00:00:00Z",
    "runtime_environment": null,
    "type": "agent_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 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"
}