# cozeloop-go

**Repository Path**: coze-dev/cozeloop-go

## Basic Information

- **Project Name**: cozeloop-go
- **Description**: CozeLoop 的 Golang SDK 🧭
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: feat/add_with_exporter
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-07-26
- **Last Updated**: 2025-07-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# CozeLoop Go SDK
[English](README.md) | [简体中文](README.zh_CN.md)

## Overview

The CozeLoop SDK is a Go client for interacting with [CozeLoop platform](https://loop.coze.cn).
Key features:
- Report trace
- Get and format prompt

## Requirement
- Go 1.18 or higher

## Installation

`go get github.com/coze-dev/cozeloop-go`

## Usage

### Initialize

To get started, visit https://loop.coze.cn/console/enterprise/personal/open/oauth/apps and create an OAuth app.
Then you can get your owner appid, public key and private key.

Set your environment variables:
```bash
export COZELOOP_WORKSPACE_ID=your workspace id
export COZELOOP_JWT_OAUTH_CLIENT_ID=your client id
export COZELOOP_JWT_OAUTH_PRIVATE_KEY=your private key
export COZELOOP_JWT_OAUTH_PUBLIC_KEY_ID=your public key id
```

### Report Trace

```go
func main() {
    ctx, span := loop.StartSpan(ctx, "root", "custom")

    span.SetInput(ctx, "Hello") 
    span.SetOutput(ctx, "World") 
	
    span.Finish(ctx)
	
    loop.Close(ctx)
}
```

### Get Prompt
```go
func main() {
    prompt, err := loop.GetPrompt(ctx, loop.GetPromptParam{PromptKey: "your_prompt_key"})
    messages, err := loop.PromptFormat(ctx, prompt, map[string]any{
        "var1": "your content",
    })
}
```

You can see more examples [here](examples).

## Contribution

Please check [Contributing](CONTRIBUTING.md) for more details.

## Security

If you discover a potential security issue in this project, or think you may
have discovered a security issue, we ask that you notify Bytedance Security via our [security center](https://security.bytedance.com/src) or [vulnerability reporting email](sec@bytedance.com).

Please do **not** create a public GitHub issue.

## License

This project is licensed under the [MIT License](LICENSE).