Resources

amigo_sdk.resources.conversation.AsyncConversationResource

Conversation resource for Amigo API operations.

create_conversation(body, params, abort_event=None) async

Create a new conversation and stream NDJSON events.

Returns an async generator yielding ConversationCreateConversationResponse events.

interact_with_conversation(conversation_id, params, abort_event=None, *, initial_message_type='user-message', text_message=None, audio_bytes=None, audio_content_type=None, external_event_message_content=None, external_event_message_timestamp=None) async

Interact with a conversation and stream NDJSON events.

Returns an async generator yielding ConversationInteractWithConversationResponse events.

finish_conversation(conversation_id) async

Finish a conversation.

get_conversations(params) async

Get conversations.

get_conversation_messages(conversation_id, params) async

Get conversation messages.

recommend_responses_for_interaction(conversation_id, interaction_id) async

Recommend responses for an interaction.

get_interaction_insights(conversation_id, interaction_id) async

Get insights for an interaction.

get_message_source(conversation_id, message_id) async

Get the source of a message.

generate_conversation_starters(body) async

Generate conversation starters.

list(params) async

Alias for get_conversations.

create(*args, **kwargs)

Alias for create_conversation.

interact(*args, **kwargs)

Alias for interact_with_conversation.

finish(conversation_id) async

Alias for finish_conversation.

messages(conversation_id, params) async

Alias for get_conversation_messages.

amigo_sdk.resources.conversation.ConversationResource

Conversation resource for synchronous operations.

create_conversation(body, params, abort_event=None)

Create a new conversation and stream NDJSON events.

interact_with_conversation(conversation_id, params, abort_event=None, *, initial_message_type='user-message', text_message=None, audio_bytes=None, audio_content_type=None, external_event_message_content=None, external_event_message_timestamp=None)

Interact with a conversation and stream NDJSON events.

finish_conversation(conversation_id)

Finish a conversation.

get_conversations(params)

Get a list of conversations matching the query parameters.

get_conversation_messages(conversation_id, params)

Get messages for a conversation.

recommend_responses_for_interaction(conversation_id, interaction_id)

Get recommended responses for an interaction.

get_interaction_insights(conversation_id, interaction_id)

Get insights for an interaction.

get_message_source(conversation_id, message_id)

Get the audio/media source URL for a message.

generate_conversation_starters(body)

Generate conversation starter suggestions.

list(params)

Alias for get_conversations.

create(*args, **kwargs)

Alias for create_conversation.

interact(*args, **kwargs)

Alias for interact_with_conversation.

finish(conversation_id)

Alias for finish_conversation.

messages(conversation_id, params)

Alias for get_conversation_messages.

amigo_sdk.resources.user.AsyncUserResource

User resource for Amigo API operations.

get_users(params=None) async

Get a list of users in the organization.

create_user(body) async

Create (invite) a new user to the organization.

delete_user(user_id) async

Delete a user by ID. Returns None on success (e.g., 204).

update_user(user_id, body) async

Update user information. Returns None on success (e.g., 204).

get_user_model(user_id) async

Get the latest user model for a user.

list(params=None) async

Alias for get_users.

create(body) async

Alias for create_user.

delete(user_id) async

Alias for delete_user.

update(user_id, body) async

Alias for update_user.

get_model(user_id) async

Alias for get_user_model.

amigo_sdk.resources.user.UserResource

User resource (synchronous).

get_users(params=None)

Get a list of users in the organization.

create_user(body)

Create (invite) a new user to the organization.

delete_user(user_id)

Delete a user by ID.

update_user(user_id, body)

Update user information.

get_user_model(user_id)

Get the latest user model for a user.

list(params=None)

Alias for get_users.

create(body)

Alias for create_user.

delete(user_id)

Alias for delete_user.

update(user_id, body)

Alias for update_user.

get_model(user_id)

Alias for get_user_model.

amigo_sdk.resources.organization.AsyncOrganizationResource

Organization resource for Amigo API operations.

get() async

Get the details of an organization.

amigo_sdk.resources.organization.OrganizationResource

Organization resource for synchronous operations.

get()

Get the details of the organization.

amigo_sdk.resources.service.AsyncServiceResource

Service resource for Amigo API operations.

get_services(params=None) async

List services for the organization.

create_service(body) async

Create a new service.

update_service(service_id, body) async

Update a service.

upsert_version_set(service_id, version_set_name, body) async

Upsert a service version set.

delete_version_set(service_id, version_set_name) async

Delete a service version set.

list(params=None) async

Alias for get_services.

create(body) async

Alias for create_service.

amigo_sdk.resources.service.ServiceResource

Service resource (synchronous).

get_services(params=None)

List services for the organization.

create_service(body)

Create a new service.

update_service(service_id, body)

Update a service.

upsert_version_set(service_id, version_set_name, body)

Upsert a service version set.

delete_version_set(service_id, version_set_name)

Delete a service version set.

list(params=None)

Alias for get_services.

create(body)

Alias for create_service.