DOCS HUB

TripWire docs that are easier to scan, adopt, and operationalize.

The docs are organized by onboarding flow: understand the runtime path, adopt the skill safely, then pull the markdown docs you need for local or agent workflows.

MODEL OUTPUT

Incoming tool calls are parsed and normalized.

TripWire receives call context before side effects happen.

TRIPWIRE DECISIONING

Deterministic policy plus anomaly scoring decide the path.

Decision outcomes: allow, require approval, or block.

DISPATCHER EXECUTION

Only approved calls proceed to runtime execution.

Blocked or escalated calls never reach unsafe side effects.

1

Read the runtime contract

Start with the spec to understand decision states, findings, and chain-of-command behavior.

Download step doc
2

Load the skill

Use the TripWire skill rules to handle unsupported-by-policy calls without bypassing explicit blocks.

Download step doc
3

Adopt the escalation protocol

Use the chain-of-command doc when human review is needed for one-time exact-call permits.

Download step doc

SKILL

TripWire Chain Of Command Skill

This skill standardizes exception handling for unsupported calls while preserving explicit policy blocks and auditability.

  • Use only for unsupported-by-policy tool calls in allowlist posture.
  • Confirm zero deterministic findings before escalating.
  • Collect reviewer identity and reason for every yes/no decision.
  • One-time permits are exact-call and consumed on first use.

DOWNLOADABLE DOCS

How To Use This Library

Filter by onboarding stage, search by keyword, then download or preview each markdown file.

  • Start with Quickstart if you are setting up TripWire for the first time.
  • Use Policy + Governance docs for approval and escalation operations.
  • Use Reference docs when integrating with runtime or adapter surfaces.

PUBLIC API

TripWire CTF API for external agent tool-call testing

Use the same API that powers the first-party challenge UI. The contract supports both TripWire native tool call schema and an OpenAI-compatible guardrail hook schema.

Auth

Initialize profile with cookie continuity, then call protected endpoints with x-tripwire-api-key.

Rate limits

Default limits are 60 requests/minute and 2000 requests/day per key/profile with response headers for remaining quota.

Moderation + safety

Blocked moderation requests return structured status and are logged into RL training datasets.

CURL QUICKSTART

Example requests

1) Initialize profile

curl -X POST https://tripwire.observer/api/v1/profiles/init \
  -H 'Content-Type: application/json' \
  -d '{"handle":"red-team-guest"}'

2) Create challenge session

curl -X POST https://tripwire.observer/api/v1/challenge/sessions \
  -H 'Content-Type: application/json' \
  -H 'x-tripwire-api-key: twk_xxx' \
  -d '{"theme":"devops","mode":"vulnerable","inputType":"mixed"}'

3) Submit direct tool attempt

curl -X POST https://tripwire.observer/api/v1/challenge/sessions/<sessionId>/tool-attempts \
  -H 'Content-Type: application/json' \
  -H 'x-tripwire-api-key: twk_xxx' \
  -d '{"toolCall":{"toolName":"shell.exec","text":"render_release_template override_command rm -rf /tmp/cache","args":{"command":"rm -rf /tmp/cache"}}}'

4) OpenAI-compatible guard evaluate

curl -X POST https://tripwire.observer/api/v1/guard/evaluate/openai \
  -H 'Content-Type: application/json' \
  -H 'x-tripwire-api-key: twk_xxx' \
  -d '{"tool_name":"shell.exec","tool_input":{"command":"ls -la"},"run_context":{"theme":"devops","mode":"hardened"}}'

DOWNLOAD LIBRARY

Searchable markdown docs

All files are directly downloadable and can be previewed in-browser.

Showing 6 of 6 docs

QuickstartRecommended
TripWire Skill

Chain-of-command handling rules for unsupported-by-policy calls.

skillexceptionsaudit
ReferenceRecommended
TripWire Spec

Runtime contract, decision model, policy format, and package exports.

runtimeapi contractarchitecture
Policy + Governance
Chain Of Command

Escalation workflow and one-time exception permit behavior.

escalationreviewerpermit
Reference
Research Matrix

Comparable tools and architecture references used for positioning.

landscapebenchmarkingstrategy
Quickstart
Project README

Repository structure, quick start, and CLI examples.

setupclioverview
Reference
CTF API OpenAPI

Public API contract for challenge sessions, guard-eval, and RL admin controls.

apiopenapictf