BoxResponse - Scoopika

import { AgentResponse } from "@scoopika/types";

type BoxResponse = {
	name: string;
	run: AgentResponse;
}[];

[
	{
		"name": "AGENT_NAME",
		"run": {
			"run_id": "RUN_1",
			"session_id": "SESSION_1",
			"response": {
				"type": "text",
				"content": "Hey, how can I assist you?"
			}
		}
	}
]

Returned as a box run response.

Props

The box will return an array of objects with the following properties:

name

string

The agent name.

run

AgentResponse

The response returned from the agent run.

Reference to AgentResponse

import { AgentResponse } from "@scoopika/types";

type BoxResponse = {
	name: string;
	run: AgentResponse;
}[];

[
	{
		"name": "AGENT_NAME",
		"run": {
			"run_id": "RUN_1",
			"session_id": "SESSION_1",
			"response": {
				"type": "text",
				"content": "Hey, how can I assist you?"
			}
		}
	}
]

Was this page helpful?

Suggest edits Raise issue

RunHistory BoxData

import { AgentResponse } from "@scoopika/types";

type BoxResponse = {
	name: string;
	run: AgentResponse;
}[];

[
	{
		"name": "AGENT_NAME",
		"run": {
			"run_id": "RUN_1",
			"session_id": "SESSION_1",
			"response": {
				"type": "text",
				"content": "Hey, how can I assist you?"
			}
		}
	}
]

Types

​Props

Props