Research and cited briefs

Read a selected research corpus overview

Read deterministic counts for an exact sealed corpus; selected items are not audience or market size. Requires agent:research.

POST /research-api/projects/overview

Contract reviewed: 2026-11-03 · sha256:ab393e91e9b7f18a

Read as Markdown Download public contract Download OpenAPI

Overview

Read deterministic counts for an exact sealed corpus; selected items are not audience or market size. Requires agent:research.

A successful HTTP response can mean that a request was accepted rather than completed. For background work, save the returned ID and check the same operation until it finishes. A scheduled or accepted post is published only when the platform confirms it; a client timeout does not establish the result.

Authentication and permissions

Accepted credential classes: user_session, delegated_oauth, personal_access_token
Delegated capability: agent:research
Minimum workspace role: viewer
Access scope: Resources this user is authorized to access
All-workspace consent required: No
Changes state: No
When the operation is complete: currently authorized exact Research resource data

A token can use only the rights held by its owner. Each request checks workspace membership, resource ownership, selected workspaces and granted capabilities. Core and full profiles change which tools are displayed; they do not grant access.

Request fields

Required means required inside its parent object and selected branch. A required child does not make an optional parent required. Rules and field names below are copied from the contract.

Request fields
Field / branch	Type / required	Constraints
`$`	`object`Required in parent	`additionalProperties: false`
`workspace_id`	`string`Required in parent	`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)$"`
`project_id`	`string`Required in parent	`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)$"`
`project_revision`	`integer`Required in parent	`maximum: 9007199254740991` `exclusiveMinimum: 0`
`corpus_snapshot_id`	`string`Required in parent	`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)$"`

Complete JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "workspace_id": {
      "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)$"
    },
    "project_id": {
      "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)$"
    },
    "project_revision": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "corpus_snapshot_id": {
      "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": [
    "workspace_id",
    "project_id",
    "project_revision",
    "corpus_snapshot_id"
  ],
  "additionalProperties": false
}

Response and completion

Success HTTP statuses: 200. When the operation is complete: currently authorized exact Research resource data.

Required means required inside its parent object and selected branch. A required child does not make an optional parent required. Rules and field names below are copied from the contract.

Response and completion
Field / branch	Type / required	Constraints
`$`	`object`Required in parent	—
`project_id`	`string`Required in parent	`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)$"`
`project_revision`	`integer`Required in parent	`maximum: 9007199254740991` `exclusiveMinimum: 0`
`corpus_snapshot_id`	`string`Required in parent	`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)$"`
`method_version`	`string`Required in parent	`const: "literal-mentions/v1"`
`coverage`	`string`Required in parent	`enum: ["supplied_set","bounded_sample","partial"]`
`evidence_count`	`integer`Required in parent	`minimum: 0` `maximum: 9007199254740991`
`unique_items`	`integer`Required in parent	`minimum: 0` `maximum: 9007199254740991`
`brand_union_count`	`integer`Required in parent	`minimum: 0` `maximum: 9007199254740991`
`overlap_count`	`integer`Required in parent	`minimum: 0` `maximum: 9007199254740991`
`brands`	`array`Required in parent	`maxItems: 20`
`brands[]`	`object`Optional / item	—
`brands[].id`	`string`Required in parent	`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)$"`
`brands[].name`	`string`Required in parent	`minLength: 1` `maxLength: 100`
`brands[].matched_items`	`integer`Required in parent	`minimum: 0` `maximum: 9007199254740991`
`brands[].observed_mention_share`	`number \| null`Required in parent	—
`brands[].observed_mention_share`anyOf 1	`number`Required in parent	`minimum: 0` `maximum: 1`
`brands[].observed_mention_share`anyOf 2	`null`Required in parent	—
`brands[].evidence`	`array`Required in parent	`maxItems: 500`
`brands[].evidence[]`	`object`Optional / item	—
`brands[].evidence[].evidence_id`	`string`Required in parent	`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)$"`
`brands[].evidence[].revision`	`integer`Required in parent	`maximum: 9007199254740991` `exclusiveMinimum: 0`
`languages`	`array`Required in parent	`maxItems: 501`
`languages[]`	`object`Optional / item	—
`languages[].language`	`string \| null`Required in parent	—
`languages[].language`anyOf 1	`string`Required in parent	`minLength: 1` `maxLength: 35`
`languages[].language`anyOf 2	`null`Required in parent	—
`languages[].item_count`	`integer`Required in parent	`minimum: 0` `maximum: 9007199254740991`
`platforms`	`array`Required in parent	`maxItems: 8`
`platforms[]`	`object`Optional / item	—
`platforms[].platform`	`string \| null`Required in parent	—
`platforms[].platform`anyOf 1	`string`Required in parent	`enum: ["threads","instagram","facebook","youtube","x","reddit","web"]`
`platforms[].platform`anyOf 2	`null`Required in parent	—
`platforms[].item_count`	`integer`Required in parent	`minimum: 0` `maximum: 9007199254740991`
`sources`	`array`Required in parent	`maxItems: 3`
`sources[]`	`object`Optional / item	—
`sources[].category`	`string`Required in parent	`enum: ["your_accounts","public_posts","team_notes"]`
`sources[].item_count`	`integer`Required in parent	`minimum: 0` `maximum: 9007199254740991`
`history`	`object`Required in parent	—
`history.eligible`	`boolean`Required in parent	`const: false`
`history.reason`	`string`Required in parent	`const: "insufficient_comparable_history"`

