Skip to content

Latest commit

 

History

History
54 lines (36 loc) · 9.08 KB

README.md

File metadata and controls

54 lines (36 loc) · 9.08 KB

Feedback

Overview

Available Operations

create

Sends a feature request, bug report or other feedback to the Moderation API team. The team reads every request and can reply by email. Limited to 5 requests per minute per organization.

Example Usage

from moderation_api import ModerationAPI
import os


with ModerationAPI(
    secret_key=os.getenv("MODAPI_SECRET_KEY", ""),
) as ma_client:

    res = ma_client.feedback.create(title="Filter queue items by author trust level", description="We review queue items by hand. We want to see items from new authors first, so we need a filter for trust level on the queue items list.", type_="feature_request", source="mcp")

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
title str ✔️ A short summary of the request.
description str ✔️ What you tried to do, why, and what is missing or does not work. Plain text. Blank lines start new paragraphs.
project_id Optional[str] ➖ The project to act on, by ID or name. Required with an organization key unless the key reaches only one project; list projects with GET /projects. A project key acts on its own project and needs no value: naming another one is an error.
type Optional[models.CreateFeedbackType] ➖ The kind of feedback.
source Optional[models.Source] ➖ Where the feedback was written: MCP server, agent skill, CLI or API.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.CreateFeedbackResponse

Errors

Error Type Status Code Content Type
errors.BadRequestError 400 application/json
errors.AuthenticationError 401 application/json
errors.RateLimitError 429 application/json
errors.ModerationAPIDefaultError 4XX, 5XX */*