Meta tools

Tools to help discover and introspect the Vee3 catalog.

GET/v1/meta-tools/tool

https://api.vee3.io/v1/meta-tools/tool

0 tokens

Return the full schema, examples, and token cost for one capability.

Authorization

Send your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

MCP

The same capability is available as an MCP tool on Vee3 hosted MCP.

Tool name

meta-tools.describe

Parameters1 field

tool_namestringRequired

MCP tool name (for example `x-twitter.create_post`) or capability id (for example `create-x-post`).

max length 128

Response46 fields

capability_idstring

Described capability id.

toolobject

44 fields

Full capability detail including fields, examples, and bindings.

mcp_tool_namestring

MCP tool name when the capability is exposed over MCP.

group_idstring

Capability group id.

summarystring

Short capability summary.

agent_descriptionstring

Longer description intended for agents.

usage_unit_labelstring

Label for usage reporting (for example screenshots).

request_fieldsarrayitems

13 fields

Request parameter schema for the capability.

namestring

Request parameter name.

type_namestring

Parameter type (string, integer, boolean, or enum).

descriptionstring

Parameter description.

requiredboolean

Whether the parameter is required.

defaultscalar

Default value when omitted (string, integer, or boolean), or null when none.

surfacesarrayitems

1 field

Surfaces where the parameter applies.

surfacestring

rest or mcp.

enum_valuesarrayitems

1 field

Allowed enum values when type_name is enum.

valuestring

Allowed enum value.

constraintsobject

3 fields

Optional numeric or length limits.

minimuminteger

Minimum allowed numeric value when set.

maximuminteger

Maximum allowed numeric value when set.

max_lengthinteger

Maximum allowed string length when set.

response_fieldsarrayitems

7 fields

Response field schema for the capability.

namestring

Response field name.

type_namestring

Field type (string, integer, boolean, enum, array, or object).

descriptionstring

Field description.

childrenarrayitems

3 fields

Nested response field specs when type_name is array or object. Items use the same shape and may nest further.

namestring

Response field name.

type_namestring

Field type (string, integer, boolean, enum, array, or object).

descriptionstring

Field description.

error_codesarrayitems

1 field

Error codes that may appear in error responses.

error_codestring

Machine-readable error code.

success_body_codesarrayitems

1 field

Non-error body codes that may appear on HTTP 200 responses.

body_codestring

Machine-readable success-body code.

examplesarrayitems

6 fields

Request examples for the capability.

namestring

Example identifier.

descriptionstring

What the example demonstrates.

request_bodyobject

1 field

Sample request payload for the capability.

parameterstring

Capability-specific request parameter documented in the example.

surfacesarrayitems

1 field

Surfaces where the example applies.

surfacestring

rest or mcp.

response_examplesarrayitems

5 fields

Response examples for the capability.

namestring

Example identifier.

descriptionstring

What the example demonstrates.

status_codeinteger

HTTP status code for the example response.

response_bodyobject

1 field

Sample response payload for the capability.

fieldstring

Capability-specific response field documented in the example.

HTTP errors: unauthorized, not_found, validation_error

Example request

Python

import requests

url = "https://api.vee3.io/v1/meta-tools/tool"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "tool_name": "website-screenshots.capture"
}

response = requests.get(url, headers=headers, params=params)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Full schema and bindings for the website screenshot capability.

website_screenshot.json

