Stream Completion

curl --request POST \
  --url https://parea-ai-backend-us-9ac16cdbc7a7b006.onporter.run/api/parea/v1/api/parea/v1/completion/stream \
  --header 'Content-Type: application/json' \
  --header 'x-user-id: <api-key>' \
  --data '
{
  "llm_inputs": {},
  "llm_configuration": {},
  "project_name": "default",
  "project_uuid": "<string>",
  "experiment_uuid": "<string>",
  "parent_trace_id": "<string>",
  "root_trace_id": "<string>",
  "end_user_identifier": "<string>",
  "deployment_id": "<string>",
  "eval_metric_ids": [
    123
  ],
  "metadata": {},
  "tags": [
    "<string>"
  ],
  "target": "<string>",
  "trace_id": "<string>",
  "trace_name": "<string>",
  "provider_api_key": "<string>",
  "cache": true,
  "log_omit_inputs": false,
  "log_omit_outputs": false,
  "log_omit": false,
  "log_sample_rate": 1,
  "inference_id": "<string>",
  "name": "<string>",
  "retry": false,
  "fallback_strategy": [
    "<string>"
  ],
  "stream": false
}
'

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

POST

api

parea

completion

stream

Stream Completion

curl --request POST \
  --url https://parea-ai-backend-us-9ac16cdbc7a7b006.onporter.run/api/parea/v1/api/parea/v1/completion/stream \
  --header 'Content-Type: application/json' \
  --header 'x-user-id: <api-key>' \
  --data '
{
  "llm_inputs": {},
  "llm_configuration": {},
  "project_name": "default",
  "project_uuid": "<string>",
  "experiment_uuid": "<string>",
  "parent_trace_id": "<string>",
  "root_trace_id": "<string>",
  "end_user_identifier": "<string>",
  "deployment_id": "<string>",
  "eval_metric_ids": [
    123
  ],
  "metadata": {},
  "tags": [
    "<string>"
  ],
  "target": "<string>",
  "trace_id": "<string>",
  "trace_name": "<string>",
  "provider_api_key": "<string>",
  "cache": true,
  "log_omit_inputs": false,
  "log_omit_outputs": false,
  "log_omit": false,
  "log_sample_rate": 1,
  "inference_id": "<string>",
  "name": "<string>",
  "retry": false,
  "fallback_strategy": [
    "<string>"
  ],
  "stream": false
}
'

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

x-user-id

string

header

required

Body

application/json

llm_inputs

Llm Inputs · object

Key-value pairs as inputs to prompt template. Only needs to be provided if deployment_id is provided or llm_configuration.messages are templated.

llm_configuration

LLMInputsSchema · object

LLM configuration parameters such as messages, functions, etc.

Show child attributes

llm_configuration.model

string | null

Model name

llm_configuration.provider

enum<string> | null

Provider name

Available options:

openai,

azure,

anthropic,

anyscale,

vertexai,

aws_bedrock,

openrouter,

mistral,

litellm,

groq,

fireworks,

cohere

llm_configuration.model_params

ModelParamsSchema · object

Model parameters

Show child attributes

llm_configuration.model_params.model

string | null

default:""

Model name

llm_configuration.model_params.temp

number | null

default:1

Temperature

Required range: 0 <= x <= 1

llm_configuration.model_params.top_p

number | null

default:1

Top p

Required range: 0 <= x <= 1

llm_configuration.model_params.frequency_penalty

number | null

default:0

Frequency penalty

Required range: -2 <= x <= 2

llm_configuration.model_params.presence_penalty

number | null

default:0

Presence penalty

Required range: -2 <= x <= 2

llm_configuration.model_params.max_length

integer | null

Max length of the output

llm_configuration.model_params.response_format

Response Format · object

Response format

llm_configuration.model_params.safe_prompt

boolean | null

Safe prompt. Only used for Mistral

llm_configuration.messages

MessageSchema · object[] | null

List of messages

Show child attributes

llm_configuration.messages.content

default:""

Message content

llm_configuration.messages.role

enum<string>

default:user

Message role

Available options:

user,

assistant,

system,

user,

assistant,

function,

tool

llm_configuration.history

MessageSchema · object[] | null

List of history messages which are prepended to messages. Useful for chatbot applications which rely on deployed prompts.

Show child attributes

llm_configuration.history.content

default:""

Message content

llm_configuration.history.role

enum<string>

default:user

Message role

Available options:

user,

assistant,

system,

user,

assistant,

function,

tool

llm_configuration.functions

any[] | null

List of function schemas, following the OpenAI API format

llm_configuration.function_call

Optionally, specify the fnction call, following OpenAI API behavior.

project_name

string | null

default:default

Project name which is used to associate the log with a project.

project_uuid

string | null

Project UUID which is used to associate the log with a project. Does not need to be provided if the project_name is provided.

experiment_uuid

string | null

Experiment UUID which is used to associate the log with an experiment.

parent_trace_id

string | null

UUID of the parent log. If given, will be used to associate the generation in a chain & create hierarchical nested logs.

root_trace_id

string | null

UUID of the root log. If given, will be used to associate the generation in a chain & create hierarchical nested logs.

end_user_identifier

string | null

Special field to track the end user which is interacting with your LLM app.

deployment_id

string | null

This is the ID for a specific deployed prompt. You can find your deployed prompts on the Deployments tab. If a deployment_id is provided, Parea will fetch all of the associated configuration including model name, model parameters, and any associated functions. Any information provided on the llm_configuration field will be used instead of the associated deployed prompts fields.

eval_metric_ids

integer[] | null

List of evaluation metric IDs deployed on Parea which should be used to evaluate the completion output.

metadata

Metadata · object

Key-value pairs to be associated with the log.

Response

Successful Response

Completion Fetch Deployed Prompt

⌘I

General

Tracing

Experiments

LLM Proxy

Datasets

SDK

Stream Completion

Authorizations

Body

Response