Complete JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "project_id": {
      "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)$"
    },
    "project_revision": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "corpus_snapshot_id": {
      "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)$"
    },
    "method_version": {
      "type": "string",
      "const": "literal-mentions/v1"
    },
    "coverage": {
      "type": "string",
      "enum": [
        "supplied_set",
        "bounded_sample",
        "partial"
      ]
    },
    "evidence_count": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "unique_items": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "brand_union_count": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "overlap_count": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "brands": {
      "maxItems": 20,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "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)$"
          },
          "name": {
            "type": "string",
            "minLength": 1,
            "maxLength": 100
          },
          "matched_items": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          },
          "observed_mention_share": {
            "anyOf": [
              {
                "type": "number",
                "minimum": 0,
                "maximum": 1
              },
              {
                "type": "null"
              }
            ]
          },
          "evidence": {
            "maxItems": 500,
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "evidence_id": {
                  "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)$"
                },
                "revision": {
                  "type": "integer",
                  "exclusiveMinimum": 0,
                  "maximum": 9007199254740991
                }
              },
              "required": [
                "evidence_id",
                "revision"
              ]
            }
          }
        },
        "required": [
          "id",
          "name",
          "matched_items",
          "observed_mention_share",
          "evidence"
        ]
      }
    },
    "languages": {
      "maxItems": 501,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "language": {
            "anyOf": [
              {
                "type": "string",
                "minLength": 1,
                "maxLength": 35
              },
              {
                "type": "null"
              }
            ]
          },
          "item_count": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          }
        },
        "required": [
          "language",
          "item_count"
        ]
      }
    },
    "platforms": {
      "maxItems": 8,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "platform": {
            "anyOf": [
              {
                "type": "string",
                "enum": [
                  "threads",
                  "instagram",
                  "facebook",
                  "youtube",
                  "x",
                  "reddit",
                  "web"
                ]
              },
              {
                "type": "null"
              }
            ]
          },
          "item_count": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          }
        },
        "required": [
          "platform",
          "item_count"
        ]
      }
    },
    "sources": {
      "maxItems": 3,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "category": {
            "type": "string",
            "enum": [
              "your_accounts",
              "public_posts",
              "team_notes"
            ]
          },
          "item_count": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          }
        },
        "required": [
          "category",
          "item_count"
        ]
      }
    },
    "history": {
      "type": "object",
      "properties": {
        "eligible": {
          "type": "boolean",
          "const": false
        },
        "reason": {
          "type": "string",
          "const": "insufficient_comparable_history"
        }
      },
      "required": [
        "eligible",
        "reason"
      ]
    }
  },
  "required": [
    "project_id",
    "project_revision",
    "corpus_snapshot_id",
    "method_version",
    "coverage",
    "evidence_count",
    "unique_items",
    "brand_union_count",
    "overlap_count",
    "brands",
    "languages",
    "platforms",
    "sources",
    "history"
  ]
}

