Skip to main content

Get skill tool schema

GET 
/api/v2/agent/:agentCode/skill/:skillCode/schema

Returns the JSON schema(s) built at runtime for the skill, so integrators know the exact body shape to send to the execute endpoint. Skills that expose several tools (MCPs, Text, Math and so on) return one entry per tool, each with its tool code.

When the skill needs a personal connection that the caller does not have yet, no schema can be resolved, because an MCP lists its tools over the authenticated session. In that case the response carries an empty tools array and a pendingActions entry with the URL to create the connection.

Request​

Path Parameters

    agentCode stringrequired

    Code of the agent that declares the skill.

    skillCode stringrequired

    Code of the skill whose schema is requested.

Query Parameters

    connectionId uuid

    Optional personal connection used to resolve the skill. An MCP lists its tools over the authenticated session, so the returned tool set can differ per connection. Only valid for skills configured with a personal connection; when omitted the caller's default connection for the connector is used.

    culture string

    Use this param to override the culture of the response. Options: - en (default) - es

Responses​

Returns the skill's tool schema(s), or the pending actions the caller must complete before they can be resolved.

Schema

    skillCode stringnullable

    tools

    object[]

    nullable

  • Array [

    • toolCode stringnullable
    description stringnullable
    schema

  • ]

    • pendingActions

    object[]

    nullable

  • Array [

    • oneOf

    type stringnullable
    url stringnullable
    connectorId uuid
    connectorName stringnullable
    connectorImgUrl stringnullable
    type stringnullable

  • ]

Loading...