Api References

You can interact with the API through HTTP requests from any language. Keep in mind that, using OpenAi's SDK is not supported by us.

Authentication

We use API keys for authentication. Visit your API Keys page to retrieve the API key you'll use in your requests.

Remember that your API key is a secret! Do not share it with others or expose it in any client-side code (browsers, apps). Production requests must be routed through your own backend server where your API key can be securely loaded from an environment variable or key management service.

All API requests should include your API key in an X-Api-Key HTTP header as follows:

X-Api-Key: YOUR_API_KEY

Making requests

You can paste the command below into your terminal to run your first API request. Make sure to replace YOUR_API_KEY with your secret API key.

curl https://api.pienteger.com/oaiv1/completions \
-H "X-Api-Key: YOUR_API_KEY" \
-d '{"model": "text-davinci-003", "prompt": "Say this is a test", "temperature": 0, "max_tokens": 7}'

This request queries the Davinci model to complete the text starting with a prompt of "Say this is a test". The max_tokens parameter sets an upper bound on how many tokens the API will return. You should get a response back that resembles the following:

{
    "id": "cmpl-GERzeJQ4lvqPk8SkZu4XMIuR",
    "object": "text_completion",
    "created": 1586839808,
    "model": "text-davinci:003",
    "choices": [
        {
            "text": "\n\nThis is indeed a test",
            "index": 0,
            "logprobs": null,
            "finish_reason": "length"
        }
    ],
    "usage": {
        "prompt_tokens": 5,
        "completion_tokens": 7,
        "total_tokens": 12
    }
}

Now you've generated your first completion. If you concatenate the prompt and the completion text (which the API will do for you if you set the echo parameter to true), the resulting text is "Say this is a test. This is indeed a test." You can also set the stream parameter to true for the API to stream back text (as data-only server-sent events).

Models

List and describe the various models available in the API. You can refer to the Models documentation to understand what models are available and the differences between them.

List models

GET https://api.pienteger.com/oaiv1/getmodels

Lists the currently available models, and provides basic information about each one such as the owner and availability.

Example request

curl https://api.pienteger.com/oaiv1/models \
  -H 'X-Api-Key: YOUR_API_KEY'

Example response

{
  "data": [
    {
      "id": "model-id-0",
      "object": "model",
      "owned_by": "organization-owner",
      "permission": [...]
    },
    {
      "id": "model-id-1",
      "object": "model",
      "owned_by": "organization-owner",
      "permission": [...]
    },
    {
      "id": "model-id-2",
      "object": "model",
      "owned_by": "openai",
      "permission": [...]
    },
  ],
  "object": "list"
}

Retrieve model

GET https://api.pienteger.com/oaiv1/models/{model}

Retrieves a model instance, providing basic information about the model such as the owner and permissions.

Path parameters

Name	Type	Status	Description
model	string	Required	The ID of the model to use for this request

Example request

curl https://api.pienteger.com/oaiv1/models/text-davinci-003 \
  -H 'X-Api-Key: YOUR_API_KEY'

Example response

{
  "id": "text-davinci-003",
  "object": "model",
  "owned_by": "openai",
  "permission": [...]
}

Completions

Given a prompt, the model will return one or more predicted completions, and can also return the probabilities of alternative tokens at each position.

Create completion

POST https://api.pienteger.com/oaiv1/completions

Creates a completion for the provided prompt and parameters.

Request body

Name	Type	Status	Description	Default
model	string	Required	ID of the model to use. You can use the List models API to see all of your available models, or see our Model overview for descriptions of them.
prompt	string	Optional	The prompt to complete.	<|endoftext|>
suffix	string	Optional	The suffix to append to the completion.	null
max_tokens	integer	Optional	The maximum number of tokens to generate in the completion. The token count of your prompt plus max_tokens cannot exceed the model's context length. Most models have a context length of 2048 tokens (except for the newest models, which support 4096).	16
user	string	Read Only	Your Pienteger Id will be injected here.