api.md

Shared Types

from writerai.types import (
    ErrorMessage,
    ErrorObject,
    FunctionDefinition,
    FunctionParams,
    GraphData,
    Logprobs,
    LogprobsToken,
    Source,
    ToolCall,
    ToolCallStreaming,
    ToolChoiceJsonObject,
    ToolChoiceString,
    ToolParam,
)

Applications

Types:

from writerai.types import (
    ApplicationGenerateContentChunk,
    ApplicationGenerateContentResponse,
    ApplicationRetrieveResponse,
    ApplicationListResponse,
)

Methods:

• client.applications.retrieve(application_id) -> ApplicationRetrieveResponse
• client.applications.list(**params) -> SyncCursorPage[ApplicationListResponse]
• client.applications.generate_content(application_id, **params) -> ApplicationGenerateContentResponse

Jobs

Types:

from writerai.types.applications import (
    ApplicationGenerateAsyncResponse,
    ApplicationJobsListResponse,
    JobCreateResponse,
    JobRetryResponse,
)

Methods:

• client.applications.jobs.create(application_id, **params) -> JobCreateResponse
• client.applications.jobs.retrieve(job_id) -> ApplicationGenerateAsyncResponse
• client.applications.jobs.list(application_id, **params) -> SyncApplicationJobsOffset[ApplicationGenerateAsyncResponse]
• client.applications.jobs.retry(job_id) -> JobRetryResponse

Graphs

Types:

from writerai.types.applications import ApplicationGraphsResponse

Methods:

• client.applications.graphs.update(application_id, **params) -> ApplicationGraphsResponse
• client.applications.graphs.list(application_id) -> ApplicationGraphsResponse

Chat

Types:

from writerai.types import (
    ChatCompletion,
    ChatCompletionChoice,
    ChatCompletionChunk,
    ChatCompletionMessage,
    ChatCompletionParams,
    ChatCompletionUsage,
)

Methods:

• client.chat.chat(**params) -> ChatCompletion

Completions

Types:

from writerai.types import Completion, CompletionChunk, CompletionParams

Methods:

• client.completions.create(**params) -> Completion

Models

Types:

from writerai.types import ModelListResponse

Methods:

• client.models.list() -> ModelListResponse

Graphs

Types:

from writerai.types import (
    Graph,
    Question,
    QuestionResponseChunk,
    GraphCreateResponse,
    GraphUpdateResponse,
    GraphDeleteResponse,
    GraphRemoveFileFromGraphResponse,
)

Methods:

• client.graphs.create(**params) -> GraphCreateResponse
• client.graphs.retrieve(graph_id) -> Graph
• client.graphs.update(graph_id, **params) -> GraphUpdateResponse
• client.graphs.list(**params) -> SyncCursorPage[Graph]
• client.graphs.delete(graph_id) -> GraphDeleteResponse
• client.graphs.add_file_to_graph(graph_id, **params) -> File
• client.graphs.question(**params) -> Question
• client.graphs.remove_file_from_graph(file_id, *, graph_id) -> GraphRemoveFileFromGraphResponse

Files

Types:

from writerai.types import File, FileDeleteResponse, FileRetryResponse

Methods:

• client.files.retrieve(file_id) -> File
• client.files.list(**params) -> SyncCursorPage[File]
• client.files.delete(file_id) -> FileDeleteResponse
• client.files.download(file_id) -> BinaryAPIResponse
• client.files.retry(**params) -> FileRetryResponse
• client.files.upload(**params) -> File

Tools

Types:

from writerai.types import (
    ToolAIDetectResponse,
    ToolContextAwareSplittingResponse,
    ToolParsePdfResponse,
    ToolWebSearchResponse,
)

Methods:

• client.tools.ai_detect(**params) -> ToolAIDetectResponse
• client.tools.context_aware_splitting(**params) -> ToolContextAwareSplittingResponse
• client.tools.parse_pdf(file_id, **params) -> ToolParsePdfResponse
• client.tools.web_search(**params) -> ToolWebSearchResponse

Comprehend

Types:

from writerai.types.tools import ComprehendMedicalResponse

Methods:

• client.tools.comprehend.medical(**params) -> ComprehendMedicalResponse

Translation

Types:

from writerai.types import TranslationRequest, TranslationResponse

Methods:

• client.translation.translate(**params) -> TranslationResponse

Vision

Types:

from writerai.types import VisionRequest, VisionResponse

Methods:

• client.vision.analyze(**params) -> VisionResponse