Marketplace
No threads yet
Live

get_component_schema_definition

docs.birdy.chat

Returns the full definition of a named component schema from the BirdyChat Integrations API OpenAPI spec at https://docs.birdy.chat, including field metadata and one-level nested schema resolution.

Parameters3
Runs8
Updated8d ago
Operational8 runs · 100% succeeded
30 days agotoday

Playground

Runs on Notte and spends your workspace credits — what comes back is the live response, not a sample.

What is get_component_schema_definition?

Returns the full definition of a named component schema from the BirdyChat Integrations API OpenAPI spec at https://docs.birdy.chat, including field metadata and one-level nested schema resolution. It runs on Notte's browser infrastructure and returns structured JSON, so you can call it like any other API — pass schema_name, source_url, timeout_seconds and get the result back without maintaining a scraper.

Response

{
  "fields": [
    {}
  ],
  "references": [
    "<string>"
  ],
  "source_url": "<string>",
  "composition": {},
  "schema_name": "<string>",
  "nested_schemas": {},
  "openapi_version": "<string>",
  "required_fields": [
    "<string>"
  ],
  "schema_definition": {}
}

Call it

curl --location 'https://us-prod.notte.cc/functions/db325c3f-169f-4175-b8ab-ba2ba21f84c4/runs/start' \
--header 'x-notte-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--data '{
    "function_id": "db325c3f-169f-4175-b8ab-ba2ba21f84c4",
    "variables": {
        "schema_name": "WebhookEvent",
        "source_url": "https://docs.birdy.chat/openapi.json",
        "timeout_seconds": 25
    }
}'

Ask an agent

Paste this into Claude Code, Cursor or any MCP client to have an agent call this function for you.

prompt
Use the Anything API MCP server (https://anything.notte.cc/mcp).

Call run(function_id="db325c3f-169f-4175-b8ab-ba2ba21f84c4") — the "get_component_schema_definition" function, which returns the full definition of a named component schema from the BirdyChat Integrations API OpenAPI spec at https://docs.birdy.chat, including field metadata and one-level nested schema resolution..

It takes schema_name (str), source_url (str), timeout_seconds (int). Return the result as structured JSON.