api.md

Shared

Types:

• ErrorMessage
• ErrorObject
• FunctionDefinition
• FunctionParams
• GraphData
• Logprobs
• LogprobsToken
• Source
• ToolCall
• ToolCallStreaming
• ToolChoiceJsonObject
• ToolChoiceString
• ToolParam

Applications

Types:

• ApplicationGenerateContentChunk
• ApplicationGenerateContentResponse
• ApplicationRetrieveResponse
• ApplicationListResponse

Methods:

• client.applications.retrieve(applicationID) -> ApplicationRetrieveResponse
• client.applications.list({ ...params }) -> ApplicationListResponsesCursorPage
• client.applications.generateContent(applicationID, { ...params }) -> ApplicationGenerateContentResponse

Jobs

Types:

• ApplicationGenerateAsyncResponse
• ApplicationJobsListResponse
• JobCreateResponse
• JobRetryResponse

Methods:

• client.applications.jobs.create(applicationID, { ...params }) -> JobCreateResponse
• client.applications.jobs.retrieve(jobID) -> ApplicationGenerateAsyncResponse
• client.applications.jobs.list(applicationID, { ...params }) -> ApplicationGenerateAsyncResponsesApplicationJobsOffset
• client.applications.jobs.retry(jobID) -> JobRetryResponse

Graphs

Types:

• ApplicationGraphsResponse

Methods:

• client.applications.graphs.update(applicationID, { ...params }) -> ApplicationGraphsResponse
• client.applications.graphs.list(applicationID) -> ApplicationGraphsResponse

Chat

Types:

• ChatCompletion
• ChatCompletionChoice
• ChatCompletionChunk
• ChatCompletionMessage
• ChatCompletionParams
• ChatCompletionUsage

Methods:

• client.chat.chat({ ...params }) -> ChatCompletion

Completions

Types:

• Completion
• CompletionChunk
• CompletionParams

Methods:

• client.completions.create({ ...params }) -> Completion

Models

Types:

• ModelListResponse

Methods:

• client.models.list() -> ModelListResponse

Graphs

Types:

• Graph
• Question
• QuestionResponseChunk
• GraphCreateResponse
• GraphUpdateResponse
• GraphDeleteResponse
• GraphRemoveFileFromGraphResponse

Methods:

• client.graphs.create({ ...params }) -> GraphCreateResponse
• client.graphs.retrieve(graphID) -> Graph
• client.graphs.update(graphID, { ...params }) -> GraphUpdateResponse
• client.graphs.list({ ...params }) -> GraphsCursorPage
• client.graphs.delete(graphID) -> GraphDeleteResponse
• client.graphs.addFileToGraph(graphID, { ...params }) -> File
• client.graphs.question({ ...params }) -> Question
• client.graphs.removeFileFromGraph(fileID, { ...params }) -> GraphRemoveFileFromGraphResponse

Files

Types:

• File
• FileDeleteResponse
• FileRetryResponse

Methods:

• client.files.retrieve(fileID) -> File
• client.files.list({ ...params }) -> FilesCursorPage
• client.files.delete(fileID) -> FileDeleteResponse
• client.files.download(fileID) -> Response
• client.files.retry({ ...params }) -> FileRetryResponse
• client.files.upload({ ...params }) -> File

Tools

Types:

• ToolAIDetectResponse
• ToolContextAwareSplittingResponse
• ToolParsePdfResponse
• ToolWebSearchResponse

Methods:

• client.tools.aiDetect({ ...params }) -> ToolAIDetectResponse
• client.tools.contextAwareSplitting({ ...params }) -> ToolContextAwareSplittingResponse
• client.tools.parsePdf(fileID, { ...params }) -> ToolParsePdfResponse
• client.tools.webSearch({ ...params }) -> ToolWebSearchResponse

Comprehend

Types:

• ComprehendMedicalResponse

Methods:

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

Translation

Types:

• TranslationRequest
• TranslationResponse

Methods:

• client.translation.translate({ ...params }) -> TranslationResponse

Vision

Types:

• VisionRequest
• VisionResponse

Methods:

• client.vision.analyze({ ...params }) -> VisionResponse