Gets the latest API deployment for an assistant. Use user-scoped authentication because the operation requires organization and project context.
Parameters
Configuration for the client connection.
request
GetAssistantDeploymentRequest
required
Deployment lookup request.
Assistant ID for the deployment.
Usage
import {
ConnectionConfig,
GetAssistantDeploymentRequest,
GetAssistantApiDeployment,
} 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 request = new GetAssistantDeploymentRequest();
request.setAssistantid("ASSISTANT_ID_PLACEHOLDER");
const response = await GetAssistantApiDeployment(connectionCfg, request);
console.dir(response.toObject());
Response
Numeric status code for the operation.
Indicates whether the operation was successful.
API deployment. If no deployment exists, the deployment field may be omitted.
Unique identifier for the API deployment.
Assistant ID for the deployment.
First message the assistant sends when the session starts.
Message used when the assistant cannot understand or handle input.
Speech-to-text provider configuration.
Text-to-speech provider configuration.
Current deployment status.
Number of idle-timeout retries.
Message sent on idle timeout.
Maximum session duration in seconds.
Timestamp when the deployment was created.
Timestamp when the deployment was last updated.
Error details when the operation fails.
Stable, machine-readable numeric code.
Developer-oriented message with diagnostic details.
Human-friendly description safe for display to end users.
Errors
| Code | Meaning |
|---|
1011001 | Unauthenticated request. |
1011002 | Missing authentication scope. |
1011003 | Invalid assistantId. |
1011004 | Unable to get assistant API deployment. |
