Containers - OpenRouter | Documentation

Overview

Containers endpoints

Available Operations

ListContainerFiles - List container files
GetContainerFile - Retrieve a container file
DownloadContainerFileContent - Download container file content
PromoteContainerFile - Promote a container file into workspace documents

ListContainerFiles

Lists the files in a container, in lexicographic path order. The container id is the canonical id returned in bash/shell tool results; a restarted session is a separate container with its own id. Paginate with limit and after (pass the previous page’s last_id); has_more: true always means the next page is fetchable that way.

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.Containers.ListContainerFiles(ctx, "sess_abc123", openrouter.Pointer[int64](100), 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.
`containerID`	`string`	:heavy_check_mark:	The canonical container id, exactly as returned in a bash/shell tool result — a restarted session has its own `-r<nonce>`-suffixed id. A session-derived id is always `sess_` + the sanitized session key, which is not necessarily the raw session id that was sent.	sess_abc123
`limit`	`*int64`	:heavy_minus_sign:	Maximum number of files to return (1-1000). Defaults to 100 when absent.	100
`after`	`*string`	:heavy_minus_sign:	Forward cursor: a container file id from a previous page (typically `last_id`); listing resumes strictly after that file.	cfile_b3V0L3JlcG9ydC5jc3Y
`opts`	[]operations.Option	:heavy_minus_sign:	The options for this request.

Response

*components.ContainerFileListResponse, error

Errors

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

GetContainerFile

Returns the metadata of a single file in a container.

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.Containers.GetContainerFile(ctx, "sess_abc123", "cfile_b3V0L3JlcG9ydC5jc3Y")
    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.
`containerID`	`string`	:heavy_check_mark:	The canonical container id, exactly as returned in a bash/shell tool result — a restarted session has its own `-r<nonce>`-suffixed id. A session-derived id is always `sess_` + the sanitized session key, which is not necessarily the raw session id that was sent.	sess_abc123
`fileID`	`string`	:heavy_check_mark:	Container file id (`cfile_` + base64url of the file path).	cfile_b3V0L3JlcG9ydC5jc3Y
`opts`	[]operations.Option	:heavy_minus_sign:	The options for this request.

Response

*components.ContainerFile, 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.TooManyRequestsResponseError	429	application/json
sdkerrors.InternalServerResponseError	500	application/json
sdkerrors.ServiceUnavailableResponseError	503	application/json
sdkerrors.APIError	4XX, 5XX	/

DownloadContainerFileContent

Streams the raw bytes of a file in a container.

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.Containers.DownloadContainerFileContent(ctx, "sess_abc123", "cfile_b3V0L3JlcG9ydC5jc3Y")
    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.
`containerID`	`string`	:heavy_check_mark:	The canonical container id, exactly as returned in a bash/shell tool result — a restarted session has its own `-r<nonce>`-suffixed id. A session-derived id is always `sess_` + the sanitized session key, which is not necessarily the raw session id that was sent.	sess_abc123
`fileID`	`string`	:heavy_check_mark:	Container file id (`cfile_` + base64url of the file path).	cfile_b3V0L3JlcG9ydC5jc3Y
`opts`	[]operations.Option	:heavy_minus_sign:	The options for this request.

Response

io.ReadCloser, 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.TooManyRequestsResponseError	429	application/json
sdkerrors.InternalServerResponseError	500	application/json
sdkerrors.ServiceUnavailableResponseError	503	application/json
sdkerrors.APIError	4XX, 5XX	/

PromoteContainerFile

Copies a file from the container’s sandbox prefix into the workspace’s durable document storage, so it outlives the container. Returns the new document in the Files API shape, with a durable file id in the documents namespace. The copy counts against the workspace’s storage quota exactly like an upload.

Example Usage

package main

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

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

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

    res, err := s.Containers.PromoteContainerFile(ctx, "sess_abc123", "cfile_b3V0L3JlcG9ydC5jc3Y")
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        switch res.Type {
            case components.FileResponseTypeAnthropic:
                // res.AnthropicFile is populated
            case components.FileResponseTypeOpenai:
                // res.OpenAIFile is populated
            case components.FileResponseTypeOpenrouter:
                // res.OpenRouterFile is populated
            default:
                // Unknown type - use res.GetUnknownRaw() for raw JSON
        }

    }
}

Parameters

Parameter	Type	Required	Description	Example
`ctx`	context.Context	:heavy_check_mark:	The context to use for the request.
`containerID`	`string`	:heavy_check_mark:	The canonical container id, exactly as returned in a bash/shell tool result — a restarted session has its own `-r<nonce>`-suffixed id. A session-derived id is always `sess_` + the sanitized session key, which is not necessarily the raw session id that was sent.	sess_abc123
`fileID`	`string`	:heavy_check_mark:	Container file id (`cfile_` + base64url of the file path).	cfile_b3V0L3JlcG9ydC5jc3Y
`opts`	[]operations.Option	:heavy_minus_sign:	The options for this request.

Response

*components.FileResponse, 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.PayloadTooLargeResponseError	413	application/json
sdkerrors.TooManyRequestsResponseError	429	application/json
sdkerrors.InternalServerResponseError	500	application/json
sdkerrors.ServiceUnavailableResponseError	503	application/json
sdkerrors.APIError	4XX, 5XX	/

​Overview

​Available Operations

​ListContainerFiles

​Example Usage

​Parameters

​Response

​Errors

​GetContainerFile

​Example Usage

​Parameters

​Response

​Errors

​DownloadContainerFileContent

​Example Usage

​Parameters

​Response

​Errors

​PromoteContainerFile

​Example Usage

​Parameters

​Response

​Errors

Overview

Available Operations

ListContainerFiles

Example Usage

Parameters

Response

Errors

GetContainerFile

Example Usage

Parameters

Response

Errors

DownloadContainerFileContent

Example Usage

Parameters

Response

Errors

PromoteContainerFile

Example Usage

Parameters

Response

Errors