Skip to main content
Gets paginated API deployments for an assistant. Use user-scoped authentication because the operation requires organization and project context.
For setup and authentication options, see the Installation guide and Authentication.

Parameters

connectionConfig
ConnectionConfig
required
Configuration for the client connection.
request
GetAllAssistantDeploymentRequest
required
Deployment list request.

Usage

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());

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.
paginated
Paginated
Pagination metadata.
error
Error
Error details when the operation fails.

Errors

CodeMeaning
1016001Unauthenticated request.
1016002Missing authentication scope.
1016003Invalid assistantId.
1016004Invalid request.
1016005Unable to get assistant API deployments.