create-assistant

Authorizations

x-api-key

string

header

required

API key from Rapida credentials.

Headers

x-client-source

enum<string>

default:sdk

Client source identifier. SDK clients send this automatically.

Available options:

sdk

x-auth-id

string

Optional user identifier to propagate with the request.

Body

application/json

assistantProvider

object

required

Provider configuration for the assistant. Provide exactly one of model, agentkit, or websocket.

Hide child attributes

assistantProvider.assistantId

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

assistantProvider.description

string

assistantProvider.model

object

Hide child attributes

assistantProvider.model.modelProviderName

string

required

Model provider name.

Example:

"openai"

assistantProvider.model.template

object

Hide child attributes

assistantProvider.model.template.prompt

object[]

Hide child attributes

assistantProvider.model.template.prompt.role

string

Example:

"system"

assistantProvider.model.template.prompt.content

string

Example:

"You are a helpful support assistant."

assistantProvider.model.template.promptVariables

object[]

Hide child attributes

assistantProvider.model.template.promptVariables.id

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

assistantProvider.model.template.promptVariables.name

string

assistantProvider.model.template.promptVariables.type

string

assistantProvider.model.template.promptVariables.defaultValue

string

assistantProvider.model.assistantModelOptions

object[]

Hide child attributes

assistantProvider.model.assistantModelOptions.id

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

assistantProvider.model.assistantModelOptions.key

string

assistantProvider.model.assistantModelOptions.value

string

assistantProvider.agentkit

object

Hide child attributes

assistantProvider.agentkit.agentKitUrl

string

required

AgentKit gRPC endpoint in host or host:port format.

Example:

"agent.your-domain.com:50051"

assistantProvider.agentkit.certificate

string

Optional PEM CA certificate for private or self-signed TLS.

assistantProvider.agentkit.metadata

object

gRPC metadata sent to the AgentKit backend.

Hide child attributes

assistantProvider.agentkit.metadata.{key}

string

assistantProvider.agentkit.transportSecurity

enum<string>

default:TLS

AgentKit transport security mode.

Available options:

TLS,

PLAINTEXT

assistantProvider.agentkit.tlsVerification

enum<string>

default:VERIFY

AgentKit TLS verification mode.

Available options:

VERIFY,

SKIP_VERIFY

assistantProvider.agentkit.tlsServerName

string

TLS server name override for certificate verification.

Example:

"agent.your-domain.com"

assistantProvider.agentkit.connectTimeoutMs

integer<uint32>

default:10000

Connection timeout in milliseconds.

Required range: 1 <= x <= 300000

assistantProvider.agentkit.keepaliveTimeMs

integer<uint32>

default:30000

Keepalive ping interval in milliseconds.

Required range: 10000 <= x <= 3600000

assistantProvider.agentkit.keepaliveTimeoutMs

integer<uint32>

default:10000

Keepalive response timeout in milliseconds.

Required range: 1000 <= x <= 300000

assistantProvider.agentkit.maxRecvMessageBytes

integer<uint32>

default:16777216

Maximum inbound gRPC message size.

Required range: 1024 <= x <= 104857600

assistantProvider.agentkit.maxSendMessageBytes

integer<uint32>

default:16777216

Maximum outbound gRPC message size.

Required range: 1024 <= x <= 104857600

assistantProvider.websocket

object

Hide child attributes

assistantProvider.websocket.websocketUrl

string

required

WebSocket provider URL.

Example:

"wss://agent.example.com/ws"

assistantProvider.websocket.headers

object

Hide child attributes

assistantProvider.websocket.headers.{key}

string

assistantProvider.websocket.connectionParameters

object

Hide child attributes

assistantProvider.websocket.connectionParameters.{key}

string

name

string

required

Assistant name.

Example:

"Support assistant"

assistantKnowledges

object[]

Hide child attributes

assistantKnowledges.knowledgeId

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

assistantKnowledges.assistantId

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

assistantKnowledges.rerankerModelProviderId

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

assistantKnowledges.rerankerModelProviderName

string

assistantKnowledges.assistantKnowledgeRerankerOptions

object[]

Hide child attributes

assistantKnowledges.assistantKnowledgeRerankerOptions.id

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

assistantKnowledges.assistantKnowledgeRerankerOptions.key

string

assistantKnowledges.assistantKnowledgeRerankerOptions.value

string

assistantKnowledges.topK

integer<uint32>

Example:

5

assistantKnowledges.scoreThreshold

number<float>

Example:

0.5

assistantKnowledges.retrievalMethod

string

Example:

"semantic"

assistantKnowledges.rerankerEnable

boolean

assistantTools

object[]

Hide child attributes

assistantTools.assistantId

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

assistantTools.name

string

Example:

"handoff"

assistantTools.description

string

assistantTools.fields

object

assistantTools.executionMethod

string

assistantTools.executionOptions

object[]

Hide child attributes

assistantTools.executionOptions.id

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

assistantTools.executionOptions.key

string

assistantTools.executionOptions.value

string

description

string

Assistant description.

Example:

"Answers customer support questions."

visibility

string

Assistant visibility.

Example:

"private"

language

string

Assistant language code.

Example:

"en"

source

string

Optional source system for imported assistants.

sourceIdentifier

string

Optional source-system identifier.

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

