Skip to main content
POST
/
api
/
v2
/
projects
/
{project_id}
/
sessions
/
{session_id}
/
completions
Record Completion
curl --request POST \
  --url https://api.example.com/api/v2/projects/{project_id}/sessions/{session_id}/completions \
  --header 'Content-Type: application/json' \
  --data '
{
  "messages": [
    {
      "content": "<string>",
      "role": "system"
    }
  ],
  "inputs": {},
  "media_inputs": {},
  "tool_schema": [
    {
      "type": "<string>",
      "function": {
        "name": "<string>",
        "description": "<string>",
        "parameters": "<unknown>"
      }
    }
  ],
  "session_info": {
    "custom_metadata": {}
  },
  "trace_info": {
    "trace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "prompt_info": {
    "prompt_template_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "environment": "<string>"
  },
  "call_info": {
    "start_time": 123,
    "end_time": 123,
    "model": "<string>",
    "provider": "<string>",
    "provider_info": {},
    "llm_parameters": {},
    "usage": {
      "prompt_tokens": 123,
      "completion_tokens": 123
    },
    "api_style": "batch"
  },
  "test_run_info": {
    "test_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "test_case_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "eval_results": {},
  "response_info": {
    "function_call_response": {
      "name": "<string>",
      "arguments": "<string>"
    }
  },
  "completion_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "parent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "output_schema": {}
}
'
{
  "completion_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Path Parameters

project_id
string
required
session_id
string
required

Body

application/json
messages
required
inputs
Inputs · object
media_inputs
Media Inputs · object
tool_schema
OpenaiTool · object
session_info
SessionInfo · object
trace_info
TraceInfo · object
prompt_info
PromptInfo · object
call_info
CallInfo · object
test_run_info
TestRunInfo · object
eval_results
Eval Results · object
response_info
ResponseInfo · object
completion_id
string<uuid> | null
parent_id
string<uuid> | null
output_schema
Output Schema · object

Response

201 - application/json
completion_id
string<uuid>
required

The session entry ID