Expand description
Generated types from OpenAPI spec.
Run just generate-sdk-types to regenerate from api/openapi/api.yaml.
Auto-generated types from OpenAPI spec.
Types are generated at compile time from api/openapi/api.json via build.rs.
No generated files are checked into git - types are always fresh.
§Usage
ⓘ
use modelrelay::generated::{Customer, Tier, Project, MessageRole, Citation};
use modelrelay::generated::MessageRoleExt; // Extension trait for as_str()Modules§
Structs§
- Account
Balance Response - Account balance information for PAYGO billing
- Agent
Agent- Agent
Create Request AgentCreateRequest- Agent
Fragment Ref AgentFragmentRef- Agent
List Response AgentListResponse- Agent
Resource AgentResource- Agent
Response AgentResponse- Agent
RunOptions AgentRunOptions- Agent
RunRequest AgentRunRequest- Agent
RunResponse AgentRunResponse- Agent
Test Request AgentTestRequest- Agent
Tool Ref AgentToolRef- Agent
Update Request AgentUpdateRequest- Agent
Version AgentVersion- ApiError
ApiError- Auth
Response AuthResponse- Auth
Tokens AuthTokens- Auto
Topup Config Request AutoTopupConfigRequest- Auto
Topup Config Response AutoTopupConfigResponse- Auto
Topup Confirm Request AutoTopupConfirmRequest- Auto
Topup Limits AutoTopupLimits- Auto
Topup Payment Method AutoTopupPaymentMethod- Auto
Topup Setup Response AutoTopupSetupResponse- Change
Tier Request ChangeTierRequest- Checkout
Session Response CheckoutSessionResponse- Citation
Citation- Content
Part File ContentPartFile- Content
Part File File ContentPartFileFile- Content
Part Text ContentPartText- Crypto
Topup Config Response CryptoTopupConfigResponse- Crypto
Topup Submit Request CryptoTopupSubmitRequest- Customer
Customer- Customer
Balance Response CustomerBalanceResponse- Customer
Create CustomerCreate- Customer
Create External Id - External customer identifier from your system
- Customer
External Id - External customer identifier from your system
- Customer
Ledger Entry CustomerLedgerEntry- Customer
Ledger Response CustomerLedgerResponse- Customer
Me CustomerMe- Customer
MeCheckout Request CustomerMeCheckoutRequest- Customer
MeResponse CustomerMeResponse- Customer
MeSubscription - Customer-visible subscription details for the current tier.
- Customer
MeSubscription Response CustomerMeSubscriptionResponse- Customer
MeSubscription Tier Display Name - Human-readable tier name
- Customer
MeUsage - Customer-visible usage metrics for the current billing window.
- Customer
MeUsage Response CustomerMeUsageResponse- Customer
Metadata - Arbitrary customer metadata (max 10KB). Keys are limited to 40 characters. Values can be any JSON type. Nesting depth limited to 5 levels.
- Customer
Token Response CustomerTokenResponse- Customer
Token Response Customer External Id - External customer identifier
- Customer
Topup Request CustomerTopupRequest- Customer
Topup Response CustomerTopupResponse- Customer
Usage Point CustomerUsagePoint- Customer
With Subscription CustomerWithSubscription- Image
Data - A single generated image.
- Image
PinResponse - Response from pin/unpin operations.
- Image
Request - Request to generate images from a text prompt.
- Image
Response - Response containing generated images.
- Image
Usage - Usage statistics for image generation.
- Input
Item InputItem- Issued
ApiKey IssuedApiKey- Json
Patch Operation JsonPatchOperation- Json
Schema Format JsonSchemaFormat- Message
List Response MessageListResponse- Message
Response MessageResponse- Message
Send Request MessageSendRequest- Model
Model- ModelId
- LLM model identifier (e.g., claude-sonnet-4-5, gpt-4o).
- Models
Response ModelsResponse- Ndjson
Stream Event - Events sent during streaming responses (application/x-ndjson). Each line is a JSON object with an “event” field indicating the type.
- Node
Error V0 NodeErrorV0- NodeId
- Workflow node identifier. Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores.
- Node
Result V0 NodeResultV0- Outbound
Webhook Event OutboundWebhookEvent- Output
Format OutputFormat- Output
Item OutputItem- Plan
Hash - SHA-256 hash of the compiled workflow plan (64 hex characters).
- Plugin
Agent V0 PluginAgentV0- Plugin
Command V0 PluginCommandV0- Plugin
GitHub RefV0 PluginGitHubRefV0- Plugin
Manifest V0 PluginManifestV0- Plugin
Summary V0 PluginSummaryV0- Plugins
Compile Request - Request to compile a Claude Code plugin into a workflow. One of source or files must be provided (mutually exclusive).
- Plugins
Compile Response PluginsCompileResponse- Project
Project- Request
Id - Unique identifier for an LLM request within a workflow run.
- Responses
Batch Error ResponsesBatchError- Responses
Batch Item - Single request item for batch responses.
- Responses
Batch Request ResponsesBatchRequest- Responses
Batch Request Options ResponsesBatchRequestOptions- Responses
Batch Response ResponsesBatchResponse- Responses
Batch Result ResponsesBatchResult- Responses
Batch Usage ResponsesBatchUsage- Responses
Request ResponsesRequest- Responses
Response ResponsesResponse- Responses
Stream Envelope ResponsesStreamEnvelope- RlmContext
Request - Request body for uploading RLM context
- RlmContext
Response - Response from RLM context upload
- RlmExecute
Request - Request body for RLM execute endpoint
- RlmExecute
Request Data Source - External data source configuration for wrapper_v1 integration
- RlmExecute
Request Data Source Limits - Request/response limits for the data source
- RlmExecute
Response - Response from RLM execute endpoint
- RlmExecute
Response Trajectory Item RlmExecuteResponseTrajectoryItem- RlmExecute
Response Usage - Aggregated token usage across all LLM calls
- RunCost
Line Item V0 RunCostLineItemV0- RunCost
Summary V0 RunCostSummaryV0- RunId
- Unique identifier for a workflow run.
- RunNode
Step LlmCall V0 - Per-step LLM call metadata.
- RunNode
Step V0 - Step-level execution details for a node.
- RunNode
Step Waiting V0 - Waiting details for a step when client tools are pending.
- RunNode
Steps V0 - Step history for a node in a workflow run.
- RunStep
Detail RunStepDetail- RunSteps
Response RunStepsResponse- RunSummary
RunSummary- RunTask
RunTask- RunTasks
Response RunTasksResponse- RunTool
Call Detail RunToolCallDetail- RunTool
Call Detail Tool Call RunToolCallDetailToolCall- RunTool
Result V0 - Result for a tool call executed during a run.
- RunTool
Result V0Tool Call RunToolResultV0ToolCall- Runs
Create Options V0 RunsCreateOptionsV0- Runs
Create Request - Create a workflow run. The workflow spec must include a resolved model for every llm.responses/route.switch node (including map.fanout subnodes); /runs does not resolve tiers or default models. Use model_override or model_overrides to override models at runtime.
- Runs
Create Request Model Overrides - Per-node model overrides. Use nodes for top-level nodes and fanout_subnodes for map.fanout subnodes.
- Runs
Create Request Model Overrides Fanout Subnodes Item RunsCreateRequestModelOverridesFanoutSubnodesItem- Runs
Create Response RunsCreateResponse- Runs
GetResponse RunsGetResponse- Runs
Pending Tool Call V0 - A pending tool call waiting for a result.
- Runs
Pending Tool Call V0Tool Call RunsPendingToolCallV0ToolCall- Runs
Pending Tools Node V0 - A node with pending tool calls.
- Runs
Pending Tools Response - Response containing pending tool calls for a workflow run.
- Runs
Tool Results Request - Request to submit tool execution results for a waiting run.
- Runs
Tool Results Response - Response after submitting tool results.
- Session
Create Request - Request body for creating a session.
- Session
List Response - Paginated list of sessions.
- Session
Message Create Request - Request body for appending a message to a session.
- Session
Message Response - A message within a session.
- Session
Response - A session resource.
- Session
Update Request - Request body for updating session metadata. Null values remove keys.
- Session
With Messages Response - A session with its full message history.
- Sha256
Hash - SHA-256 hash (64 hex characters).
- Signup
Project SignupProject- SqlPolicy
SqlPolicy- SqlPolicy
Aggregations SqlPolicyAggregations- SqlPolicy
Columns SqlPolicyColumns- SqlPolicy
Fts SqlPolicyFts- SqlPolicy
Joins SqlPolicyJoins- SqlPolicy
Limits SqlPolicyLimits- SqlPolicy
Ordering SqlPolicyOrdering- SqlPolicy
Subqueries SqlPolicySubqueries- SqlPolicy
Tables SqlPolicyTables- SqlProfile
SqlProfile- SqlProfile
Input SqlProfileInput- SqlProfile
Update SqlProfileUpdate- SqlValidate
Overrides SqlValidateOverrides- SqlValidate
Request - Validate a SQL query against a policy or profile
- SqlValidate
Response - SQL validation result
- State
Handle Create Request StateHandleCreateRequest- State
Handle List Response StateHandleListResponse- State
Handle Response StateHandleResponse- Subscription
Subscription- Subscription
Status - Subscription status for a customer.
- Tier
Tier- Tier
Code - Tier code identifier (e.g., free, pro, enterprise).
- Tier
Create TierCreate- Tier
Create Display Name - Human-readable tier name
- Tier
Display Name - Human-readable tier name
- Tier
Model TierModel- Tier
Model Create - Model to add to a tier. Pricing is derived from the model_pricing table.
- Tier
Update TierUpdate- Tier
Update Display Name - Human-readable tier name
- Tool
Tool- Tool
Call ToolCall- Tool
Call Delta - Incremental tool call data during streaming
- Tool
Call Delta Function ToolCallDeltaFunction- Tool
Call Function ToolCallFunction- Tool
Call Id - Unique identifier for a tool call. Treated as an opaque string and must be preserved exactly.
- Tool
Choice ToolChoice- Tool
Function ToolFunction- Tool
Hook Config ToolHookConfig- Tool
Hook Config Input ToolHookConfigInput- Tool
Hook Config Update ToolHookConfigUpdate- Tool
Hook Event ToolHookEvent- Tool
Hook Test Result ToolHookTestResult- Tool
Image Generation - Configuration for server-side image generation tool
- Tool
Name - Tool identifier. For tools.v0 client tools, use dot-separated lowercase segments (e.g. fs.search).
- Topup
History Response TopupHistoryResponse- Topup
Request TopupRequest- Topup
Response TopupResponse- Topup
Session Response TopupSessionResponse- Usage
- Token usage statistics. All fields default to 0 if not present.
- User
User- Webhook
Config WebhookConfig- Webhook
Config Input WebhookConfigInput- Webhook
Config Update WebhookConfigUpdate- Webhook
Test Result WebhookTestResult- Workflow
Issue - A lint or compile issue for a workflow spec.
- Workflow
Spec - A
workflowspec. The canonical JSON Schema is available at/schemas/workflow.schema.json. - Workflows
Compile Response - Response from compiling a workflow spec.
- Workflows
Lint Response - Response from linting a workflow spec.
Enums§
- Agent
Create Request Tool Failure Policy AgentCreateRequestToolFailurePolicy- Agent
RunOptions Tool Failure Policy AgentRunOptionsToolFailurePolicy- Agent
Update Request Tool Failure Policy AgentUpdateRequestToolFailurePolicy- Agent
Version Tool Failure Policy AgentVersionToolFailurePolicy- Billing
Mode - Billing mode for a project. ‘managed’ uses ModelRelay billing with tiers and subscriptions. ‘byob’ (Bring Your Own Billing) allows external billing.
- Billing
Provider - Billing provider backing the subscription or tier.
- Content
Part ContentPart- Image
Response Format - Output format for generated images.
- Input
Item Type InputItemType- Json
Patch Operation Op JsonPatchOperationOp- Message
Role MessageRole- Model
Capability - Workflow-critical model capability identifier. Server-side tools are not model capabilities; they require only tools support.
- Model
Relay Api - Generated types from ModelRelay OpenAPI spec
- Ndjson
Stream Event Event - Event type
- Node
Status V0 NodeStatusV0- Node
Type V0 - Type of workflow node.
- Output
Format Type OutputFormatType- Output
Item Type OutputItemType- Plugins
Compile Request Mode - Compile mode. Currently only ‘intent’ is supported.
- Price
Interval - Billing interval for a tier.
- Provider
Id - LLM provider identifier.
- Responses
Batch Result Status ResponsesBatchResultStatus- Responses
Stream Envelope Stream Mode ResponsesStreamEnvelopeStreamMode- Responses
Stream Envelope Stream Version ResponsesStreamEnvelopeStreamVersion- Responses
Stream Envelope Type ResponsesStreamEnvelopeType- RlmExecute
Request Data Source Type RlmExecuteRequestDataSourceType- RunStatus
V0 RunStatusV0- RunTask
Status RunTaskStatus- SqlPolicy
Dialect SqlPolicyDialect- Tier
Billing Mode - Billing mode for a tier. ‘subscription’ uses monthly spend limits; ‘paygo’ uses prepaid balances.
- Tool
Call Type ToolCallType- Tool
Choice Type ToolChoiceType- Tool
Hook Config Fail Behavior ToolHookConfigFailBehavior- Tool
Hook Config Hook Type ToolHookConfigHookType- Tool
Hook Config Input Fail Behavior ToolHookConfigInputFailBehavior- Tool
Hook Config Input Hook Type ToolHookConfigInputHookType- Tool
Hook Config Update Fail Behavior ToolHookConfigUpdateFailBehavior- Tool
Hook Event Status ToolHookEventStatus- Tool
Hook Test Result Status ToolHookTestResultStatus- Tool
Type ToolType- Topup
Source - How a top-up was initiated.
- Topup
Status - Status of a top-up session.
- Webhook
Config Events Item WebhookConfigEventsItem- Webhook
Config Input Events Item WebhookConfigInputEventsItem- Webhook
Config Update Events Item WebhookConfigUpdateEventsItem- Webhook
Test Result Status WebhookTestResultStatus
Traits§
- Message
Role Ext - Extension trait for MessageRole providing convenience methods.