State

Create/Update state settings(merge).

post/v1/state

Request

  • Base URL: https://apipie.ai
  • URL: https://apipie.ai/v1/state
  • Auth: one of:
    • HTTP bearer
    • API key in header x-api-key

Query parameters

app_namestring

Optional. Enables the ablity for centralized APIkey state management for enterprises.

Request body

enable_user_statesboolean

If true, scope is per-user (user_id + user). If false, scope is per-app (user_id + app label).

userstring

Required when enable_user_states=true. Identifies the end-user.

enable_inline_cliboolean

Enable a command line CLI for state management at the prompt, use ':help' in the prompt to any LLM for more details

gui_onlyboolean

When true, state configuration can only be performed through the APIpie GUI and cannot be edited via API or inline cli for this API key.

deletestring[]

Keys to remove from the existing settings (partial delete). Use POST to perform partial key deletes.

Example request

{
  "user": "12345",
  "settings": {
    "anon": true,
    "max_tokens": 300,
    "memory": true,
    "mem_session": "user123-sessionA",
    "mem_expire": 1440,
    "integrity": 12,
    "model": "openai/gpt-4o-mini",
    "shortMem": 3,
    "longMem": 2,
    "routing": "perf",
    "tools_model": "gpt-4o-mini",
    "user": "user487",
    "tool_choice": "auto",
    "vector_provider": "pinecone",
    "search_whitelist": [
      "apnews.com",
      "bbc.com",
      "reuters.com"
    ],
    "search_blacklist": [
      "cnn.com",
      "foxnews.com"
    ],
    "temperature": 1,
    "top_p": 1,
    "web_search_options": {
      "search_context_size": "medium"
    }
  }
}

Response

Updated state

scope'user' | 'app'
keystring

user (when user scope) or app label (when app scope)

enable_inline_cliboolean

Whether inline CLI is enabled for this state

gui_onlyboolean

When true, state configuration can only be performed through the APIpie GUI and cannot be edited via API or inline cli. Needs to be app scoped (disable user_states).

Example response

{
  "settings": {
    "anon": true,
    "max_tokens": 300,
    "memory": true,
    "mem_session": "user123-sessionA",
    "mem_expire": 1440,
    "integrity": 12,
    "model": "openai/gpt-4o-mini",
    "shortMem": 3,
    "longMem": 2,
    "routing": "perf",
    "tools_model": "gpt-4o-mini",
    "user": "user487",
    "tool_choice": "auto",
    "vector_provider": "pinecone",
    "search_whitelist": [
      "apnews.com",
      "bbc.com",
      "reuters.com"
    ],
    "search_blacklist": [
      "cnn.com",
      "foxnews.com"
    ],
    "temperature": 1,
    "top_p": 1,
    "web_search_options": {
      "search_context_size": "medium"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.