API

Every campaigncleaner.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.

New to Corsair? See API access, authentication, and error handling.

Campaign

delete

campaign.delete Delete a saved Campaign Cleaner campaign by ID Risk: destructive · Irreversible

await corsair.campaigncleaner.api.campaign.delete({});

Input

Name	Type	Required	Description
`campaignId`	`string`	Yes	—

Output

Name	Type	Required	Description
`status`	`success \| failure`	Yes	—
`error`	`string`	No	—

list

campaign.list List saved Campaign Cleaner campaigns Risk: read

await corsair.campaigncleaner.api.campaign.list({});

Input: empty object Output

Name	Type	Required	Description
`campaign_list`	`object[]`	Yes	—

campaign_list full type

{
  id: string,
  campaign_name: string,
  status: processing | completed | paused,
  date_added: string
}[]

pdfAnalysis

campaign.pdfAnalysis Download PDF analysis for a processed campaign Risk: read

await corsair.campaigncleaner.api.campaign.pdfAnalysis({});

Input

Name	Type	Required	Description
`campaignId`	`string`	Yes	—

Output

Name	Type	Required	Description
`content_type`	`string`	Yes	—
`content_base64`	`string`	Yes	—

status

campaign.status Get processing status for a Campaign Cleaner campaign Risk: read

await corsair.campaigncleaner.api.campaign.status({});

Input

Name	Type	Required	Description
`campaignId`	`string`	Yes	—

Output

Name	Type	Required	Description
`campaign_status`	`object`	Yes	—

campaign_status full type

{
  id: string,
  campaign_name: string,
  status: processing | completed | paused,
  date_added: string
}

Credits

get

credits.get Get remaining Campaign Cleaner credits Risk: read

await corsair.campaigncleaner.api.credits.get({});

Input: empty object Output

Name	Type	Required	Description
`credits`	`number`	Yes	—

Overview

Plugins

Campaign

delete

list

pdfAnalysis

status

Credits

get

​Campaign

​delete

​list

​pdfAnalysis

​status

​Credits

​get

Campaign

delete

list

pdfAnalysis

status

Credits

get