api.md

API Reference

Note: This page is auto-generated by mkdocstrings. Run mkdocs serve or mkdocs build to render the full API documentation from source docstrings.

Top-level API

::: nighthawk options: members: - UNSET - UnsetType - Extend - Merge - function - FunctionDefinition - get_function_definition - FunctionCall - FunctionCallHandler - FunctionCallError - function_call_scope - get_function_call - run - scope - Scope - get_scope - ExecutionReference - UsageMeter

Errors

::: nighthawk.errors

Configuration

::: nighthawk.configuration options: members: - StepExecutorConfiguration - StepContextLimits

Backends

Base settings

::: nighthawk.backends.base options: members: - BackendModelSettings

Claude Code shared settings

::: nighthawk.backends.claude_code_settings options: members: - ClaudeCodeModelSettings - PermissionMode - SettingSource

Claude Code (SDK)

::: nighthawk.backends.claude_code_sdk options: members: - ClaudeCodeSdkModel - ClaudeCodeSdkModelSettings

Claude Code (CLI)

::: nighthawk.backends.claude_code_cli options: members: - ClaudeCodeCliModel - ClaudeCodeCliModelSettings

Codex

::: nighthawk.backends.codex options: members: - CodexModel - CodexModelSettings - SandboxMode - ModelReasoningEffort

Step context

::: nighthawk.runtime.step_context options: members: - StepContext - get_step_context

Model response contracts

::: nighthawk.runtime.model_outcome options: members: - ModelStepResponse - ModelOutcome

Tool declarations

::: nighthawk.tools.declarations options: members: - ToolEntry

Resilience

::: nighthawk.resilience options: members: - budget - BudgetExceededError - BudgetLimitKind - CostFunction - retrying - timeout - fallback - vote - plurality - circuit_breaker - CircuitState - CircuitOpenError

Testing

::: nighthawk.testing options: members: - ScriptedExecutor - CallbackExecutor

Oversight

::: nighthawk.oversight options: members: - StepCommit - Rewrite - Accept - RejectOperation - AbortStep - Oversight - StepAbortedError - OperationDecision - StepCommitDecision

Lifecycle

::: nighthawk.lifecycle options: members: - StepLifecycle - StepStarted - StepFinished - StepCompleted - StepRaised - StepFailed - StepInterrupted - FailureStage

Embedded steps and binding processing

See Embedded execution for executable synchronous and asynchronous examples.

::: nighthawk.runtime.step_definition options: members: - BlockKind - StepDefinition

::: nighthawk.runtime.embedded options: members: - execute_step - execute_step_async - BindingWriter

::: nighthawk.runtime.bindings options: members: - infer_binding_types - validate_output_bindings - BindingError - BindingDeclarationError - BindingValidationError - MISSING_ANNOTATION

Runtime executor boundary

::: nighthawk.runtime.agent options: members: - AgentStepExecutor - StepExecutionAgent - SyncExecutionAgent - AsyncExecutionAgent

::: nighthawk.runtime.step_executor options: members: - StepExecutor - ConfigurableStepExecutor - SyncStepExecutor - AsyncStepExecutor

::: nighthawk.configuration options: members: - ModelSelection

::: nighthawk.runtime.step_outcome options: members: - Pass - Return - Break - Continue - Raise - StepOutcome - OutcomeKind

::: nighthawk.runtime.step_request options: members: - StepRequest - StepCandidate

::: nighthawk.runtime.operation_contract options: members: - OperationRequest - OperationFinished - OperationError - OperationRejection - OperationRejectedError - OperationDeliveryError - OperationStatus - OperationKind - OperationPhase

::: nighthawk.runtime.expression options: members: - evaluate_expression - evaluate_expression_async

::: nighthawk.runtime.assignment options: members: - AssignmentResult - assign_expression - assign_expression_async

::: nighthawk.runtime.context options: members: - ContextRequest - ContextBuilder - DefaultContextBuilder

::: nighthawk.runtime.environment options: members: - StepEnvironment

::: nighthawk.runtime.inspection options: members: - describe_value