Private Providers - OpenRouter

Overview

Private Providers endpoints

Available Operations

List - List private providers
Create - Create a private provider
Delete - Delete a private provider
Get - Get a private provider
Update - Update a private provider

List

List the organization’s private providers. Requires the private endpoints entitlement. Management key required.

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.PrivateProviders.List(ctx)
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.ListPrivateProvidersResponse, error

Errors

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

Create

Create a private, bring-your-own-key provider visible only to your organization. Use its slug as provider_slug when creating private endpoints. Requires both the private endpoints and the private providers entitlements. Management key required.

Example Usage

package main

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

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

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

    res, err := s.PrivateProviders.Create(ctx, components.CreatePrivateProviderRequest{
        Name: "Acme",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`request`	components.CreatePrivateProviderRequest	✔️	The request object to use for the request.
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.CreatePrivateProviderResponse, error

Errors

Error Type	Status Code	Content Type
sdkerrors.BadRequestResponseError	400	application/json
sdkerrors.UnauthorizedResponseError	401	application/json
sdkerrors.ForbiddenResponseError	403	application/json
sdkerrors.NotFoundResponseError	404	application/json
sdkerrors.RequestTimeoutResponseError	408	application/json
sdkerrors.ConflictResponseError	409	application/json
sdkerrors.UnprocessableEntityResponseError	422	application/json
sdkerrors.TooManyRequestsResponseError	429	application/json
sdkerrors.InternalServerResponseError	500	application/json
sdkerrors.BadGatewayResponseError	502	application/json
sdkerrors.APIError	4XX, 5XX	/

Delete

Delete a private provider. Refuses (409) while any private endpoint still runs under it. Management key required.

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.PrivateProviders.Delete(ctx, "acme")
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description	Example
`ctx`	context.Context	✔️	The context to use for the request.
`slug`	`string`	✔️	N/A	acme
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.DeletePrivateProviderResponse, error

Errors

Error Type	Status Code	Content Type
sdkerrors.BadRequestResponseError	400	application/json
sdkerrors.UnauthorizedResponseError	401	application/json
sdkerrors.ForbiddenResponseError	403	application/json
sdkerrors.NotFoundResponseError	404	application/json
sdkerrors.RequestTimeoutResponseError	408	application/json
sdkerrors.ConflictResponseError	409	application/json
sdkerrors.UnprocessableEntityResponseError	422	application/json
sdkerrors.TooManyRequestsResponseError	429	application/json
sdkerrors.InternalServerResponseError	500	application/json
sdkerrors.BadGatewayResponseError	502	application/json
sdkerrors.APIError	4XX, 5XX	/

Get

Get one of the organization’s private providers by slug. Management key required.

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.PrivateProviders.Get(ctx, "acme")
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description	Example
`ctx`	context.Context	✔️	The context to use for the request.
`slug`	`string`	✔️	N/A	acme
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.GetPrivateProviderResponse, 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	/

Update

Update a private provider’s details or declared data policy. The name and slug cannot change. Refuses (409) a data-policy change while OpenRouter pins the declared policy on one of its endpoints. Management key required.

Example Usage

package main

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

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

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

    res, err := s.PrivateProviders.Update(ctx, "acme", components.UpdatePrivateProviderRequest{})
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description	Example
`ctx`	context.Context	✔️	The context to use for the request.
`slug`	`string`	✔️	N/A	acme
`updatePrivateProviderRequest`	components.UpdatePrivateProviderRequest	✔️	N/A
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.UpdatePrivateProviderResponse, error

Errors

Error Type	Status Code	Content Type
sdkerrors.BadRequestResponseError	400	application/json
sdkerrors.UnauthorizedResponseError	401	application/json
sdkerrors.ForbiddenResponseError	403	application/json
sdkerrors.NotFoundResponseError	404	application/json
sdkerrors.RequestTimeoutResponseError	408	application/json
sdkerrors.ConflictResponseError	409	application/json
sdkerrors.UnprocessableEntityResponseError	422	application/json
sdkerrors.TooManyRequestsResponseError	429	application/json
sdkerrors.InternalServerResponseError	500	application/json
sdkerrors.BadGatewayResponseError	502	application/json
sdkerrors.APIError	4XX, 5XX	/

​Overview

​Available Operations

​List

​Example Usage

​Parameters

​Response

​Errors

​Create

​Example Usage

​Parameters

​Response

​Errors

​Delete

​Example Usage

​Parameters

​Response

​Errors

​Get

​Example Usage

​Parameters

​Response

​Errors

​Update

​Example Usage

​Parameters

​Response

​Errors

Overview

Available Operations

List

Example Usage

Parameters

Response

Errors

Create

Example Usage

Parameters

Response

Errors

Delete

Example Usage

Parameters

Response

Errors

Get

Example Usage

Parameters

Response

Errors

Update

Example Usage

Parameters

Response

Errors