> ## Documentation Index
> Fetch the complete documentation index at: https://doc.rapida.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get All API Deployments

> Get assistant API deployments from the Rapida SDK.

Gets paginated API deployments for an assistant. Use user-scoped authentication because the operation requires organization and project context.

> [!NOTE]
>
> For setup and authentication options, see the [Installation guide](https://doc.rapida.ai/api-reference/installation.md) and [Authentication](https://doc.rapida.ai/api-reference/authentication.md).

## Parameters

**connectionConfig** `ConnectionConfig` *required*

Configuration for the client connection.

**request** `GetAllAssistantDeploymentRequest` *required*

Deployment list request.

**assistantId** `uint64` *required*

Assistant ID for the deployments.

**paginate** `Paginate` *required*

Pagination configuration for the request.

**page** `uint32` *required*

Page number to retrieve.

**pageSize** `uint32` *required*

Number of deployments to return per page.

**criterias** `Criteria[]`

Optional filtering criteria to apply to the deployment search.

**key** `string` *required*

Field name to filter by.

**value** `string` *required*

Value to match against the field.

**logic** `string` *required*

Criteria logic. Accepted values: `should` or `must`.

## Usage

```ts React theme={null}
import {
  ConnectionConfig,
  GetAllAssistantDeploymentRequest,
  GetAllAssistantApiDeployment,
  Paginate,
} from "@rapidaai/react";

const auth = ConnectionConfig.WithDebugger({
  authorization: "AUTHORIZATION_TOKEN_PLACEHOLDER",
  userId: "AUTH_ID_PLACEHOLDER",
  projectId: "PROJECT_ID_PLACEHOLDER",
});
const connectionCfg = ConnectionConfig.DefaultConnectionConfig(auth);

const pagination = new Paginate();
pagination.setPage(1);
pagination.setPagesize(20);

const request = new GetAllAssistantDeploymentRequest();
request.setAssistantid("ASSISTANT_ID_PLACEHOLDER");
request.setPaginate(pagination);

const response = await GetAllAssistantApiDeployment(connectionCfg, request);
console.dir(response.toObject());
```

```python Python theme={null}
import os
from pprint import pprint

from rapida import ConnectionConfig, Paginate
from rapida.clients.protos.assistant_deployment_pb2 import (
    GetAllAssistantDeploymentRequest,
)

auth = ConnectionConfig.with_debugger(
    authorization=os.getenv("RAPIDA_AUTHORIZATION"),
    user_id=os.getenv("RAPIDA_AUTH_ID"),
    project_id=os.getenv("RAPIDA_PROJECT_ID"),
)
connection_config = ConnectionConfig.default_connection_config(auth)

response = connection_config.assistant_deployment_client.GetAllAssistantApiDeployment(
    GetAllAssistantDeploymentRequest(
        assistantId=int(os.getenv("RAPIDA_ASSISTANT_ID")),
        paginate=Paginate(page=1, pageSize=20),
    ),
    metadata=connection_config.auth,
)
pprint(response)
```

```go Go theme={null}
package main

import (
	"context"
	"fmt"
	"os"

	clients "github.com/rapidaai/rapida-go/rapida/clients"
	connections "github.com/rapidaai/rapida-go/rapida/connections"
	protos "github.com/rapidaai/rapida-go/protos"
)

func main() {
	connectionConfig := connections.DefaultconnectionConfig(
		connections.WithPersonalToken(
			os.Getenv("RAPIDA_AUTHORIZATION"),
			os.Getenv("RAPIDA_AUTH_ID"),
			os.Getenv("RAPIDA_PROJECT_ID"),
		),
	)

	response, err := clients.GetAllAssistantApiDeployment(
		context.Background(),
		connectionConfig,
		&protos.GetAllAssistantDeploymentRequest{
			AssistantId: 2227823180112723968,
			Paginate: &protos.Paginate{
				Page:     1,
				PageSize: 20,
			},
		},
	)
	if err != nil {
		fmt.Printf("error while getting API deployments: %+v\n", err)
		return
	}
	fmt.Printf("get API deployments response: %+v\n", response)
}
```

## Response

**code** `int32`

Numeric status code for the operation.

**success** `boolean`

Indicates whether the operation was successful.

**data** `AssistantApiDeployment[]`

API deployments returned by the request.

**id** `uint64`

Unique identifier for the API deployment.

**assistantId** `uint64`

Assistant ID for the deployment.

**greeting** `string`

First message the assistant sends when the session starts.

**greetingInterruptible** `boolean`

Controls whether users can interrupt the opening greeting in audio sessions.

**mistake** `string`

Message used when the assistant cannot understand or handle input.

**unclearInputTimeout** `double`

Seconds to wait after interrupted or unclear input before asking the user to repeat.

**unclearInputMessage** `string`

Message sent when the assistant could not understand the user input.

**inputAudio** `DeploymentAudioProvider`

Speech-to-text provider configuration.

**outputAudio** `DeploymentAudioProvider`

Text-to-speech provider configuration.

**status** `string`

Current deployment status.

**idealTimeout** `uint64`

Idle timeout in seconds.

**idealTimeoutBackoff** `uint64`

Number of idle-timeout retries.

**idealTimeoutMessage** `string`

Message sent on idle timeout.

**maxSessionDuration** `uint64`

Maximum session duration in seconds.

**createdDate** `timestamp`

Timestamp when the deployment was created.

**updatedDate** `timestamp`

Timestamp when the deployment was last updated.

**paginated** `Paginated`

Pagination metadata.

**currentPage** `uint32`

Current page returned by the API.

**totalItem** `uint32`

Total number of matching deployments.

**error** `Error`

Error details when the operation fails.

**errorCode** `string`

Stable, machine-readable numeric code.

**errorMessage** `string`

Developer-oriented message with diagnostic details.

**humanMessage** `string`

Human-friendly description safe for display to end users.

## Errors

| Code | Meaning |
| - | - |
| `1016001` | Unauthenticated request. |
| `1016002` | Missing authentication scope. |
| `1016003` | Invalid `assistantId`. |
| `1016004` | Invalid request. |
| `1016005` | Unable to get assistant API deployments. |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.