{
  "capability_id": "website-screenshot",
  "tool": {
    "capability_id": "website-screenshot",
    "group_id": "website-screenshots",
    "group_display_name": "Website Screenshots",
    "display_name": "Website screenshots",
    "summary": "Capture any public URL - viewport, full page, signed PNG or JPEG.",
    "agent_description": "Capture a screenshot of a public website...",
    "usage_unit_label": "screenshots",
    "status": "live",
    "rest_method": "POST",
    "rest_path": "/v1/website-screenshots/screenshot",
    "mcp_tool_name": "website-screenshots.capture",
    "token_cost": 20,
    "request_fields": [
      {
        "name": "url",
        "type_name": "string",
        "description": "Public http or https URL to capture.",
        "required": true,
        "default": null,
        "surfaces": [
          {
            "surface": "mcp"
          },
          {
            "surface": "rest"
          }
        ],
        "constraints": {
          "minimum": null,
          "maximum": null,
          "max_length": 2048
        }
      },
      {
        "name": "file_name",
        "type_name": "string",
        "description": "Optional account-relative storage path for the screenshot.",
        "required": false,
        "default": null,
        "surfaces": [
          {
            "surface": "mcp"
          },
          {
            "surface": "rest"
          }
        ],
        "constraints": {
          "minimum": null,
          "maximum": null,
          "max_length": 255
        }
      }
    ],
    "response_fields": [
      {
        "name": "screenshot_id",
        "type_name": "string",
        "description": "Unique identifier, prefix ss_."
      },
      {
        "name": "screenshot_url",
        "type_name": "string",
        "description": "Signed download URL from account file storage."
      },
      {
        "name": "download_code",
        "type_name": "string",
        "description": "Short code to pass to vee3-get-file."
      }
    ],
    "error_codes": [
      {
        "error_code": "unauthorized"
      },
      {
        "error_code": "url_blocked"
      },
      {
        "error_code": "screenshot_timeout"
      },
      {
        "error_code": "uploaded_file_name_in_use"
      }
    ],
    "success_body_codes": [],
    "examples": [
      {
        "name": "basic_viewport",
        "description": "Capture the default viewport after DOM content loaded.",
        "request_body": {
          "url": "https://example.com",
          "wait_until": "domcontentloaded"
        },
        "surfaces": [
          {
            "surface": "rest"
          }
        ]
      }
    ],
    "response_examples": [
      {
        "name": "signed_url",
        "description": "Response when return_mode is url.",
        "status_code": 200,
        "response_body": {
          "screenshot_id": "ss_example01abcdef12",
          "status": "completed",
          "url": "https://example.com",
          "screenshot_url": "https://storage.googleapis.com/vee3-screenshots/ss_example01abcdef12.png?X-Goog-Signature=...",
          "return_mode": "url"
        }
      }
    ]
  }
}

GET/v1/meta-tools/token-balance

https://api.vee3.io/v1/meta-tools/token-balance

0 tokens

Return monthly token allowance, usage, remaining balance, and reset time.

Authorization

Send your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

MCP

The same capability is available as an MCP tool on Vee3 hosted MCP.

Tool name

meta-tools.token_balance

Parameters0 fields

Response7 fields

billing_planstring

Current billing plan id (free, starter, pro, scale).

monthly_token_allowanceinteger

Total tokens included in the current billing period.

tokens_usedinteger

Tokens consumed in the current billing period.

tokens_remaininginteger

Tokens left before quota is exhausted.

billing_period_startstring

ISO 8601 start of the current billing period.

billing_period_endstring

ISO 8601 end of the current billing period.

billing_period_resets_atstring

ISO 8601 timestamp when the token allowance resets (same as period end).

HTTP errors: unauthorized, payment_required

Example request

Python

import requests

url = "https://api.vee3.io/v1/meta-tools/token-balance"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {

}

response = requests.get(url, headers=headers, params=params)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Token allowance and usage for a free-plan account mid-period.

free_plan_balance.json

{
  "billing_plan": "free",
  "monthly_token_allowance": 1000,
  "tokens_used": 120,
  "tokens_remaining": 880,
  "billing_period_start": "2026-05-01T00:00:00Z",
  "billing_period_end": "2026-06-01T00:00:00Z",
  "billing_period_resets_at": "2026-06-01T00:00:00Z"
}

GET/v1/meta-tools/tools

https://api.vee3.io/v1/meta-tools/tools

0 tokens

Return every live Vee3 capability and MCP tool name available to agents.

