For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
ModelsChatRankingsDocs
DocsAPI ReferenceClient SDKsAgent SDKCookbookChangelog
DocsAPI ReferenceClient SDKsAgent SDKCookbookChangelog
    • Overview
    • Usage for Agents
  • TypeScript SDK
    • Overview
  • Python SDK
    • Overview
  • Go SDK
      • Analytics
      • APIKeys
      • Byok
      • Chat
      • Credits
      • Embeddings
      • Endpoints
      • Generations
      • Guardrails
        • Models
        • Formats
      • OAuth
      • Observability
      • Organization
      • Presets
      • Providers
      • Rerank
      • Beta.Responses
      • Transcriptions
      • Speech
      • VideoGeneration
      • Workspaces
  • DevTools
    • Overview
    • Migrating to @openrouter/agent
LogoLogo
ModelsChatRankingsDocs
On this page
  • Supported Types
  • FormatTextConfig
  • FormatJSONObjectConfig
  • FormatJSONSchemaConfig
  • Union Discrimination
Go SDKAPI ReferenceModels

Formats - Go SDK

Formats type definition
Was this page helpful?
Previous

OAuth - Go SDK

OAuth method reference
Next
Built with

The Go SDK and docs are currently in beta. Report issues on GitHub.

Text response format configuration

Supported Types

FormatTextConfig

1formats := components.CreateFormatsText(components.FormatTextConfig{/* values here */})

FormatJSONObjectConfig

1formats := components.CreateFormatsJSONObject(components.FormatJSONObjectConfig{/* values here */})

FormatJSONSchemaConfig

1formats := components.CreateFormatsJSONSchema(components.FormatJSONSchemaConfig{/* values here */})

Union Discrimination

Use the Type field to determine which variant is active, then access the corresponding field:

1switch formats.Type {
2 case components.FormatsTypeText:
3 // formats.FormatTextConfig is populated
4 case components.FormatsTypeJSONObject:
5 // formats.FormatJSONObjectConfig is populated
6 case components.FormatsTypeJSONSchema:
7 // formats.FormatJSONSchemaConfig is populated
8 default:
9 // Unknown type - use formats.GetUnknownRaw() for raw JSON
10}