Tool

Test a tool

post/v1/{organization}/tool/test

Request

Base URL
https://api.amigo.ai
Auth
HTTP bearer and API key in header X-ORG-ID and HTTP basic
TypeScript
https://skmtc.dev/amigo/apis/amigo-api/docs/v1/:organization/tool/test/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

organizationstring required

Headers

x-mongo-cluster-namestring nullable

The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.

Sec-WebSocket-Protocolstring[]

Request body

commit_branchstring required

The branch in the tools repo whose tip will be tested.

project_pathstring required

The directory in the tools repo that contains the pyproject.toml file corresponding to the tool version to publish.

required_envvarsobject required

The environment variables required for the tool to run.

required_secret_envvarsobject required

The secret environment variables required for the tool to run.

Response

Succeeded

Changes

No operation changes recorded.