🛠️ How can I get the schema for an Action? - Composio

When will I need to provide input parameters?

When executing actions without agents, you’ll need to provide the input parameters. There are two ways to obtain these parameters:

Programmatically using our SDK
Using the API Section of our documentation

SDK
API Section

Install packages:

pip install composio-openai

npm install composio-core

Import libraries & get action schema:

from composio import ComposioToolSet, Action
import json

composio_toolset = ComposioToolSet()

# Get the action schema
action_schema = composio_toolset.get_action_schemas(actions=[Action.GITHUB_STAR_A_REPOSITORY_FOR_THE_AUTHENTICATED_USER])

# Print the parameters in a readable format
print(json.dumps(action_schema[0].parameters.properties, indent=2))

import { OpenAIToolSet } from "composio-core";

const composio_toolset = new OpenAIToolSet();

const schema = await composio_toolset.getActionsSchema({
  actions: ["github_star_a_repository_for_the_authenticated_user"],
});

console.log(JSON.stringify(schema[0].parameters.properties, null, 2));

Output

{
  "owner": {
    "description": "The account owner of the repository. The name is not case sensitive. Please provide a value of type string. This parameter is required.",
    "title": "Owner",
    "type": "string"
  },
  "repo": {
    "description": "The name of the repository without the `.git` extension. The name is not case sensitive. Please provide a value of type string. This parameter is required.",
    "title": "Repo",
    "type": "string"
  }
}