Audit environment wiring

curl --request GET \
  --url https://realtime-api.voiceflow.com/v1/stable/environment/<environmentAlias>/audit-wiring \
  --header 'Authorization: Bearer <token>'

const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/environment/<environmentAlias>/audit-wiring?projectID=<projectID>', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer <token>',
  },
});
const data = await response.json();

import requests

response = requests.get(
    'https://realtime-api.voiceflow.com/v1/stable/environment/<environmentAlias>/audit-wiring?projectID=<projectID>',
    headers={'Authorization': 'Bearer <token>'},
)
data = response.json()

{
  "audit": {
    "phase1VarSetters": {},
    "phase2OrphanDefaults": [
      {
        "toolID": "<string>",
        "function": "<string>",
        "agent": "<string>",
        "input": "<string>",
        "defaultVar": "<string>",
        "note": "<string>"
      }
    ],
    "phase3ShouldFulfillWithCanonicalSource": [
      {
        "toolID": "<string>",
        "function": "<string>",
        "agent": "<string>",
        "input": "<string>",
        "suggestedDefaultVar": "<string>",
        "note": "<string>"
      }
    ],
    "phase4UncapturedOutputs": [
      {
        "function": "<string>",
        "output": "<string>",
        "toolCount": 0,
        "note": "<string>"
      }
    ],
    "phase5MalformedWiring": [
      {
        "toolID": "<string>",
        "function": "<string>",
        "agent": "<string>",
        "input": "<string>",
        "issue": "<string>",
        "current": "<string>",
        "shouldBe": "<string>"
      }
    ],
    "phase6SuggestedCaptures": [
      {
        "function": "<string>",
        "output": "<string>",
        "suggestedVar": "<string>",
        "currentCapturesTo": [
          "<string>"
        ],
        "note": "<string>"
      }
    ],
    "phase7SideEffectOnly": [
      {
        "function": "<string>",
        "agents": [
          "<string>"
        ],
        "note": "<string>"
      }
    ],
    "phase8OrphanFunctions": [
      {
        "function": "<string>",
        "inputCount": 0,
        "outputCount": 0,
        "note": "<string>"
      }
    ],
    "phase9ArgsSecretsReads": [
      {
        "function": "<string>",
        "attachments": [
          {
            "agent": "<string>",
            "toolID": "<string>"
          }
        ],
        "note": "<string>"
      }
    ],
    "phase10EmptyToolDescriptions": [
      {
        "toolID": "<string>",
        "function": "<string>",
        "agent": "<string>",
        "note": "<string>"
      }
    ]
  }
}

Audit environment wiring

Check how tools, functions and variables connect.

GET

/v1/stable/environment/{environmentAlias}/audit-wiring

curl --request GET \
  --url https://realtime-api.voiceflow.com/v1/stable/environment/<environmentAlias>/audit-wiring \
  --header 'Authorization: Bearer <token>'

const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/environment/<environmentAlias>/audit-wiring?projectID=<projectID>', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer <token>',
  },
});
const data = await response.json();

import requests

response = requests.get(
    'https://realtime-api.voiceflow.com/v1/stable/environment/<environmentAlias>/audit-wiring?projectID=<projectID>',
    headers={'Authorization': 'Bearer <token>'},
)
data = response.json()

{
  "audit": {
    "phase1VarSetters": {},
    "phase2OrphanDefaults": [
      {
        "toolID": "<string>",
        "function": "<string>",
        "agent": "<string>",
        "input": "<string>",
        "defaultVar": "<string>",
        "note": "<string>"
      }
    ],
    "phase3ShouldFulfillWithCanonicalSource": [
      {
        "toolID": "<string>",
        "function": "<string>",
        "agent": "<string>",
        "input": "<string>",
        "suggestedDefaultVar": "<string>",
        "note": "<string>"
      }
    ],
    "phase4UncapturedOutputs": [
      {
        "function": "<string>",
        "output": "<string>",
        "toolCount": 0,
        "note": "<string>"
      }
    ],
    "phase5MalformedWiring": [
      {
        "toolID": "<string>",
        "function": "<string>",
        "agent": "<string>",
        "input": "<string>",
        "issue": "<string>",
        "current": "<string>",
        "shouldBe": "<string>"
      }
    ],
    "phase6SuggestedCaptures": [
      {
        "function": "<string>",
        "output": "<string>",
        "suggestedVar": "<string>",
        "currentCapturesTo": [
          "<string>"
        ],
        "note": "<string>"
      }
    ],
    "phase7SideEffectOnly": [
      {
        "function": "<string>",
        "agents": [
          "<string>"
        ],
        "note": "<string>"
      }
    ],
    "phase8OrphanFunctions": [
      {
        "function": "<string>",
        "inputCount": 0,
        "outputCount": 0,
        "note": "<string>"
      }
    ],
    "phase9ArgsSecretsReads": [
      {
        "function": "<string>",
        "attachments": [
          {
            "agent": "<string>",
            "toolID": "<string>"
          }
        ],
        "note": "<string>"
      }
    ],
    "phase10EmptyToolDescriptions": [
      {
        "toolID": "<string>",
        "function": "<string>",
        "agent": "<string>",
        "note": "<string>"
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

Voiceflow bearer token

Path Parameters

environmentAlias

string

required

Query Parameters

projectID

string

required

The ID of the project to operate on.

Response

200 - application/json

audit

object

required

One list per check. Each entry names the function, agent or tool it is about and says why.

Show child attributes

phase1VarSetters

object

required

phase2OrphanDefaults

object[]

required

Show child attributes

toolID

string

required

function

string

required

agent

string

required

input

string

required

defaultVar

string

required

note

string

required

phase3ShouldFulfillWithCanonicalSource

object[]

required

Show child attributes

toolID

string

required

function

string

required

agent

string

required

input

string

required

suggestedDefaultVar

string

required

note

string

required

phase4UncapturedOutputs

object[]

required

Show child attributes

function

string

required

output

string

required

toolCount

number

required

note

string

required

phase5MalformedWiring

object[]

required

Show child attributes

toolID

string

required

function

string

required

agent

string

required

input

string

required

issue

string

required

current

string

required

shouldBe

string

required

phase6SuggestedCaptures

object[]

required

Show child attributes

function

string

required

output

string

required

suggestedVar

string

required

currentCapturesTo

string[]

required

note

string

required

phase7SideEffectOnly

object[]

required

Show child attributes

function

string

required

agents

string[]

required

note

string

required

phase8OrphanFunctions

object[]

required

Show child attributes

function

string

required

inputCount

number

required

outputCount

number

required

note

string

required

phase9ArgsSecretsReads

object[]

required

Show child attributes

function

string

required

attachments

object[]

required

Show child attributes

agent

string

required

toolID

string

required

note

string

required

phase10EmptyToolDescriptions

object[]

required

Show child attributes

toolID

string

required

function

string

required

agent

string

required

note

string

required