Get All Assistants - rapida.ai documentation

Retrieves a paginated list of all assistants with optional filtering criteria using the Rapida API.

For more authentication options, see: https://doc.rapida.ai/api-reference/authentication

Parameters

connectionConfig

ConnectionConfig

required

Configuration for the client connection.

request

GetAllAssistantRequest

required

Show child attributes

paginate

Paginate

required

Pagination configuration for the request.

Show child attributes

page

uint32

required

The page number to retrieve (0-based indexing).

pageSize

uint32

required

Number of assistants to return per page.

criterias

Criteria[]

Optional array of filtering criteria to apply to the assistant search.

Show child attributes

key

string

required

The field name to filter by.

value

string

required

The value to match against the specified key.

logic

string

required

The logic operator for the criteria. Accepted values: “should” | “must”

Usage

from rapida import (
    ConnectionConfig,
    GetAllAssistantRequest,
    get_all_assistant,
)
from pprint import pprint

connection_config = ConnectionConfig.default_connection_config(
    ConnectionConfig.with_sdk("{rapida-api-key}")
)
response = get_all_assistant(
    client_cfg=connection_config,
    request=GetAllAssistantRequest(
        paginate=Paginate(page=0, pageSize=20),
        # criterias=[Criteria(key="KEY", value="VALUE", logic="should")],
    ),
)
pprint(response)

Response

code

int32

Numeric status code for the operation.

success

boolean

Indicates whether the operation was successful.

data

Assistant[]

Array of assistant objects returned by the request.

Show child attributes

uint64

Unique identifier for the assistant.

status

string

Current status of the assistant.

visibility

string

Visibility setting of the assistant.

source

string

Source system or origin of the assistant.

sourceIdentifier

uint64

Identifier mapping to the assistant’s source.

assistantTools

AssistantTool[]

Array of tools available to the assistant.

projectId

uint64

Associated project identifier.

organizationId

uint64

Associated organization identifier.

assistantProviderModelId

uint64

Model identifier tied to the assistant provider.

assistantProviderModel

AssistantProviderModel

Detailed information about the assistant’s provider model.

Show child attributes

uint64

Unique identifier for the provider model.

template

TextChatCompletePrompt

Template configuration for text chat completion.

Show child attributes

prompt

TextPrompt[]

Array of prompt configurations.

Show child attributes

role

string

Role of the prompt (e.g., “system”, “user”, “assistant”).

content

string

Content of the prompt.

promptVariables

Variable[]

Array of variables used in the prompt template.

description

string

Description of the provider model.

modelProviderId

uint64

Identifier of the model provider.

modelProviderName

string

Name of the model provider.

assistantModelOptions

Metadata[]

Array of model configuration options.

Show child attributes

uint64

Unique identifier for the metadata entry.

key

string

The option key name.

value

string

The option value.

status

string

Status of the provider model.

createdBy

uint64

Identifier of the creator.

createdUser

User

User object of the creator.

updatedBy

uint64

Identifier of the last updater.

updatedUser

User

User object of the last updater.

createdDate

timestamp

Timestamp when the provider model was created.

updatedDate

timestamp

Timestamp when the provider model was last updated.

name

string

Name of the assistant.

description

string

Description of the assistant’s purpose.

assistantTag

Tag

Tag information associated with the assistant.

language

string

Language setting for the assistant.

organization

Organization

Organization details associated with the assistant.

createdBy

uint64

Identifier of the assistant creator.

createdUser

User

User object of the assistant creator.

updatedBy

uint64

Identifier of the last updater.

updatedUser

User

User object of the last updater.

createdDate

timestamp

Timestamp when the assistant was created.

updatedDate

timestamp

Timestamp when the assistant was last updated.

debuggerDeployment

AssistantDebuggerDeployment

Configuration for debugger deployment.

phoneDeployment

AssistantPhoneDeployment

Configuration for phone deployment.

whatsappDeployment

AssistantWhatsappDeployment

Configuration for WhatsApp deployment.

webPluginDeployment

AssistantWebpluginDeployment

Configuration for web plugin deployment.

apiDeployment

AssistantApiDeployment

Configuration for API deployment.

assistantConversations

AssistantConversation[]

Array of conversations associated with the assistant.

assistantWebhooks

AssistantWebhook[]

Array of webhooks configured for the assistant.

error

object

Error information, if applicable.

Show child attributes

errorCode

string

Machine-readable error code.

errorMessage

string

Detailed error message.

paginated

object

Pagination information for the response.

Show child attributes

totalCount

int64

Total number of assistants available.

totalPages

int32

Total number of pages available.

currentPage

int32

Current page number (0-based).

pageSize

int32

Number of items per page.

hasNext

boolean

Indicates if there are more pages available.

hasPrevious

boolean

Indicates if there are previous pages available.

Documentation Index

​Parameters

​Usage

​Response

Parameters

Usage

Response