Composway Docs
Tool reference

Get entity list

Get the extracted entity list for a campaign.

Tool name: get_campaign_entities

Cost: Free - not billed, and does not draw on a plan quota.

Read-only

This tool only reads. It never creates or changes anything, so an assistant may call it without asking you first.

Get the extracted entity list for a campaign.

Parameters

ParameterTypeRequiredNotes
campaignIdstring (uuid)Yes-
Full input JSON Schema
{
	"$schema": "https://json-schema.org/draft/2020-12/schema",
	"type": "object",
	"properties": {
		"campaignId": {
			"type": "string",
			"format": "uuid",
			"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
		}
	},
	"required": ["campaignId"]
}

Response

Full output JSON Schema
{
	"$schema": "https://json-schema.org/draft/2020-12/schema",
	"type": "object",
	"properties": {
		"data": {
			"type": "object",
			"propertyNames": {
				"type": "string"
			},
			"additionalProperties": {
				"type": "object",
				"properties": {},
				"additionalProperties": {}
			}
		},
		"prompt": {
			"anyOf": [
				{
					"type": "string"
				},
				{
					"type": "null"
				}
			]
		},
		"queriesFanOut": {
			"anyOf": [
				{
					"type": "array",
					"items": {
						"type": "object",
						"properties": {},
						"additionalProperties": {}
					}
				},
				{
					"type": "null"
				}
			]
		}
	},
	"required": ["data"],
	"additionalProperties": false
}

On this page