import type { AgentData } from "@scoopika/types";

{
	"id": "AGENT_1",
	"name": "agent_name",
	"description": "agent description",
	"avatar": "IMG_URL",
	"chained": false,
	"prompts": [],
	"tools": []
}

AgentData represents the information of an agent within Scoopika.

​
Useful Props

id
string

The agent ID.

name
string

The agent name.

avatar
string | undefined

The agent avatar. usually a url, but if you use the AI generated avatars in the platform till will actually be in base64.

description
string

The agent description.

​
Props Not For Developer Interaction

The following properties are included for informational purposes only and are not intended for direct developer interaction:

prompts
Prompt[]

The prompts the agent has, you won’t need to deal with this one,

tools
ToolSchema[]

A list of tools the agent has, you won’t need to deal with this one too and it’s only used by the Box instance under the hood.

chained
boolean
deprecated

If the agent uses prompt chaining. this feature was removed.

wanted_responses
string[]
deprecated

The wanted prompts response to return from the agent. this feature was removed.

timeout
number | undefined

This is not being used for now.

import type { AgentData } from "@scoopika/types";

{
	"id": "AGENT_1",
	"name": "agent_name",
	"description": "agent description",
	"avatar": "IMG_URL",
	"chained": false,
	"prompts": [],
	"tools": []
}

Was this page helpful?

AgentResponseAudioRes