Workspaces - OpenRouter | Documentation

Overview

Workspaces endpoints

Available Operations

List - List workspaces
Create - Create a workspace
Delete - Delete a workspace
Get - Get a workspace
Update - Update a workspace
ListBudgets - List workspace budgets
DeleteBudget - Delete a workspace budget
SetBudget - Create or update a workspace budget
ListMembers - List workspace members
BulkAddMembers - Bulk add members to a workspace
BulkRemoveMembers - Bulk remove members from a workspace

List

List all workspaces for the authenticated user. Management key required.

Example Usage

package main

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

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

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

    res, err := s.Workspaces.List(ctx, optionalnullable.From(openrouter.Pointer[int64](0)), openrouter.Pointer[int64](50))
    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.
`offset`	optionalnullable.OptionalNullable[`int64`]	:heavy_minus_sign:	Number of records to skip for pagination	0
`limit`	`*int64`	:heavy_minus_sign:	Maximum number of records to return (max 100)	50
`opts`	[]operations.Option	:heavy_minus_sign:	The options for this request.

Response

*operations.ListWorkspacesResponse, error

Errors

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

Create

Create a new workspace for the authenticated user. Management key required.

Example Usage

package main

import(
	"context"
	"os"
	openrouter "github.com/OpenRouterTeam/go-sdk"
	"github.com/OpenRouterTeam/go-sdk/optionalnullable"
	"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.Workspaces.Create(ctx, components.CreateWorkspaceRequest{
        DefaultImageModel: optionalnullable.From(openrouter.Pointer("openai/dall-e-3")),
        DefaultProviderSort: optionalnullable.From(openrouter.Pointer("price")),
        DefaultTextModel: optionalnullable.From(openrouter.Pointer("openai/gpt-4o")),
        Description: optionalnullable.From(openrouter.Pointer("Production environment workspace")),
        Name: "Production",
        Slug: "production",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

Parameters

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

Response

*components.CreateWorkspaceResponse, error

Errors

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

Delete

Delete an existing workspace. The default workspace cannot be deleted. Workspaces with active API keys cannot be deleted; remove the keys first. 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.Workspaces.Delete(ctx, "production")
    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.
`id`	`string`	:heavy_check_mark:	The workspace ID (UUID) or slug	production
`opts`	[]operations.Option	:heavy_minus_sign:	The options for this request.

Response

*components.DeleteWorkspaceResponse, 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.InternalServerResponseError	500	application/json
sdkerrors.APIError	4XX, 5XX	/

Get

Get a single workspace by ID or 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.Workspaces.Get(ctx, "production")
    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.
`id`	`string`	:heavy_check_mark:	The workspace ID (UUID) or slug	production
`opts`	[]operations.Option	:heavy_minus_sign:	The options for this request.

Response

*components.GetWorkspaceResponse, error

Errors

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

Update

Update an existing workspace by ID or slug. 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.Workspaces.Update(ctx, "production", components.UpdateWorkspaceRequest{
        Name: openrouter.Pointer("Updated Workspace"),
        Slug: openrouter.Pointer("updated-workspace"),
    })
    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.
`id`	`string`	:heavy_check_mark:	The workspace ID (UUID) or slug	production
`updateWorkspaceRequest`	components.UpdateWorkspaceRequest	:heavy_check_mark:	N/A	{ “name”: “Updated Workspace”, “slug”: “updated-workspace” }
`opts`	[]operations.Option	:heavy_minus_sign:	The options for this request.

Response

*components.UpdateWorkspaceResponse, 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.InternalServerResponseError	500	application/json
sdkerrors.APIError	4XX, 5XX	/

ListBudgets

List all budgets configured for a workspace. 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.Workspaces.ListBudgets(ctx, "production")
    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.
`id`	`string`	:heavy_check_mark:	The workspace ID (UUID) or slug	production
`opts`	[]operations.Option	:heavy_minus_sign:	The options for this request.

Response

*components.ListWorkspaceBudgetsResponse, error

Errors

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

DeleteBudget

Remove the budget for a given interval. 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.Workspaces.DeleteBudget(ctx, "production", components.WorkspaceBudgetIntervalMonthly)
    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.
`id`	`string`	:heavy_check_mark:	The workspace ID (UUID) or slug	production
`interval`	components.WorkspaceBudgetInterval	:heavy_check_mark:	Budget reset interval. Use “lifetime” for a one-time budget that never resets.	monthly
`opts`	[]operations.Option	:heavy_minus_sign:	The options for this request.

Response

*components.DeleteWorkspaceBudgetResponse, error

Errors

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

SetBudget

Create or update the budget for a given interval. Budget limits must strictly decrease as the interval narrows (lifetime > monthly > weekly > daily). The optional include_byok_in_budgets flag is a workspace-wide setting: when provided it applies to every budget interval for the workspace, not just the interval in this request. Note that a change made here is applied to budget enforcement immediately, but an already-open workspace settings page in the web dashboard may keep showing the previous value until it is reloaded. 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.Workspaces.SetBudget(ctx, "production", components.WorkspaceBudgetIntervalMonthly, components.UpsertWorkspaceBudgetRequest{
        IncludeByokInBudgets: openrouter.Pointer(true),
        LimitUsd: 100.0,
    })
    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.
`id`	`string`	:heavy_check_mark:	The workspace ID (UUID) or slug	production
`interval`	components.WorkspaceBudgetInterval	:heavy_check_mark:	Budget reset interval. Use “lifetime” for a one-time budget that never resets.	monthly
`upsertWorkspaceBudgetRequest`	components.UpsertWorkspaceBudgetRequest	:heavy_check_mark:	N/A	{ “include_byok_in_budgets”: true, “limit_usd”: 100 }
`opts`	[]operations.Option	:heavy_minus_sign:	The options for this request.

Response

*components.UpsertWorkspaceBudgetResponse, error

Errors

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

ListMembers

List all members of a workspace. Returns paginated results. For the default workspace, returns all organization members (implicit membership). Management key required.

Example Usage

package main

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

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

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

    res, err := s.Workspaces.ListMembers(ctx, "production", optionalnullable.From(openrouter.Pointer[int64](0)), openrouter.Pointer[int64](50))
    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.
`id`	`string`	:heavy_check_mark:	The workspace ID (UUID) or slug	production
`offset`	optionalnullable.OptionalNullable[`int64`]	:heavy_minus_sign:	Number of records to skip for pagination	0
`limit`	`*int64`	:heavy_minus_sign:	Maximum number of records to return (max 100)	50
`opts`	[]operations.Option	:heavy_minus_sign:	The options for this request.

Response

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

BulkAddMembers

Add multiple organization members to a workspace. Members are assigned the same role they hold in the organization. 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.Workspaces.BulkAddMembers(ctx, "production", components.BulkAddWorkspaceMembersRequest{
        UserIds: []string{
            "user_abc123",
            "user_def456",
        },
    })
    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.
`id`	`string`	:heavy_check_mark:	The workspace ID (UUID) or slug	production
`bulkAddWorkspaceMembersRequest`	components.BulkAddWorkspaceMembersRequest	:heavy_check_mark:	N/A	{ “user_ids”: [ “user_abc123”, “user_def456” ] }
`opts`	[]operations.Option	:heavy_minus_sign:	The options for this request.

Response

*components.BulkAddWorkspaceMembersResponse, 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.InternalServerResponseError	500	application/json
sdkerrors.APIError	4XX, 5XX	/

BulkRemoveMembers

Remove multiple members from a workspace. Members with active API keys in the workspace cannot be removed. SCIM-managed members cannot be removed; changes must be made in your identity provider. 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.Workspaces.BulkRemoveMembers(ctx, "production", components.BulkRemoveWorkspaceMembersRequest{
        UserIds: []string{
            "user_abc123",
            "user_def456",
        },
    })
    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.
`id`	`string`	:heavy_check_mark:	The workspace ID (UUID) or slug	production
`bulkRemoveWorkspaceMembersRequest`	components.BulkRemoveWorkspaceMembersRequest	:heavy_check_mark:	N/A	{ “user_ids”: [ “user_abc123”, “user_def456” ] }
`opts`	[]operations.Option	:heavy_minus_sign:	The options for this request.

Response

*components.BulkRemoveWorkspaceMembersResponse, 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.InternalServerResponseError	500	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

​ListBudgets

​Example Usage

​Parameters

​Response

​Errors

​DeleteBudget

​Example Usage

​Parameters

​Response

​Errors

​SetBudget

​Example Usage

​Parameters

​Response

​Errors

​ListMembers

​Example Usage

​Parameters

​Response

​Errors

​BulkAddMembers

​Example Usage

​Parameters

​Response

​Errors

​BulkRemoveMembers

​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

ListBudgets

Example Usage

Parameters

Response

Errors

DeleteBudget

Example Usage

Parameters

Response

Errors

SetBudget

Example Usage

Parameters

Response

Errors

ListMembers

Example Usage

Parameters

Response

Errors

BulkAddMembers

Example Usage

Parameters

Response

Errors

BulkRemoveMembers

Example Usage

Parameters

Response

Errors