Skip to content

Endpoint Documentation

GET /v1/skills/:integration/:endpoint

Returns complete documentation for a single endpoint, including parameters, description, usage example, and error codes. This is what agents use to understand how to call an endpoint before executing it.

Required. Bearer token: Authorization: Bearer sk_xxx

ParameterTypeRequiredDescription
integrationstringYesIntegration slug (e.g., github)
endpointstringYesEndpoint action name (e.g., create_issue)
{
"name": "create_issue",
"method": "POST",
"category": "issues",
"description": "Create an issue in a GitHub repository.",
"parameters": [
{
"name": "repo",
"type": "string",
"required": true,
"description": "Repository in owner/repo format"
},
{
"name": "title",
"type": "string",
"required": true,
"description": "Issue title"
},
{
"name": "body",
"type": "string",
"required": false,
"description": "Issue body (supports markdown)"
},
{
"name": "labels",
"type": "array",
"required": false,
"description": "Label names to apply"
},
{
"name": "assignees",
"type": "array",
"required": false,
"description": "Usernames to assign"
}
],
"example": "skillett run github create_issue --repo acme/webapp --title \"Bug report\"",
"errors": [
{ "code": 400, "cause": "Bad Request", "fix": "Check parameter types and required fields" },
{ "code": 404, "cause": "Not Found", "fix": "Verify the repository exists and you have access" },
{ "code": 422, "cause": "Validation Failed", "fix": "Check for invalid field values" }
]
}
FieldTypeDescription
namestringEndpoint action name
methodstringHTTP method
categorystringCategory this endpoint belongs to
descriptionstringWhat this endpoint does
parameters[]arrayParameter definitions
parameters[].namestringParameter name
parameters[].typestringstring, number, boolean, array, object
parameters[].requiredbooleanWhether the parameter is required
parameters[].descriptionstringWhat this parameter does
examplestringCLI usage example
errors[]arrayPossible error responses
CodeErrorDescription
401unauthorizedMissing or invalid API key
404not_foundIntegration or endpoint not found
Terminal window
$ curl -H "Authorization: Bearer sk_a1b2c3d4..." \
https://api.skillett.dev/v1/skills/github/create_issue