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 Functions API

The Functions API from Amigo — 4 operation(s) for functions.

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

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

This API exposes 6 operations across 4 paths, and defines 11 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.

6 operations 4 paths 11 schemas 1 DELETE2 GET2 POST1 PUT

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 Functions 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 6

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

Functions 6
GET
/v1/{workspace_id}/functions
List every platform function registered in the workspace
list-functions 1 param → 200429
GET
/v1/{workspace_id}/functions/{function_name}
Get a registered platform function by name
get-function 2 params → 200404429422
PUT
/v1/{workspace_id}/functions/{function_name}
Deploy (validate + upsert) a platform function
deploy-function 2 params body → 200400422429
DELETE
/v1/{workspace_id}/functions/{function_name}
Remove a registered platform function
delete-function 2 params → 204404429422
POST
/v1/{workspace_id}/functions/{function_name}/invoke
Execute a registered platform function
invoke-function 2 params body → 200404422429
POST
/v1/{workspace_id}/functions/{function_name}/test
Test invoke + persist lasttest telemetry on the row
test-function 2 params body → 200404429422

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are RegisteredFunctionResponse (16 properties), RegisteredFunction (11 properties), TestInvokeResponse (6 properties), ValidationError (5 properties). Each schema is shown below with its type and property counts.

ReturnColumn
object
One column in a UDTF's output schema. UC RETURNS TABLE( , , ...) requires declaring the schema at deploy time. This list anchors that schema for functiontype=u…
3 properties 2 required
InvokeRequest
object
Invoke a registered function with caller-supplied args.
1 property
RegisteredFunction
object
The authored shape of a platform function. Identical wire format whether it's authored as a YAML file in the repo or POSTed to /v1/{ws}/functions/deploy. The d…
11 properties 3 required
platform_lib__platform_functions__models__Parameter
object
Typed declaration of one input parameter. For SQL function types, name becomes the :name placeholder in the SQL template. For Python function types, name becom…
4 properties 3 required
HTTPValidationError
object
1 property
TestInvokeResponse
object
Response shape for POST /v1/{ws}/functions/{name}/test. Structural superset of :class:InvokeResponse. Adds status and error so the DC can render the executor's…
6 properties
RegisteredFunctionListResponse
object
2 properties 2 required
ValidationError
object
5 properties 3 required
FunctionExample
object
One example call, surfaced to the LLM and the DC test panel. Examples are first-class metadata, not buried in a UC COMMENT clause the way Databricks' native au…
3 properties 2 required
RegisteredFunctionResponse
object
Single row from platform.functions.
16 properties 4 required
InvokeResponse
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amigo-functions-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 Functions 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.