Run a valid snapchat-data.get_profile call through the same SDK surface used by every toolkit.

Minimal tool call

ts
import { Eyeball } from "@eyeball/sdk";

const eyeball = new Eyeball({
  apiKey: process.env.EYEBALL_API_KEY!,
  baseUrl: process.env.EYEBALL_EXECUTOR_URL!,
});

const output = await eyeball.tools.run(
  "snapchat-data.get_profile",
  {
  "handle": "example_handle"
},
  { userId: "demo_user" },
);
console.log(output);

The model receives canonical output. Your application retains the execution envelope through tools.execute or the execution APIs when it needs IDs, status, versions, and latency.

Supported canonical tools

ToolPurposeExecutionEffectVersion
snapchat-data.get_profileRetrieve a public creator or user profile and visible metrics.sync or asyncread1.0.0

Only the rows above are implemented. A capability tool omitted by this manifest returns not_supported; eyeball never synthesizes provider parity.

Supported canonical triggers

This manifest does not implement a canonical trigger.

Input and output schemas

snapchat-data.get_profile

Input schema

JSON
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "urn:eyeball:social_media_data:get_profile:1.0.0:snapchat-data",
  "type": "object",
  "description": "Public profile selector.",
  "additionalProperties": false,
  "required": [
    "handle"
  ],
  "properties": {
    "handle": {
      "type": "string",
      "description": "Public profile handle or username.",
      "minLength": 1
    }
  }
}

Output schema

JSON
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "urn:eyeball:social_media_data:get_profile:output:1.0.0:snapchat-data",
  "type": "object",
  "description": "Requested public profile.",
  "additionalProperties": false,
  "required": [
    "profile"
  ],
  "properties": {
    "profile": {
      "type": "object",
      "description": "A normalized public creator, user, channel, or community profile.",
      "additionalProperties": false,
      "required": [
        "profileId",
        "platform",
        "handle",
        "displayName",
        "verified",
        "followers",
        "following",
        "totalPosts"
      ],
      "properties": {
        "profileId": {
          "type": "string",
          "description": "Provider identifier of the public profile.",
          "minLength": 1
        },
        "platform": {
          "type": "string",
          "description": "Social platform represented by the result.",
          "minLength": 1
        },
        "handle": {
          "type": "string",
          "description": "Platform handle, username, channel name, or community name.",
          "minLength": 1
        },
        "displayName": {
          "type": "string",
          "description": "Public display name.",
          "minLength": 1
        },
        "bio": {
          "type": "string",
          "description": "Public biography or description."
        },
        "verified": {
          "type": "boolean",
          "description": "Whether the profile is verified."
        },
        "followers": {
          "type": "integer",
          "minimum": 0,
          "description": "Visible follower or subscriber count."
        },
        "following": {
          "type": "integer",
          "minimum": 0,
          "description": "Visible following count."
        },
        "totalPosts": {
          "type": "integer",
          "minimum": 0,
          "description": "Visible total public post count."
        },
        "profileUrl": {
          "type": "string",
          "format": "uri",
          "description": "Public profile URL."
        },
        "avatarUrl": {
          "type": "string",
          "format": "uri",
          "description": "Public avatar URL."
        },
        "channelId": {
          "type": "string",
          "description": "Platform channel identifier when distinct from the profile ID."
        }
      }
    }
  }
}

Authentication

PropertyValue
Auth classapi_key
Required scopesNone
Optional scopesNone
Credential fieldsapiKey

Credentials are resolved inside the executor by CredentialProvider. They never belong in tool input, x_provider, model context, logs, or execution output.

Provider-specific extensions

This manifest declares no provider-specific schema extensions. Use only canonical fields.

Provider differences may appear only under x_provider.snapchat-data and only when the schema above declares them.

Sync and async behavior

All tools are synchronous by nature, but callers may choose mode: "async" to queue them.

Mutations require a stable Idempotency-Key. The TypeScript SDK accepts it as idempotencyKey; it is never part of the JSON request body.

REST example

Bash
curl "$EYEBALL_EXECUTOR_URL/v1/execute" \
  -H "Authorization: Bearer $EYEBALL_API_KEY" \
  -H 'Content-Type: application/json' \
  --data '{"tool":"snapchat-data.get_profile","userId":"demo_user","input":{"handle":"example_handle"},"mode":"sync"}'

Mock support

Point EYEBALL_EXECUTOR_URL at a mock-configured executor to run through the real catalog, validation, credential seam, adapter, normalized errors, and execution records with no Snapchat via ScrapeCreators account. Mock selection changes the executor endpoint and trusted provider base-URL configuration, never the execute request.

Limitations

  • This page describes the manifest's explicit P0 subset, not every operation offered by the provider.
  • Provider account policy, consent UI, quota details, and current wire compatibility still require a real-provider certification pass.
  • Fields outside the canonical schemas and declared x_provider extensions are rejected.

Versions

ContractVersion
Runtime catalog1.1
Manifest catalog1.0
Manifest schema1.0
Sourcescrapecreators
TierP0
Capabilitiessocial_media_data

Next

Use Testing with mocks to exercise this toolkit before connecting a live provider account.