> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.runtype.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.runtype.com/_mcp/server.

# Report a problem

POST https://api.runtype.com/v1/agent-feedback
Content-Type: application/json

Report a problem with the Runtype API, MCP tools, documentation, SDKs, CLI, or dashboard. Built for coding agents: include a category, a short note, and the affected request ID or URL. Any API key can submit, and submitting costs no credits. Secret-looking values in the note are redacted before storage.

Reference: https://docs.runtype.com/api-reference/runtype-api/agent-feedback/report-a-problem

## Authentication

- `Authorization` header (bearer token, required) — API key or Clerk session token

## Servers

- `https://api.runtype.com` (Production, default)
- `https://api.runtype-staging.com` (Staging)

## Request

### Body (application/json)

This endpoint expects an object.

- `category` (enum, required) — Which part of Runtype the problem is in.
  - Allowed values: `api`, `mcp`, `documentation`, `sdk`, `cli`, `dashboard`, `other`
- `note` (string, required) — Short description of the problem: what you tried, what you expected, and what happened.
- `requestId` (string, optional) — The affected request, execution, or record ID, when there is one.
- `toolName` (string, optional) — The MCP tool, SDK method, or CLI command involved, when there is one.
- `url` (string, optional) — The affected endpoint path or documentation URL, when there is one.

## Response

### 202

Feedback received

- `id` (string, required) — Receipt ID for this report (agfb_...). Quote it in follow-ups.
- `status` (enum, required)
  - Allowed values: `received`

## Errors

### 400 Bad Request Error

Invalid parameters

- `error` (string, required)
- `details` (list of ErrorDetailsItems, optional)

### 401 Unauthorized Error

Unauthorized

- `error` (string, required)
- `details` (list of ErrorDetailsItems, optional)

### 429 Too Many Requests Error

Too many reports in a short window

- `error` (string, required)
- `details` (list of ErrorDetailsItems, optional)

## Types

### ErrorDetailsItems

- `message` (string, required)
- `code` (string, optional) — Stable Runtype validation code (e.g. MISSING_REQUIRED_FIELD, INVALID_ENUM).
- `path` (string, optional) — Dotted JSON path to the offending field.
- `suggestion` (string, optional) — Actionable hint (allowed values, accepted range, …).

## Examples

### Report a failing API call

**Request**

```json
{
  "category": "api",
  "note": "POST /v1/dispatch returned 500 when the flow had no steps; expected a 400 validation error.",
  "requestId": "req_01jv0000000000000000000001",
  "url": "/v1/dispatch"
}
```

**Response**

```json
{
  "id": "string",
  "status": "received"
}
```

**SDK Code**

```python Report a failing API call
import requests

url = "https://api.runtype.com/v1/agent-feedback"

payload = {
    "category": "api",
    "note": "POST /v1/dispatch returned 500 when the flow had no steps; expected a 400 validation error.",
    "requestId": "req_01jv0000000000000000000001",
    "url": "/v1/dispatch"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript Report a failing API call
const url = 'https://api.runtype.com/v1/agent-feedback';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"category":"api","note":"POST /v1/dispatch returned 500 when the flow had no steps; expected a 400 validation error.","requestId":"req_01jv0000000000000000000001","url":"/v1/dispatch"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Report a failing API call
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.runtype.com/v1/agent-feedback"

	payload := strings.NewReader("{\n  \"category\": \"api\",\n  \"note\": \"POST /v1/dispatch returned 500 when the flow had no steps; expected a 400 validation error.\",\n  \"requestId\": \"req_01jv0000000000000000000001\",\n  \"url\": \"/v1/dispatch\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Report a failing API call
require 'uri'
require 'net/http'

url = URI("https://api.runtype.com/v1/agent-feedback")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"category\": \"api\",\n  \"note\": \"POST /v1/dispatch returned 500 when the flow had no steps; expected a 400 validation error.\",\n  \"requestId\": \"req_01jv0000000000000000000001\",\n  \"url\": \"/v1/dispatch\"\n}"

response = http.request(request)
puts response.read_body
```

