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

The Workspaces API from Amigo — 8 operation(s) for workspaces.

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

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

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

11 operations 8 paths 15 schemas 5 GET1 PATCH3 POST2 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 Workspaces 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 11

Across 8 paths, the API surfaces 11 operations — 5 GET, 1 PATCH, 3 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Workspaces 11
GET
/v1/workspaces/{workspace_id}
Get a workspace
get-workspace 1 param → 200404403401
PATCH
/v1/workspaces/{workspace_id}
Update a workspace
update-workspace 1 param body → 200404403401422
GET
/v1/workspaces
List workspaces
list-workspaces 2 params → 200403401422
POST
/v1/workspaces/{workspace_id}/provision
Provision workspace resources
provision-workspace 1 param → 200404403401
POST
/v1/workspaces/{workspace_id}/archive
Archive a workspace
archive-workspace 1 param body → 200404403401422
GET
/v1/workspaces/{workspace_id}/environment-check
Pre-check environment conversion
check-environment-conversion 2 params → 200403401422
POST
/v1/workspaces/{workspace_id}/convert-environment
Convert workspace environment
convert-workspace-environment 1 param body → 200404403401422
GET
/v1/workspaces/{workspace_id}/test-caller-numbers
Get test caller numbers
get-test-caller-numbers 1 param → 200
PUT
/v1/workspaces/{workspace_id}/test-caller-numbers
Update test caller numbers
update-test-caller-numbers 1 param body → 200422
GET
/v1/workspaces/{workspace_id}/test-credential-ids
Get test credential IDs
get-test-credential-ids 1 param → 200
PUT
/v1/workspaces/{workspace_id}/test-credential-ids
Update test credential IDs
update-test-credential-ids 1 param body → 200422

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are WorkspaceResponse (10 properties), ValidationError (5 properties), PaginatedResponse_WorkspaceResponse_ (4 properties), UpdateWorkspaceRequest (4 properties). Each schema is shown below with its type and property counts.

SlugString
string
TestCredentialIdsResponse
object
1 property 1 required
TestCallerNumbersResponse
object
1 property 1 required
EnvironmentCheckResponse
object
3 properties 3 required
HTTPValidationError
object
1 property
StrippedNonemptyString
string
WorkspaceResponse
object
10 properties 10 required
TestCallerNumbersRequest
object
1 property 1 required
ArchiveWorkspaceRequest
object
1 property 1 required
UpdateWorkspaceRequest
object
4 properties
PaginatedResponse_WorkspaceResponse_
object
4 properties 2 required
ValidationError
object
5 properties 3 required
TestCredentialIdsRequest
object
1 property 1 required
ConvertEnvironmentRequest
object
2 properties 2 required
ProvisionResponse
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amigo-workspaces-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 Workspaces 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.