v2

latestOpenAPI 3.1.02026-07-26143251806.6 KB
request

Log Request

post/log-request

Request body

providerstring required
modelstring required
request_start_timestring date-time required
request_end_timestring date-time required
parametersobject

Model parameters including temperature, max_tokens, etc. Can also include structured output configuration via response_format.json_schema. See documentation for structured output examples.

tagsstring[]
metadataobject

Custom key-value pairs for tracking additional request information. Keys are limited to 1024 characters.

prompt_namestring nullable
prompt_idinteger nullable

The ID of the prompt template used for this request. This is useful for tracking which prompt was used in the request.

prompt_version_numberinteger nullable
prompt_input_variablesobject
input_tokensinteger
output_tokensinteger
pricenumber
function_namestring
scoreinteger
api_typestring nullable
status'SUCCESS' | 'WARNING' | 'ERROR'

Request status.

ValueDescription
SUCCESSRequest completed successfully (default)
WARNINGRequest succeeded but had issues (e.g., retries, degraded response)
ERRORRequest failed
error_type'PROVIDER_TIMEOUT' | 'PROVIDER_QUOTA_LIMIT' | 'PROVIDER_RATE_LIMIT' | 'PROVIDER_PARTIAL_RESPONSE' | 'PROVIDER_AUTH_ERROR' | 'PROVIDER_ERROR' | 'TEMPLATE_RENDER_ERROR' | 'VARIABLE_MISSING_OR_EMPTY' | 'UNKNOWN_ERROR' nullable

Categorized error type.

ValueDescriptionAllowed Statuses
PROVIDER_RATE_LIMITRate limit hit on provider APIWARNING, ERROR
PROVIDER_QUOTA_LIMITAccount quota or spending limit exceededWARNING, ERROR
PROVIDER_PARTIAL_RESPONSEProvider returned a successful response, but the saved output may be incomplete, filtered, blocked, malformed, or otherwise partialWARNING
VARIABLE_MISSING_OR_EMPTYRequired template variable was missing or emptyWARNING
PROVIDER_TIMEOUTRequest timed outERROR
PROVIDER_AUTH_ERRORAuthentication failed with providerERROR
PROVIDER_ERRORGeneral provider-side errorERROR
TEMPLATE_RENDER_ERRORFailed to render prompt templateERROR
UNKNOWN_ERRORUncategorized errorWARNING, ERROR
error_messagestring nullable

Detailed error message describing what went wrong. Maximum 1024 characters.

Response

Successful Response

idinteger required
status'SUCCESS' | 'WARNING' | 'ERROR'

Request status indicating success, warning, or error.

error_typestring nullable

Categorized error type if status is WARNING or ERROR.

error_messagestring nullable

Detailed error message if status is WARNING or ERROR.