Skip to main content
POST
/
api
/
parea
/
v1
/
deployed-prompt
p = Parea(api_key="PAREA_API_KEY")  # replace with your API key

def main() -> UseDeployedPromptResponse:
    return p.get_prompt(
        UseDeployedPrompt(
            deployment_id="p-qZrnFesaeCpqcXJ_yL3wi",
            llm_inputs={"x": "Python", "y": "Flask"},
        )
    )

{
  "deployment_id": "<string>",
  "version_number": 123,
  "name": "<string>",
  "functions": [
    "<string>"
  ],
  "function_call": "<string>",
  "prompt": {
    "raw_messages": [
      {}
    ],
    "messages": [
      {}
    ],
    "inputs": {}
  },
  "model": "<string>",
  "provider": "openai",
  "model_params": {}
}
p = Parea(api_key="PAREA_API_KEY")  # replace with your API key

def main() -> UseDeployedPromptResponse:
    return p.get_prompt(
        UseDeployedPrompt(
            deployment_id="p-qZrnFesaeCpqcXJ_yL3wi",
            llm_inputs={"x": "Python", "y": "Flask"},
        )
    )

Authorizations

​
x-user-id
string
header
required

Body

application/json
​
deployment_id
string
required

ID of deployed prompt

​
llm_inputs
Llm Inputs · object

If provided, these key-value pairs will be used to replace the corresponding keys in the templated prompt

Response

Successful Response

​
deployment_id
string
required

This is the ID for a deployed prompt. You can find your deployed prompts on the Deployments tab.

​
version_number
number
required

Version number of the deployed prompt

​
name
string | null

Name of the deployed prompt

​
functions
string[] | null

If deployed prompt has function, these will appear as JSON strings.

​
function_call
string | null

If deployed prompt has a specified function call, it will appear.

​
prompt
PromptSchema · object

The messages of the deployed prompt

​
model
string | null

Model name of deployed prompt

​
provider
enum<string> | null

Provider name of deployed prompt

Available options:
openai,
azure,
anthropic,
anyscale,
vertexai,
aws_bedrock,
openrouter,
mistral,
litellm,
groq,
fireworks,
cohere
​
model_params
Model Params · object

Model parameters of deployed prompt