How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Amigo Tool API

The Tool API from Amigo — 10 operation(s) for tool.

Amigo Tool API is one of 72 APIs that Amigo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Tool. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 13 operations across 10 paths, and defines 45 schemas. It is described by OpenAPI 3.2.0, at version 0.1.0.

Requests are made against 5 base URLs: https://api.amigo.ai, https://internal-api.amigo.ai, https://api-eu-central-1.amigo.ai, https://api-ap-southeast-2.amigo.ai, https://api-ca-central-1.amigo.ai.

13 operations 10 paths 45 schemas 2 DELETE5 GET6 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.1.0
Base URL
https://api.amigo.ai
Authentication
HTTP Bearer, API Key, HTTP Basic
Resource Areas
1

Authentication & Security 3

Amigo Tool API declares 3 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (Bearer-Authorization). An API key is passed in the header as X-ORG-ID (Bearer-Authorization-Organization). It accepts HTTP basic authentication (Basic). By default, every request must be authenticated.

  • Bearer-Authorization — Amigo issued JWT token that identifies an user. It's issued either after logging in through the frontend, or manually through the [SignInWithAPIKey](sign-in-wi…
  • Bearer-Authorization-Organization — An optional organization identifier that indicates from which organization the token is issued. This is used in rare cases where the user to authenticate is ma…
  • Basic — The username should be set to {orgid}{userid}, and the password should be the Amigo issued JWT token that identifies the user.

Paths & Operations 13

Across 10 paths, the API surfaces 13 operations — 2 DELETE, 5 GET, 6 POST. Each is listed below with its method, path, parameters, and response codes.

Tool 13
GET
/v1/{organization}/tool/amigo_tool_scaffold.tar.gz
Get the latest tool scaffold release
get-tool-scaffold-release 3 params → 200404422401403503429
POST
/v1/{organization}/tool/
Create a new tool
create-tool 3 params body → 201404409422400401403503
GET
/v1/{organization}/tool/
Get tools
get-tools 9 params → 200404422401403503429
DELETE
/v1/{organization}/tool/{tool_id}/version/{versions}
Deprecate tool versions
deprecate-tool-version 5 params → 204404422401403503429
DELETE
/v1/{organization}/tool/{tool_id}
Deprecate a tool
deprecate-tool 4 params → 204404409422401403503429
POST
/v1/{organization}/tool/{tool_id}
Modify a tool
modify-tool 4 params body → 204404422401403503429
POST
/v1/{organization}/tool/test
Test a tool
test-tool 3 params body → 200404400422401403503429
POST
/v1/{organization}/tool/{tool_id}/envvar
Modify the environment variables of a tool
modify-tool-envvars 4 params body → 204404409400422401403503
POST
/v1/{organization}/tool/{tool_id}/version
Publish a new version of a tool
publish-tool-version 4 params body → 201404400409422401403503
GET
/v1/{organization}/tool/{tool_id}/version
Get tool versions
get-tool-versions 10 params → 200404422401403503429
GET
/v1/{organization}/tool/invocation
Get tool invocations
get-tool-invocations 12 params → 200404400422401403503429
POST
/v1/{organization}/tool/{tool_id}/version/{version}/invoke
Invoke a tool version
invoke-tool-version 5 params body → 200404400422401403503429
GET
/v1/{organization}/tool/invocation/search
Search tool invocations
search-tool-invocations 10 params → 200404422401403503429

Schemas 45

The contract defines 45 schemas that model the data the API accepts and returns. The most detailed are ToolVersionInstance (16 properties), ToolInstance (12 properties), ToolInvocationInstance (10 properties), src__app__endpoints__tool__test_tool__Request (5 properties). Each schema is shown below with its type and property counts.

src__app__endpoints__tool__create_tool__Request
object
3 properties 3 required
src__app__endpoints__tool__search_tool_invocations__Response
object
1 property 1 required
FailedInvocationResult
object
5 properties 4 required
InsertRequest
object
3 properties 3 required
UpdateRequest
object
2 properties 2 required
EngageUserInvocationMetadata
object
3 properties 2 required
Input
object
4 properties 4 required
src__app__endpoints__tool__test_tool__Request
object
5 properties 5 required
FailedInvocationStatus
object
4 properties 3 required
Tag
object
2 properties 2 required
src__app__endpoints__tool__test_tool__Response
object
1 property 1 required
InvocationResult
SucceededInvocationResult
object
3 properties 2 required
StateTransitionInvocationMetadata
object
5 properties 4 required
src__app__endpoints__tool__modify_tool_envvars__Request
object
3 properties
StrippedNonemptyString___w__s_____
string
SimulationConversationInvocationSource
object
5 properties 4 required
src__app__endpoints__tool__get_tool_versions__Response__FilterValues
object
1 property 1 required
src__app__endpoints__tool__invoke_tool_version__Request
object
1 property 1 required
src__app__endpoints__tool__modify_tool_envvars__Request__DeleteRequest
object
1 property 1 required
ToolInstance
object
12 properties 10 required
src__app__endpoints__tool__modify_tool__Request
object
2 properties
ToolInvocationInstance
object
10 properties 8 required
amigo_lib__mongo__collections__tool__Tool__UserInfo
object
2 properties 2 required
ToolVersionInstance
object
16 properties 14 required
src__app__endpoints__tool__publish_tool_version__Response
object
1 property 1 required
src__app__endpoints__tool__invoke_tool_version__Response
object
1 property 1 required
SucceededInvocationStatus
object
2 properties 1 required
InvocationStatus
Version
object
3 properties 3 required
AgentFrameworkInvocationMetadata
src__app__endpoints__tool__get_tool_invocations__Response
object
3 properties 3 required
ToolCallStateInvocationMetadata
object
3 properties 2 required
amigo_lib__pydantic__base_model__StrippedNonemptyString__1
string
src__app__endpoints__tool__get_tools__Response__FilterValues
object
1 property 1 required
src__app__endpoints__tool__publish_tool_version__Request
object
2 properties 2 required
StrippedNonemptyString_A-Z______
string
StrippedNonemptyString_a-z0-9______
string
InvocationSource
RegularConversationInvocationSource
object
5 properties 4 required
src__app__endpoints__tool__get_tool_versions__Response
object
4 properties 4 required
amigo_lib__mongo__collections__tool_version__ToolVersion__UserInfo
object
2 properties 2 required
src__app__endpoints__tool__get_tools__Response
object
4 properties 4 required
StrippedNonemptyString_a-z___a-z0-9_______
string
src__app__endpoints__tool__create_tool__Response
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amigo-tool-api-openapi.yml Raw ↑

Other APIs Amigo publishes across the network.

Amigo Account API
Amigo Admin API
Amigo Agent Definitions API
Amigo Agent Runs API
Amigo Agents API
Amigo Analytics API
Amigo API Keys API
Amigo Audit API
Amigo Auth API
Amigo Billing API
Amigo Calls API
Amigo Command Center API
Where this information came from

This is an independent, third-party profile of Amigo Tool API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.