Create Application Interaction

post https://api.egp.scale.com/v4/interactions/

time	status	user agent
Retrieving recent requests…

Loading…

Body Params

application_variant_id

string

required

Identifier for the application variant that performed this interaction.

thread_id

string

Optional UUID identifying the conversation thread associated with the interaction.The interaction will be associated with the thread if the id represents an existing thread.If the thread with the specified id is not found, a new thread will be created.

input

object

required

The input data for the interaction.

output

object

required

The output data from the interaction.

start_timestamp

date-time

required

Timestamp marking the start of the interaction.

duration_ms

integer

Defaults to 0

Duration of the interaction in milliseconds.

operation_status

string

Defaults to SUCCESS

The outcome status of the interaction.

operation_metadata

object

Optional metadata related to the operation, including custom or predefined keys.

trace_spans

array of objects

List of trace spans associated with the interaction.These spans provide insight into the individual steps taken by nodes involved in generating the output.

Trace Spans

guardrail_results

array of objects

Results of the guardrails executed on the input

Guardrail Results

Headers

x-selected-account-id

string

Responses

Response body

object

application_variant_id

string

required

Identifier for the application variant that performed this interaction.

thread_id

string

input

object

required

The input data for the interaction.

Has additional fields

output

object

required

The output data from the interaction.

Has additional fields

start_timestamp

date-time

required

Timestamp marking the start of the interaction.

duration_ms

integer

Defaults to 0

Duration of the interaction in milliseconds.

operation_status

string

Defaults to SUCCESS

The outcome status of the interaction.

SUCCESS ERROR

operation_metadata

object

Optional metadata related to the operation, including custom or predefined keys.

Has additional fields

trace_spans

array of objects

List of trace span entities associated with the interaction.

Trace Spans

object

node_id

string

required

Identifier for the node that emitted this trace span.

operation_type

string

required

Type of the operation, e.g., RERANKING.

COMPLETION RERANKING RETRIEVAL CUSTOM

operation_status

string

Defaults to SUCCESS

The outcome of the operation performed by this node.

SUCCESS ERROR

start_timestamp

date-time

required

The start time of the step.

end_timestamp

date-time

The end time of the step.

operation_input

object

The JSON representation of the input that this step received.

Has additional fields

operation_output

object

The JSON representation of the output that this step emitted.

Has additional fields

operation_metadata

object

The JSON representation of the metadata insights emitted during execution. This can differ based on different types of operations.

Has additional fields

duration_ms

integer

Defaults to 0

The duration of the operation step in milliseconds.

string

required

Unique identifier for the trace span.

application_interaction_id

string

required

The ID of the application interaction this trace span belongs to.

guardrail_results

array of objects

Results of the guardrails executed on the input

Guardrail Results

object

string

required

guardrail_id

string

required

application_spec_id

string

required

application_variant_id

string

required

application_interaction_id

string

required

policy_id

string

required

severity

string

required

low high

triggered

boolean

required

score

number

required

description

string

result_metadata

object

Has additional fields

created_at

date-time

required

The date and time when the entity was created in ISO format.

guardrail

object

required

policy

object

required

string

required

Unique identifier for the interaction.

Language

Credentials

Header

Request


xxxxxxxxxx
10
1
curl --request POST \
2
     --url https://api.egp.scale.com/v4/interactions/ \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "duration_ms": 0,
8
  "operation_status": "SUCCESS"
9
}
10
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful Response

422Validation Error