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

The Surfaces API from Amigo — 8 operation(s) for surfaces.

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

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

This API exposes 11 operations across 8 paths, and defines 21 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 21 schemas 1 DELETE4 GET1 PATCH5 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 Surfaces 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 — 1 DELETE, 4 GET, 1 PATCH, 5 POST. Each is listed below with its method, path, parameters, and response codes.

Surfaces 11
POST
/v1/{workspace_id}/surfaces
Create Surface
create-surface 1 param body → 200422429
GET
/v1/{workspace_id}/surfaces
List Surfaces
list-surfaces 6 params → 200429422
GET
/v1/{workspace_id}/surfaces/review
List surfaces pending review
list-surface-review-queue 3 params → 200429422
GET
/v1/{workspace_id}/surfaces/{surface_id}
Get Surface
get-surface 2 params → 200404429422
PATCH
/v1/{workspace_id}/surfaces/{surface_id}
Update a surface spec
update-surface 2 params body → 200404409422429
DELETE
/v1/{workspace_id}/surfaces/{surface_id}
Archive (soft-delete) a surface
archive-surface 2 params → 200404409429422
POST
/v1/{workspace_id}/surfaces/{surface_id}/approve
Approve a surface pending review
approve-surface 2 params → 200404409429422
POST
/v1/{workspace_id}/surfaces/{surface_id}/reject
Reject a surface pending review
reject-surface 2 params body → 200404409429422
GET
/v1/{workspace_id}/surfaces/{surface_id}/progress
Get field-level completion status
get-surface-progress 2 params → 200404429422
POST
/v1/{workspace_id}/surfaces/{surface_id}/reshape
Create new surface with only unfilled fields
reshape-surface 2 params → 200404409429422
POST
/v1/{workspace_id}/surfaces/{surface_id}/deliver
Deliver Surface
deliver-surface 2 params body → 200404409422429

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are SurfaceResponse (25 properties), CreateSurfaceRequest (15 properties), CreateSurfaceResponse (13 properties), SurfaceField (12 properties). Each schema is shown below with its type and property counts.

FieldType
string
Input field types for surface data collection.
DeliverSurfaceRequest
object
Request to mark a surface as delivered.
1 property 1 required
CreateSurfaceRequest
object
Request to create a new surface. The agent generates a SurfaceSpec and sends it here.
15 properties 3 required
SurfaceSection
object
A page/step in a multi-page surface form.
4 properties 2 required
DescriptionString
string
BrandingConfig
object
Visual branding for patient-facing surfaces.
4 properties
NameString
string
SurfaceProgressResponse
object
7 properties 7 required
DeliverSurfaceResponse
object
10 properties 3 required
UpdateSurfaceRequest
object
Partial update to an existing surface. All fields are optional. Only provided fields are merged into the spec. Only allowed while status is CREATED or DELIVERE…
11 properties
RejectSurfaceRequest
object
1 property
SurfaceStatus
string
Lifecycle status of a surface.
CreateSurfaceResponse
object
13 properties 9 required
ArchiveResponse
object
2 properties 2 required
HTTPValidationError
object
1 property
ValidationError
object
5 properties 3 required
PaginatedResponse_SurfaceResponse_
object
4 properties 2 required
SurfaceField
object
A single data collection field in a surface spec. Generated by agents from HSM analysis. Each field maps to a specific piece of data the world model needs.
12 properties 3 required
SurfaceResponse
object
25 properties 4 required
ReviewActionResponse
object
3 properties 3 required
ChannelType
string
Delivery channels for surfaces.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amigo-surfaces-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 Surfaces 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.