Getting Started

Secret3 models are currently in closed beta access. Please reach out to us for access.

Generate an API Key

The API Key is a long-lived access token that represents access to your account. DO NOT share the key publicly (eg. directly on a frontend) or check it into version control (eg. git).

Upon logging in, generate an API key on the home as shown below. Each account has a limit to the total number of active API keys. If you require more keys, please reach out to our team. An unused API key may be deleted on the console at any time.

Making a Completion Request

The API is OpenAI client-compatible making it easy to integrate with existing applications.

CURL

Sample Request

Execute the following curl command on the terminal. Please ensure you have entered a correct API key.

curl --location 'https://api.secret3.com/v1/chat/completions' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'Authorization: Bearer {API_KEY}' \
--data '{
  "model": "b1",
  "messages": [
    {
      "role": "system",
      "content": "You are a helpful assistant."
    },
    {
      "role": "user",
      "content": "What is the price of bitcoin?"
    }
  ]
}'

Sample Response

{
  "id": "8922032d-33f1-426b-5bf3-eb79bcda2cc7",
  "choices": [
    {
      "finish_reason": "stop",
      "index": 0,
      "logprobs": null,
      "message": {
        "content": "Based on the most recent information provided in the search results, the price of Bitcoin is approximately $96,680 to $97,575. The exact price varies slightly between different sources, but falls within this range. The price has seen some volatility recently, with a 24-hour decline of around 1-2% reported by multiple sources.",
        "refusal": null,
        "role": "assistant"
      }
    }
  ],
  "created": 1738827875,
  "model": "b1",
  "object": "chat.completion",
  "service_tier": null,
  "system_fingerprint": null,
  "usage": {
    "completion_tokens": 75,
    "prompt_tokens": 64,
    "total_tokens": 139,
    "completion_tokens_details": null,
    "prompt_tokens_details": null
  }
}

Python

Install the OpenAI SDK

As the API is OpenAI client-compatible, you can use the official OpenAI SDK for Python. Get started by installing the SDK using pip:

pip install openai

Sample Request

Execute the following curl command on the terminal. Please ensure you have entered a correct API key.

from openai import OpenAI

API_KEY = "INSERT API KEY"

messages = [
    {
        "role": "system",
        "content": "You are a helpful assistant.",
    },
    {   
        "role": "user",
        "content": "What is the price of bitcoin?",
    },
]

client = OpenAI(api_key=API_KEY, base_url="https://api.secret3.com/v1")

completion = client.chat.completions.create(
    model="b1",
    messages=messages,
)

print(completion.choices[0].message)

Sample Response

Based on the most recent information provided in the search results, the price of Bitcoin is approximately $96,680 to $97,575. The exact price varies slightly between different sources, but falls within this range. The price has seen some volatility recently, with a 24-hour decline of around 1-2% reported by multiple sources.

Eliza

If you are new to Eliza, please refer to the getting started documentation. Please replace the environment variables shown below before running the program.

Environment Variables

As the API is OpenAI client-compatible, only minor adjustments to the .env file is required.

OPENAI_API_KEY=#API_KEY
OPENAI_API_URL=https://api.secret3.com/v1
SMALL_OPENAI_MODEL=b1
MEDIUM_OPENAI_MODEL=b1
LARGE_OPENAI_MODEL=b1