V1/tool | Amigo Documentation

Create a new tool

post

Create a new tool.

Authorizations

Path parameters

organizationstringRequired

Header parameters

x-mongo-cluster-nameany ofOptional

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.

stringOptional

or

nullOptional

Body

namestring · min: 1Required

The name of the tool.

Pattern: ^[a-z0-9_]+$

descriptionstring · min: 1Required

A description of the tool.

Responses

201

Succeeded.

application/json

401

Invalid authorization credentials.

403

Missing required permissions.

404

The specified organization does not exist.

409

A tool with the same name already exists.

422

Invalid request path parameter or request body failed validation.

429

The user has exceeded the rate limit of 20 requests per minute for this endpoint.

503

The service is going through temporary maintenance.

post

POST /v1/{organization}/tool/ HTTP/1.1
Host: api.amigo.ai
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 78

{
  "name": "text",
  "description": "text",
  "tags": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

{
  "id": "text"
}

Deprecate tool versions

delete

Authorizations

Path parameters

organizationstringRequired

tool_idstringRequired

The ID of the tool to deprecate.

Pattern: ^[a-f0-9]{24}$

versionsstringRequired

A semver constraint that specifies the version to deprecate. All versions that match this constraint will be deprecated.

Header parameters

x-mongo-cluster-nameany ofOptional

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.

stringOptional

or

nullOptional

Responses

204

Succeeded.

400

Invalid semver constraint.

401

Invalid authorization credentials.

403

Missing required permissions.

404

The specified organization or tool does not exist.

422

Invalid request path parameter or request body failed validation.

429

The user has exceeded the rate limit of 20 requests per minute for this endpoint.

503

The service is going through temporary maintenance.

delete

DELETE /v1/{organization}/tool/{tool_id}/version/{versions} HTTP/1.1
Host: api.amigo.ai
Authorization: Bearer JWT
Accept: */*

No content

Modify a tool

post

Authorizations

Path parameters

organizationstringRequired

tool_idstringRequired

The ID of the tool to modify

Pattern: ^[a-f0-9]{24}$

Header parameters

x-mongo-cluster-nameany ofOptional

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.

stringOptional

or

nullOptional

Body

descriptionany ofOptional

A description of this tool. Only updates if not-null.

string · min: 1Optional

or

nullOptional

tagsany ofOptional

The tags of this tool. Only updates if not-null.

or

nullOptional

Responses

204

Succeeded.

401

Invalid authorization credentials.

403

Missing required permissions.

404

The specified organization or tool does not exist.

422

Invalid request path parameter or request body failed validation.

429

The user has exceeded the rate limit of 20 requests per minute for this endpoint.

503

The service is going through temporary maintenance.

post

POST /v1/{organization}/tool/{tool_id} HTTP/1.1
Host: api.amigo.ai
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 64

{
  "description": "text",
  "tags": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

No content

Deprecate a tool

delete

Authorizations

Path parameters

organizationstringRequired

tool_idstringRequired

The ID of the tool to deprecate.

Pattern: ^[a-f0-9]{24}$

Header parameters

x-mongo-cluster-nameany ofOptional

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.

stringOptional

or

nullOptional

Responses

204

Succeeded.

401

Invalid authorization credentials.

403

Missing required permissions.

404

The specified organization or tool does not exist.

422

Invalid request path parameter or request body failed validation.

429

The user has exceeded the rate limit of 20 requests per minute for this endpoint.

503

The service is going through temporary maintenance.

delete

DELETE /v1/{organization}/tool/{tool_id} HTTP/1.1
Host: api.amigo.ai
Authorization: Bearer JWT
Accept: */*

No content

Modify the environment variables of a tool

post

Authorizations

Path parameters

organizationstringRequired

tool_idstringRequired

The ID of the tool to modify

Pattern: ^[a-f0-9]{24}$

Header parameters

x-mongo-cluster-nameany ofOptional

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.

stringOptional

or

nullOptional

Body

Responses

204

Succeeded.

400

The specified environment variables to update or delete do not exist, or the environment variables to delete are used by non-deprecated tool versions.

401

Invalid authorization credentials.

403

Missing required permissions.

404

The specified organization or tool does not exist.

409

An environment variable with the same name as the one to insert exists or has been recently deleted.

422

Invalid request body or request path parameter.

429

The user has exceeded the rate limit of 20 requests per minute for this endpoint.

503

The service is going through temporary maintenance.

post

POST /v1/{organization}/tool/{tool_id}/envvar HTTP/1.1
Host: api.amigo.ai
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 132

{
  "inserts": [
    {
      "name": "text",
      "value": "text",
      "is_secret": true
    }
  ],
  "updates": [
    {
      "name": "text",
      "value": "text"
    }
  ],
  "deletes": [
    {
      "name": "text"
    }
  ]
}

No content