Response

Assistant created.

code

integer<int32>

Example:

200

success

boolean

Example:

true

data

object

Hide child attributes

data.id

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

data.status

string

data.visibility

string

data.source

string

data.sourceIdentifier

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

data.projectId

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

data.organizationId

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

data.assistantProvider

string

data.assistantProviderId

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

data.name

string

data.description

string

data.assistantProviderModel

object

Hide child attributes

data.assistantProviderModel.id

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

data.assistantProviderModel.template

object

Hide child attributes

data.assistantProviderModel.template.prompt

object[]

Hide child attributes

data.assistantProviderModel.template.prompt.role

string

Example:

"system"

data.assistantProviderModel.template.prompt.content

string

Example:

"You are a helpful support assistant."

data.assistantProviderModel.template.promptVariables

object[]

Hide child attributes

data.assistantProviderModel.template.promptVariables.id

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

data.assistantProviderModel.template.promptVariables.name

string

data.assistantProviderModel.template.promptVariables.type

string

data.assistantProviderModel.template.promptVariables.defaultValue

string

data.assistantProviderModel.description

string

data.assistantProviderModel.assistantId

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

data.assistantProviderModel.modelProviderName

string

data.assistantProviderModel.assistantModelOptions

object[]

Hide child attributes

data.assistantProviderModel.assistantModelOptions.id

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

data.assistantProviderModel.assistantModelOptions.key

string

data.assistantProviderModel.assistantModelOptions.value

string

data.assistantProviderModel.status

string

data.assistantProviderAgentkit

object

Hide child attributes

data.assistantProviderAgentkit.id

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

data.assistantProviderAgentkit.description

string

data.assistantProviderAgentkit.assistantId

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

data.assistantProviderAgentkit.status

string

data.assistantProviderAgentkit.url

string

data.assistantProviderAgentkit.certificate

string

data.assistantProviderAgentkit.metadata

object

Hide child attributes

data.assistantProviderAgentkit.metadata.{key}

string

data.assistantProviderAgentkit.transportSecurity

string

data.assistantProviderAgentkit.tlsVerification

string

data.assistantProviderAgentkit.tlsServerName

string

data.assistantProviderAgentkit.connectTimeoutMs

integer<uint32>

data.assistantProviderAgentkit.keepaliveTimeMs

integer<uint32>

data.assistantProviderAgentkit.keepaliveTimeoutMs

integer<uint32>

data.assistantProviderAgentkit.maxRecvMessageBytes

integer<uint32>

data.assistantProviderAgentkit.maxSendMessageBytes

integer<uint32>

data.assistantProviderWebsocket

object

Hide child attributes

data.assistantProviderWebsocket.id

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

data.assistantProviderWebsocket.description

string

data.assistantProviderWebsocket.assistantId

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

data.assistantProviderWebsocket.url

string

data.assistantProviderWebsocket.headers

object

Hide child attributes

data.assistantProviderWebsocket.headers.{key}

string

data.assistantProviderWebsocket.parameters

object

Hide child attributes

data.assistantProviderWebsocket.parameters.{key}

string

data.assistantProviderWebsocket.status

string

data.assistantTag

object

Hide child attributes

data.assistantTag.id

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

data.assistantTag.assistantId

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

data.assistantTag.tag

string[]

data.createdBy

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

data.updatedBy

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

data.createdDate

string<date-time>

data.updatedDate

string<date-time>

data.assistantTools

object[]

Hide child attributes

data.assistantTools.id

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

data.assistantTools.assistantId

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

data.assistantTools.name

string

data.assistantTools.description

string

data.assistantTools.fields

object

data.assistantTools.executionMethod

string

data.assistantTools.executionOptions

object[]

Hide child attributes

data.assistantTools.executionOptions.id

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

data.assistantTools.executionOptions.key

string

data.assistantTools.executionOptions.value

string

data.assistantTools.status

string

data.assistantKnowledges

object[]

Hide child attributes

data.assistantKnowledges.id

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

data.assistantKnowledges.knowledgeId

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

data.assistantKnowledges.rerankerEnable

boolean

data.assistantKnowledges.topK

integer<uint32>

data.assistantKnowledges.scoreThreshold

number<float>

data.assistantKnowledges.retrievalMethod

string

data.assistantKnowledges.rerankerModelProviderId

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

data.assistantKnowledges.rerankerModelProviderName

string

data.assistantKnowledges.assistantKnowledgeRerankerOptions

object[]

Hide child attributes

data.assistantKnowledges.assistantKnowledgeRerankerOptions.id

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

data.assistantKnowledges.assistantKnowledgeRerankerOptions.key

string

data.assistantKnowledges.assistantKnowledgeRerankerOptions.value

string

data.assistantKnowledges.status

string

error

object

Platform error response details. errorCode is a stable platform error code. See PlatformErrorCode for documented code/message mappings.

Hide child attributes

error.errorCode

string

Stable platform error code.

Pattern: ^[0-9]+$

Example:

"1002003"

error.errorMessage

string

Stable client-safe error message.

Example:

"missing toNumber parameter"

error.humanMessage

string

Client-safe human-readable message.

Example:

"Please provide the required toNumber parameter."

Assistant

Assistant deployments

Calls

Authorizations

Headers

Body

Response