API

Every crowterminal.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.

Agent

register

agent.register Self-register an agent and receive a new API key Risk: write

await corsair.crowterminal.api.agent.register({});

Input

Name	Type	Required	Description
`agentName`	`string`	Yes	—
`agentDescription`	`string`	No	—

Output

Name	Type	Required	Description
`success`	`boolean`	No	—
`message`	`string`	No	—
`apiKey`	`string`	No	—
`agentId`	`string`	No	—

Data

getTypes

data.getTypes List the analytics data types each platform accepts Risk: read

await corsair.crowterminal.api.data.getTypes({});

Input: empty object Output

Name	Type	Required	Description
`success`	`boolean`	No	—
`dataTypes`	`object`	Yes	—

dataTypes full type

{
}

ingest

data.ingest Ingest one platform analytics data point Risk: write

await corsair.crowterminal.api.data.ingest({});

Input

Name	Type	Required	Description
`clientId`	`string`	Yes	—
`platform`	`TIKTOK \| INSTAGRAM \| YOUTUBE`	Yes	—
`dataType`	`retention \| demographics \| traffic_sources \| watch_time \| audience_activity \| follower_growth \| video_performance \| sound_performance \| hashtag_performance \| reach_sources \| content_interactions \| story_metrics \| reel_metrics \| subscriber_growth \| click_through_rate \| impression_sources \| end_screen_performance`	Yes	—
`videoId`	`string`	No	—
`data`	`object`	Yes	—
`confidence`	`number`	No	—

data full type

{
}

Output

Name	Type	Required	Description
`success`	`boolean`	No	—

ingestBulk

data.ingestBulk Ingest up to 50 analytics data points at once Risk: write

await corsair.crowterminal.api.data.ingestBulk({});

Input

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

items full type

{
  clientId: string,
  platform: TIKTOK | INSTAGRAM | YOUTUBE,
  dataType: retention | demographics | traffic_sources | watch_time | audience_activity | follower_growth | video_performance | sound_performance | hashtag_performance | reach_sources | content_interactions | story_metrics | reel_metrics | subscriber_growth | click_through_rate | impression_sources | end_screen_performance,
  videoId?: string,
  data: {
  },
  confidence?: number
}[]

Output

Name	Type	Required	Description
`success`	`boolean`	No	—
`total`	`number`	No	—
`results`	`any[]`	No	—

Intelligence

getByokPlatform

intelligence.getByokPlatform Get raw algorithm context without LLM inference charges Risk: read

await corsair.crowterminal.api.intelligence.getByokPlatform({});

Input: empty object Output

Name	Type	Required	Description
`success`	`boolean`	No	—
`platforms`	`string[]`	No	—
`intelligence`	`any`	No	—

getPlatform

intelligence.getPlatform Get TikTok, Instagram and YouTube algorithm insights Risk: read

await corsair.crowterminal.api.intelligence.getPlatform({});

Input: empty object Output

Name	Type	Required	Description
`success`	`boolean`	No	—
`data`	`any`	No	—

Memory

compareMd

memory.compareMd Diff an agent markdown against all stored versions Risk: read

await corsair.crowterminal.api.memory.compareMd({});

Input

Name	Type	Required	Description
`clientId`	`string`	Yes	—
`agentMd`	`object`	Yes	—

agentMd full type

{
}

Output

Name	Type	Required	Description
`success`	`boolean`	No	—
`clientId`	`string`	No	—
`comparison`	`string`	No	—
`message`	`string`	No	—
`recommendation`	`string`	No	—
`differences`	`any[]`	No	—
`missingFields`	`string[]`	No	—

engagementAnalysis

memory.engagementAnalysis Correlate every agent field with historical engagement Risk: read

await corsair.crowterminal.api.memory.engagementAnalysis({});

Input

Name	Type	Required	Description
`clientId`	`string`	Yes	—
`agentMd`	`object`	Yes	—

agentMd full type

{
}

Output

Name	Type	Required	Description
`success`	`boolean`	No	—
`clientId`	`string`	No	—
`analysis`	`string`	No	—
`message`	`string`	No	—
`versionsAnalyzed`	`number`	No	—
`overallStats`	`object`	No	—
`fieldAnalysis`	`any[]`	No	—

overallStats full type

{
}

get

memory.get Get the stored skill for one client Risk: read

await corsair.crowterminal.api.memory.get({});

Input

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

Output

Name	Type	Required	Description
`success`	`boolean`	No	—
`clientId`	`string`	No	—
`clientName`	`string`	No	—
`version`	`number`	No	—
`updatedAt`	`string`	No	—
`skill`	`object`	No	—

skill full type

{
  primaryNiche?: string,
  subNiches?: string[],
  contentStyle?: string,
  signatureStyle?: string,
  hookPatterns?: string[],
  avgEngagement?: number,
  bestPostingTimes?: {
    day?: number,
    hour?: number,
    score?: number
  }[]
}

getBulk

memory.getBulk Read stored skills for up to 50 clients Risk: read

