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§
- error
- Error types.
Structs§
- ApiError
ApiError- Auth
Response AuthResponse- Auth
Tokens AuthTokens- Citation
Citation- Content
Part ContentPart- Customer
Customer- Customer
Create CustomerCreate- Customer
Create External Id - External customer identifier from your system
- Customer
External Id - External customer identifier from your system
- Customer
Me CustomerMe- Customer
MeExternal Id - External customer identifier from your system
- Customer
MeResponse CustomerMeResponse- Customer
MeUsage - Usage summary for the current billing period.
- Customer
MeUsage Response CustomerMeUsageResponse- Customer
Token Response CustomerTokenResponse- Customer
Token Response Customer External Id - External customer identifier
- Device
Start Response DeviceStartResponse- Device
Token Error DeviceTokenError- Input
Item InputItem- Json
Schema Format JsonSchemaFormat- Model
Model- ModelId
- LLM model identifier (e.g., claude-sonnet-4-20250514, 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- 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- Plugins
Load Request PluginsLoadRequest- Plugins
Load Response V0 PluginsLoadResponseV0- Plugins
RunRequest PluginsRunRequest- Plugins
RunResponse V0 PluginsRunResponseV0- Project
Project- Request
Id - Unique identifier for an LLM request within a workflow run.
- Responses
Batch Error ResponsesBatchError- Responses
Batch Request ResponsesBatchRequest- Responses
Batch Request Options ResponsesBatchRequestOptions- Responses
Batch Response ResponsesBatchResponse- Responses
Batch Result ResponsesBatchResult- Responses
Request ResponsesRequest- Responses
Response ResponsesResponse- Responses
Stream Envelope ResponsesStreamEnvelope- RunCost
Line Item V0 RunCostLineItemV0- RunCost
Summary V0 RunCostSummaryV0- RunId
- Unique identifier for a workflow run.
- Runs
Create Options V0 RunsCreateOptionsV0- Runs
Create Request RunsCreateRequest- Runs
Create Response RunsCreateResponse- Runs
GetResponse RunsGetResponse- Runs
Pending Tool Call V0 - A pending tool call waiting for a result.
- Runs
Pending Tools Node V0 - A node with pending tool calls.
- Runs
Pending Tools Response - Response containing pending tool calls for a workflow run.
- Sha256
Hash - SHA-256 hash (64 hex characters).
- 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 TierModelCreate- 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
Choice ToolChoice- Tool
Function ToolFunction- Usage
- Token usage statistics. All fields default to 0 if not present.
- User
User- Workflow
Spec V0 - A
workflow.v0spec. The canonical JSON Schema is available at/schemas/workflow_v0.schema.json.
Enums§
- Content
Part Type ContentPartType- Customer
MeUsage State - Whether the customer can make more requests
- Input
Item Type InputItemType- Message
Role MessageRole- Model
Capability - Workflow-critical model capability identifier.
- 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- Price
Interval - Billing interval for a tier.
- Project
Customer Oauth Providers Item ProjectCustomerOauthProvidersItem- Provider
Id - LLM provider identifier.
- Responses
Stream Envelope Type ResponsesStreamEnvelopeType- RunStatus
V0 RunStatusV0- Tool
Call Type ToolCallType- Tool
Choice Type ToolChoiceType- Tool
Type ToolType
Traits§
- Message
Role Ext - Extension trait for MessageRole providing convenience methods.