Models - OpenRouter | Documentation

Overview

Model information endpoints

Available Operations

Get - Get a model by its slug
List - List all models and their properties
Count - Get total count of available models
ListForUser - List models filtered by user provider preferences, privacy settings, and guardrails

Get

Returns full details for a single model identified by its author and slug (e.g. openai/gpt-4). Supports variant suffixes (e.g. openai/gpt-4:free) and resolves known slug aliases.

Example Usage

package main

import(
	"context"
	"os"
	openrouter "github.com/OpenRouterTeam/go-sdk"
	"log"
)

func main() {
    ctx := context.Background()

    s := openrouter.New(
        openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")),
    )

    res, err := s.Models.Get(ctx, "openai", "gpt-4")
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description	Example
`ctx`	context.Context	:heavy_check_mark:	The context to use for the request.
`author`	`string`	:heavy_check_mark:	The author/organization of the model	openai
`slug`	`string`	:heavy_check_mark:	The model slug, optionally including a variant suffix (e.g. gpt-4 or gpt-4:free)	gpt-4
`opts`	[]operations.Option	:heavy_minus_sign:	The options for this request.

Response

*components.ModelResponse, error

Errors

Error Type	Status Code	Content Type
sdkerrors.ForbiddenResponseError	403	application/json
sdkerrors.NotFoundResponseError	404	application/json
sdkerrors.InternalServerResponseError	500	application/json
sdkerrors.APIError	4XX, 5XX	/

List

List all models and their properties

Example Usage

package main

import(
	"context"
	"os"
	openrouter "github.com/OpenRouterTeam/go-sdk"
	"github.com/OpenRouterTeam/go-sdk/models/operations"
	"log"
)

func main() {
    ctx := context.Background()

    s := openrouter.New(
        openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")),
    )

    res, err := s.Models.List(ctx, &operations.GetModelsRequest{})
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        for {
            // handle items

            res, err = res.Next()

            if err != nil {
                // handle error
            }

            if res == nil {
                break
            }
        }
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	:heavy_check_mark:	The context to use for the request.
`request`	operations.GetModelsRequest	:heavy_check_mark:	The request object to use for the request.
`opts`	[]operations.Option	:heavy_minus_sign:	The options for this request.

Response

*operations.GetModelsResponse, error

Errors

Error Type	Status Code	Content Type
sdkerrors.BadRequestResponseError	400	application/json
sdkerrors.ForbiddenResponseError	403	application/json
sdkerrors.InternalServerResponseError	500	application/json
sdkerrors.APIError	4XX, 5XX	/

Count

Get total count of available models

Example Usage

package main

import(
	"context"
	"os"
	openrouter "github.com/OpenRouterTeam/go-sdk"
	"log"
)

func main() {
    ctx := context.Background()

    s := openrouter.New(
        openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")),
    )

    res, err := s.Models.Count(ctx, nil)
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description	Example
`ctx`	context.Context	:heavy_check_mark:	The context to use for the request.
`outputModalities`	`*string`	:heavy_minus_sign:	Filter models by output modality. Accepts a comma-separated list of modalities (text, image, audio, embeddings) or “all” to include all models. Defaults to “text”.	text
`opts`	[]operations.Option	:heavy_minus_sign:	The options for this request.

Response

*components.ModelsCountResponse, error

Errors

Error Type	Status Code	Content Type
sdkerrors.BadRequestResponseError	400	application/json
sdkerrors.ForbiddenResponseError	403	application/json
sdkerrors.InternalServerResponseError	500	application/json
sdkerrors.APIError	4XX, 5XX	/

ListForUser

List models filtered by user provider preferences, privacy settings, and guardrails. Returns text-output models by default; pass output_modalities (e.g. image,audio,embeddings or all) to include other modalities. If requesting through a regional hostname, the results will be filtered to models that satisfy in-region routing for that region.

Example Usage

package main

import(
	"context"
	openrouter "github.com/OpenRouterTeam/go-sdk"
	"os"
	"github.com/OpenRouterTeam/go-sdk/models/operations"
	"github.com/OpenRouterTeam/go-sdk/optionalnullable"
	"log"
)

func main() {
    ctx := context.Background()

    s := openrouter.New()

    res, err := s.Models.ListForUser(ctx, operations.ListModelsUserSecurity{
        Bearer: os.Getenv("OPENROUTER_BEARER"),
    }, optionalnullable.From(openrouter.Pointer[int64](0)), openrouter.Pointer[int64](500), nil)
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        for {
            // handle items

            res, err = res.Next()

            if err != nil {
                // handle error
            }

            if res == nil {
                break
            }
        }
    }
}

Parameters

Parameter	Type	Required	Description	Example
`ctx`	context.Context	:heavy_check_mark:	The context to use for the request.
`security`	operations.ListModelsUserSecurity	:heavy_check_mark:	The security requirements to use for the request.
`offset`	optionalnullable.OptionalNullable[`int64`]	:heavy_minus_sign:	Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned	0
`limit`	`*int64`	:heavy_minus_sign:	Maximum number of records to return (max 1000). When both offset and limit are omitted, the full list is returned	500
`outputModalities`	`*string`	:heavy_minus_sign:	Filter models by output modality. Accepts a comma-separated list of modalities (text, image, audio, embeddings) or “all” to include all models. Defaults to “text”.	text
`opts`	[]operations.Option	:heavy_minus_sign:	The options for this request.

Response

*operations.ListModelsUserResponse, error

Errors

Error Type	Status Code	Content Type
sdkerrors.UnauthorizedResponseError	401	application/json
sdkerrors.ForbiddenResponseError	403	application/json
sdkerrors.NotFoundResponseError	404	application/json
sdkerrors.InternalServerResponseError	500	application/json
sdkerrors.APIError	4XX, 5XX	/

​Overview

​Available Operations

​Get

​Example Usage

​Parameters

​Response

​Errors

​List

​Example Usage

​Parameters

​Response

​Errors

​Count

​Example Usage

​Parameters

​Response

​Errors

​ListForUser

​Example Usage

​Parameters

​Response

​Errors

Overview

Available Operations

Get

Example Usage

Parameters

Response

Errors

List

Example Usage

Parameters

Response

Errors

Count

Example Usage

Parameters

Response

Errors

ListForUser

Example Usage

Parameters

Response

Errors