```java Report a failing API call
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.runtype.com/v1/agent-feedback")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"category\": \"api\",\n  \"note\": \"POST /v1/dispatch returned 500 when the flow had no steps; expected a 400 validation error.\",\n  \"requestId\": \"req_01jv0000000000000000000001\",\n  \"url\": \"/v1/dispatch\"\n}")
  .asString();
```

```php Report a failing API call
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.runtype.com/v1/agent-feedback', [
  'body' => '{
  "category": "api",
  "note": "POST /v1/dispatch returned 500 when the flow had no steps; expected a 400 validation error.",
  "requestId": "req_01jv0000000000000000000001",
  "url": "/v1/dispatch"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp Report a failing API call
using RestSharp;

var client = new RestClient("https://api.runtype.com/v1/agent-feedback");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"category\": \"api\",\n  \"note\": \"POST /v1/dispatch returned 500 when the flow had no steps; expected a 400 validation error.\",\n  \"requestId\": \"req_01jv0000000000000000000001\",\n  \"url\": \"/v1/dispatch\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Report a failing API call
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "category": "api",
  "note": "POST /v1/dispatch returned 500 when the flow had no steps; expected a 400 validation error.",
  "requestId": "req_01jv0000000000000000000001",
  "url": "/v1/dispatch"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.runtype.com/v1/agent-feedback")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### Report a documentation gap

**Request**

```json
{
  "category": "documentation",
  "note": "The upsert-record page does not say sourceVariable must resolve to a JSON object.",
  "url": "https://docs.runtype.com/developer-guides/records"
}
```

**Response**

```json
{
  "id": "string",
  "status": "received"
}
```

**SDK Code**

```python Report a documentation gap
import requests

url = "https://api.runtype.com/v1/agent-feedback"

payload = {
    "category": "documentation",
    "note": "The upsert-record page does not say sourceVariable must resolve to a JSON object.",
    "url": "https://docs.runtype.com/developer-guides/records"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript Report a documentation gap
const url = 'https://api.runtype.com/v1/agent-feedback';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"category":"documentation","note":"The upsert-record page does not say sourceVariable must resolve to a JSON object.","url":"https://docs.runtype.com/developer-guides/records"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Report a documentation gap
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.runtype.com/v1/agent-feedback"

	payload := strings.NewReader("{\n  \"category\": \"documentation\",\n  \"note\": \"The upsert-record page does not say sourceVariable must resolve to a JSON object.\",\n  \"url\": \"https://docs.runtype.com/developer-guides/records\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Report a documentation gap
require 'uri'
require 'net/http'

url = URI("https://api.runtype.com/v1/agent-feedback")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"category\": \"documentation\",\n  \"note\": \"The upsert-record page does not say sourceVariable must resolve to a JSON object.\",\n  \"url\": \"https://docs.runtype.com/developer-guides/records\"\n}"

response = http.request(request)
puts response.read_body
```

```java Report a documentation gap
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.runtype.com/v1/agent-feedback")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"category\": \"documentation\",\n  \"note\": \"The upsert-record page does not say sourceVariable must resolve to a JSON object.\",\n  \"url\": \"https://docs.runtype.com/developer-guides/records\"\n}")
  .asString();
```

```php Report a documentation gap
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.runtype.com/v1/agent-feedback', [
  'body' => '{
  "category": "documentation",
  "note": "The upsert-record page does not say sourceVariable must resolve to a JSON object.",
  "url": "https://docs.runtype.com/developer-guides/records"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp Report a documentation gap
using RestSharp;

var client = new RestClient("https://api.runtype.com/v1/agent-feedback");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"category\": \"documentation\",\n  \"note\": \"The upsert-record page does not say sourceVariable must resolve to a JSON object.\",\n  \"url\": \"https://docs.runtype.com/developer-guides/records\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Report a documentation gap
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "category": "documentation",
  "note": "The upsert-record page does not say sourceVariable must resolve to a JSON object.",
  "url": "https://docs.runtype.com/developer-guides/records"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.runtype.com/v1/agent-feedback")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```