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

The Dashboards API from Amigo — 4 operation(s) for dashboards.

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

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

This API exposes 7 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.

7 operations 4 paths 11 schemas 1 DELETE3 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 Dashboards 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 7

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

Dashboards 7
POST
/v1/{workspace_id}/dashboards
Create Dashboard
create_dashboard_v1__workspace_id__dashboards_post 1 param body → 201422
GET
/v1/{workspace_id}/dashboards
List Dashboards
list_dashboards_v1__workspace_id__dashboards_get 4 params → 200422
GET
/v1/{workspace_id}/dashboards/{dashboard_id}
Get Dashboard
get_dashboard_v1__workspace_id__dashboards__dashboard_id__get 2 params → 200422
PUT
/v1/{workspace_id}/dashboards/{dashboard_id}
Update Dashboard
update_dashboard_v1__workspace_id__dashboards__dashboard_id__put 2 params body → 200422
DELETE
/v1/{workspace_id}/dashboards/{dashboard_id}
Delete Dashboard
delete_dashboard_v1__workspace_id__dashboards__dashboard_id__delete 2 params → 204422
GET
/v1/{workspace_id}/dashboards/by-slug/{slug}
Get Dashboard By Slug
get_dashboard_by_slug_v1__workspace_id__dashboards_by_slug__slug__get 2 params → 200422
POST
/v1/{workspace_id}/dashboards/{dashboard_id}/execute
Execute Dashboard
execute_dashboard_v1__workspace_id__dashboards__dashboard_id__execute_post 2 params body → 200422

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are DashboardDefinitionResponse (13 properties), UpdateDashboardRequest (7 properties), CreateDashboardRequest (7 properties), ValidationError (5 properties). Each schema is shown below with its type and property counts.

DashboardExecuteResponse
object
2 properties 2 required
NameString
string
HTTPValidationError
object
1 property
DescriptionString
string
CreateDashboardRequest
object
7 properties 2 required
ValidationError
object
5 properties 3 required
PaginatedResponse_DashboardDefinitionResponse_
object
4 properties 2 required
PanelResultResponse
object
4 properties 3 required
DashboardDefinitionResponse
object
13 properties 7 required
ExecutePanelRequest
object
1 property
UpdateDashboardRequest
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amigo-dashboards-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 Dashboards 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.