How do I report a bug?

Last updated: June 28, 2025

The easier it is for the team to reproduce your issue, the faster your issues will be resolved. Below are some tips for giving us the information we need to get to the bottom of your issues quickly.

Details

The more details you can provide, the easier it will be for our team to pinpoint the issue. Below are the most helpful details you can give us. Code snippets are for a simple example where the user used an invalid API key.

Requests and responses

Send us an example request and response (example below) that produced the error you're facing. These are the most helpful. Make sure to include:

  • Messages

  • Tool definitions

  • The full response_format if using structured outputs

You can submit logs of the HTTP strings, or show your usage of the SDK. An example showing the SDK. can be found below:

chat_completion = client.chat.completions.create(
    model="llama3.3-70b",
    messages=[
        {"role": "system", "content": "You help users report issues."},
        {"role": "user", "content": "The app crashes when I log in."}
    ],
    tools=[
        {
            "type": "function",
            "function": {
                "name": "report_issue",
                "parameters": {
                    "type": "object",
                    "properties": {
                        "summary": {"type": "string"},
                        "severity": {"type": "string"}
                    },
                    "required": ["summary", "severity"]
                }
            }
        }
    ],
    tool_choice={"type": "function", "function": {"name": "report_issue"}}
)


{
  "id": "chatcmpl-8012abcd-764e-4bb2-bc89-0cbacde78329",
  "object": "chat.completion",
  "created": 1724874823,
  "model": "llama3.3-70b",
  "system_fingerprint": "fp_cerebras_sdk_001",
  "choices": [
    {
      "index": 0,
      "finish_reason": "tool_calls",
      "message": {
        "role": "assistant",
        "tool_calls": [
          {
            "id": "toolcall-19fe83a8",
            "type": "function",
            "function": {
              "name": "report_issue",
              "arguments": "{\n  \"summary\": \"App crashes on login\",\n  \"severity\": \"high\"\n}"
            }
          }
        ]
      }
    }
  ],
  "usage": {
    "prompt_tokens": 28,
    "completion_tokens": 20,
    "total_tokens": 48
  },
  "time_info": {
    "queue_time": 0.000088731,
    "prompt_time": 0.000902211,
    "completion_time": 0.004918114,
    "total_time": 0.019207001,
    "created": 1724874823
  }
}

Other Useful Details

  • Timestamp/rough time interval

  • Are you using our SDK, or something else? Langchain, etc.