await corsair.crowterminal.api.memory.getBulk({});

Input

Name	Type	Required	Description
`clientIds`	`string[]`	Yes	—

Output

Name	Type	Required	Description
`success`	`boolean`	No	—
`total`	`number`	No	—
`clients`	`object[]`	Yes	—

clients full type

{
  clientId: string,
  success?: boolean,
  skill?: {
    primaryNiche?: string,
    subNiches?: string[],
    contentStyle?: string,
    signatureStyle?: string,
    hookPatterns?: string[],
    avgEngagement?: number,
    bestPostingTimes?: {
      day?: number,
      hour?: number,
      score?: number
    }[]
  } | null
}[]

getChangelog

memory.getChangelog Read the change history of a client skill Risk: read

await corsair.crowterminal.api.memory.getChangelog({});

Input

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

Output

Name	Type	Required	Description
`success`	`boolean`	No	—
`clientId`	`string`	No	—
`message`	`string`	No	—
`changelog`	`any[]`	Yes	—

getPattern

memory.getPattern Trend one skill field across stored versions Risk: read

await corsair.crowterminal.api.memory.getPattern({});

Input

Name	Type	Required	Description
`clientId`	`string`	Yes	—
`field`	`string`	Yes	—

Output

Name	Type	Required	Description
`success`	`boolean`	No	—
`clientId`	`string`	No	—
`field`	`string`	No	—
`trend`	`string`	No	—
`versionsAnalyzed`	`number`	No	—
`dataPoints`	`any[]`	Yes	—

validateChanges

memory.validateChanges Check proposed edits against historical outcomes Risk: read

await corsair.crowterminal.api.memory.validateChanges({});

Input

Name	Type	Required	Description
`clientId`	`string`	Yes	—
`proposedChanges`	`object[]`	Yes	—

proposedChanges full type

{
  field: string,
  oldValue?: any,
  newValue?: any
}[]

Output

Name	Type	Required	Description
`success`	`boolean`	No	—
`clientId`	`string`	No	—
`validation`	`string`	No	—
`message`	`string`	No	—
`warnings`	`any[]`	Yes	—
`recommendations`	`any[]`	Yes	—

Sandbox

engagementAnalysis

sandbox.engagementAnalysis Run a mock engagement analysis Risk: read

await corsair.crowterminal.api.sandbox.engagementAnalysis({});

Input

Name	Type	Required	Description
`agentMd`	`object`	No	—

agentMd full type

{
}

Output

Name	Type	Required	Description
`success`	`boolean`	No	—
`versionsAnalyzed`	`number`	No	—
`overallStats`	`object`	No	—
`fieldAnalysis`	`any[]`	No	—

overallStats full type

{
}

getClient

sandbox.getClient Get mock client data for testing Risk: read

await corsair.crowterminal.api.sandbox.getClient({});

Input: empty object Output

Name	Type	Required	Description
`success`	`boolean`	No	—
`clientId`	`string`	No	—
`clientName`	`string`	No	—
`version`	`number`	No	—
`skill`	`object`	No	—

skill full type

{
  primaryNiche?: string,
  subNiches?: string[],
  contentStyle?: string,
  signatureStyle?: string,
  hookPatterns?: string[],
  avgEngagement?: number,
  bestPostingTimes?: {
    day?: number,
    hour?: number,
    score?: number
  }[]
}

getMemory

sandbox.getMemory Get mock skill data for testing Risk: read

await corsair.crowterminal.api.sandbox.getMemory({});

Input: empty object Output

Name	Type	Required	Description
`success`	`boolean`	No	—
`clientId`	`string`	No	—
`clientName`	`string`	No	—
`version`	`number`	No	—
`skill`	`object`	No	—

skill full type

{
  primaryNiche?: string,
  subNiches?: string[],
  contentStyle?: string,
  signatureStyle?: string,
  hookPatterns?: string[],
  avgEngagement?: number,
  bestPostingTimes?: {
    day?: number,
    hour?: number,
    score?: number
  }[]
}

validate

sandbox.validate Run a mock validation Risk: read

await corsair.crowterminal.api.sandbox.validate({});

Input

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

proposedChanges full type

{
  field: string,
  oldValue?: any,
  newValue?: any
}[]

Output

Name	Type	Required	Description
`success`	`boolean`	No	—
`validation`	`string`	No	—
`warnings`	`any[]`	Yes	—
`recommendations`	`any[]`	Yes	—

Status

get

status.get Get CrowTerminal service health Risk: read

await corsair.crowterminal.api.status.get({});

Input: empty object Output

Name	Type	Required	Description
`status`	`string`	Yes	—
`timestamp`	`string`	No	—
`version`	`string`	No	—
`services`	`object`	No	—
`metrics`	`object`	No	—
`endpoints`	`object`	No	—

services full type

{
}

metrics full type

{
}

endpoints full type

{
}

getComponents

status.getComponents Get per-component health and latency Risk: read

