api.md

Shared Types

from perplexity.types import (
    APIPublicSearchResult,
    BrowserSessionResponse,
    ChatMessageInput,
    ChatMessageOutput,
    Choice,
    ContextualizedEmbeddingObject,
    EmbeddingObject,
    EmbeddingsUsage,
    JsonSchemaFormat,
    ResponseFormat,
    SearchResult,
    UsageInfo,
    UserLocation,
    WebSearchOptions,
)

Chat

Types:

from perplexity.types import StreamChunk

Completions

Methods:

• client.chat.completions.create(**params) -> StreamChunk

Search

Types:

from perplexity.types import SearchCreateResponse

Methods:

• client.search.create(**params) -> SearchCreateResponse

Responses

Types:

from perplexity.types import (
    Annotation,
    ContentPart,
    ErrorInfo,
    FunctionCallOutputItem,
    FunctionToolParam,
    InputItemParam,
    OutputItem,
    ResponseFile,
    ResponseFileList,
    ResponseStreamChunk,
    ResponseCreateParams,
    ResponsesUsage,
    ResponseCreateResponse,
    ResponseRetrieveResponse,
)

Methods:

• client.responses.create(**params) -> ResponseCreateResponse
• client.responses.retrieve(response_id) -> ResponseRetrieveResponse

Files

Methods:

• client.responses.files.list(response_id) -> ResponseFileList
• client.responses.files.content(file_id, *, response_id) -> BinaryAPIResponse

Embeddings

Types:

from perplexity.types import EmbeddingCreateResponse

Methods:

• client.embeddings.create(**params) -> EmbeddingCreateResponse

ContextualizedEmbeddings

Types:

from perplexity.types import ContextualizedEmbeddingCreateResponse

Methods:

• client.contextualized_embeddings.create(**params) -> ContextualizedEmbeddingCreateResponse

Browser

Sessions

Methods:

• client.browser.sessions.create() -> BrowserSessionResponse
• client.browser.sessions.delete(session_id) -> None

Async

Chat

Completions

Types:

from perplexity.types.async_.chat import (
    CompletionCreateResponse,
    CompletionListResponse,
    CompletionGetResponse,
)

Methods:

• client.async*.chat.completions.create(**params) -> CompletionCreateResponse
• client.async*.chat.completions.list() -> CompletionListResponse
• client.async*.chat.completions.get(api*request, **params) -> CompletionGetResponse