api.md

Authors

Types:

from moderation_api.types import (
    AuthorCreateResponse,
    AuthorRetrieveResponse,
    AuthorUpdateResponse,
    AuthorListResponse,
    AuthorDeleteResponse,
)

Methods:

• client.authors.create(**params) -> AuthorCreateResponse
• client.authors.retrieve(id) -> AuthorRetrieveResponse
• client.authors.update(id, **params) -> AuthorUpdateResponse
• client.authors.list(**params) -> AuthorListResponse
• client.authors.delete(id) -> AuthorDeleteResponse

Queue

Types:

from moderation_api.types import QueueRetrieveResponse, QueueGetStatsResponse

Methods:

• client.queue.retrieve(id) -> QueueRetrieveResponse
• client.queue.get_stats(id, **params) -> QueueGetStatsResponse

Items

Types:

from moderation_api.types.queue import ItemListResponse, ItemResolveResponse, ItemUnresolveResponse

Methods:

• client.queue.items.list(id, **params) -> ItemListResponse
• client.queue.items.resolve(item_id, *, id, **params) -> ItemResolveResponse
• client.queue.items.unresolve(item_id, *, id, **params) -> ItemUnresolveResponse

Actions

Types:

from moderation_api.types import (
    ActionCreateResponse,
    ActionRetrieveResponse,
    ActionUpdateResponse,
    ActionListResponse,
    ActionDeleteResponse,
)

Methods:

• client.actions.create(**params) -> ActionCreateResponse
• client.actions.retrieve(id) -> ActionRetrieveResponse
• client.actions.update(id, **params) -> ActionUpdateResponse
• client.actions.list(**params) -> ActionListResponse
• client.actions.delete(id) -> ActionDeleteResponse

Execute

Types:

from moderation_api.types.actions import ExecuteExecuteResponse, ExecuteExecuteByIDResponse

Methods:

• client.actions.execute.execute(**params) -> ExecuteExecuteResponse
• client.actions.execute.execute_by_id(action_id, **params) -> ExecuteExecuteByIDResponse

Content

Types:

from moderation_api.types import ContentSubmitResponse

Methods:

• client.content.submit(**params) -> ContentSubmitResponse

Account

Types:

from moderation_api.types import AccountListResponse

Methods:

• client.account.list() -> AccountListResponse

Auth

Types:

from moderation_api.types import AuthCreateResponse, AuthRetrieveResponse

Methods:

• client.auth.create() -> AuthCreateResponse
• client.auth.retrieve() -> AuthRetrieveResponse

Wordlist

Types:

from moderation_api.types import (
    WordlistRetrieveResponse,
    WordlistUpdateResponse,
    WordlistListResponse,
    WordlistGetEmbeddingStatusResponse,
)

Methods:

• client.wordlist.retrieve(id) -> WordlistRetrieveResponse
• client.wordlist.update(id, **params) -> WordlistUpdateResponse
• client.wordlist.list() -> WordlistListResponse
• client.wordlist.get_embedding_status(id) -> WordlistGetEmbeddingStatusResponse

Words

Types:

from moderation_api.types.wordlist import WordAddResponse, WordRemoveResponse

Methods:

• client.wordlist.words.add(id, **params) -> WordAddResponse
• client.wordlist.words.remove(id, **params) -> WordRemoveResponse