API reference

Authenticate and call the OpenLIT REST API to retrieve prompts and secrets programmatically

The OpenLIT REST API lets you integrate Prompt Hub and Vault directly into any application or script — without installing an SDK. All endpoints accept JSON request bodies and return JSON responses.

Authentication

Every request must include your OpenLIT API key in the Authorization header:

Authorization: Bearer <api-key>

To create an API key, navigate to API Keys in OpenLIT and click Create API Key.

Base URL

Replace the base URL below with the address of your OpenLIT instance:

http://127.0.0.1:3000

If OpenLIT is deployed on a remote host, substitute the appropriate hostname or IP address.

Endpoints

POST /api/prompt/get-compiled

Fetch a prompt from Prompt Hub and optionally compile it with runtime variables.

curl

curl --request POST \
  --url http://127.0.0.1:3000/api/prompt/get-compiled \
  --header 'Authorization: Bearer _OPENLIT_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "prompt_name",
    "shouldCompile": true,
    "variables": { "name": "John" }
  }'

Request parameters

header.Authorization · string · required

Bearer <api-key> — your OpenLIT API key.

body.name · string

Name of the prompt to retrieve. Use either name or promptId.

body.promptId · string

Unique ID of the prompt. Use either promptId or name.

body.version · string

Specific semantic version to retrieve (e.g. 3.2.1). Omit to get the latest version.

body.shouldCompile · boolean

When true, replaces {{variableName}} placeholders in the prompt with values from variables.

body.variables · object

Key-value pairs substituted into the prompt when shouldCompile is true.

body.metaProperties · object

Additional metadata stored in the prompt’s access history.

Response

200

{
  "err": null,
  "res": {
    "promptId": "88c4cbcd-87f9-4957-a37b-b41066e17471",
    "name": "prompt_name",
    "version": "3.3.3",
    "tags": ["user", "greeting"],
    "metaProperties": { "model": "gpt4" },
    "prompt": "Hello {{name}}, how are you today?",
    "compiledPrompt": "Hello John, how are you today?"
  }
}

err · null | string

null on success, or an error message string on failure.

res · object

Hide properties

promptId · string

Unique identifier for the prompt.

name · string

The prompt name as stored in Prompt Hub.

version · string

Semantic version of the returned prompt (e.g. 3.3.3).

tags · string[]

Tags associated with the prompt.

metaProperties · object

Key-value metadata stored alongside the prompt.

prompt · string

The raw prompt text, including any unresolved {{variable}} placeholders.

compiledPrompt · string

The prompt with all variables substituted. Present only when shouldCompile is true.

---

POST /api/vault/get-secrets

Retrieve secrets from Vault. Optionally filter by key or tag.

curl

curl --request POST \
  --url http://127.0.0.1:3000/api/vault/get-secrets \
  --header 'Authorization: Bearer _OPENLIT_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{}'

Request parameters

header.Authorization · string · required

Bearer <api-key> — your OpenLIT API key.

body.key · string

Fetch a single secret by its key (e.g. OPENAI_API_KEY). Omit to fetch all secrets.

body.tags · string[]

Fetch only secrets that have all of the specified tags assigned.

Response

200

{
  "err": null,
  "res": {
    "ANTHROPIC_API_KEY": "ANTHROPIC_API_VALUE",
    "OPENAI_API_KEY": "OPENAI_API_VALUE"
  }
}

err · null | string

null on success, or an error message string on failure.

res · object

A flat object where each key is the secret’s key name and each value is the secret’s value.

---

Prompt Hub

Manage and version prompts in the OpenLIT UI

Vault

Store and manage LLM API keys and secrets centrally