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

The User API from Amigo — 8 operation(s) for user.

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

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

This API exposes 10 operations across 8 paths, and defines 25 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 8 paths 25 schemas 1 DELETE4 GET5 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 User 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 8 paths, the API surfaces 10 operations — 1 DELETE, 4 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.

User 10
POST
/v1/{organization}/user/
Create a new user
create-invited-user 3 params body → 201409404422401403503429
GET
/v1/{organization}/user/
Get users
get-users 8 params → 200404422401403503429
POST
/v1/{organization}/user/signin_with_api_key
Sign in with API key
sign-in-with-api-key 6 params → 200404401422503429
POST
/v1/{organization}/user/signin
Sign in with email
sign-in-with-email 3 params body → 200404422503
POST
/v1/{organization}/user/{requested_user_id}
Update user info
update-user-info 4 params body → 204422404409401403503429
DELETE
/v1/{organization}/user/{requested_user_id}
Delete an user
delete-user 4 params → 204404400422409401403503
GET
/v1/{organization}/user/{user_id}/user_model
Get user model
get-user-model 4 params → 200404422401403503429
GET
/v1/{organization}/user/{user_id}/memory
Get memories
get-memories 9 params → 200404422401403503429
GET
/v1/{organization}/user/search/
Search users
search-users 5 params → 200404422401403503429
POST
/v1/{organization}/user/{requested_user_id}/variable
Modify the variables of an user
modify-user-variables 4 params body → 204422404400401403503429

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are src__app__endpoints__user__get_users__Response__UserInstance (11 properties), src__app__endpoints__user__search_users__Response__UserInstance (10 properties), src__app__endpoints__user__update_user_info__Request (9 properties), src__app__endpoints__user__create_invited_user__Request (8 properties). Each schema is shown below with its type and property counts.

src__app__endpoints__user__get_user_model__Response
object
2 properties 2 required
src__app__endpoints__user__create_invited_user__Request
object
8 properties 4 required
UserStats
object
3 properties 3 required
StrippedNonemptyString_a-z___a-z0-9_______
string
StrippedNonemptyString_a-z-_____a-z-____0_2____
string
src__app__endpoints__user__sign_in_with_email__Request
object
2 properties 2 required
_NotSet
object
A specific type to indicate that a field is not set in the request.
src__app__endpoints__user__modify_user_variables__Request
object
2 properties
Preferences-Output
object
Preferences that the user can set to customize their experience.
6 properties
src__app__endpoints__user__search_users__Response
object
1 property 1 required
src__app__endpoints__user__sign_in_with_api_key__Response
object
2 properties 2 required
MemoryInstance
object
6 properties 6 required
src__app__endpoints__user__create_invited_user__Response
object
2 properties 2 required
UserModel
object
3 properties 3 required
src__app__endpoints__user__update_user_info__Request
object
9 properties
src__app__endpoints__user__get_memories__Response
object
3 properties 3 required
UpsertRequest
object
3 properties 3 required
UserDimension-Output
object
2 properties 2 required
src__app__endpoints__user__modify_user_variables__Request__DeleteRequest
object
1 property 1 required
src__app__endpoints__user__create_invited_user__Request__Preferences
object
6 properties
amigo_lib__pydantic__base_model__StrippedNonemptyString__1
string
src__app__endpoints__user__search_users__Response__UserInstance
object
10 properties 10 required
StrippedNonemptyString_a-z___a-z0-9___lambda__at_0xffff718d0a90__
string
src__app__endpoints__user__get_users__Response
object
3 properties 3 required
src__app__endpoints__user__get_users__Response__UserInstance
object
11 properties 11 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amigo-user-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 User 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.