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

The Organization API from Amigo — 11 operation(s) for organization.

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

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

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

18 operations 11 paths 64 schemas 4 DELETE7 GET6 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 Organization 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 18

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

Organization 18
GET
/v1/{organization}/organization/
Get an organization
get-organization 3 params → 200404422503
PUT
/v1/{organization}/organization/
Create an organization
create-organization 3 params body → 201422409400401403503429
POST
/v1/{organization}/organization/
Modify an organization
modify-organization 3 params body → 204404422503429401403
DELETE
/v1/{organization}/organization/
Delete an organization
delete-organization 3 params → 204422404401400409403503
POST
/v1/{organization}/organization/agent
Create an agent
create-agent 3 params body → 201404422409401403503429
GET
/v1/{organization}/organization/agent
Get agents for an organization
get-agents 7 params → 200404422401403503429
POST
/v1/{organization}/organization/agent/{agent_id}/
Create an agent version
create-agent-version 5 params body → 201404422409400401403503
DELETE
/v1/{organization}/organization/agent/{agent_id}/
Delete an agent
delete-agent 4 params → 200404400409422401403503
POST
/v1/{organization}/organization/service_hierarchical_state_machine
Create a service hierarchical state machine
create-service-hierarchical-state-machine 3 params body → 201404422409401403503429
GET
/v1/{organization}/organization/service_hierarchical_state_machine
Get service hierarchical state machines for an organization
get-service-hierarchical-state-machines 7 params → 200404422401403503429
POST
/v1/{organization}/organization/service_hierarchical_state_machine/{service_hierarchical_state_machine_id}/
Create a service hierarchical state machine version
create-service-hierarchical-state-machine-version 6 params body → 201404400409422401403503
DELETE
/v1/{organization}/organization/service_hierarchical_state_machine/{state_machine_id}/
Delete a service hierarchical state machine
delete-service-hierarchical-state-machine 4 params → 200404400409422401403503
POST
/v1/{organization}/organization/api_key/
Create an API key
create-api-key 3 params body → 201404400422409401403503
GET
/v1/{organization}/organization/api_key/
Get API keys for the organization
get-api-keys 3 params → 200422404401403503429
DELETE
/v1/{organization}/organization/api_key/{api_key_id}/
Delete an API key
delete-api-key 4 params → 200404422401403503429
GET
/v1/{organization}/organization/agent/{agent_id}/version
Get agent versions
get-agent-versions 8 params → 200404422401403503429
GET
/v1/{organization}/organization/service_hierarchical_state_machine/{service_hierarchical_state_machine_id}/version
Get service hierarchical state machine versions
get-service-hierarchical-state-machine-versions 8 params → 200404422401403503429
GET
/v1/{organization}/organization/user_dimensions/
Get user dimensions for the organization
get-user-dimensions 3 params → 200422404401403503429

Schemas 64

The contract defines 64 schemas that model the data the API accepts and returns. The most detailed are ServiceHierarchicalStateMachineInstance (14 properties), ToolCallState-Input (11 properties), ToolCallState-Output (11 properties), ActionState-Input (11 properties). Each schema is shown below with its type and property counts.