Authorization

Send your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

MCP

The same capability is available as an MCP tool on Vee3 hosted MCP.

Tool name

meta-tools.list_all

Parameters0 fields

Response4 fields

toolsarrayitems

3 fields

Live tool summaries for every capability exposed to agents.

mcp_tool_namestring

MCP tool name when the capability is exposed over MCP.

group_idstring

Capability group id.

summarystring

Short capability summary.

HTTP errors: unauthorized, payment_required

Example request

Python

import requests

url = "https://api.vee3.io/v1/meta-tools/tools"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {

}

response = requests.get(url, headers=headers, params=params)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200All live capabilities exposed to agents.

live_tools.json

{
  "tools": [
    {
      "mcp_tool_name": "meta-tools.list_all",
      "group_id": "meta-tools",
      "summary": "Return every live Vee3 capability and MCP tool name available to agents."
    },
    {
      "mcp_tool_name": "website-screenshots.capture",
      "group_id": "website-screenshots",
      "summary": "Capture any public URL - viewport, full page, signed PNG or JPEG."
    }
  ]
}

GET/v1/meta-tools/group-tools

https://api.vee3.io/v1/meta-tools/group-tools

0 tokens

Return every live tool in one capability group.

Authorization

Send your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

MCP

The same capability is available as an MCP tool on Vee3 hosted MCP.

Tool name

meta-tools.list_group_tools

Parameters1 field

group_idstringRequired

Group id to list tools for (for example website-screenshots).

max length 128

Response4 fields

group_idstring

Requested group id.

toolsarrayitems

2 fields

Live tool summaries in the requested group.

namestring

MCP tool name when the capability is exposed over MCP.

summarystring

Short capability summary.

HTTP errors: unauthorized, not_found, validation_error

Example request

Python

import requests

url = "https://api.vee3.io/v1/meta-tools/group-tools"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "group_id": "website-screenshots"
}

response = requests.get(url, headers=headers, params=params)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Live tools in the website-screenshots group.

website_screenshots_group.json

{
  "group_id": "website-screenshots",
  "tools": [
    {
      "name": "website-screenshots.capture",
      "summary": "Capture any public URL - viewport, full page, signed PNG or JPEG."
    }
  ]
}

GET/v1/meta-tools/groups

https://api.vee3.io/v1/meta-tools/groups

0 tokens

Return every capability group with summaries and live tool counts.

Authorization

Send your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

MCP

The same capability is available as an MCP tool on Vee3 hosted MCP.

Tool name

meta-tools.list_groups

Parameters0 fields

Response5 fields

groupsarrayitems

4 fields

Capability groups with live tool counts.

group_idstring

Group id (for example website-screenshots).

display_namestring

Human-readable group name.

summarystring

Short group summary.

live_tool_countinteger

Number of live capabilities in the group.

HTTP errors: unauthorized

Example request

Python

import requests

url = "https://api.vee3.io/v1/meta-tools/groups"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {

}

response = requests.get(url, headers=headers, params=params)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200All capability groups with live tool counts.

catalog_groups.json

{
  "groups": [
    {
      "group_id": "meta-tools",
      "display_name": "Meta tools",
      "summary": "Discovery and introspection helpers for agents.",
      "live_tool_count": 8
    },
    {
      "group_id": "website-screenshots",
      "display_name": "Website Screenshots",
      "summary": "Capture screenshots of public websites.",
      "live_tool_count": 1
    }
  ]
}

POST/v1/meta-tools/report-bug

https://api.vee3.io/v1/meta-tools/report-bug

0 tokens

Report a bug, error, or unexpected behavior encountered while using Vee3.

Authorization

Send your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

MCP

The same capability is available as an MCP tool on Vee3 hosted MCP.

Tool name

meta-tools.report_bug

Parameters4 fields

summarystringRequired

Short title describing the issue.

max length 200

descriptionstringRequired

