Composway Docs
Tool reference

Get task status

Poll the status of a long-running analysis task by the domain record it is linked to (e.g.

Tool name: get_task_status

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.

Poll the status of a long-running analysis task by the domain record it is linked to (e.g. recordType=campaigns with the campaignId). Use to track progress after a create/confirm/attach that kicks off background analysis.

Parameters

ParameterTypeRequiredNotes
recordType"content_analyses" | "serp_snapshots" | "campaigns" | "search_intent_classifications" | "target_ai_prompts" | "workspaces"Yes-
recordIdstring (uuid)Yes-
Full input JSON Schema
{
	"$schema": "https://json-schema.org/draft/2020-12/schema",
	"type": "object",
	"properties": {
		"recordType": {
			"type": "string",
			"enum": [
				"content_analyses",
				"serp_snapshots",
				"campaigns",
				"search_intent_classifications",
				"target_ai_prompts",
				"workspaces"
			]
		},
		"recordId": {
			"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": ["recordType", "recordId"]
}

Response

Full output JSON Schema
{
	"$schema": "https://json-schema.org/draft/2020-12/schema",
	"type": "object",
	"properties": {
		"taskId": {
			"type": "string"
		},
		"status": {
			"type": "string"
		},
		"createdAt": {
			"type": "string"
		},
		"result": {
			"anyOf": [
				{},
				{
					"type": "null"
				}
			]
		},
		"error": {
			"anyOf": [
				{},
				{
					"type": "null"
				}
			]
		},
		"message": {
			"anyOf": [
				{
					"type": "string"
				},
				{
					"type": "null"
				}
			]
		}
	},
	"required": ["taskId", "status", "createdAt"],
	"additionalProperties": false
}

On this page