amigo_lib__mongo__collections__api_key__APIKey__UserInfo
object
2 properties 2 required
VoiceConfigInstance
object
4 properties 1 required
amigo_lib__mongo__collections__service_hierarchical_state_machine__ServiceHierarchicalStateMachine__UserInfo
object
2 properties 2 required
DecisionState-Output
object
A passthrough state in which the Agent must decide, among a list of exit conditions, one that the session has satisfied, and transitions to the next state asso…
8 properties 8 required
Identity-Input
object
5 properties 5 required
src__app__endpoints__organization__modify_organization__Request__Preferences
object
6 properties
AnnotationState-Input
object
4 properties 4 required
StateOrRefName
string
ToolCallState-Output
object
A state that executes a tool call.
11 properties 11 required
RelationshipToDeveloper-Input
object
4 properties 4 required
Identity-Output
object
5 properties 5 required
ResultPersistence
string
src__app__endpoints__organization__modify_organization__Request
object
5 properties
src__app__endpoints__organization__create_service_hierarchical_state_machine_version__Request
object
9 properties 9 required
src__app__endpoints__organization__get_service_hierarchical_state_machine_versions__Response
object
3 properties 3 required
src__app__endpoints__organization__create_service_hierarchical_state_machine_version__Request__ToolCallSpec
object
6 properties 6 required
APIKeyInstance
object
9 properties 9 required
src__app__endpoints__organization__get_agent_versions__Response
object
3 properties 3 required
ReflectionState-Input
object
8 properties 8 required
src__app__endpoints__organization__create_api_key__Response
object
3 properties 3 required
ExitCondition-Input
object
2 properties 2 required
src__app__endpoints__organization__create_agent_version__Response
object
2 properties 2 required
src__app__endpoints__organization__create_api_key__Request
object
3 properties 2 required
RelationshipToDeveloper-Output
object
4 properties 4 required
ActionState-Input
object
11 properties 11 required
src__app__endpoints__organization__create_service_hierarchical_state_machine__Request
object
1 property 1 required
ExitCondition-Output
object
2 properties 2 required
amigo_lib__pydantic__base_model__StrippedNonemptyString__3
string
src__app__endpoints__organization__create_agent__Response
object
1 property 1 required
Preferences-Output
object
Preferences that the user can set to customize their experience.
6 properties
DecisionState-Input
object
8 properties 8 required
src__app__endpoints__organization__create_service_hierarchical_state_machine__Response
object
1 property 1 required
ServiceHierarchicalStateMachineInstance
object
14 properties 14 required
RecallState-Output
object
A passthrough state in which an active memory extraction for the provided queries is performed, and the result added to the working memory, before proceeding t…
5 properties 5 required
src__app__endpoints__organization__get_agent_versions__Response__AgentInstance
object
11 properties 11 required
AnnotationState-Output
object
A passthrough state in which the agent adds a pre-determined inner thought message before continuing.
4 properties 4 required
src__app__endpoints__organization__create_agent_version__Request
object
6 properties
State
src__app__endpoints__organization__create_organization__Request__Preferences
object
6 properties
UserDimension-Input
object
2 properties 2 required
UserDimension-Output
object
2 properties 2 required
VoiceConfig
object
1 property 1 required
src__app__endpoints__organization__get_agents__Response
object
3 properties 3 required
src__app__endpoints__organization__get_api_keys__Response
object
1 property 1 required
amigo_lib__mongo__collections__agent__Agent__UserInfo
object
2 properties 2 required
StateMachineInstance
object
4 properties 4 required
src__app__endpoints__organization__create_agent__Request
object
1 property 1 required
src__app__endpoints__organization__get_service_hierarchical_state_machines__Response
object
3 properties 3 required
ReflectionState-Output
object
A passthrough state in which the agent reflects on the conversation so far and adds an inner thought message before continuing.
8 properties 8 required
StrippedNonemptyString_a-z-______
string
src__app__endpoints__organization__create_organization__Response
object
1 property 1 required
amigo_lib__pydantic__base_model__StrippedNonemptyString__1
string
src__app__endpoints__organization__get_user_dimensions__Response
object
1 property 1 required
ActionState-Output
object
A state associated with an objective and a list of actions. The Agent will perform these actions towards achieving the objective. The session may transition to…
11 properties 11 required
src__app__endpoints__organization__create_organization__Request
object
7 properties 6 required
amigo_lib__mongo__collections__service_hierarchical_state_machine__ServiceHierarchicalStateMachine__ToolCallSpec
object
A description of a tool call that the agent can make in this state.
6 properties 6 required
RecallState-Input
object
5 properties 5 required
src__app__endpoints__organization__delete_api_key__Response
object
1 property 1 required
ExternalStateName
string
src__app__endpoints__organization__get_organization__Response
object
4 properties 4 required
src__app__endpoints__organization__create_service_hierarchical_state_machine_version__Response
object
2 properties 2 required
src__app__endpoints__organization__get_agents__Response__AgentInstance
object
4 properties 4 required
amigo_lib__pydantic__base_model__StrippedNonemptyString__2
string
ToolCallState-Input
object
11 properties 11 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amigo-organization-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 Organization 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.