Detailed explanation of what went wrong, what was expected, and steps to reproduce if known.

max length 8000

related_capability_idstringOptional

MCP tool name or capability id involved in the issue, if applicable.

max length 128

error_detailsstringOptional

Raw error message, stack trace, or API response that shows the failure.

max length 8000

Response3 fields

report_idstring

Unique identifier for the submitted bug report.

statusstring

Submission status. Always "received" on success.

created_atstring

ISO 8601 timestamp when the report was recorded.

HTTP errors: unauthorized, validation_error, rate_limit_exceeded

Example request

Python

import requests

url = "https://api.vee3.io/v1/meta-tools/report-bug"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "summary": "x-twitter.user_info returned unexpected error for valid user_name",
    "description": "Called x-twitter.user_info with user_name 'openai'. Expected a user profile but received an internal server error.",
    "related_capability_id": "x-twitter.user_info",
    "error_details": "internal_error: An internal server error occurred (request_id=abc123)"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Bug report accepted and recorded.

received.json

{
  "report_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "status": "received",
  "created_at": "2026-06-19T12:00:00Z"
}

POST/v1/meta-tools/request-feature

https://api.vee3.io/v1/meta-tools/request-feature

0 tokens

Request a new capability or feature that Vee3 does not offer yet.

Authorization

Send your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

MCP

The same capability is available as an MCP tool on Vee3 hosted MCP.

Tool name

meta-tools.request_feature

Parameters4 fields

summarystringRequired

Short title describing the requested capability or feature.

max length 200

descriptionstringRequired

Detailed explanation of what is needed, why it cannot be done with existing tools, and how it would help.

max length 8000

related_capability_idstringOptional

Capability id this request extends or relates to, if applicable.

max length 128

use_casestringOptional

Example workflow or scenario where this feature would be used.

max length 8000

Response3 fields

request_idstring

Unique identifier for the submitted feature request.

statusstring

Submission status. Always "received" on success.

created_atstring

ISO 8601 timestamp when the request was recorded.

HTTP errors: unauthorized, validation_error, rate_limit_exceeded

Example request

Python

import requests

url = "https://api.vee3.io/v1/meta-tools/request-feature"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "summary": "Add LinkedIn company profile lookup",
    "description": "Need to fetch public LinkedIn company pages by company name or URL. No existing Vee3 capability covers LinkedIn data.",
    "use_case": "Research target companies for outbound sales — pull employee count, industry, and recent posts."
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Feature request accepted and recorded.

received.json

{
  "request_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "status": "received",
  "created_at": "2026-06-19T12:00:00Z"
}

GET/v1/meta-tools/search

https://api.vee3.io/v1/meta-tools/search

0 tokens

Search live Vee3 capabilities by keyword or task description.

Authorization

Send your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

MCP

The same capability is available as an MCP tool on Vee3 hosted MCP.

Tool name

meta-tools.search

Parameters3 fields

querystringRequired

Keywords or short task description (for example `tiktok video comments` or `domain availability`).

max length 256

group_idstringOptional

Optional group id to narrow results (for example `x-twitter`).

max length 128

limitintegerOptional

Maximum results to return (1–20).

Default: 8 · min 1, max 20

Response5 fields

querystring

Normalized search query that was executed.

resultsarrayitems

3 fields

Ranked capability matches visible to the caller.

tool_namestring

MCP tool name for the matched capability.

summarystring

Short capability summary.

costinteger

Successful request token cost for the capability.

HTTP errors: unauthorized, not_found, validation_error

Example request

Python

import requests

url = "https://api.vee3.io/v1/meta-tools/search"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "query": "tiktok video comments"
}

response = requests.get(url, headers=headers, params=params)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Top matches for a domain availability query.

domain_availability.json

{
  "query": "domain availability",
  "results": [
    {
      "tool_name": "domains.check_availability",
      "summary": "Check whether domain names are available to register.",
      "cost": 5
    }
  ]
}