OpenRouterAPI

chat_completions(request::ChatCompletionsRequest; verbose::Bool=false)

Sends a chat completion request to the OpenRouter API.

Arguments

• request::ChatCompletionsRequest: The chat completion request object.
• verbose::Bool: (optional) If true, returns the full API response. Defaults to false.

Returns

• The chat completion response, or the full API response if verbose is true.

encoded_image_url(img_path::String)

Encodes an image file to a base64 data URL.

Arguments

• img_path::String: The path to the image file.

Returns

• A base64 data URL representing the encoded image.

encoded_pdf_url(pdf_path::String)

Encodes a PDF file to a base64 data URL.

Arguments

• pdf_path::String: The path to the PDF file.

Returns

• A base64 data URL representing the encoded PDF.

get_all_models()

Retrieves a list of available models from the OpenRouter API.

Returns

• A list of available models.

get_credits()

Retrieves the credit balance for the authenticated user.

Returns

• The credit balance.

get_meta_key()

Retrieves information about the current API key.

Returns

• Information about the current API key.

text_completion(request::TextCompletionRequest; verbose::Bool=false)

Sends a text completion request to the OpenRouter API.

Arguments

• request::TextCompletionRequest: The text completion request object.
• verbose::Bool: (optional) If true, returns the full API response. Defaults to false.

Returns

• The completed text, or the full API response if verbose is true.

chatCompletions_request

ChatCompletionsRequest(;
    model=nothing,
    messages=nothing,
    tools=nothing,
    tool_choice=nothing,
    response_format=nothing,
)

- model::String
- messages::Vector{Message}
- tools::Vector{Tool}
- tool_choice::ToolChoice
- response_format::ResponseFormat

FunctionDescription Function Description

FunctionDescription(;
    description=nothing,
    name=nothing,
    parameters=nothing,
)

- description::String
- name::String
- parameters::Any

Message DefaultMessage

Message(;
    role=nothing,
    content=nothing,
)

- role::String
- content::MessageContent

Message_content

MessageContent(; value=nothing)

Part

Part(;
    type=nothing,
    text=nothing,
    image_url=nothing,
    file=nothing,
)

- type::String
- text::String
- image_url::PartImageUrl
- file::PartFile

Part_file

PartFile(;
    filename=nothing,
    file_data=nothing,
)

- filename::String
- file_data::String

Partimageurl

PartImageUrl(;
    url=nothing,
)

- url::String

Response_format response format Description

ResponseFormat(;
    type=nothing,
    json_schema=nothing,
)

- type::String
- json_schema::ResponseFormatJsonSchema

Responseformatjson_schema

ResponseFormatJsonSchema(;
    name=nothing,
    strict=true,
    schema=nothing,
)

- name::String
- strict::Bool
- schema::Any

textCompletion_request

TextCompletionRequest(;
    model=nothing,
    prompt=nothing,
)

- model::String
- prompt::String

Tool Tool Description

Tool(;
    type=nothing,
    var"function"=nothing,
)

- type::String
- var"function"::FunctionDescription

ToolChoice ToolChoice

ToolChoice(; value=nothing)

ToolChoice_anyOf

ToolChoiceAnyOf(;
    type=nothing,
    var"function"=nothing,
)

- type::String
- var"function"::ToolChoiceAnyOfFunction

ToolChoiceanyOffunction

ToolChoiceAnyOfFunction(;
    name=nothing,
)

- name::String

The default API base path for APIs in DefaultApi. This can be used to construct the OpenAPI.Clients.Client instance.

chat/completions

chat/completions

Params:

• chatcompletionsrequest::ChatCompletionsRequest

Return: Any, OpenAPI.Clients.ApiResponse

Get credits

Returns the total credits purchased and used for the authenticated user

Params:

Return: Any, OpenAPI.Clients.ApiResponse

Get current API key

Get information on the API key associated with the current authentication session

Params:

Return: Any, OpenAPI.Clients.ApiResponse

List available models

Returns a list of models available through the API

Params:

Return: Any, OpenAPI.Clients.ApiResponse

/completions

Send a completion request to a selected model (text-only format)

Params:

• textcompletionrequest::TextCompletionRequest

Return: Any, OpenAPI.Clients.ApiResponse