> For the documentation index, fetch https://sync.so/docs/llms.txt. Append .md to a page URL for Markdown. Documentation-search MCP: https://sync.so/docs/_mcp/server.

# Submit Feedback

POST https://api.sync.so/v2/feedback
Content-Type: application/json

Report a problem you hit with the API or the sync. MCP server, such as an error that didn't say what to fix, a wrong result, a missing capability, or a workaround you needed. Send one report per problem. The sync. team reviews reports daily. Works with an API key, an OAuth access token, or a Studio session. Submitting feedback doesn't change, retry, or cancel any job. Limited to 30 reports per minute per caller. Unknown body fields return 400.

Reference: https://sync.so/docs/api-reference/api/feedback-api/submit

## Authentication

- `x-api-key` header (required) — API Key authentication via header

## Servers

- `https://api.sync.so` (Default, default)
- `https://dev-api.sync.so` (dev)
- `http://localhost:3001` (local)

## Request

### Body (application/json)

This endpoint expects an object.

- `kind` (enum, required) — The kind of problem: `confusing_error` (an error that didn't say what to fix), `bug` (a wrong result or crash), `missing_capability` (an endpoint, tool, or option you needed), `workaround` (extra steps you had to take), `docs` (documentation or a description that misled you), or `other`.
  - Allowed values: `confusing_error`, `bug`, `missing_capability`, `workaround`, `docs`, `other`
- `message` (string, required) — What you tried, what happened, and what would have helped. Include the exact error text. Don't include personal data or secrets. 1 to 4,000 characters.
- `severity` (enum, optional) — `blocker`: you couldn't finish. `major`: you finished with a workaround. `minor`: an annoyance.
  - Allowed values: `blocker`, `major`, `minor`
- `tool` (string, optional) — The MCP tool or API operation the feedback is about.
- `errorCode` (string, optional) — The error code you received, such as an `errorCode` field.
- `generationId` (UUID, optional) — The generation the feedback is about.
- `jobId` (string, optional) — Another job the feedback is about, such as an import, transcription, or translation ID.
- `source` (enum, optional) — Where the report comes from. Defaults to `api`. The sync. MCP server sends `mcp`.
  - Allowed values: `api`, `mcp`
- `mcpVersion` (string, optional) — The sync. MCP server version. Sent by the MCP server.
- `client` (FeedbackClient, optional) — The client or agent sending the report.

## Response

### 202

Report received

- `id` (UUID, required) — The reference ID for this report.
- `received` (boolean, required) — Always `true`.

## Errors

### 400 Bad Request Error

Bad Request - Invalid input or unsupported model

- `message` (GenerationErrorMessage, required) — A message describing the error.
- `statusCode` (double, required) — The type of error that occurred.
- `errorCode` (string, optional) — Stable, machine-readable error code (e.g. project_not_found, voice_not_found, concurrency_limit_reached). Branch your error handling on this, not on the message text. The full catalog of codes with messages and suggested fixes is served unauthenticated at GET /v2/errors.
- `suggestion` (string, optional) — A suggested fix an agent can act on.
- `field` (string, optional) — The request field the error refers to, when the failure is tied to a specific field (e.g. projectId, voiceId, input[].assetId).
- `docsUrl` (string, optional) — Link to the documentation page for the failing operation.
- `requestId` (string, optional) — Present on unexpected 500 responses. Include it when contacting support so the failing request can be located directly.
- `generationId` (string, optional) — Original generation ID when available for an uncertain keyed submission or a DUPLICATE_SUBMISSION. Poll this ID; do not create another action to bypass IDEMPOTENCY_OUTCOME_UNKNOWN.
- `dialogueEditSection` (DialogueEditRetimeFailureSection, optional) — For dialogue_edit_removal_too_large: the section to change, when it can be identified. Create a new dialogue edit preview before submitting again.
- `lineNumber` (integer, optional) — For batch creation, on dialogue edit refusals only: the 1-based line of the refused record, counting non-empty JSONL lines. With a `rows` body, line N is `rows[N-1]`. Other record errors name the line only in `message`.

### 401 Unauthorized Error

Unauthorized - Invalid or missing authentication

- `message` (GenerationErrorMessage, required) — A message describing the error.
- `statusCode` (double, required) — The type of error that occurred.
- `errorCode` (string, optional) — Stable, machine-readable error code (e.g. project_not_found, voice_not_found, concurrency_limit_reached). Branch your error handling on this, not on the message text. The full catalog of codes with messages and suggested fixes is served unauthenticated at GET /v2/errors.
- `suggestion` (string, optional) — A suggested fix an agent can act on.
- `field` (string, optional) — The request field the error refers to, when the failure is tied to a specific field (e.g. projectId, voiceId, input[].assetId).
- `docsUrl` (string, optional) — Link to the documentation page for the failing operation.
- `requestId` (string, optional) — Present on unexpected 500 responses. Include it when contacting support so the failing request can be located directly.
- `generationId` (string, optional) — Original generation ID when available for an uncertain keyed submission or a DUPLICATE_SUBMISSION. Poll this ID; do not create another action to bypass IDEMPOTENCY_OUTCOME_UNKNOWN.
- `dialogueEditSection` (DialogueEditRetimeFailureSection, optional) — For dialogue_edit_removal_too_large: the section to change, when it can be identified. Create a new dialogue edit preview before submitting again.
- `lineNumber` (integer, optional) — For batch creation, on dialogue edit refusals only: the 1-based line of the refused record, counting non-empty JSONL lines. With a `rows` body, line N is `rows[N-1]`. Other record errors name the line only in `message`.

### 429 Feedback Too Many Requests Error

Too Many Requests: more than 30 feedback reports in a minute. Wait the number of seconds in the `Retry-After` header before sending another report.

- `message` (GenerationErrorMessage, required) — A message describing the error.
- `statusCode` (double, required) — The type of error that occurred.
- `dialogueEditSection` (DialogueEditRetimeFailureSection, optional) — For dialogue_edit_removal_too_large: the section to change, when it can be identified. Create a new dialogue edit preview before submitting again.
- `docsUrl` (string, optional) — Link to the documentation page for the failing operation.
- `errorCode` (string, optional) — Stable, machine-readable error code (e.g. project_not_found, voice_not_found, concurrency_limit_reached). Branch your error handling on this, not on the message text. The full catalog of codes with messages and suggested fixes is served unauthenticated at GET /v2/errors.
- `field` (string, optional) — The request field the error refers to, when the failure is tied to a specific field (e.g. projectId, voiceId, input[].assetId).
- `generationId` (string, optional) — Original generation ID when available for an uncertain keyed submission or a DUPLICATE_SUBMISSION. Poll this ID; do not create another action to bypass IDEMPOTENCY_OUTCOME_UNKNOWN.
- `limit` (double, optional) — Maximum reports per window (30).
- `lineNumber` (integer, optional) — For batch creation, on dialogue edit refusals only: the 1-based line of the refused record, counting non-empty JSONL lines. With a `rows` body, line N is `rows[N-1]`. Other record errors name the line only in `message`.
- `remaining` (double, optional) — Reports remaining in the window.
- `requestId` (string, optional) — Present on unexpected 500 responses. Include it when contacting support so the failing request can be located directly.
- `resetTime` (datetime, optional) — End of the current window.
- `retryAfter` (double, optional) — Seconds to wait before sending another report.
- `retryAfterSeconds` (double, optional) — Seconds to wait before sending another report, also sent in Retry-After.
- `suggestion` (string, optional) — A suggested fix an agent can act on.

### 500 Internal Server Error

Internal Server Error - An unexpected failure on our side. The body carries errorCode internal_error and a requestId; include the requestId when contacting support.

- `message` (GenerationErrorMessage, required) — A message describing the error.
- `statusCode` (double, required) — The type of error that occurred.
- `errorCode` (string, optional) — Stable, machine-readable error code (e.g. project_not_found, voice_not_found, concurrency_limit_reached). Branch your error handling on this, not on the message text. The full catalog of codes with messages and suggested fixes is served unauthenticated at GET /v2/errors.
- `suggestion` (string, optional) — A suggested fix an agent can act on.
- `field` (string, optional) — The request field the error refers to, when the failure is tied to a specific field (e.g. projectId, voiceId, input[].assetId).
- `docsUrl` (string, optional) — Link to the documentation page for the failing operation.
- `requestId` (string, optional) — Present on unexpected 500 responses. Include it when contacting support so the failing request can be located directly.
- `generationId` (string, optional) — Original generation ID when available for an uncertain keyed submission or a DUPLICATE_SUBMISSION. Poll this ID; do not create another action to bypass IDEMPOTENCY_OUTCOME_UNKNOWN.
- `dialogueEditSection` (DialogueEditRetimeFailureSection, optional) — For dialogue_edit_removal_too_large: the section to change, when it can be identified. Create a new dialogue edit preview before submitting again.
- `lineNumber` (integer, optional) — For batch creation, on dialogue edit refusals only: the 1-based line of the refused record, counting non-empty JSONL lines. With a `rows` body, line N is `rows[N-1]`. Other record errors name the line only in `message`.

## Types

### FeedbackClient

- `name` (string, required) — Your client or agent, such as an MCP host name.
- `version` (string, optional) — Your client or agent version.

### GenerationErrorMessage

A message describing the error.

- string
- list of string

### DialogueEditRetimeFailureSection

The dialogue-edit section that removes too much speech to stay in sync.

- `slotIndex` (integer, required) — Zero-based index of the section in the preview's `resultSlots`.
- `sourceStartMs` (integer, optional) — Start of the section in the source video, in absolute milliseconds.
- `sourceDurationMs` (integer, optional) — Length of the section in the source video, in milliseconds.

## Examples

**Request**

```json
{
  "kind": "confusing_error",
  "message": "POST /v2/generate returned generation_input_video_inaccessible for a presigned URL that plays in a browser. Saying whether the URL had expired or was blocked would have helped.",
  "severity": "major",
  "tool": "generations.create",
  "errorCode": "generation_input_video_inaccessible",
  "generationId": "6533643b-acbb-4c4f-a5b3-5ba2e5ab6b5f"
}
```

**Response**

```json
{
  "id": "2f1c9a7e-4b3d-4e8a-9c21-7d5e6f8a9b0c",
  "received": true
}
```

**SDK Code**

```python
import requests

url = "https://api.sync.so/v2/feedback"

payload = {
    "kind": "confusing_error",
    "message": "POST /v2/generate returned generation_input_video_inaccessible for a presigned URL that plays in a browser. Saying whether the URL had expired or was blocked would have helped.",
    "severity": "major",
    "tool": "generations.create",
    "errorCode": "generation_input_video_inaccessible",
    "generationId": "6533643b-acbb-4c4f-a5b3-5ba2e5ab6b5f"
}
headers = {
    "x-api-key": "<apiKey>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript
const url = 'https://api.sync.so/v2/feedback';
const options = {
  method: 'POST',
  headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{"kind":"confusing_error","message":"POST /v2/generate returned generation_input_video_inaccessible for a presigned URL that plays in a browser. Saying whether the URL had expired or was blocked would have helped.","severity":"major","tool":"generations.create","errorCode":"generation_input_video_inaccessible","generationId":"6533643b-acbb-4c4f-a5b3-5ba2e5ab6b5f"}'
};

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

```go
package main

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

func main() {

	url := "https://api.sync.so/v2/feedback"

	payload := strings.NewReader("{\n  \"kind\": \"confusing_error\",\n  \"message\": \"POST /v2/generate returned generation_input_video_inaccessible for a presigned URL that plays in a browser. Saying whether the URL had expired or was blocked would have helped.\",\n  \"severity\": \"major\",\n  \"tool\": \"generations.create\",\n  \"errorCode\": \"generation_input_video_inaccessible\",\n  \"generationId\": \"6533643b-acbb-4c4f-a5b3-5ba2e5ab6b5f\"\n}")

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

	req.Header.Add("x-api-key", "<apiKey>")
	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
require 'uri'
require 'net/http'

url = URI("https://api.sync.so/v2/feedback")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"kind\": \"confusing_error\",\n  \"message\": \"POST /v2/generate returned generation_input_video_inaccessible for a presigned URL that plays in a browser. Saying whether the URL had expired or was blocked would have helped.\",\n  \"severity\": \"major\",\n  \"tool\": \"generations.create\",\n  \"errorCode\": \"generation_input_video_inaccessible\",\n  \"generationId\": \"6533643b-acbb-4c4f-a5b3-5ba2e5ab6b5f\"\n}"

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

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.sync.so/v2/feedback")
  .header("x-api-key", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"kind\": \"confusing_error\",\n  \"message\": \"POST /v2/generate returned generation_input_video_inaccessible for a presigned URL that plays in a browser. Saying whether the URL had expired or was blocked would have helped.\",\n  \"severity\": \"major\",\n  \"tool\": \"generations.create\",\n  \"errorCode\": \"generation_input_video_inaccessible\",\n  \"generationId\": \"6533643b-acbb-4c4f-a5b3-5ba2e5ab6b5f\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.sync.so/v2/feedback', [
  'body' => '{
  "kind": "confusing_error",
  "message": "POST /v2/generate returned generation_input_video_inaccessible for a presigned URL that plays in a browser. Saying whether the URL had expired or was blocked would have helped.",
  "severity": "major",
  "tool": "generations.create",
  "errorCode": "generation_input_video_inaccessible",
  "generationId": "6533643b-acbb-4c4f-a5b3-5ba2e5ab6b5f"
}',
  'headers' => [
    'Content-Type' => 'application/json',
    'x-api-key' => '<apiKey>',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.sync.so/v2/feedback");
var request = new RestRequest(Method.POST);
request.AddHeader("x-api-key", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"kind\": \"confusing_error\",\n  \"message\": \"POST /v2/generate returned generation_input_video_inaccessible for a presigned URL that plays in a browser. Saying whether the URL had expired or was blocked would have helped.\",\n  \"severity\": \"major\",\n  \"tool\": \"generations.create\",\n  \"errorCode\": \"generation_input_video_inaccessible\",\n  \"generationId\": \"6533643b-acbb-4c4f-a5b3-5ba2e5ab6b5f\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "x-api-key": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = [
  "kind": "confusing_error",
  "message": "POST /v2/generate returned generation_input_video_inaccessible for a presigned URL that plays in a browser. Saying whether the URL had expired or was blocked would have helped.",
  "severity": "major",
  "tool": "generations.create",
  "errorCode": "generation_input_video_inaccessible",
  "generationId": "6533643b-acbb-4c4f-a5b3-5ba2e5ab6b5f"
] as [String : Any]

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api.sync.so/v2/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()
```