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 Surface Patient API

The Surface Patient API from Amigo — 10 operation(s) for surface patient.

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

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

This API exposes 10 operations across 10 paths, and defines 17 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.

10 operations 10 paths 17 schemas 5 GET4 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 Surface Patient 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 10

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

Surface Patient 10
GET
/s/f/{surface_id}
Redirect To Surface
redirect-to-surface 1 param → 200302404410422
GET
/s/{token}/lookup/{lookup_type}
Lookup Field
lookup-surface-field 3 params → 200401422429
POST
/s/{token}/ocr
Ocr Extract
ocr-surface-extract 1 param body → 200401429422
GET
/s/{token}
Render Surface
render-surface 1 param → 200401410429422
GET
/s/{token}/spec
Get Surface Spec
get-surface-spec 1 param → 200401404409410429422
GET
/s/{token}/availability
Get Availability
get-surface-availability 3 params → 200401410422429
POST
/s/{token}/book
Book Appointment
book-surface-appointment 1 param body → 200401404409410422429
POST
/s/{token}/heal
Heal Field
heal-surface-field 1 param body → 200401429422
POST
/s/{token}/submit
Submit Surface
submit-surface 1 param → 200401409410429422
PUT
/s/{token}/fields/{key}
Save Field
save-surface-field 2 params body → 200401413429500422

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are PatientSurfaceSpec (10 properties), HealFieldRequest (6 properties), SurfaceSpecResponse (5 properties), ValidationError (5 properties). Each schema is shown below with its type and property counts.

SurfaceErrorResponse
object
Error envelope returned by patient-facing surface JSON endpoints. Frontend (forms-app) reads errorcode for branching and message for user-visible copy. reason…
4 properties 1 required
AvailabilityResponse
object
Available appointment slots grouped by date.
1 property
PatientSurfaceSpec
object
Patient-facing surface spec — what forms-app renders. Free-form by design: fields/sections/branding are forwarded from the upstream surface document as raw dic…
10 properties
LookupResponse
object
Autocompletion results for a surface lookup field.
1 property
SaveFieldResponse
object
Acknowledgement returned when a field is auto-saved.
1 property
OcrResponse
object
Structured field extraction result for an uploaded image.
2 properties 1 required
SurfaceSpecResponse
object
Surface render bundle returned to forms-app SSR.
5 properties 1 required
HTTPValidationError
object
1 property
BookingRequest
object
1 property 1 required
ValidationError
object
5 properties 3 required
BookingResponse
object
Acknowledgement returned when a booking request is accepted.
3 properties 3 required
OcrRequest
object
2 properties 1 required
AvailabilitySlot
object
4 properties 3 required
FieldSaveRequest
object
1 property 1 required
AvailabilityDate
object
2 properties 1 required
HealFieldResponse
object
3 properties 2 required
HealFieldRequest
object
6 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amigo-surface-patient-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 Surface Patient 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.