API Reference

Parasail offers a direct drop-in replacement for OpenAI's batch API. The same documentation, guides, and cookbooks apply.

We encourage you to use OpenAI's or community-built client libraries for your preferred language.

The only workflow changes are:

  • Use the Parasail URL: https://api.saas.parasail.io

  • Use your Parasail API key. Create one here.

  • Use an open model that Parasail supports instead of ChatGPT.

OpenAI API reference

OpenAI Batch API reference

OpenAI Files API reference

Client Setup

# pip install openai
from openai import OpenAI

client = OpenAI(
    base_url="https://api.saas.parasail.io/v1",
    api_key="$PARASAIL_API_KEY",
)

Chat Completions vs Text Completions:

As long as vLLM keeps support for both we have support for both endpoints.

/completions endpoint provides the completion for a single prompt and takes a single string as an input, whereas the /chat/completions provides the responses for a given dialog and requires the input in a specific format corresponding to the message history.

/v1/completions is for single prompt. you can use this endpoints if your app provides those services

-translation
-text or code generation
-revise a message
-write an email

On the other hand you use /v1/chat/completions if your app provides those services

-chatgpt style chatbots
-virtual assistant for customer service
-interactive surveys and forms

Last updated