Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Data Models

Complete reference for all data models and schemas used in OctoLLM APIs.

Core Models

TaskContract

Complete task specification with goals, constraints, and budgets.

Schema Details

ArmCapability

Arm registration and capability description.

Schema Details

Domain-Specific Models

CodeGeneration

Code generation requests and responses.

Schema Details

ValidationResult

Output validation results from Judge Arm.

Schema Details

RetrievalResult

Knowledge retrieval results from Retriever Arm.

Schema Details

PIIDetection

PII detection results from Safety Guardian.

Schema Details

Common Patterns

Resource Budget

{
  "max_tokens": 4096,
  "max_time_seconds": 300,
  "max_cost_dollars": 0.50,
  "max_llm_calls": 10
}

Provenance Metadata

{
  "arm_id": "coder-arm-1",
  "timestamp": "2025-11-15T10:30:00Z",
  "command_hash": "sha256:abcd1234...",
  "data_sources": ["github.com/repo/file.py"],
  "model_version": "gpt-4-1106-preview",
  "tests_passed": ["test_syntax", "test_security"]
}

See Also