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 Workspace Data Queries API

The Workspace Data Queries API from Amigo — 3 operation(s) for workspace data queries.

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

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

This API exposes 6 operations across 3 paths, and defines 12 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 3 paths 12 schemas 1 DELETE2 GET1 PATCH2 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 Workspace Data Queries 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 3 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Workspace Data Queries 6
GET
/v1/{workspace_id}/data_queries
List workspace data queries
list-workspace-data-queries 4 params → 200403401422
POST
/v1/{workspace_id}/data_queries
Create Workspace Data Query
create-workspace-data-query 1 param body → 201409422
GET
/v1/{workspace_id}/data_queries/{query_id}
Get Workspace Data Query
get-workspace-data-query 2 params → 200404422
PATCH
/v1/{workspace_id}/data_queries/{query_id}
Update Workspace Data Query
update-workspace-data-query 2 params body → 200404409422
DELETE
/v1/{workspace_id}/data_queries/{query_id}
Delete Workspace Data Query
delete-workspace-data-query 2 params → 204404422
POST
/v1/{workspace_id}/data_queries/{query_id}/invoke
Invoke Workspace Data Query
invoke-workspace-data-query 2 params body → 200404503422

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are src__routes__workspace_data_queries__list_workspace_data_queries__Response__Item (9 properties), WorkspaceDataQueryItem (9 properties), ValidationError (5 properties), src__routes__workspace_data_queries__update_workspace_data_query__Request (5 properties). Each schema is shown below with its type and property counts.

src__routes__workspace_data_queries__list_workspace_data_queries__Response__Item
object
9 properties 8 required
src__routes__workspace_data_queries__list_workspace_data_queries__Response
object
3 properties 2 required
src__routes__workspace_data_queries__invoke_workspace_data_query__Response
object
3 properties
HTTPValidationError
object
1 property
src__routes__workspace_data_queries__create_workspace_data_query__Request__Parameter
object
Strict write-side validator for one declared parameter.
4 properties 3 required
src__routes__workspace_data_queries__update_workspace_data_query__Request
object
PATCH body — every field optional. Present ⇒ overwrite; absent ⇒ keep.
5 properties
src__routes__workspace_data_queries__create_workspace_data_query__Request
object
Create body — the authored shape of a new workspace data query. The SQL template + parameters parity check + multi-statement / session-state-command refusal ru…
5 properties 3 required
src__routes__workspace_data_queries__update_workspace_data_query__Request__Parameter
object
Strict write-side validator for one declared parameter.
4 properties 3 required
ValidationError
object
5 properties 3 required
WorkspaceDataQueryItem
object
Wire shape for the response of every read + create/update handler. id (UUID) is the stable handle — every URL except list takes it. name is the workspace-visib…
9 properties 8 required
src__routes__workspace_data_queries__invoke_workspace_data_query__Request
object
1 property
StoredParameter
object
One typed input parameter to a workspace data query — trusted shape. Read-path model: the DB's CHECK constraints already enforced name regex and type enum on w…
4 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amigo-workspace-data-queries-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 Workspace Data Queries 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.