await corsair.crowterminal.api.status.getComponents({});

Input: empty object Output

Name	Type	Required	Description
`timestamp`	`string`	No	—
`components`	`object[]`	Yes	—
`summary`	`object`	No	—

components full type

{
  name: string,
  status: string,
  latency?: string,
  details?: string
}[]

summary full type

{
}

getHistory

status.getHistory Get seven days of uptime points for charting Risk: read

await corsair.crowterminal.api.status.getHistory({});

Input: empty object Output

Name	Type	Required	Description
`timestamp`	`string`	No	—
`period`	`string`	No	—
`dataPoints`	`object[]`	Yes	—
`summary`	`object`	No	—

dataPoints full type

{
  date: string,
  uptime?: number
}[]

summary full type

{
}

getIncidents

status.getIncidents List recent incidents and affected components Risk: read

await corsair.crowterminal.api.status.getIncidents({});

Input: empty object Output

Name	Type	Required	Description
`timestamp`	`string`	No	—
`incidents`	`object[]`	Yes	—
`subscribe`	`string`	No	—

incidents full type

{
  timestamp?: string,
  status?: string,
  duration?: string,
  components?: string[]
}[]

getUptime

status.getUptime Get 24h and 7d uptime percentages Risk: read

await corsair.crowterminal.api.status.getUptime({});

Input: empty object Output

Name	Type	Required	Description
`timestamp`	`string`	No	—
`currentStatus`	`string`	No	—
`uptime`	`object`	Yes	—
`recentIncidents`	`any[]`	No	—

uptime full type

{
}

ping

status.ping Check that CrowTerminal is responding Risk: read

await corsair.crowterminal.api.status.ping({});

Input: empty object Output

Name	Type	Required	Description
`pong`	`boolean`	Yes	—
`timestamp`	`string`	No	—

Webhooks

create

webhooks.create Register a CrowTerminal webhook Risk: write

await corsair.crowterminal.api.webhooks.create({});

Input

Name	Type	Required	Description
`url`	`string`	Yes	—
`events`	`skill.updated \| skill.version_created \| data.ingested \| validation.blocked \| posting.completed \| posting.failed[]`	Yes	—
`secret`	`string`	No	—

Output

Name	Type	Required	Description
`success`	`boolean`	No	—
`id`	`string`	No	—
`secret`	`string`	No	—

delete

webhooks.delete Delete a CrowTerminal webhook Risk: destructive · Irreversible

await corsair.crowterminal.api.webhooks.delete({});

Input

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

Output

Name	Type	Required	Description
`success`	`boolean`	No	—

list

webhooks.list List registered CrowTerminal webhooks Risk: read

await corsair.crowterminal.api.webhooks.list({});

Input: empty object Output

Name	Type	Required	Description
`success`	`boolean`	No	—
`webhooks`	`object[]`	Yes	—

webhooks full type

{
  id?: string
}[]

test

webhooks.test Send a test delivery to a webhook URL Risk: write

await corsair.crowterminal.api.webhooks.test({});

Input

Name	Type	Required	Description
`url`	`string`	Yes	—
`secret`	`string`	No	—

Output

Name	Type	Required	Description
`success`	`boolean`	No	—

update

webhooks.update Update a CrowTerminal webhook Risk: write

await corsair.crowterminal.api.webhooks.update({});

Input

Name	Type	Required	Description
`webhookId`	`string`	Yes	—
`url`	`string`	No	—
`events`	`skill.updated \| skill.version_created \| data.ingested \| validation.blocked \| posting.completed \| posting.failed[]`	No	—
`isActive`	`boolean`	No	—

Output

Name	Type	Required	Description
`success`	`boolean`	No	—

Overview

Plugins

Agent

register

Data

getTypes

ingest

ingestBulk

Intelligence

getByokPlatform

getPlatform

Memory

compareMd

engagementAnalysis

get

getBulk

getChangelog

getPattern

validateChanges

Sandbox

engagementAnalysis

getClient

getMemory

validate

Status

get

getComponents

getHistory

getIncidents

getUptime

ping

Webhooks

create

delete

list

test

update

​Agent

​register

​Data

​getTypes

​ingest

​ingestBulk

​Intelligence

​getByokPlatform

​getPlatform

​Memory

​compareMd

​engagementAnalysis

​get

​getBulk

​getChangelog

​getPattern

​validateChanges

​Sandbox

​engagementAnalysis

​getClient

​getMemory

​validate

​Status

​get

​getComponents

​getHistory

​getIncidents

​getUptime

​ping

​Webhooks

​create

​delete

​list

​test

​update

Agent

register

Data

getTypes

ingest

ingestBulk

Intelligence

getByokPlatform

getPlatform

Memory

compareMd

engagementAnalysis

get

getBulk

getChangelog

getPattern

validateChanges

Sandbox

engagementAnalysis

getClient

getMemory

validate

Status

get

getComponents

getHistory

getIncidents

getUptime

ping

Webhooks

create

delete

list

test

update