Errors and safe retries

Check the HTTP status and response body. A 400 validation error may contain a ZodError; handler errors use error, message and code fields. Keep request_id or x-request-id for diagnosis, without credentials. Fix 401/403 access errors before retrying, and follow Retry-After for 429. If a write is uncertain or returns 5xx, read the existing result first. Reuse an idempotency key only where supported; retry behaviour varies by operation and does not guarantee exactly-once delivery.

Troubleshooting guide

Examples

These examples use fictional values checked against the schemas. Replace the IDs with ones you are authorized to use, the media with ready assets and the dates with your confirmed publishing time. Check the account’s eligibility before submitting a write. This page sends no API requests.

Set SOSOAPI_ACCESS_TOKEN on your server to a credential accepted by this operation, and keep it out of browser code. For an AI Agent, use sosoapi auth login to sign in through the browser and let the CLI refresh its credentials.

request.json

{
  "workspace_id": "11111111-1111-4111-8111-111111111111",
  "project_id": "11111111-1111-4111-8111-111111111111",
  "project_revision": 1,
  "corpus_snapshot_id": "11111111-1111-4111-8111-111111111111"
}

cURL

curl --request POST \
  "https://gqeshlawtcexsapabaui.supabase.co/functions/v1/research-api/projects/overview" \
  -H "Authorization: Bearer $SOSOAPI_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  --data-binary @request.json

JavaScript

// Server-side JavaScript. Do not print tokens or credential-bearing responses.
const token = process.env.SOSOAPI_ACCESS_TOKEN;
if (!token) throw new Error("Set an accepted credential for this operation");
const response = await fetch("https://gqeshlawtcexsapabaui.supabase.co/functions/v1/research-api/projects/overview", {
  method: "POST",
  headers: { "Content-Type": "application/json", Authorization: "Bearer " + token },
  body: JSON.stringify({
  "workspace_id": "11111111-1111-4111-8111-111111111111",
  "project_id": "11111111-1111-4111-8111-111111111111",
  "project_revision": 1,
  "corpus_snapshot_id": "11111111-1111-4111-8111-111111111111"
})
});
const result = await response.json();
// Check response.ok, the operation-specific body and completion state before continuing.

CLI

npx sosoapi api post /research-api/projects/overview < request.json

Synthetic response example

{
  "project_id": "11111111-1111-4111-8111-111111111111",
  "project_revision": 1,
  "corpus_snapshot_id": "11111111-1111-4111-8111-111111111111",
  "method_version": "literal-mentions/v1",
  "coverage": "supplied_set",
  "evidence_count": 0,
  "unique_items": 0,
  "brand_union_count": 0,
  "overlap_count": 0,
  "brands": [],
  "languages": [],
  "platforms": [],
  "sources": [],
  "history": {
    "eligible": false,
    "reason": "insufficient_comparable_history"
  }
}

MCP: sosoapi_research_projects_overview

All API operations Authentication and permissions

Privacy preferences

Necessary features

Optional usage analytics

Also allow session replay on this public website

Read a selected research corpus overview

Overview

Authentication and permissions

Request fields

Response and completion

Errors and safe retries

Examples

request.json

cURL

JavaScript

CLI

Synthetic response example

Read a selected research corpus overview

Overview

Authentication and permissions

Request fields

Response and completion

Errors and safe retries

Examples

request.json

cURL

JavaScript

CLI

Synthetic response example

Related tools and guides