Parea AI Parea API
The Parea API from Parea AI — 19 operation(s) for parea.
The Parea API from Parea AI — 19 operation(s) for parea.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/parea-parea-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: AI REST Parea API
version: 1.0.0
description: The Parea AI REST API provides programmatic access to the Parea platform, including trace logging for LLM calls, experiment creation and management, dataset operations, LLM proxy completions, and project management. Authentication is performed via the x-api-key header.
contact:
url: https://www.parea.ai/
email: support@parea.ai
license:
name: Proprietary
servers:
- url: https://parea-ai-backend-us-9ac16cdbc7a7b006.onporter.run
description: Parea AI US Production
security:
- APIKeyHeader: []
tags:
- name: Parea
paths:
/api/parea/v1/:
get:
summary: Health Check
operationId: health_check_api_parea_v1__get
responses:
'200':
description: Successful Response
content:
application/json:
schema:
additionalProperties:
type: string
type: object
title: Response Health Check Api Parea V1 Get
security:
- APIKeyHeader: []
- APIKeyHeader: []
- APIKeyHeader: []
tags:
- Parea
/api/parea/v1/completion:
post:
summary: Completion
description: 'Get a completion response using either one of your organization’s deployed prompts, or by providing completion details including prompt and inputs in the request.
This endpoint acts as a LLM gateway/proxy endpoint to generate completions from different LLMs.'
operationId: completion_api_parea_v1_completion_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CompletionsSchema'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/CompletionsResponseSchema'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- APIKeyHeader: []
- APIKeyHeader: []
- APIKeyHeader: []
tags:
- Parea
/api/parea/v1/completion/stream:
post:
summary: Stream Completion
description: 'Get a completion response using either one of your organization’s deployed prompts, or by providing completion details including prompt and inputs in the request.
This endpoint acts as a LLM gateway/proxy endpoint to generate completions from different LLMs.'
operationId: stream_completion_api_parea_v1_completion_stream_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CompletionsSchema'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- APIKeyHeader: []
- APIKeyHeader: []
- APIKeyHeader: []
tags:
- Parea
/api/parea/v1/deployed-prompt:
post:
summary: Fetch Deployed Prompt
description: Given a deployment_id, fetches the deployed prompt and its details. Can be optionally used to fill-in the templated prompt with provided inputs.
operationId: fetch_deployed_prompt_api_parea_v1_deployed_prompt_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeploymentPromptIdSchema'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/GetDeployedPromptResponseSchema'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- APIKeyHeader: []
- APIKeyHeader: []
- APIKeyHeader: []
tags:
- Parea
/api/parea/v1/feedback:
post:
summary: Record Feedback
description: Record any (user) feedback & ground truth/correction of output for a log.
operationId: record_feedback_api_parea_v1_feedback_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FeedbackRequestSchema'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- APIKeyHeader: []
- APIKeyHeader: []
- APIKeyHeader: []
tags:
- Parea
/api/parea/v1/trace_log:
put:
summary: Update Trace Log
description: Update fields of a trace log.
operationId: update_trace_log_api_parea_v1_trace_log_put
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateLogSchema'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- APIKeyHeader: []
- APIKeyHeader: []
- APIKeyHeader: []
tags:
- Parea
post:
summary: Record Trace Log
description: Log a (LLM) span to visualize inference results, or chains.
operationId: record_trace_log_api_parea_v1_trace_log_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TraceLogSchema'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- APIKeyHeader: []
- APIKeyHeader: []
- APIKeyHeader: []
tags:
- Parea
/api/parea/v1/trace_log/langchain:
post:
summary: Record Langchain Trace Log
operationId: record_langchain_trace_log_api_parea_v1_trace_log_langchain_post
requestBody:
content:
application/json:
schema:
type: object
title: Run
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- APIKeyHeader: []
- APIKeyHeader: []
- APIKeyHeader: []
tags:
- Parea
/api/parea/v1/experiment:
post:
summary: Create Experiment Api
description: Create an experiment and get the associated experiment uuid.
operationId: create_experiment_api_api_parea_v1_experiment_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateExperimentRequestSchema'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ExperimentSchema'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- APIKeyHeader: []
- APIKeyHeader: []
- APIKeyHeader: []
tags:
- Parea
/api/parea/v1/experiment/{experiment_uuid}/stats:
get:
summary: Get Experiment Stats Api
description: Fetches aggregated stats for every root-level trace log in an experiment.
operationId: get_experiment_stats_api_api_parea_v1_experiment__experiment_uuid__stats_get
security:
- APIKeyHeader: []
- APIKeyHeader: []
- APIKeyHeader: []
parameters:
- name: experiment_uuid
in: path
required: true
schema:
type: string
title: Experiment Uuid
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ExperimentStatsSchema'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Parea
/api/parea/v1/experiment/{experiment_uuid}/finished:
post:
summary: Finish Experiment Api
description: Finishes an experiment, calculates stats and returns all stats for root trace logs
operationId: finish_experiment_api_api_parea_v1_experiment__experiment_uuid__finished_post
security:
- APIKeyHeader: []
- APIKeyHeader: []
- APIKeyHeader: []
parameters:
- name: experiment_uuid
in: path
required: true
schema:
type: string
title: Experiment Uuid
requestBody:
content:
application/json:
schema:
title: Finish Experiment Request
$ref: '#/components/schemas/FinishExperimentRequestSchema'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ExperimentStatsSchema'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Parea
/api/parea/v1/project:
post:
summary: Create Or Get Project Api
description: Create a project or get the project if it already exists. Is used to find out UUID of project.
operationId: create_or_get_project_api_api_parea_v1_project_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateGetProjectRequestSchema'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/CreateGetProjectResponseSchema'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- APIKeyHeader: []
- APIKeyHeader: []
- APIKeyHeader: []
tags:
- Parea
/api/parea/v1/collection/{test_collection_identifier}:
get:
summary: Get Test Case Collection By Identifier
description: "Fetches dataset/test case collection by its ID or name.\n\nArgs:\n test_collection_identifier (Union[str, int]): ID or name of the test case collection/dataset."
operationId: get_test_case_collection_by_identifier_api_parea_v1_collection__test_collection_identifier__get
security:
- APIKeyHeader: []
- APIKeyHeader: []
- APIKeyHeader: []
parameters:
- name: test_collection_identifier
in: path
required: true
schema:
anyOf:
- type: string
- type: integer
title: Test Collection Identifier
responses:
'200':
description: Successful Response
content:
application/json:
schema:
title: Response Get Test Case Collection By Identifier Api Parea V1 Collection Test Collection Identifier Get
$ref: '#/components/schemas/GetTestCaseCollectionResponseSchema'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Parea
/api/parea/v1/collection:
post:
summary: Create Collection
description: Creates a dataset
operationId: create_collection_api_parea_v1_collection_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateTestCaseCollectionRequestSchema'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/CreateTestCaseCollectionResponseSchema'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- APIKeyHeader: []
- APIKeyHeader: []
- APIKeyHeader: []
tags:
- Parea
/api/parea/v1/testcases:
post:
summary: Create Test Cases For Dataset
description: "Adds items/test cases to a dataset. If the dataset does not exist, it will be created.\nReturns the IDs of the created items/test cases.\n\nReturns:\n List[int]: List of IDs of the created items/test cases."
operationId: create_test_cases_for_dataset_api_parea_v1_testcases_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateTestCasesSchema'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
items:
type: integer
type: array
title: Response Create Test Cases For Dataset Api Parea V1 Testcases Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- APIKeyHeader: []
- APIKeyHeader: []
- APIKeyHeader: []
tags:
- Parea
/api/parea/v1/trace_log/{trace_id}:
get:
summary: Get Trace Log Api
description: Fetches a trace log by its UUID.
operationId: get_trace_log_api_api_parea_v1_trace_log__trace_id__get
security:
- APIKeyHeader: []
- APIKeyHeader: []
- APIKeyHeader: []
parameters:
- name: trace_id
in: path
required: true
schema:
type: string
title: Trace Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
title: Response Get Trace Log Api Api Parea V1 Trace Log Trace Id Get
$ref: '#/components/schemas/TraceLogTreeSchema'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Parea
/api/parea/v1/experiments:
post:
summary: List Experiments Api
description: Lists experiments given a set of filters incl. their high-level statistics.
operationId: list_experiments_api_api_parea_v1_experiments_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ListExperimentsRequestSchema'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ExperimentWithStatsSchema'
type: array
title: Response List Experiments Api Api Parea V1 Experiments Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- APIKeyHeader: []
- APIKeyHeader: []
- APIKeyHeader: []
tags:
- Parea
/api/parea/v1/experiment/{experiment_uuid}/trace_logs:
post:
summary: Get Experiment Trace Logs Api
description: "Fetches all trace logs for an experiment.\n\nArgs:\n experiment_uuid (str): UUID of the experiment.\n\nReturns:\n list[TraceLogTreeSchema]: List of trace logs for the experiment."
operationId: get_experiment_trace_logs_api_api_parea_v1_experiment__experiment_uuid__trace_logs_post
security:
- APIKeyHeader: []
- APIKeyHeader: []
- APIKeyHeader: []
parameters:
- name: experiment_uuid
in: path
required: true
schema:
type: string
title: Experiment Uuid
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/FilterBaseSchema'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TraceLogTreeSchema'
title: Response Get Experiment Trace Logs Api Api Parea V1 Experiment Experiment Uuid Trace Logs Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Parea
/api/parea/v1/get_trace_logs:
post:
summary: Get Trace Logs Api
description: Fetches trace logs and returns them as a paginated response.
operationId: get_trace_logs_api_api_parea_v1_get_trace_logs_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/QueryParamsPaginationPublic'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedResponse_TraceLogTreeSchema_'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- APIKeyHeader: []
- APIKeyHeader: []
- APIKeyHeader: []
tags:
- Parea
/api/parea/v1/update_test_case/{dataset_id}/{test_case_id}:
post:
summary: Update Test Case
description: "Update the item/test case of the dataset with any given fields.\n\nArgs:\n dataset_id (int): ID of the dataset.\n test_case_id (int): ID of the item/test case.\n update_test_case_request (UpdateTestCasePublicRequestSchema): Request body containing the fields to update."
operationId: update_test_case_api_parea_v1_update_test_case__dataset_id___test_case_id__post
security:
- APIKeyHeader: []
- APIKeyHeader: []
- APIKeyHeader: []
parameters:
- name: dataset_id
in: path
required: true
schema:
type: integer
title: Dataset Id
- name: test_case_id
in: path
required: true
schema:
type: integer
title: Test Case Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateTestCasePublicRequestSchema'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Parea
components:
schemas:
CompletionsResponseSchema:
properties:
content:
type: string
title: Content
description: Generated completion content.
latency:
type: number
title: Latency
description: Latency of the completion in seconds.
input_tokens:
type: integer
title: Input Tokens
description: Number of tokens in the input.
output_tokens:
type: integer
title: Output Tokens
description: Number of tokens in the output.
total_tokens:
type: integer
title: Total Tokens
description: Total number of tokens in the input and output.
cost:
type: number
title: Cost
description: Cost of the completion in USD.
model:
type: string
title: Model
description: Model name.
provider:
type: string
title: Provider
description: Provider name.
cache_hit:
type: boolean
title: Cache Hit
description: If true, the completion was fetched from the cache.
status:
type: string
title: Status
description: Status of the completion. Either 'success' or 'error'.
error:
title: Error
description: Error message if the completion failed.
type:
- string
- 'null'
trace_id:
title: Trace Id
description: UUID of the log of the completion. Will be the same as the `trace_id` in the request if provided.
type:
- string
- 'null'
start_timestamp:
type: string
title: Start Timestamp
description: Start timestamp of the completion.
end_timestamp:
type: string
title: End Timestamp
description: End timestamp of the completion.
inference_id:
type: string
title: Inference Id
description: UUID of the log of the completion. The same as the `trace_id` in the request if provided.
type: object
required:
- content
- latency
- input_tokens
- output_tokens
- total_tokens
- cost
- model
- provider
- cache_hit
- status
- start_timestamp
- end_timestamp
- inference_id
title: CompletionsResponseSchema
example:
cache_hit: true
content: Sure! Here's a simple Hello World program...
cost: 0.0008
end_timestamp: '2024-07-24 18:05:17'
input_tokens: 22
latency: 0.0
model: gpt-4o-mini-2024-07-18
output_tokens: 189
start_timestamp: '2024-07-24 18:05:17'
status: success
total_tokens: 211
trace_id: ush221-d23rfcasc-21cdsc
LLMInputsSchema:
properties:
model:
title: Model
description: Model name
type:
- string
- 'null'
provider:
description: Provider name
$ref: '#/components/schemas/ProviderName'
model_params:
description: Model parameters
$ref: '#/components/schemas/ModelParamsSchema'
messages:
title: Messages
description: List of messages
items:
$ref: '#/components/schemas/MessageSchema'
type:
- array
- 'null'
history:
title: History
description: List of history messages which are prepended to messages. Useful for chatbot applications which rely on deployed prompts.
items:
$ref: '#/components/schemas/MessageSchema'
type:
- array
- 'null'
functions:
title: Functions
description: List of function schemas, following the OpenAI API format
items: {}
type:
- array
- 'null'
function_call:
anyOf:
- type: string
- additionalProperties:
type: string
type: object
title: Function Call
description: Optionally, specify the fnction call, following OpenAI API behavior.
type: object
title: LLMInputsSchema
InputsSchema-Input:
properties:
model:
title: Model
description: Model name
type:
- string
- 'null'
provider:
title: Provider
description: Provider name
type:
- string
- 'null'
model_params:
description: Parameters such as temperature.
$ref: '#/components/schemas/ParamsSchema'
messages:
title: Messages
description: Messages to LLM
items:
$ref: '#/components/schemas/MessageSchema'
type:
- array
- 'null'
functions:
title: Functions
description: A list of functions the model may generate JSON inputs for. Assumes every item in list has key 'name', 'description' and 'parameters'
items: {}
type:
- array
- 'null'
function_call:
anyOf:
- type: string
- type: object
title: Function Call
description: "Controls how the model responds to function calls. “autoâ€\x9D means the model can pick between an end-user or calling a function. To specifying a particular function name use a dictionary with key=“nameâ€\x9D and value=“my_functionâ€\x9D. This will force the model to call that function."
type: object
title: InputsSchema
description: Inputs for LLM inference such as messages, functions and additional parameters.
CreateGetProjectRequestSchema:
properties:
name:
type: string
title: Name
description: Name of the project
type: object
required:
- name
title: CreateGetProjectRequestSchema
examples:
- name: development
ProviderName:
type: string
enum:
- openai
- azure
- anthropic
- anyscale
- vertexai
- aws_bedrock
- openrouter
- mistral
- litellm
- groq
- fireworks
- cohere
title: ProviderName
MessageSchema:
properties:
content:
anyOf:
- type: string
- items: {}
type: array
title: Content
description: Message content
default: ''
role:
allOf:
- $ref: '#/components/schemas/Role'
description: Message role
default: user
type: object
title: MessageSchema
UpdateTestCasePublicRequestSchema:
properties:
inputs:
title: Inputs
description: Key-value pairs for the inputs of that item
type:
- object
- 'null'
target:
title: Target
description: Target/ground truth value for the item
type:
- string
- 'null'
tags:
title: Tags
description: Tags for the item
items:
type: string
type:
- array
- 'null'
type: object
title: UpdateTestCasePublicRequestSchema
description: Any set field will be used to update the item in the dataset.
examples:
- inputs:
framework: gin
language: golang
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
type: object
required:
- loc
- msg
- type
title: ValidationError
CreateTestCaseCollectionResponseSchema:
properties:
id:
type: integer
title: Id
description: Unique identifier for the dataset
last_updated_at:
type: string
title: Last Updated At
description: Timestamp when the dataset was last updated
test_case_ids:
items:
type: integer
type: array
title: Test Case Ids
description: List of created test case IDs in the dataset
type: object
required:
- id
- last_updated_at
- test_case_ids
title: CreateTestCaseCollectionResponseSchema
examples:
- id: 5000
last_updated_at: '2021-06-01T00:00:00Z'
test_case_ids:
- 12345
FeedbackRequestSchema:
properties:
trace_id:
title: Trace Id
description: UUID of the trace log
type:
- string
- 'null'
inference_id:
title: Inference Id
description: UUID of the trace log
type:
- string
- 'null'
score:
type: number
maximum: 1.0
minimum: 0.0
title: Score
description: Feedback score
comment:
title: Comment
description: Feedback comment
type:
- string
- 'null'
target:
title: Target
description: "Optional target or “gold standardâ€\x9D of log."
type:
- string
- 'null'
organization_id:
title: Organization Id
description: Field will be automatically filled-in.
type:
- string
- 'null'
name:
title: Name
description: Deprecated field
type:
- string
- 'null'
type: object
required:
- score
title: FeedbackRequestSchema
examples:
- name: test
score: 0.5
target: perfect answer
trace_id: sasdc-csd-rnFesaeCpqcXJ_yL3wi
CreateExperimentRequestSchema:
properties:
name:
type: string
title: Name
description: Name of the experiment
run_name:
title: Run Name
description: Name of the run. Must be unique for each experiment and can only contain alphanumeric characters, hyphens, and underscores.
type:
- string
- 'null'
project_uuid:
type: string
title: Project Uuid
description: UUID of the project associated with this experiment
is_public:
type: boolean
title: Is Public
description: If experiment should be public
default: false
metadata:
title: Metadata
description: Any additional key-value pairs which provide context or are useful for filtering.
additionalProperties:
type: string
type:
- object
- 'null'
type: object
required:
- name
- project_uuid
title: CreateExperimentRequestSchema
examples:
- metadata:
dataset: dev 123
name: Test Experiment
project_uuid: '...'
run_name: test-experiment
GetDeployedPromptResponseSchema:
properties:
deployment_id:
type: string
title: Deployment Id
description: This is the ID for a deployed prompt. You can find your deployed prompts on the Deployments tab.
version_number:
type: number
title: Version Number
description: Version number of the deployed prompt
name:
title: Name
description: Name of the deployed prompt
type:
- string
# --- truncated at 32 KB (93 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/parea/refs/heads/main/openapi/parea-parea-api-openapi.yml