Skip to content
FeedbackDashboard

Generate an AI commit message for a specific SDK

client.Projects.GenerateCommitMessage(ctx, params) (*ProjectGenerateCommitMessageResponse, error)
POST/v0/projects/{project}/generate_commit_message

Generates an AI commit message by comparing two git refs in the SDK repository.

ParametersExpand Collapse
params ProjectGenerateCommitMessageParams
Project param.Field[string]optional

Path param

Query param: Language target

const ProjectGenerateCommitMessageParamsTargetPython ProjectGenerateCommitMessageParamsTarget = "python"
const ProjectGenerateCommitMessageParamsTargetNode ProjectGenerateCommitMessageParamsTarget = "node"
const ProjectGenerateCommitMessageParamsTargetTypescript ProjectGenerateCommitMessageParamsTarget = "typescript"
const ProjectGenerateCommitMessageParamsTargetJava ProjectGenerateCommitMessageParamsTarget = "java"
const ProjectGenerateCommitMessageParamsTargetKotlin ProjectGenerateCommitMessageParamsTarget = "kotlin"
const ProjectGenerateCommitMessageParamsTargetGo ProjectGenerateCommitMessageParamsTarget = "go"
const ProjectGenerateCommitMessageParamsTargetRuby ProjectGenerateCommitMessageParamsTarget = "ruby"
const ProjectGenerateCommitMessageParamsTargetTerraform ProjectGenerateCommitMessageParamsTarget = "terraform"
const ProjectGenerateCommitMessageParamsTargetCli ProjectGenerateCommitMessageParamsTarget = "cli"
const ProjectGenerateCommitMessageParamsTargetCsharp ProjectGenerateCommitMessageParamsTarget = "csharp"
const ProjectGenerateCommitMessageParamsTargetPhp ProjectGenerateCommitMessageParamsTarget = "php"
const ProjectGenerateCommitMessageParamsTargetOpenAPI ProjectGenerateCommitMessageParamsTarget = "openapi"
const ProjectGenerateCommitMessageParamsTargetSql ProjectGenerateCommitMessageParamsTarget = "sql"
BaseRef param.Field[string]

Body param: Base ref for comparison

HeadRef param.Field[string]

Body param: Head ref for comparison

ReturnsExpand Collapse
type ProjectGenerateCommitMessageResponse struct{…}
AICommitMessage string

Generate an AI commit message for a specific SDK

package main

import (
  "context"
  "fmt"

  "github.com/stainless-api/stainless-api-go"
  "github.com/stainless-api/stainless-api-go/option"
)

func main() {
  client := stainless.NewClient(
    option.WithAPIKey("My API Key"),
  )
  response, err := client.Projects.GenerateCommitMessage(context.TODO(), stainless.ProjectGenerateCommitMessageParams{
    Project: stainless.String("project"),
    Target: stainless.ProjectGenerateCommitMessageParamsTargetPython,
    BaseRef: "base_ref",
    HeadRef: "head_ref",
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.AICommitMessage)
}
{
  "ai_commit_message": "ai_commit_message"
}
Returns Examples
{
  "ai_commit_message": "ai_commit_message"
}