Getting Started
Observability
Search & Analytics
Prompt Templates
- GETList prompt template versions
- POSTCreate prompt template version by ID
- GETGet prompt template version by ID
- POSTGet bound prompt template version by ID
- DELDelete prompt template version
- POSTUpdate environment for prompt template version
- POSTCreate prompt template version by name
- GETList prompt templates
- POSTCreate prompt template
- GETGet all prompt templates by environment
- GETGet prompt template
- DELDelete prompt template
- PATCHUpdate prompt template
- GETGet prompt template by name and environment
- POSTGet bound prompt template by name and environment
Insights
Evaluation Criteria
- GETList Evaluation Criteria
- POSTCreate Evaluation Criteria
- GETList Code Evaluation Criteria
- POSTCreate Code Evaluation Criteria
- GETGet Code Evaluation Criteria
- DELDelete Code Evaluation Criteria
- PATCHUpdate Code Evaluation Criteria
- PATCHDisable Code Evaluation Criteria
- PATCHEnable Code Evaluation Criteria
- GETList Code Evaluation Criteria Versions
- POSTCreate Code Evaluation Criteria Version
- GETGet Code Evaluation Criteria Version
- POSTPublish Code Evaluation Criteria Version
- GETGet Evaluation Criteria
- DELDelete Evaluation Criteria
- PATCHDisable Criteria
- PATCHEnable Criteria
- PATCHReorder Criteria
- GETList Evaluation Criteria Versions
- POSTCreate Evaluation Criteria Version
- GETGet Evaluation Criteria Version
- DELDelete Evaluation Criteria Version
- POSTDeploy Evaluation Criteria Version
- POSTExecute Evals for Completion
- POSTExecute Evals for Trace
Prompt Datasets
- GETList Prompt Test Cases
- POSTUpload Prompt Test Cases
- GETList Prompt Test Cases by Dataset Name
- GETList Prompt Test Cases
- POSTBulk Create Prompt Test Cases
- DELBulk Delete Prompt Test Cases
- GETGet Prompt Test Case
- DELDelete Prompt Test Case
- PATCHUpdate Prompt Test Case
- GETGet Prompt Dataset
- GETGet Prompt Dataset by Name
- GETList Prompt Datasets
- POSTCreate Prompt-Level Dataset
- GETGet Prompt Dataset
- DELDelete Prompt Dataset
- PATCHUpdate Prompt Dataset
Agent Datasets
Configuration
- POSTCreate Project
- GETList Projects
- GETGet Project
- PUTUpdate Project
- DELDelete Project
- GETList Project Members
- POSTAdd Project Member
- DELRemove Project Member
- PATCHUpdate Project Member
- GETList Environments
- POSTCreate Environment
- DELDelete Environment
- PATCHUpdate Environment
- GETList Users
- POSTCreate User
- GETGet User
- DELDelete User
- PATCHUpdate User
Saved Searches
Prompt Optimization
Review Queues
Update Completion
curl --request POST \
--url https://api.example.com/api/v2/projects/{project_id}/completions/{completion_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"new_messages": [
{
"content": "<string>",
"role": "system"
}
],
"eval_results": null
}
'{
"completion_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}Observability
Update Completion
Append messages or evaluation results to an existing completion. Use for streaming responses or adding post-hoc evaluation metrics.
POST
/
api
/
v2
/
projects
/
{project_id}
/
completions
/
{completion_id}
Update Completion
curl --request POST \
--url https://api.example.com/api/v2/projects/{project_id}/completions/{completion_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"new_messages": [
{
"content": "<string>",
"role": "system"
}
],
"eval_results": null
}
'{
"completion_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
new_messages
(OpenAISystemMessage · object | OpenAIDeveloperMessage · object | OpenAIUserMessage · object | OpenAIAssistantMessage · object | OpenAIToolMessage · object)[]AnthropicMessage · object[]SimpleProviderMessage · object[]VertexMessage · object[]BedrockConverseMessage · object[](OpenAIResponsesMessageItem · object | OpenAIResponsesFunctionCallItem · object | OpenAIResponsesFunctionCallOutputItem · object | OpenAIResponsesReasoningItem · object | OpenAIResponsesBuiltinToolItem · object | SimpleProviderMessage · object)[]
- OpenAISystemMessage
- OpenAIDeveloperMessage
- OpenAIUserMessage
- OpenAIAssistantMessage
- OpenAIToolMessage
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
200 - application/json
RecordCompletionInfo(completion_id: uuid.UUID = FieldInfo(annotation=NoneType, required=True, description='The session entry ID'))
The session entry ID
⌘I